E-Commerce Cancel Request Message (CWCancel)

 

The EC_CANCELS job, started through Working with E-Commerce Job Control (EJCT), handles Cancel Request messages from the web storefront. 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 Process Overview for additional processing information

E-Commerce Cancel Request Message: Sample XML

Attribute Name

Type

Length

Comments

Message

One Message element is required.

source

alpha

 

Identifies the source of the message.

WEB indicates the XML message is from the web storefront.

Required.

target

alpha

 

Identifies the target of the message. RDC indicates the XML message is sent to CWSerenade.

Required.

type

alpha

 

Identifies the type of information in the XML message. CWCancel indicates the message contains a cancellation request.

Required.

Cancel

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 CWSerenade 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.

Required.

order_reason

numeric

2

A code that represents the reason for canceling the order.

Maps to the CNR Cancel reason code field in the Order Detail table.

Line

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.

Maps to the Seq # field in the Order Detail table.

qty

numeric

5

The quantity on the order line to cancel.

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.

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>

SO10_10x OROMS 5.0 2018 OTN