Currently the webhook system for Store handles two types of events:
store-schedule-update
store-status-update
Event store-schedule-update
store-schedule-update
Sent to know that the opening hours of a Store has been modified. Endpoint Get Store by Id must be used to retrieve the updated opening hours.
APP SCOPE
Channel | Pos | Riders | Loyalty |
---|---|---|---|
✔️ | ✖️ | ✖️ | ✖️ |
WEBHOOK FORMAT
{
"eventType": "store-schedule-update",
"storeId": "string",
"data": {}
}
FIELDS SPECIFICATION
Field | Description |
---|---|
eventType | The type of event |
storeId | The storeId where the event occurred |
data | Empty object |
Event store-status-update
store-status-update
Sent to know that the availability of a Store has been modified.
APP SCOPE
Channel | Pos | Rider | Loyalty |
---|---|---|---|
✔️ | ✖️ | ✖️ | ✖️ |
WEBHOOK FORMAT
{
"eventType": "store-status-update",
"storeId": "string",
"data": {
"status": "string"
"closedUntilDate": "string"
}
}
FIELDS SPECIFICATION
Field | Description |
---|---|
eventType | The type of event |
storeId | The storeId where the event occurred |
data.status | The new Store availability status. Possible values for this field: - open - close |
data.closedUntilDate | The date on which the shop will be reopened. Possible values: - a date in ISO format, in case the data.status field value is close - an empty string, in case the data.status field value is open |