Sign in

v1

latestOpenAPI 3.0.12026-08-062555238.4 KB
Store API endpoints

Update branch status on SuperApp

Use this endpoint to update a branch's status on SuperApp.

A branch can hold one of following statuses:

  • Active (1): Branch is active on the platform and customers are able to place orders.
  • Inactive (2): Branch is active on the platform but customers would not be able to place orders.

Please be aware that it may take approximately 5 minutes for the changes to be reflected on the SuperApp.

post/branches/{branch_id}/visibility/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

status_idinteger required

status of the branch which must take effect.

Example request

{
  "status_id": 2
}

Response

Branch status updated successfully