Sign in
Products

List products

List the retail products available across the sites the caller's API key can access. Results are paginated and support filtering by free-text query, exact product code and inventory category. Use the show endpoint to retrieve the full product detail for any item returned here.

get/shop/products

Query parameters

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

querystring

Filter for products where the name matches a search query.

product_codestring

Filter for products with the specified product code. Partial matches can be searched by using a * wildcard.

inventory_category_idstring[]

Filter for products that belong to one of the specified inventory categories.

Response

A list of product response objects.

Example response

{
  "data": [
    {
      "name": "Dan's Hand Moisturiser",
      "currency": "gbp",
      "description": "For silky soft hands",
      "product_code": "MAS123",
      "price_from": 1000,
      "price_to": 5000,
      "standard_price": 5000,
      "image": {
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "original_url": "https://example.com/media/super-cool-photo.jpg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
      },
      "tags": [
        {
          "name": "Moisturisers"
        }
      ],
      "categories": [
        {
          "name": "Moisturisers"
        }
      ],
      "price_rules": [
        {
          "date_from": "2020-02-01",
          "date_to": "2020-04-01",
          "price": 20000
        }
      ],
      "revenue_centre": "spa",
      "customer_cancellation_permitted": "allowed",
      "customer_cancellation_min_duration": "P7D"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.