Appendix: Order Status Data Type
The order status data type is used to track an order at the courier service and contains the code of the order's current delivery status, its plain-language explanation, a delivered flag, and the actual delivery date, filled in based on the delivered flag. This data type is used in the order creation, order status change, and status history methods.
Order Status
| Parameter | Data type | Required | Description | Comment |
|---|---|---|---|---|
| deliveryServiceCode | string | 1 | Courier service code | Agreed upon during system integration |
| actualStatus | string | 1 | Order status at the time of transmission, as a code | Filled in per the Order Status Directory |
| statusComment | string | 1 | Human-readable status explanation | Filled in per the Order Status Directory |
| statusAssignmentDate | string | 1 | Timestamp of the status assignment in the courier service's IS | Per "ISO 8601," UTC00 (YYYY-MM-DDThh:mm:ssZ) |
| hasBeenDelivered | bool | 1 | Order-delivered flag | Fill-in rule: set "true" if the order has been delivered or handed to the customer. When passing "true," the actualDeliveryDate field must be filled in. Otherwise "false." |
| actualDeliveryDate | string | 0 | Timestamp of the actual delivery time | Per "ISO 8601," UTC00 (YYYY-MM-DDThh:mm:ssZ). Not set if the order was not handed to the customer; assigned and set at the moment it is handed to the customer. |