OrderState

Uses the Component:OrderStateType

The OrderState component represents the current and history states of the order. This component may occur many times reflecting the history of states.

Fields and Components

Table 7.23. Fields and Components

Name Description Occurrence Type Data Type User Notes
OrderStateCode

Defines a common enumeration of state values.

0..1Field scl:OrderStateTypeEnumeratedType  
OtherOrderStateCode

To define a code that is not part of the enumeration

0..1Field oag:CodeType  
StateDateTime

The date and time the state took effect. Only the most recent state is the current state. This facilitates a dealer awareness of the order fulfillment timeline.

0..1Field oag:xbt_DateTimeType  
OrderStateDescription

Order State description

0..1Field oag:TextType  

Sample XML

The XML Sample provided here is an approximation of the generated XML for this component. Not all of the fields are required for implementation.

Example 7.31. OrderState

<OrderState>
     <OrderStateCode>......</OrderStateCode>     [0..1]
     <OtherOrderStateCode>......</OtherOrderStateCode>     [0..1]
     <StateDateTime>......</StateDateTime>     [0..1]
     <OrderStateDescription>......</OrderStateDescription>     [0..1]
</OrderState>