Sign in

v1

latestOpenAPI 3.0.12026-08-062555238.4 KB
Store API endpoints

Toggle POS integration

Use this endpoint to enable or disable POS integration for a branch.

By default, this toggle is disabled when a branch is created. This is to ensure that vendors can verify that the catalog syncs are successful before enabling the POS integration. Once enabled, orders will be processed through the partner's POS system. If the toggle is disabled, orders will not flow through the POS system. Instead, they will be processed manually through the branch's tablets. However, catalog syncs can still be made for the branch, even if the toggle is off.

patch/branches/{branch_id}/status

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

activeboolean

Example request

{
  "active": true
}

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