1. Order service layer

The order domain model

Version:
03000012.png

Class: Order

The Order class is responsible for representing an order.

NameTypeDescription
OrderIdStringUnique 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.
OrderDateDateTimeThe date the order was placed.
TrackingNumberStringThe tracking number for the order.
IsOfflineOrderBoolSpecifies 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.

NameTypeDescription
OrderIdStringUnique 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.
OrderDateDateTimeThe 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.

NameTypeDescription
GrantedOrderCancellationIndicates that the order cancellation request was granted.
DeniedOrderCancellationIndicates that the order cancellation request was denied.
If you have suggestions for improving this article, let us know!