POST https://webhook.example.com

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. When the snooze timeframe lapses, or if the snoozed status is removed manually, items will be 'Unsnoozed'.
Both the Snooze and Unsnooze events will be communicated to all channels hosting a menu containing the snoozed items.

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

  • operations array[object] Required
    Hide operations attributes Show operations attributes object
    • action string

      The action to perform on the items

      Values are snooze or unsnooze.

    • data object
      Hide data attribute Show data attribute object
      • items array[object]
        Hide items attributes Show items attributes object
        • plu string Required

          The unique identifier (Price Look-Up) of the item

        • snoozeStart string(date-time)

          When snooze status should begin in UTC

        • snoozeEnd string(date-time)

          When snooze status should end in UTC

Responses

  • 200

    Ok

  • 400

    Not Found

POST /channel/snooze
Request examples 
{
  "accountId": "5b****71c6489f0029****d4",
  "locationId": "5c****ecc6489f0001****b8",
  "channelLinkId": "5e****abc11dec0001****9b",
  "operations": [
    {
      "action": "snooze",
      "data": {
        "items": [
          {
            "plu": "PIE1",
            "snoozeStart": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
            "snoozeEnd": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ"
          },
          {
            "plu": "MSB1",
            "snoozeStart": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
            "snoozeEnd": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ"
          }
        ]
      }
    }
  ]
}
{
  "accountId": "5b****71c6489f0029****d4",
  "locationId": "5c****ecc6489f0001****b8",
  "channelLinkId": "5e****abc11dec0001****9b",
  "operations": [
    {
      "action": "snooze",
      "data": {
        "items": [
          {
            "plu": "PIE1",
            "snoozeStart": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
            "snoozeEnd": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ"
          }
        ],
        "allSnoozedItems": [
          {
            "plu": "PIE1",
            "snoozeStart": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
            "snoozeEnd": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ"
          },
          {
            "plu": "MSB1",
            "snoozeStart": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
            "snoozeEnd": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ"
          }
        ]
      }
    }
  ]
}
{
  "accountId": "5b****71c6489f0029****d4",
  "locationId": "5c****ecc6489f0001****b8",
  "channelLinkId": "5e****abc11dec0001****9b",
  "operations": [
    {
      "action": "unsnooze",
      "data": {
        "items": [
          {
            "plu": "PIE1",
            "snoozeStart": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
            "snoozeEnd": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ"
          },
          {
            "plu": "MSB1",
            "snoozeStart": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
            "snoozeEnd": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ"
          }
        ],
        "allSnoozedItems": []
      }
    }
  ]
}