HomeGuidesAPI DocumentationAPI UpdatesAsk a QuestionStatus Page
API Documentation

Snooze / Unsnooze Products

webhook
https://yourwebhook.com/snooze

Overview

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.

Format

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.

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.

Response

A snoozed product is unavailable for a set period, so this should be clear on the customer-facing menu. Two common approaches are shown below.

Unavailable state

A snoozed item can be visible but not available to select e.g. by greying out the product image.

🍔
Burger
$8.50
Sold Out
🍕
Pizza
$10.00

Back-in-stock estimate

Snooze requests include a snoozeEnd, so an estimate of when the item will be available again can be shown.

🍔
Burger
$8.50
Out of stock
until tomorrow
🍕
Pizza
$10.00

Hiding Snoozed Items
The examples above offer the best customer experience, but the key requirement is that snoozed items cannot be ordered. Removing them from view entirely is also acceptable.

Payload
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
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

Updated 7 days ago

Did this page help you?
LoadingLoading…

Updated 7 days ago

Did this page help you?