Back-end integration XML messages

WebSphere Commerce offers support for inbound and outbound messages that use the XML format. Each inbound message invokes specific behaviors within the WebSphere Commerce Server by executing a controller command. Each controller command in turn performs operations on the WebSphere Commerce database and subsystems. Some controller commands can be executed by more than one XML message. In addition, some messages can invoke different commands, depending on the content of the message.

The format of the XML messages consists of a set of XML elements defined within specific DTD files. Each DTD may contain one or more common files, identified by a .mod file extension. In addition, each inbound message is associated with a WebSphere Commerce controller command in the sys_template.xml message template definition file. All DTD, MOD, and XML files are located in the following directory:

AIXiSeriesLinuxSun Solaris Operating EnvironmentWindowsWC_installdir/CommerceServer55/xml/messaging
WebSphere Commerce StudioWCDE_installdir/CommerceServer55/xml/messaging

The following table outlines the inbound messages used and the controller command that they invoke:

XML Messages Description Controller Command
Create_WCS_Customer, Create_NC_Customer Creates a registration record for a new user, or updates a record for an existing user. UserRegistrationAdd  
Update_NC_Customer, Update_WCS_Customer Updates a registration record for an existing user. UserRegistrationUpdate
Update_WCS_OrderStatus, Update_NC_OrderStatus Updates the general status of an order. OrderStatus
Update_WCS_OrderStatus Updates the confirmation status of an order. OrderConfirmStatus
Update_WCS_OrderStatus Updates the shipping status of an order. OrderShippingStatus
Update_WCS_OrderStatus Updates the invoice status of an order. OrderInvoiceStatus
Update_WCS_ProductPrice, Update_NC_ProductPrice Updates the offer price information for a product. ProductOfferPriceUpdate
Update_WCS_ProductPrice Updates the list price information for an order. ProductListPriceUpdate
Update_NC_ProductInventory
Update_WCS_ProductInventory
Updates product inventory information. ProductInventoryUpdate
Update_WCS_PriceAndAvailability Price and Availability Response to pass in price and availability information OrderQuotationCreate 
Update_WCS_ShoppingCartTransfer Shopping Cart Transfer Response to confirm customer's shopping cart has been successfully transferred to an external system OrderTransferConfirm
Update_WCS_BatchAvailability Batch Inventory Availability Response to provide inventory availability information BatchAvailabilityResponse
Request_WCS_BE_ProductInventory Inventory Availability Check Response CheckInventoryAvailabilityBE

Note: Some messages contain the letters NC in the name and others contain the name WCS in the name. Those with names that contain the letters NC are XML messages from previous versions of WebSphere Commerce. Those with WCS in the name use updated formats that offer greater flexibility. It is generally recommended that you use the WCS versions where you have choice.

The following table outlines the back-end integration message used by the outbound messaging system, as well as the command that generates it:

XML Message Description Controller Command
Report_NC_PurchaseOrder
Sends a message to a back-end system containing information on a new order. SendXMLOrder
shoppingCartTransferRequest The originating request to transfer the customer's  shopping cart. TransferShopCartPolicyCmd
priceAndAvailabilityRequest The originating request to get price, quantity, and availability information for product items of interest to customers. RequestOrderQuotationPolicyCmd
batchAvailabilityRequest The originating request to get availability information for a list of products from an external system. RequestBatchAvailabilityPolicyCmd
Request_WCS_BE_ProductInventory The originating synchronous request to get inventory information for a list of products. CheckInventoryAvailabilityCmd