POST v1/Orders/DeliveryStatusNotify
Notify when the delivery status of the order changes
URI template
v1/Orders/DeliveryStatusNotify?sendEmail={sendEmail}Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
sendEmail |
Optional query param. If true, then email is sent |
boolean |
Default value is False |
Body Parameters
InOrderDeliveryStatusNotifyName | Description | Type | Additional information |
---|---|---|---|
payload |
Json-formatted payload string from broadcast message containing the BSP message identifier and the delivery status structure (InOrderDeliveryStatusNotify) |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "payload": "sample string 1" }
application/xml, text/xml
Sample:
<InOrderDeliveryStatusNotify xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Inbound"> <payload>sample string 1</payload> </InOrderDeliveryStatusNotify>
Response Information
Resource Description
OrderDeliveryStatusNotifyResult - the updated status. Known internal errors are BadRequest, Error
Known HTTP Status Codes:
- 200 - OK
- Successful order check-in from order state update.
- 304 - Not Modified
- Either the feature is not currently enabled, or the status change is not one NOLO manages.
- 400 - Bad Request
- An error occurred, please refer to the response body for details.
- 417 - Expectation Failed
- The requested status change is not valid, the previous state is more advanced than the new state (the order is moving backwards).
- 500 - Internal Server Error
- An internal error occurred procesing the request, check the response body and/or logs for further details.
Name | Description | Type | Additional information |
---|---|---|---|
NotifyAction | string |
None. |
|
StatusCode |
The raw error code |
integer |
None. |
Message |
The error message from the POS |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "NotifyAction": "sample string 1", "StatusCode": 2, "Message": "sample string 3" }
application/xml, text/xml
Sample:
<OrderDeliveryStatusNotifyResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1.Response"> <Message>sample string 3</Message> <NotifyAction>sample string 1</NotifyAction> <StatusCode>2</StatusCode> </OrderDeliveryStatusNotifyResult>