Sign in

v1

latestOpenAPI 3.1.02026-07-1342112262.5 KB
Item Brands

Fetch an item brand

Fetch an item brand

Required scope: business/catalogue:read

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

get/v1/item_brands/{item_brand_id}

Path parameters

item_brand_idstring required

The unique identifier of the item brand.

The unique identifier of the item brand.

Response

Successful Response

idstring required

The unique identifier of the brand.

namestring required

The name of the brand.

descriptionstring nullable required

A description of the brand.

created_atstring date-time required

The brand creation date and time in ISO 8601 format.

updated_atstring date-time nullable required

The date and time the brand was last modified in ISO 8601 format.

Example response

{
  "created_at": "2024-11-19T15:27:02+00:00",
  "description": "Italy's iconic coffee brand, blending tradition and innovation for rich, authentic flavor.",
  "id": "1757511249592-ab46acf9-7c86-4ee0-92b9-6b43e1429337",
  "image": {
    "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"
  },
  "name": "Lavazza",
  "updated_at": "2024-11-19T16:27:23+00:00"
}