API Documentation

Busy mode

post https://yourwebhook.com/busy_mode

When a store status changes to open or closed, a webhook event will be sent

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.

StatusMeaning
PAUSEDRequest to enable busy mode. The store should be 'paused' or closed temporarily, indicating that the restaurant is currently busy.
ONLINEThis is a request to disable busy mode. The store should be open as normal.
BUSYIt is the equivalent to busy mode orange, it communicates the location is currently busy.
ASAP orders should not go through 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. 

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

{
  "status": "PAUSED"
}

{
  "status": "ONLINE"
}
Language