Data Stuctures
general info
communicationMessage
locationInfo
order
orderInsertStatus
orderStatus
simpleMessage
storeDetails
task
orderImportErrors
orderStatus
health
taskType
commandType
logisticsProviders
general info
Pull
commandcommunicationMessage
locationInfo
order
orderInsertStatus
orderStatus
simpleMessage
storeDetails
task
Push
pushOrderUpdateStatusorderImportErrors
Enums
expeditionTypeorderStatus
health
taskType
commandType
logisticsProviders
The storeDetail structure gives a 3rd party the means to check the health of a store.
Based on the store, it might be posible to (temporarily) close a store to make sure no orders are being send without processing.
The treshold values can be used to make sure orders are not inserted with times that are not posible to proccess, because of some problems in the store like a production backlog.
Based on the store, it might be posible to (temporarily) close a store to make sure no orders are being send without processing.
The treshold values can be used to make sure orders are not inserted with times that are not posible to proccess, because of some problems in the store like a production backlog.
health
| Field | Type | Required | Description |
|---|---|---|---|
| healthinessStatus | int | true | Specifies the store status. Defined in the enum list found here |
| lastAliveDateTime | string | true | Shows the moment of last connect of the POS / COM system to the API |
tresholds
| Field | Type | Required | Description |
|---|---|---|---|
| minimalTakeoutWaitTime | int | true | Specifies the time needed to prepare a meal. Takeout orders with a shorter timespan will result in problems Treshold is specified in minutes |
| minimalDeliveryWaitTime | int | true | Specifies the time needed to prepare and deliver a meal. delivery orders with a shorter timespan will result in problems Treshold is specified in minutes |
