GEgetswipe
Product V2

Get list of items

Changed on

Lists the items in your catalog.

get/v2/product/list

Request

  • Base URL
    https://app.getswipe.in/api/partner
  • URL
    https://app.getswipe.in/api/partner/v2/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

messagestring

Response message

error_codestring

Error Code

errorsobject

Errors

Example response

{
  "success": true,
  "data": {
    "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",
        "developer_note": "This is a developer note"
      }
    ],
    "total_records": 10
  }
}

Changes

  • 0bcdbc62187bRevision changes
    • breaking

      for the query request parameter num_records, default value 25 was added

    • info

      api operation id v2_get_item_list removed and replaced with get_item_list

    • info

      added the new optional query request parameter sort_by

    • info

      added the new optional query request parameter sort_order

    • info

      for the query request parameter num_records, the type was generalized from integer to string

    • info

      added the optional property /// to the response with the status

    • info

      the response's property default value 0 was added for the status