Get Product List API

Endpoint

GET /product

Headers

Request Parameters (Query String)

Key	Value	Required	Default
limit	100	No	100
offset	0	No	0
term	product_sku or name	No	null

Pagination

For pagination of Product List API and Order List API, you can pass the limit and offset query parameters. The default value for limit is 100 and for offset is 0. The maximum value for limit is 100.

Response Body

Field	Type	Description
items	array	List of products. See Product Object for details.
total	integer	Total number of products matching the query parameters.

Product Object

Field	Type	Description
id	string	Unique identifier for the product
organization	Organization Object	Organization that owns the product. See Organization Object for details
sku	string	Stock keeping unit
brand	Brand Object	Brand information. See Brand Object for details
gtin	string	Global Trade Item Number
name	string	Product name
remarks	string	Additional remarks about the product
imageMain	string	URL of the main product image
packageLengthMm	number	Package length in millimeters
packageWidthMm	number	Package width in millimeters
packageHeightMm	number	Package height in millimeters
shippingWeightKg	number	Shipping weight in kilograms
caseUnit	string	Unit of measurement for cases (e.g., "EACH", "CARTON")
casePack	integer	Number of items per case
caseLengthMm	number	Case length in millimeters
caseWidthMm	number	Case width in millimeters
caseHeightMm	number	Case height in millimeters
caseWeightKg	number	Case weight in kilograms
condition	string	Product condition (e.g., "NEW")
serialNumberRequired	boolean	Whether serial number is required
expiryDateRequired	boolean	Whether expiry date is required
unknown	boolean	Whether the product is unknown
createdAt	string	Timestamp when the product was created (ISO 8601 format)
updatedAt	string	Timestamp when the product was last updated (ISO 8601 format)
otherIds	array	List of other identifiers associated with the product

Organization Object

Field	Type	Description
id	string	Unique identifier for the organization
name	string	Name of the organization
createdAt	string	Timestamp when the organization was created (ISO 8601 format)
updatedAt	string	Timestamp when the organization was last updated (ISO 8601 format)

Brand Object

Field	Type	Description
id	string	Unique identifier for the brand
name	string	Brand name
nameNormalized	string	Normalized version of the brand name
createdAt	string	Timestamp when the brand was created (ISO 8601 format)

Response Example

json

