Skip to navigation

Snooze / unsnooze items for an outlet

View as MarkdownOpen in Claude

Temporarily disable or re-enable items for a specific outlet.

Item matching: Items are matched by itemCode → items.item_code.

Snooze (disable until a time):

  • Send snoozeEnd with a RFC 3339 datetime → sets item_store.disabled_until
  • Item is unavailable until that time, then automatically available again
{
"items": [
{ "itemCode": "DIM-001", "snoozeEnd": "2026-03-13T22:00:00Z" },
{ "itemCode": "WOK-003", "snoozeEnd": "2026-03-13T14:00:00Z" }
]
}

Unsnooze (re-enable immediately):

  • Omit snoozeEnd or send null → clears item_store.disabled_until
{
"items": [
{ "itemCode": "DIM-001", "snoozeEnd": null }
]
}

Important:

  • sell_available is NOT modified — snooze is a time-bounded pause, not a permanent toggle

Authentication

X-Api-Keystring
API Key authentication via header

Path parameters

outletIdstringRequired
Outlet UUID

Headers

X-Tenant-IDstringOptional
Tenant identifier
X-ProviderstringOptional

POS provider name (validated against tenant settings)

Request

This endpoint expects an object.
itemslist of objectsRequired

Response

OK
statusstring
itemsUpdatedinteger
modifierOptionsUpdatedinteger

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error