Notification payload
Notifications calls to the subscriber endpoints are made with a JSON payload.
The payload contains the following mandatory fields:
Field | Description |
|---|---|
SubscriptionId | The unique identifier of the subscription. |
EventId | The unique identifier of the event. |
EventType | The type of the event. |
OccuredAt | The date and time when the event occurred. |
OrderId | The unique identifier of the order. |
OrderCode | The order code. |
Arguments | The additional data associated with the event. |
Depending on the event type, the payload may contain additional fields. The following table lists the possible additional payload fields for the specific event types:
Event Type | Argument Name | Description |
|---|---|---|
All Types | DueDate | The unique identifier of the order. |
OrderStatusChanged | FromStatus | The previous status of the order. |
OrderStatusChanged | ToStatus | The new status of the order. |
OrderStatusChanged | ShipmentDate | The shipment date of the order. |
OrderStatusChanged | TrackingNumber | The tracking number of the order. |