Sign in

v1

latestOpenAPI 3.0.12026-08-062555238.4 KB
Store API endpoints

Fetch a brand

Use this endpoint to fetch an existing brand by its ID.

get/brands/{brand_id}

Path parameters

brand_idstring required

A unique brand ID string provided by vendor or restaurant

Headers

Authorizationstring required
User-Agentstring required

Response

Brand retrieved successfully

idstring required

A unique brand ID string provided by vendor or restaurant. brand.

namestring required

The name of the brand.

state'UNMAPPED' | 'MAPPED' required

The state of this brand.

created_atstring required

Time RFC3339 format in UTC in which the brand has been updated

updated_atstring required

Time RFC3339 format in UTC in which the brand has been updated

Example response

{
  "id": "123004",
  "name": "KFC",
  "state": "MAPPED",
  "created_at": "2020-06-22T15:01:32.895Z",
  "updated_at": "2020-06-22T15:01:32.895Z"
}