Sign in

v1

latestOpenAPI 3.0.12026-08-062555238.4 KB
Store API endpoints

Fetch a branch

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

get/branches/{branch_id}

Path parameters

branch_idinteger required

Headers

Authorizationstring required
User-Agentstring required
Brand-Idstring required

Response

Branch retrieved successfully

idstring required

The id of the branch

namestring required

The name of the branch.

brand_idstring required

the parent brand id of this branch

state'UNMAPPED' | 'MAPPED' required

The state of this branch.

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": "a34587b290784c06",
  "name": "KFC, JLT",
  "brand_id": "1228a02e60e34037",
  "state": "MAPPED",
  "created_at": "2020-06-22T15:01:32.895Z",
  "updated_at": "2020-06-22T15:01:32.895Z"
}