Skip to main content
GET
/
consumers
/
{consumer_id}
/
commerce
/
products
Get all products
curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/commerce/products \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "source_ref": {
        "id": "<string>",
        "model": "<string>"
      },
      "name": "<string>",
      "description": "<string>",
      "description_html": "<string>",
      "categories": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "created_on": "2023-11-07T05:31:56Z",
      "last_updated_on": "2023-11-07T05:31:56Z",
      "variants": [
        {
          "id": "<string>",
          "source_ref": {
            "id": "<string>",
            "model": "<string>"
          },
          "parent_id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "description_html": "<string>",
          "categories": [
            {
              "id": "<string>",
              "name": "<string>"
            }
          ],
          "created_on": "2023-11-07T05:31:56Z",
          "sku": "<string>",
          "barcode": "<string>",
          "available_quantity": 123,
          "prices": [
            {
              "currency": "<string>",
              "price": 123
            }
          ],
          "unit_cost": {
            "amount": 123,
            "currency": "<string>"
          },
          "unit_of_measure": "<string>",
          "weight": 123,
          "weight_unit": "<string>",
          "status": "unknown",
          "variant_attributes": [
            {
              "name": "<string>",
              "value": "<string>"
            }
          ],
          "variant_images": [
            {
              "id": "<string>",
              "main_image": true,
              "url": "<string>"
            }
          ]
        }
      ],
      "status": "unknown",
      "sku": "<string>",
      "common_attributes": [
        {
          "name": "<string>",
          "values": [
            "<string>"
          ]
        }
      ],
      "variant_attributes_options": [
        {
          "name": "<string>",
          "values": [
            "<string>"
          ]
        }
      ],
      "common_images": [
        {
          "id": "<string>",
          "main_image": true,
          "url": "<string>"
        }
      ]
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2
}

Authorizations

​
Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

​
consumer_id
string<uuid>
required

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
size
integer
default:50

Page size

Required range: 1 <= x <= 100
​
updated_after
string<date-time> | null

Retrieve products updated after a specific datetime (e.g. 2025-01-31T15:00:00 for 31 of January 2025 at 3PM UTC). UTC is the only format that is supported on all connectors.

​
sku
string | null

SKU of the product. Supports multiple values separated by comma

Response

Successful Response

​
items
ProductItem · object[]
required
​
total
integer
required
Required range: x >= 0
​
page
integer
required
Required range: x >= 1
​
size
integer
required
Required range: x >= 1