Snooze / Unsnooze Products

When customers want to make one or more products or modifiers temporarily unavailable online, they will action a 'Snooze' request to prevent the item being ordered for a certain period of time. This would typically be a response to items going out of stock.

Snoozed Items on Active Menus Only
Only when a menu is published successfully to a channel, will snooze events be triggered for items contained in the menu.

Payload

Both Snooze and Unsnooze events will be communicated to all channels hosting a menu containing the snoozed items. When the snooze timeframe lapses or the snoozed status is manually removed, items will be automatically unsnoozed. Channels should therefore anticipate that items may become unsnoozed at any time, even before the originally specified snooze period ends.

string
required

accountId is the unique identifier of the customer account in Deliverect.

string
required

locationId is Deliverect's unique identifier of a physical restaurant location, store, or kitchen.

string
required

channelLinkId is an individual store’s unique ID in Deliverect.

operations
array of objects
required
length ≥ 1

Snooze or unsnooze operations to apply.

operations*
string
enum
required

"snooze" or "unsnooze".

Allowed:
data
object
required
allSnoozedItems
array of objects

Each time you receive a snooze request for your channel, you will also receive the complete list of all items (allSnoozedItems) that should currently be in a snoozed state, i.e. all previously snoozed items will be included with each request. This additional list of items can be disabled if required via Channel settings.

allSnoozedItems
Headers
string
required
Defaults to Deliverect/{version}

Identifies Deliverect as the sender of the webhook, in the format Deliverect/{version}.

string
required
Defaults to {signature}

HMAC-SHA256 signature of the raw request body, generated with your shared secret. Recompute the signature on receipt and compare it to this value to verify the request came from Deliverect (see the HMAC authentication guide).

Responses

LoadingLoading…