Sign in

v1

latestOpenAPI 3.0.12026-08-062555238.4 KB
Store API endpoints

Set branch status for a specified duration on SuperApp

Use this endpoint to set a branch's status for a specified duration on SuperApp.

In the event of a busy kitchen or unforeseen circumstances that cause delays in order fulfillment, this API can be a useful solution.

post/branches/{branch_id}/visibility/status/expiries

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

Accepted values (2)

till_timeinteger required

Time in minutes until branch must stay in given status.

Example request

{
  "status_id": 2,
  "till_time": 15
}

Response

Branch status expiry created successfully

branch_idstring required

vendor branch id

status_idinteger required

status id

start_datestring required

effective start date and time of given status.

end_datestring required

effective end date and time of given status.

created_atstring required

effective created at date and time of given status.

updated_atstring required

effective updated at date and time of given status.

Example response

{
  "branch_id": "branch-id",
  "status_id": 2,
  "start_date": "2021-10-25T15:03:17.131029Z",
  "end_date": "2021-10-25T15:03:17.131029Z",
  "created_at": "2021-10-25T15:03:17.131029Z",
  "updated_at": "2021-10-25T15:03:17.131029Z"
}