GEgetswipe
Product

Get list of items

Changed on

v1 is deprecated — use the v2 endpoint instead. Lists the items in your catalog.

get/v1/product/list

Request

  • Base URL
    https://app.getswipe.in/api/partner
  • URL
    https://app.getswipe.in/api/partner/v1/product/list
  • Auth
    HTTP bearer

Query parameters

num_recordsstring

Number of records to fetch (max 100), default : 25 items will be sent in response

pageinteger

Page number

sort_by'name' | 'category' | 'quantity' | 'unit_price' | 'price_with_tax' | 'tax_rate' | 'created_at' | 'updated_at'

Field to sort the items by. If omitted, items are returned in creation order.

sort_order'asc' | 'desc'

Sort direction applied when sort_by is set: 'asc' (default) or 'desc'.

Response

Item List fetched successfully

successboolean

Success flag

total_recordsinteger

Total Records available

Example response

{
  "success": true,
  "items": [
    {
      "id": "ITEM123",
      "name": "Item Name",
      "quantity": 1,
      "unit_price": 100,
      "tax_rate": 18,
      "price_with_tax": 118,
      "discount_percent": 10,
      "description": "Item Description",
      "hsn_code": "1234",
      "item_type": "Product",
      "unit": "kg",
      "category": "Electronics"
    }
  ],
  "total_records": 10
}

Changes