Create_WCS_ShipmentConfirmation message

The Create_WCS_ShipmentConfirmation message is an inbound message that contains information for issuing shipment confirmation for an item. A fulfillment center application generates this request and sends it to the HCL Commerce inbound message queue. After HCL Commerce processes the message, the ReleaseShipConfirm command is invoked.

On successful completion, the command redirects to the view task ReleaseShipConfirmRedirectView. The Response_WCS_CreateShipConfirm response message is generated by CreateShipConfirmOK.jsp. The command updates the required database, changing the fulfillment status of the item to confirm shipment. It gets a new manifest_id from the MANIFEST table through the key manager, and propagates the MANIFEST table with input data. If the command executes successfully and the UpdateManifestStatus is 1, the default ReleaseShipNotify.jsp generates a notification e-mail.

In addition, with the new version 2.0 of this message, if the optional fields listing products and component SKUs and serial numbers are present, the command creates new rows in the ORDSERIAL table. New serial_id values are assigned by the key manager to these rows and each new row will contain the corresponding order number, catalog entry number (derived from the SKU in the message), and the serial number code specified in the message. This table will be used to track serial numbers for the products or components that are sent back by customers after they request a return.

If the command encounters an error, it redirects to the view task ReleaseShipConfirmErrorView. This error view task for IBM MQ is implemented by CreateShipConfirmError.jsp.

Note: If the inbound message does not contain a valid ActualShipDate, the GenericApplicationError viewname is used for error message composition. The response message is generated by GenericApplicationErrorXML.jsp.

The Create_WCS_ShipmentConfirmation message uses the XML message format and follows Create_WCS_ShipmentConfirmation_20.dtd.

The following table describes the format of the Create_WCS_ShipmentConfirmation 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 UpdateManifestStatus MANIFEST UPDATEMANIFESTSTATUS Default 0, an attribute of parent element ShipmentConfirmation
2 ShipModeID Mandatory MANIFEST SHIPMODE_ID N/A
3 OrderNumber Mandatory MANIFEST ORDERS_ID N/A
4 OrderReleaseNum Mandatory MANIFEST ORDERRELEASENUM N/A
5 PackageID MANIFEST PACKAGEID N/A
6 TrackingID MANIFEST TRACKINGID N/A
7 PickUpRecordID MANIFEST PICKUPRECORDID N/A
8 ActualShipDate Mandatory MANIFEST DATESHIPPED ISO 8601 date format
9 ShippingCosts Mandatory MANIFEST SHIPPINGCOSTS N/A
10 Weight Mandatory MANIFEST WEIGHT N/A
11 measure Mandatory MANIFEST WEIGHTMEASURE An attribute of Weight
12 currency Mandatory MANIFEST SETCCURR An attribute of ShippingCosts
13 products ORDSERIAL Aggregation element, does not correspond to a particular column
14 productSKU ORDSERIAL CATENTRY_ID SKU is used to fetch Catalog Entry ID
15 productSNs ORDSERIAL Aggregation element, does not correspond to a particular column
16 productSerialNumber ORDSERIAL SERIALNUMBER N/A
13 components ORDSERIAL Aggregation element, does not correspond to a particular column
14 componentSKU ORDSERIAL CATENTRY_ID SKU is used to fetch Catalog Entry ID
15 componentSNs ORDSERIAL Aggregation element, does not correspond to a particular column
16 componentSerialNumber ORDSERIAL SERIALNUMBER N/A

The default value for the UpdateManifestStatus flag is 0. If it is set to 1, a task command is called to update the manifest status and an e-mail is sent to inform the customer about completion of product shipment.

The JSP file that generates the response message is Response_WCS_CreateShipConfirm.jsp. ReleaseShipNotify.jsp is the default JSP file, generating the e-mail if UpdateManifestStatus flag is set to 1.