DUMA/ API

List products

Lists the products that are for sale, with their sizes, prices and availability at the key’s location. Sorted by the catalogue’s own order, then name.

GEThttps://api.duma-business.com/v1/store/products

catalog:readPublishable or secret key

Responses carry Cache-Control: private, max-age=30 and Vary: Authorization, X-Api-Key, Origin.

price on a product is the lowest price of any size — “from £48”.

compareAtPrice is only set when it is higher than price. stock is null for sizes whose stock is not tracked; tracked stock needs a whole unit on hand at the key’s location to be available.

Request example

Example request
curl -X GET "https://api.duma-business.com/v1/store/products" \
  -H "Authorization: Bearer dk_pub_…"

Query parameters

categorystring
A category slug or id. An unknown category returns an empty page.
qstring
Searches product names and descriptions.
limitnumberDefault 24
Products per page, 1–100.
pagenumberDefault 1
The page to return, from 1.
localestring
A language code from GET /locales. Text comes in that language, falling back along its fallback languages, then the default.
currencystring
A three-letter currency code. Otherwise the language’s currency, otherwise the workspace’s. A product with no price in the requested currency stays in the workspace’s, and its currency says which.

Response

Response · 200
{
  "data": [
    {
      "id": "8f1c2a4e-3b6d-4c1e-9a7f-2d5b8e0c4a13",
      "slug": "oversized-hoodie",
      "name": "Oversized Hoodie",
      "description": "Heavyweight organic cotton, brushed inside.",
      "category": {
        "id": "c2a7e5d1-9f3b-4a6c-8e1d-5b7f0a2c3e94",
        "name": "Hoodies",
        "slug": "hoodies"
      },
      "images": [
        {
          "url": "https://api.duma-business.com/v1/cms/delivery/assets/5e9a1c7b-2d4f-4b8e-a6c3-1f0d9e8b7a62/file/hoodie-black.jpg",
          "altText": "Oversized Hoodie in black",
          "width": 2000,
          "height": 2500,
          "focalPoint": {
            "x": 0.5,
            "y": 0.4
          },
          "srcset": "https://api.duma-business.com/v1/cms/delivery/assets/5e9a1c7b-2d4f-4b8e-a6c3-1f0d9e8b7a62/renditions/a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d 640w, https://api.duma-business.com/v1/cms/delivery/assets/5e9a1c7b-2d4f-4b8e-a6c3-1f0d9e8b7a62/file/hoodie-black.jpg 2000w",
          "option": {
            "name": "Colour",
            "value": "Black"
          }
        }
      ],
      "currency": "GBP",
      "price": "48.00",
      "available": true,
      "options": [
        {
          "name": "Size",
          "values": [
            "S",
            "M",
            "L"
          ]
        },
        {
          "name": "Colour",
          "values": [
            "Black"
          ]
        }
      ],
      "variants": [
        {
          "id": "3d7e9b1a-6c4f-4e2d-b8a5-9f0c1e2d3a4b",
          "name": "M / Black",
          "sku": "HOOD-BLK-M",
          "barcode": "5012345678900",
          "options": {
            "Size": "M",
            "Colour": "Black"
          },
          "price": "48.00",
          "compareAtPrice": "60.00",
          "available": true,
          "stock": 7
        }
      ]
    }
  ],
  "meta": {
    "total": 36,
    "limit": 24,
    "page": 1,
    "pages": 2
  }
}