HomeGuidesAPI DocumentationAPI UpdatesAsk a QuestionStatus Page
API Documentation

Snooze Product by PLU

post
https://api.staging.deliverect.com/products/snoozeByPlus

Purpose

Mark products out of stock for a certain amount of time based on their PLU and location.

Snoozing

When snoozing the snoozeStart isn't required as the current time is default. A snoozeEnd time should be specified with a timestamp in the future which determines how long the item will remain in the snoozed state

Indefinite Snoozing
To set an item to be snoozed for an indefinite period, both the snoozeStart and snoozeEnd can be omitted.

Un-snoozing

Items will automatically become unsnoozed at the specified snoozeEnd time. To un-snooze before this time is reached, you can set a snoozeEnd timestamp with the current time or a time in the past

UTC Time Format
Time format is in UTC yyyy-MM-ddTHH:mm:ssZ (all time values in our API are in UTC time as per ISO8601)

Body Params
string
required

Unique account Id

string | null
required

Unique location Id. Set to null to snooze the PLUs across all locations in the account

plus
array of strings
required

List of product PLUs to snooze

plus*
date-time

Start of the snooze period. Time format is in UTC yyyy-MM-ddTHH:mm:ssZ (all time values in our API are in UTC time as per ISO8601)

date-time

End of the snooze period. Time format is in UTC yyyy-MM-ddTHH:mm:ssZ (all time values in our API are in UTC time as per ISO8601)

Response

Updated 4 days ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 days ago

Did this page help you?