The order domain model
Class: Order
The Order class is responsible for representing an order.
|
Name |
Type |
Description |
|---|---|---|
|
OrderId |
String |
Unique identifier for the order in the commerce system. This can be used to get a reference to the order using the commerce system's native API. Is typically empty until an order has been created in an external system. |
|
OrderDate |
DateTime |
The date the order was placed. |
|
TrackingNumber |
String |
The tracking number for the order. |
|
IsOfflineOrder |
Bool |
Specifies whether the order was placed offline (that is, in an external system or physical store) and synchronized with the online order and analytics system. |
Class: OrderHeader
The OrderHeader class is responsible for representing an order header.
|
Name |
Type |
Description |
|---|---|---|
|
OrderId |
String |
Unique identifier for the order in the commerce system. This can be used to get a reference to the order using the commerce system's native API. Is typically empty until an order has been created in an external system. |
|
OrderDate |
DateTime |
The date the order was placed. |
Class: OrderCancellation
The OrderCancellation class is an extensible enumeration that represents the result status of a request to cancel all or part of an order.
The following table contains the list of default OrderCancellation options.
|
Name |
Type |
Description |
|---|---|---|
|
Granted |
OrderCancellation |
Indicates that the order cancellation request was granted. |
|
Denied |
OrderCancellation |
Indicates that the order cancellation request was denied. |