Order Create message
The Order Create message is an outbound message that contains order details for a completed order. The WebSphere Commerce system generates this message and sends its data to an outbound message queue, where a back-end system receives the message. This application takes the message and continues any back-end business processes required to complete the specified task for the order. Use Order Create to fulfill the order process of orders that begin with the WebSphere Commerce system, but also require some additional or back-end work by a separate system.
The Order Create message uses the legacy message format and consists of a set of records, which follow each other sequentially in a buffer. The message contains order, customer, billing, merchant, and shipping information. The following data describes the Order Create message:
<ECEDOC> <PROLOG>ORDER_CREATE_PROLOG_DATA</PROLOG> <HEADER> <HDR010>ORDER_CREATE_HDR010_DATA</HDR010> <HDR020>ORDER_CREATE_HDR020_DATA</HDR020> <HDR030>ORDER_CREATE_HDR030_DATA</HDR030> <HDR040>ORDER_CREATE_HDR040_DATA</HDR040> <USRLST> <DATUSR>DATUSR_DATA</DATUSR> . .DATUSR repeated loop . <DATUSR>DATUSR_DATA</DATUSR> </USRLST> </HEADER> <ITMLST> <ITMDAT> <ITM010>ORDER_CREATE_ITM010_DATA</ITM010> <USRLST> <DATUSR>DATUSR_DATA</DATUSR> . .DATUSR repeated loop . <DATUSR>DATUSR_DATA</DATUSR> </USRLST> </ITMDAT> . .ITEM repeated loop . <ITMDAT> <ITM010>ORDER_CREATE_ITM010_DATA</ITM010> <USRLST> <DATUSR>DATUSR_DATA</DATUSR> . .DATUSR repeated loop . <DATUSR>DATUSR_DATA</DATUSR> </USRLST> </ITMDAT> </ITMLST> </ECEDOC>Notes:
- All records are in sequential order in the buffer. Indentation is used here for readability; it does not appear in the buffer.
- All fields in the data segments are left-justified and padded to the right with spaces in the buffer.
Data Segments for Order Create
- ORDER_CREATE_PROLOG_DATA Specifies the type of message the application data defines. In this case, the message is Order Create.
- ORDER_CREATE_HDR010_DATA Specifies order information within the Order Create message.
- ORDER_CREATE_HDR020_DATA Specifies customer information within the Order Create message.
- ORDER_CREATE_HDR030_DATA Specifies billing information within the Order Create message.
- ORDER_CREATE_HDR040_DATA Specifies merchant information within the Order Create message.
- DATUSR_DATA Specifies optional information to be added to the Order Create message. DATUSR_DATA appears in the <HDR> and <ITM> sections of this message.
- ORDER_CREATE_ITM010_DATA Specifies item or product shipping information within the Order Create message.
- Outbound message extension for order create messages
The Report_NC_PurchaserOrder message includes the UserData XML element, which contains the UserDataField element. We can customize the UserData element to pass extra information not included in the Report_NC_PurchaserOrder outbound message by extending the SendXMLOrderMsg command and implementing either the getHeaderExtensionRecords() method or the getItemExtensionRecords()method, depending on whether we want to add the information at the header or item level. By default, both getHeaderExtensionRecords() and getItemExtensionRecords() methods return a null String value. Once implemented, both methods should return a String object that contains a series of UserDataField elements as follows:- ORDER_CREATE_HDR010_DATA
The Order Create message includes the ORDER_CREATE_HDR010_DATA segment. This data segment consists of order specifications for the Order Create message.- ORDER_CREATE_HDR020_DATA
The Order Create message includes the ORDER_CREATE_HDR020_DATA segment. This data segment consists of customer specifications for the Order Create message.- ORDER_CREATE_HDR030_DATA
The Order Create message includes the ORDER_CREATE_HDR030_DATA segment. This data segment consists of billing details for the Order Create message.- ORDER_CREATE_HDR040_DATA
The Order Create message includes the ORDER_CREATE_HDR040_DATA segment. This data segment consists of merchant information for the Order Create message.- ORDER_CREATE_ITM010_DATA
The Order Create message includes the ORDER_CREATE_ITM010_DATA segment. This data segment consists of item or product shipping specifications for the Order Create message.- ORDER_CREATE_PROLOG_DATA
The Order Create message includes the ORDER_CREATE_PROLOG_DATA segment. This data segment identifies the type of message that is being defined; that is, the segment indicates that the message is an Order Create message with a field value of ON (Order New).- DATUSR_DATA for outbound messages
The outbound message Order Create includes the DATUSR_DATA data segment. Include the DATUSR records in this message to send additional data. We can customize the fields to pass extra data that is not included in the messages.
Related concepts
Outbound messaging system
Order notification
Related reference
Back-end integration legacy messages