Sign in

v1

latestOpenAPI 3.1.02026-07-1342112262.5 KB
Items

Fetch an item

Fetch an item

Required scope: business/catalogue:read

Deprecated alias: business/products:read (still accepted, will be removed in a future release)

get/v1/items/{item_id}

Path parameters

item_idstring required

The unique identifier of the item.

The unique identifier of the item.

Query parameters

expandExpandableItem[] nullable

Specifies which related entities to inflate in the response. Repeat the parameter to expand multiple entities, e.g. ?expand=brand&expand=category. By default, related entities are returned only as identifiers (e.g. brand_id, category_id).

Specifies which related entities to inflate in the response. Repeat the parameter to expand multiple entities, e.g. ?expand=brand&expand=category. By default, related entities are returned only as identifiers (e.g. brand_id, category_id).

Response

Successful Response

OR

Example response

{
  "brand_id": "1757511249592-ab46acf9-7c86-4ee0-92b9-6b43e1429337",
  "category_id": "1757511249593-dd25e17c-5541-4276-a078-8c3dcca296de",
  "created_at": "2024-11-19T15:27:02+00:00",
  "default_price": {
    "amount": 3800,
    "currency": "ZAR"
  },
  "description": "A rich espresso with silky steamed milk and microfoam, smooth and balanced.",
  "has_multiple_variants": false,
  "id": "1584347797665-e75edf46-394c-446a-8d25-5a6e0f244cef",
  "images": [
    {
      "created_at": "2024-11-19T15:27:02+00:00",
      "id": "1757533814961-58f649da-81e3-4877-8769-f407cfba8aff",
      "mime_type": "image/jpeg",
      "type": "image",
      "updated_at": "2024-11-19T16:27:23+00:00",
      "url": "https://images.yoco.com/foo/bar.jpg"
    }
  ],
  "is_taxable": true,
  "modifier_groups": [],
  "name": "Flat White",
  "options": [],
  "taxes": [
    {
      "name": "VAT",
      "percentage": "15.00",
      "type": "inclusive"
    }
  ],
  "type": "product",
  "updated_at": "2024-11-19T16:27:23+00:00",
  "variants": []
}