POST https://webhook.example.com
Bearer auth

Busy Mode

When a restaurant is busy, it may have to prevent new orders temporarily. When this happens, your channel will receive busy mode requests from Deliverect.

Request format Have a look at an example request on the right. Busy mode requests contain accountId, locationId, and channelLinkId to point out the target store. There's also a status entry, which can take two (string) values outlined in the table below.

Status Meaning
PAUSED Request to enable busy mode. The store should be 'paused' or closed temporarily, indicating that the restaurant is currently busy.
ONLINE This is a request to disable busy mode. The store should be open as normal.
BUSY It is the equivalent to busy mode orange, it communicates the location is currently busy. ASAP orders should not go be possible while Busy mode orange is set. The "delay" in minutes, provides an indication to increase the pickupTime on the channel end when creating a new order.

The response should indicate pausing or unpausing the store was successful with a 200 OK status code. The body of the response should echo the current status of the store after having made the change ("PAUSED" , "ONLINE", "BUSY"). You can see this in the example responses.

The "delay" corresponds to the time in minutes for busy mode orange; "BUSY" status.

application/json

Body

  • accountId string Required

    The ID of the customer account

  • locationId string Required

    The ID of a specific location in the customer account

  • channelLinkId string Required

    The unique id of the store on the channel platform

  • status string Required

    True if the store is in busy mode, false otherwise

Responses

  • 200 application/json

    Ok

    Hide response attribute Show response attribute object
    • message string
  • 400 application/json

    Bad Request

POST /channel/busy_mode
Request examples 
{
  "accountId": "5b****71c6489f0029****d4",
  "locationId": "5c****ecc6489f0001****b8",
  "channelLinkId": "5e****abc11dec0001****9b",
  "status": "PAUSED"
}
{
  "accountId": "5b****71c6489f0029****d4",
  "locationId": "5c****ecc6489f0001****b8",
  "channelLinkId": "5e****abc11dec0001****9b",
  "status": "ONLINE"
}
{
  "accountId": "61e14f0c888c8389fa5908bb",
  "locationId": "633d62de0f******f893bdf",
  "channelLinkId": "647618*******166c858de0b0",
  "status": "BUSY",
  "delay": 30
}
Response examples (200) 
{
  "message": "ONLINE"
}