Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Products

List Products

Retrieve a list of products.

get/v1/products

Query parameters

limitinteger

Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.

pageinteger

Which page of results to return. The lowest value is 1.

order'created_at' | '-created_at' | 'updated_at' | '-updated_at' | 'type' | '-type' | 'code' | '-code' | 'campaign' | '-campaign' | 'category' | '-category'

Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.

start_datestring date-time
Example:2023-12-22T10:13:06.487Z

Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.

end_datestring date-time
Example:2023-12-22T10:13:06.487Z

Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.

Response

Returns a dictionary with product objects. The products are returned sorted by creation date by default, with the most recent products appearing last, unless you specify another sequence using the order query parameter.

objectstring required

The type of the object represented by JSON. This object stores information about products in a dictionary.

data_refstring required

Identifies the name of the attribute that contains the array of product objects.

totalinteger required

Total number of product objects.

Example response

{
  "products": [
    {
      "id": "prod_0b1da8105693710357",
      "source_id": "productSourceID16",
      "name": "T-shirt",
      "image_url": "https://images.com/original.jpg",
      "created_at": "2022-05-23T06:52:55.008Z",
      "updated_at": "2022-05-23T09:24:07.405Z",
      "skus": {
        "data": [
          {
            "id": "sku_0b1621b319d248b79f",
            "source_id": "sku_source_id_4",
            "product_id": "prod_0b15f6b9f650c16990",
            "sku": "Large Pink Shirt",
            "currency": "USD",
            "created_at": "2022-05-17T10:36:30.187Z",
            "updated_at": "2022-05-17T10:55:09.137Z"
          }
        ]
      }
    }
  ]
}