Update_WCS_OrderStatus message
The Update_WCS_OrderStatus message is an inbound message that contains status information for a WebSphere Commerce order. The message has four possible forms. Although each form of the message has the same XML elements, each one is associated with a different Command. The mapping of message forms to commands is as follows:
Order Status Message Type Command OrderConfirm OrderConfirmStatus OrderShipping OrderShippingStatus OrderInvoice OrderInvoiceStatus OrderStatus OrderStatus
When an order is received by a back-end system, it generates this message, containing any order fulfillment status information, and sends it to the WebSphere Commerce inbound message queue, where the WebSphere Commerce system receives the message. WebSphere Commerce calls the appropriate Controller Command to update the tables ORDSTAT and ORDISTAT with the new order status information.
The Update_WCS_OrderStatus message uses the XML message format and follows Update_WCS_OrderStatus_30.dtd.
The following table describes the format of the Update_WCS_OrderStatus message. Each of the four Order Status message types follows the same format, except where noted. The format and the source of the XML element values are described in the following table. For a description of the database column, follow the link to its associated table. All fields are optional unless otherwise noted. The tag value length in the XML message for database fields of type INT, BIGINT and DOUBLE should be CHAR (10), CHAR(19), and CHAR(16) respectively.
Level Field Name Comment Table Name Column Name Note 1 OrderStatusType Mandatory N/A N/A OrderConfirm, OrderShipping, OrderInvoice, or OrderStatus 1.1 SerializationInfo N/A N/A If provided, it is used for checking serialization information for the message. 1.1.1 SequenceNumber ORDSTAT OSSEQNUM 1.1.2 LastUpdate Timestamp ORDSTAT OSUPDTIME 1.2 OrderStatus Header Mandatory N/A N/A 1.2.A1 Versioning Attribute N/A N/A Value of 'TRUE' or 'FALSE'. If 'TRUE' then versioning is enabled. 1.2.1 OrderNumber ORDSTAT ORDERS_ID and/or OSMORDER If type=ByWCS then ORDERS_ID (which is WebSphere Commerce order reference number), otherwise OSMORDER (which is order reference number generated by back-end system). type Attribute ByWCS or ByBackend 1.2.2 TotalPriceInfo N/A N/A 1.2.2.A1 currency Attribute ORDSTAT OSCPCUR 1.2.2.1 TotalNetPrice ORDSTAT OSPRTOT 1.2.2.2 TotalTaxPrice ORDSTAT OSTXTOT 1.2.2.3 TotalShippingPrice ORDSTAT OSSHTOT 1.2.2.4 TotalTaxOn ShippingPrice ORDSTAT OSSHTXTOT 1.2.2.5 TotalSellingPrice N/A N/A 1.2.3 Status ORDSTAT OSSTATUS The new order status must be placed in the StatusCondition attribute of this element (i.e. StatusCondition='S'). The content between the element's tags is not used. 1.2.3.A1 StatusCondition Attribute ORDSTAT OSSTATUS Default values:'C'='Confirmed' for OrderConfirm'S'='Shipped' forOrderShipping'SP'='Ship Partial''X'='canceled' 'I'='Invoiced' for OrderInvoice'BP'='Bill Partial' 1.2.4 PlacedDate Mandatory ORDSTAT OSPLTIME 1.2.5 ShippingInfo N/A N/A 1.2.5.A1 ShipCondition Attribute ORDSTAT OSSCOND Code to indicate whether partial shipment of order is allowed 'SC'=Ship Complete 'SP'=Ship Partial. 1.2.5.A2 ShipModeFlag Attribute ORDSTAT OSSMFLAG Code to indicate whether shipping address and shipping mode are at order level or order item level. 'O' = Order level 'I' = Order item level. 1.2.5.1 RequestedShipDate ORDSTAT OSRSTIME 1.2.5.2 ScheduledShip Date ORDSTAT OSSSTIME 1.2.5.3 ActualShipDate ORDSTAT OSASTIME 1.2.6 InvoiceInfo 1.2.6.1 InvoiceDate ORDSTAT OSINVTIME 1.2.6.2 InvoiceValue ORDSTAT OSINVVAL 1.2.7 Comment ORDSTAT OSCMNT 1.2.8 CustomerField First occurrence ORDSTAT FIELD1 1.2.8 CustomerField Second occurrence ORDSTAT FIELD2 1.2.8 CustomerField Third occurrence ORDSTAT FIELD3 1.2.9 UserData N/A N/A 1.3 OrderStatusItem Repeatable N/A N/A Vector 1.3.A1 Versioning Attribute N/A N/A Value of 'TRUE' or 'FALSE'. If 'TRUE' then versioning is enabled. 1.3.1 ItemNumber ORDISTAT ORDER ITMES_ID/ OIMITEM If type = ByWCS, then ORDERITMES_ID, if type = ByBackend then OIMITEM 1.3.1.A1 type Attribute N/A N/A ByWCS or ByBackEnd. 1.3.2 ProductNumber ByMerchant ORDISTAT PARTNUMBER 1.3.3 QuantityInfo N/A N/A 1.3.3.1 RequestedQuantity ORDISTAT OIQTREQUEST 1.3.3.2 ConfirmedQuantity ORDISTAT OIQTCONFIRM 1.3.3.3 ShippedQuantity ORDISTAT OIQTSHIP 1.3.4 ItemUnitPrice ORDISTAT OIUNPRC 1.3.5 TotalPriceInfo N/A N/A 1.3.5.A1 currency Attribute ORDISTAT OICPCUR 1.3.5.1 TotalNetPrice ORDISTAT OIPRTOT 1.3.5.2 TotalTaxPrice ORDISTAT OITXTOT 1.3.5.3 TotalShippingPrice ORDISTAT OISHTOT 1.3.5.4 TotalTaxOn ShippingPrice ORDISTAT OISHTXTOT 1.3.6 Status The new order status must be placed in the StatusCondition attribute of this element (i.e. StatusCondition='S'). The content between the element's tags is not used. 1.3.6.A1 StatusCondition Attribute ORDISTAT OISTATUS Default values:'C'='Confirmed' for OrderConfirm'S'='Shipped' forOrderShipping'SP'='Ship Partial''X'='canceled' 'I'='Invoiced' for OrderInvoice'BP'='Bill Partial' 1.3.7 PlacedDate ORDISTAT OIPLTIME 1.3.8 ShippingInfo N/A N/A 1.3.8A1 ShipCondition ORDISTAT OISCOND Code to indicate whether partial shipment of the line item is allowed. 'SC'=Ship Complete 'SP'=Ship Partial 1.3.8A2 ShipModeFlag N/A N/A 1.3.8.1 Requested ShipDate ORDISTAT OIRSTIME 1.3.8.2 Scheduled ShipDate ORDISTAT OISSTIME 1.3.8.3 ActualShipDate ORDISTAT OIASTIME 1.3.9 InvoiceInfo N/A N/A 1.3.9.1 InvoiceDate ORDISTAT OIINVTIME 1.3.9.2 InvoiceValue ORDISTAT OIINVVAL 1.3.10 Comment ORDISTAT OICMNT 1.3.11 CustomerField First occurrence ORDISTAT FIELD1 1.3.11 CustomerField Second occurrence ORDISTAT FIELD2 1.3.11 CustomerField Third occurrence ORDISTAT FIELD3 1.3.12 UserData N/A N/A 1.3.13 OrderInfo N/A N/A 1.3.14 BillTo N/A N/A 1.3.15 ShipTo N/A N/A 1.3.16 PurchaserInfo N/A N/A 1.3.17 AddressLine1 N/A N/A 1.3.18 AddressLine2 N/A N/A 1.3.19 AddressName N/A N/A 1.3.20 City N/A N/A 1.3.21 State N/A N/A 1.3.22 ZipCode N/A N/A 1.3.23 Country N/A N/A 1.3.24 SerialNumber N/A N/A
Related reference
Back-end integration legacy messages