Currently the webhook system for Products handles only one type of event:
products-availability-update
Event products-availability-update
products-availability-update
Sent to know that the availability of an item or a modifier is changed.
APP SCOPE
Channel | Pos | Riders | Loyalty |
---|---|---|---|
✔️ | ✖️ | ✖️ | ✖️ |
WEBHOOK FORMAT
{
"eventType": "products-availability-update",
"storeId": "string",
"data": {
"suspendInfoList": [
{
"innerId": "string",
"posRef": "string",
"type": "string",
"untilDate": "string"
}
]
}
}
FIELDS SPECIFICATION
Field | Description |
---|---|
eventType | The type of event |
storeId | The storeId where the event occurred |
data.suspendInfoList | The list of products whose availability has changed |
data.suspendInfoList.innerId | The innerId of the product whose availability has changed |
data.suspendInfoList.posRef | The posRef of the product whose availability has changed |
data.suspendInfoList.type | The type of product. The values of this field can be:- item - modifier |
data.suspendInfoList.untilDate | The date until this product is unavailable. The meaning of this field is: - if untilDate < now the product is available- if untilDate > now the product is unavailable |