Get list of items

Lists the items in your catalog.

GET /v2/product/list

Get list of items

cURL

curl --request GET \
  --url https://app.getswipe.in/api/partner/v2/product/list \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "message": "",
  "error_code": "",
  "errors": {},
  "data": {
    "items": [
      {
        "id": "ITEM123",
        "name": "Item Name",
        "quantity": 1,
        "unit_price": 100,
        "price_with_tax": 118,
        "item_type": "Product",
        "tax_rate": 18,
        "discount_percent": 10,
        "description": "Item Description",
        "hsn_code": "1234",
        "unit": "kg",
        "category": "Electronics",
        "swipe_id": 1,
        "developer_note": "This is a developer note"
      }
    ],
    "total_records": 10
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is an API key from the API Integration section of your dashboard. Keys are scoped to the company they are generated in — for testing, add a separate test company and generate the key there, so requests never touch your real books.

Query Parameters

num_records · string · default: 25

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

page · integer · default: 1

Page number

Response

200

application/json

Item List fetched successfully

success · boolean

Success flag

Example:

true

message · string

Response message

Example:

""

error_code · string

Error Code

Example:

""

errors · object

Errors

data · object

Show child attributes