Sign in

v1

latestOpenAPI 3.0.12026-08-062555238.4 KB
Store API endpoints

Create/update a branch

Use this endpoint to create/update a branch.

A branch belongs to a brand, and when a branch is created through this API, it is not considered as a real branch in our system. However, there is a manual process required by our operations team to map the branch to an actual Careem outlet. This process must be completed only once after each new branch is created using this API. You cannot create any catalog for a branch until it has mapped.

put/branches/{branch_id}

Path parameters

branch_idstring required

A unique branch ID string provided by vendor or restaurant

Headers

Authorizationstring required
User-Agentstring required
Brand-Idstring required

Request body

namestring required

Example request

{
  "name": "KFC, Marina"
}

Response

Branch updated 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"
}