{
  "items": [
    {
      "id": "x4053402-e79b-45c2-8621-377d28060777",
      "organization": {
        "id": "xf424caf-0eba-4813-b3e7-7ca0393af777",
        "name": "test organization",
        "createdAt": "2024-03-05T22:17:23.520948Z",
        "updatedAt": "2024-04-09T21:15:15.615765Z"
      },
      "sku": "sku-BLACK",
      "brand": {
        "id": "x643b7ee-7df1-48c6-b690-1e29ffa8a777",
        "name": "",
        "nameNormalized": "",
        "createdAt": "2024-03-05T22:17:28.679732Z"
      },
      "gtin": "80000000",
      "name": "SKU 01 Black",
      "remarks": "",
      "imageMain": "",
      "packageLengthMm": 1470.0,
      "packageWidthMm": 310.0,
      "packageHeightMm": 790.0,
      "shippingWeightKg": 34.0,
      "caseUnit": "EACH",
      "casePack": 0,
      "caseLengthMm": 0.0,
      "caseWidthMm": 0.0,
      "caseHeightMm": 0.0,
      "caseWeightKg": 0.0,
      "condition": "NEW",
      "serialNumberRequired": false,
      "expiryDateRequired": false,
      "unknown": false,
      "createdAt": "2024-03-05T22:20:44.087204Z",
      "updatedAt": "2024-03-05T22:20:44.087204Z",
      "otherIds": []
    },
    {
      "id": "xx0352eb-241a-4cac-834f-e0980ffca777",
      "organization": {
        "id": "3f424caf-0eba-4813-b3e7-7ca0393af777",
        "name": "test organization",
        "createdAt": "2024-03-05T22:17:23.520948Z",
        "updatedAt": "2024-04-09T21:15:15.615765Z"
      },
      "sku": "sku-N-BLUE",
      "brand": {
        "id": "5643b7ee-7df1-48c6-b690-1e29ffa8a777",
        "name": "",
        "nameNormalized": "",
        "createdAt": "2024-03-05T22:17:28.679732Z"
      },
      "gtin": "",
      "name": "SKU N Blue",
      "remarks": "",
      "imageMain": "",
      "packageLengthMm": 1500.0,
      "packageWidthMm": 260.0,
      "packageHeightMm": 810.0,
      "shippingWeightKg": 34.0,
      "caseUnit": "CARTON",
      "casePack": 1,
      "caseLengthMm": 0.0,
      "caseWidthMm": 0.0,
      "caseHeightMm": 0.0,
      "caseWeightKg": 0.0,
      "condition": "NEW",
      "serialNumberRequired": false,
      "expiryDateRequired": false,
      "unknown": false,
      "createdAt": "2024-03-05T22:20:44.106742Z",
      "updatedAt": "2024-04-01T14:31:19.875675Z",
      "otherIds": []
    },
    {
      "id": "bab7c35b-2ecb-4b40-be82-8dc1e0a86171",
      "organization": {
        "id": "3f424caf-0eba-4813-b3e7-7ca0393af888",
        "name": "test organization",
        "createdAt": "2024-03-05T22:17:23.520948Z",
        "updatedAt": "2024-04-09T21:15:15.615765Z"
      },
      "sku": "SKU-GREY",
      "brand": {
        "id": "5643b7ee-7df1-48c6-b690-1e29ffa8ab33",
        "name": "",
        "nameNormalized": "",
        "createdAt": "2024-03-05T22:17:28.679732Z"
      },
      "gtin": "",
      "name": "SKU GREY",
      "remarks": "",
      "imageMain": "",
      "packageLengthMm": 1500.0,
      "packageWidthMm": 260.0,
      "packageHeightMm": 810.0,
      "shippingWeightKg": 35.0,
      "caseUnit": "CARTON",
      "casePack": 1,
      "caseLengthMm": 0.0,
      "caseWidthMm": 0.0,
      "caseHeightMm": 0.0,
      "caseWeightKg": 0.0,
      "condition": "NEW",
      "serialNumberRequired": false,
      "expiryDateRequired": false,
      "unknown": false,
      "createdAt": "2024-03-05T22:20:44.132006Z",
      "updatedAt": "2024-04-01T14:31:19.885955Z",
      "otherIds": []
    },
    {
      "id": "4d5ab278-86f3-4237-993b-b16a19367777",
      "organization": {
        "id": "3f424caf-0eba-4813-b3e7-7ca0393af777",
        "name": "test organization",
        "createdAt": "2024-03-05T22:17:23.520948Z",
        "updatedAt": "2024-04-09T21:15:15.615765Z"
      },
      "sku": "SKU-LIGHT-GRAY",
      "brand": {
        "id": "5643b7ee-7df1-48c6-b690-1e29ffa8a777",
        "name": "",
        "nameNormalized": "",
        "createdAt": "2024-03-05T22:17:28.679732Z"
      },
      "gtin": "",
      "name": "SKU LIGHT GRAY",
      "remarks": "",
      "imageMain": "",
      "packageLengthMm": 1520.0,
      "packageWidthMm": 310.0,
      "packageHeightMm": 820.0,
      "shippingWeightKg": 44.0,
      "caseUnit": "CARTON",
      "casePack": 1,
      "caseLengthMm": 0.0,
      "caseWidthMm": 0.0,
      "caseHeightMm": 0.0,
      "caseWeightKg": 0.0,
      "condition": "NEW",
      "serialNumberRequired": false,
      "expiryDateRequired": false,
      "unknown": false,
      "createdAt": "2024-04-01T14:31:19.830702Z",
      "updatedAt": "2024-04-01T14:31:19.830702Z",
      "otherIds": []
    }
  ],
  "total": 4
}

Get Product List API ​

Endpoint ​

Headers ​

Request Parameters (Query String) ​

Pagination ​

Response Body ​

Product Object ​

Organization Object ​

Brand Object ​

Response Example ​