E-Commerce Cancel Request Message (CWCancel)
The Cancel Request message can specify the entire order ship-to, or specific items on the order. An email confirmation indicates whether the cancellation request was successful.
For more information: See:
• E-Commerce Cancel Setup for required setup.
• E-Commerce Cancel Process for additional processing information.
• E-Commerce Cancel Request Message: Sample XML for a sample message.
Attribute Name |
Type |
Length |
Comments |
|
One Message element is required. |
|||
source |
alpha |
|
Identifies the source of the message. WEB indicates the XML message is from the web storefront. |
target |
alpha |
|
Identifies the target of the message. RDC indicates the XML message is sent to Order Management System. |
type |
alpha |
|
Identifies the type of information in the XML message. Must be set to CWCancel to indicate the message contains a cancellation request. Required. |
|
One Cancel element is required. To cancel the entire order ship to, the cancel_type must be O and the order_reason must specify a valid cancel reason code. Note: If there are multiple shipping addresses, the cancel request for each ship to must be sent separately. |
|||
company_code |
numeric |
3 |
The company where the order is located. Maps to the CMP Company field in the Order Ship To table. Required. |
order_id |
numeric |
8 |
The Order Management System order number you wish to cancel. Maps to the Order # field in the Order Ship To table. Required. |
ship_to |
numeric |
3 |
The order ship to you wish to cancel. Maps to the Ship to # field in the Order Ship To table. Required. |
cancel_type |
alpha |
1 |
Indicates the type of cancel to perform. Valid values: O = Order cancel. L = Line cancel. If not defined, O Order cancel defaults. |
order_reason |
numeric |
2 |
A code that represents the reason for canceling the order. Must be a valid cancel reason code. Maps to the CNR Cancel reason code field in the Order Detail table. |
|
The Lines element, if provided, can include one or more Line elements. To cancel an order line, the cancel_type must be L and you must specify the line_number to cancel, the qty on the order line to cancel, and the reason. |
|||
line_number |
numeric |
5 |
The order detail line sequence number to cancel. Required to cancel an order line. Maps to the Seq # field in the Order Detail table. |
qty |
numeric |
5 |
The quantity on the order line to cancel. Required to cancel an order line. Maps to the ODT Qty cancelled field in the Order Detail table. |
reason |
numeric |
2 |
A code that represents the reason for canceling the order line. Must be a valid cancel reason code. If a cancel reason code is not passed, the system uses the cancel reason code defined in the Auto Soldout Cancel Reason (C20) system control value. Maps to the CNR Cancel reason code field in the Order Detail table. |
E-Commerce Cancel Request Message: Sample XML
A sample of the E-Commerce Cancel Request Message (CWCancel) in XML format is presented below.
<Message source="WEB" target="RDC" type="CWCancel">
<Cancel company_code="555" order_id="7602" ship_to="1" cancel_type="O" order_reason="1" />
<Lines>
<Line line_number="1" qty="1" reason="1" />
<Line />
</Lines>
</Message>
