Update_NC_OrderStatus message

The Update_NC_OrderStatus message is an inbound message that contains status information for a WebSphere Commerce order. A back-end application generates this message and sends it to the WebSphere Commerce inbound message queue, where the WebSphere Commerce system receives the message. WebSphere Commerce OrderStatus command updates the tables ORDSTAT and ORDISTAT with the new order status information.

The Update_NC_OrderStatus message uses the XML message format and follows Update_NC_OrderStatus_10.dtd.

The following table describes the format of the Update_NC_OrderStatus message. 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 OrderStatus Header N/A N/A N/A
1.1 OrderNumber ByBackend ORDSTAT OSMORDER Order reference number generated by the back-end system.
1.2 OrderNumber ByNC Mandatory ORDSTAT ORDERS_ID WebSphere Commerce order reference number. This is a foreign key that references column ORDERS_ID in table ORDERS.
1.3 OrderNumber ByBuyer N/A N/A No such data in WebSphere Commerce table or column.
1.4 TotalPriceInfo N/A N/A N/A
1.4.A1 currency Attribute ORDSTAT OSCPCUR Currency in which the price is expressed. The format of the currency must adhere to ISO 4217 standards.
1.4.1 TotalNetPrice ORDSTAT OSPRTOT Total product price for the order.
1.4.2 TotalTaxPrice ORDSTAT OSTXTOT Total tax for the order.
1.4.3 TotalShippingPrice ORDSTAT OSSHTOT Total shipping charges for the order.
1.4.4 TotalTaxOn ShippingPrice ORDSTAT OSSHTXTOT Total tax on shipping charges for the order.
1.5 RequisitionerID N/A N/A No such data in WebSphere Commerce table or column.
1.5.A1 type Attribute N/A N/A No such data in WebSphere Commerce table or column.
1.6 Status ORDSTAT OSSTATUS Status of the order.
1.7 DateTime Reference N/A N/A N/A
1.7.1 PlacedDate ORDSTAT OSPLTIME Order placed timestamp
1.7.2 PlacedTime N/A N/A No such data in WebSphere Commerce table or column.
1.7.3 LastUpdateDate N/A N/A No such data in WebSphere Commerce table or column.
1.7.4 LastUpdateTime ORDSTAT OSUPDTIME Last update timestamp for the order.
1.8 ShipDate Reference N/A N/A N/A
1.8.1 Requested ShipDate ORDSTAT OSRSTIME Requested shipping timestamp.
1.8.2 Scheduled ShipDate ORDSTAT OSSSTIME Scheduled shipping timestamp.
1.8.3 Actual ShipDate ORDSTAT OSASTIME Actual shipping timestamp.
1.9 CustomerField First occurrence. ORDSTAT FIELD1 Reserved for customization.
1.9 CustomerField Second occurrence. ORDSTAT FIELD2 Reserved for customization.
1.9 CustomerField Third occurrence. ORDSTAT FIELD3 Reserved for customization.
1.10 UserData N/A N/A No such data in WebSphere Commerce table or column.
2 OrderStatusItem N/A N/A N/A
2.1 OrderNumber ByBackend ORDISTAT OSMORDER Back-end system order number.
2.2 ItemNumber ByBackend ORDISTAT OIMITEM Back-end system order item number.
2.3 OrderNumber ByNC Mandatory ORDISTAT ORDERS_ID WebSphere Commerce order reference number. This is a foreign key that references column ORDERS_ID in table ORDERS.
2.4 ItemNumber ByNC ORDISTAT ORDER ITMES_ID WebSphere Commerce item reference number. This is a foreign key that references column ORDERITEMS_ID in table ORDERITEMS.
2.5 Quantity ORDISTAT OIQTCONFIRM Quantity of items confirmed.
2.6 ItemUnitPrice ORDISTAT OIUNPRC Unit price for the item.
2.7 TotalPriceInfo N/A N/A N/A
2.7.A1 currency Attribute ORDISTAT OICPCUR Currency in which the price of the item is expressed. The format of the currency must adhere to ISO 4217 standards.
2.7.1 TotalNetPrice ORDISTAT OIPRTOT Total price for the item.
2.7.2 TotalTaxPrice ORDISTAT OITXTOT Total tax for the item.
2.7.3 TotalShippingPrice ORDISTAT OISHTOT Total shipping charges for the item.
2.7.4 TotalTaxOn ShippingPrice ORDISTAT OISHTXTOT Total tax on the shipping charges for the item.
2.8 Status ORDISTAT OISTATUS Order item status.
2.9 DateTime Reference N/A N/A N/A
2.9.1 PlacedDate ORDISTAT OIPLTIME Order item placed timestamp.
2.9.2 PlacedTime N/A N/A No such data in WebSphere Commerce table or column.
2.9.3 LastUpdateDate N/A N/A No such data in WebSphere Commerce table or column.
2.9.4 LastUpdateTime N/A N/A No such data in WebSphere Commerce table or column.
2.10 ShipDate Reference N/A N/A N/A
2.10.1 Requested ShipDate ORDISTAT OIRSTIME Requested shipping timestamp.
2.10.2 Scheduled ShipDate ORDISTAT OISSDATE Scheduled shipping timestamp.
2.10.3 Actual ShipDate ORDISTAT OIASTIME Actual shipping timestamp.
2.11 Instruction ORDISTAT OICMNT Comments from the customer regarding the item ordered. For example, a customer can include a message with an ordered gift.
2.12 CustomerField First occurrence. N/A N/A Reserved for customization.
2.12 CustomerField Second occurrence. N/A N/A Reserved for customization.
2.12 CustomerField Third occurrence. N/A N/A Reserved for customization.
2.13 UserData N/A N/A No such data in WebSphere Commerce table or column.

Note:

  1. N/A means that it is a parent element name or there is no associated information mapped into the WebSphere Commerce table or column.

  2. For the ‘PlaceDate', ‘PlaceTime' and other columns with date and time related data types, 'PlacedDate' is mapped to a WebSphere Commerce table but 'PlacedTime' not. This is because in WebSphere Commerce tables, the time value (including day, hour, minute and second) is recorded in one column using the timestamp format.


Related concepts
Message classification