E-Commerce Return Request Message (CWReturn)
The EC_RETURNS job, started through Working with E-Commerce Job Control (EJCT), receives E-Commerce Return Request messages from the web storefront. The Return Request message defines the order line(s) you wish to return. The E-Commerce Return Response Message (CWReturnResponse) sends the return authorization information back to the web storefront.
For more information: See:
• Creating Return Authorizations from the Web Storefront for an overview.
• E-Commerce Return Request Message: Sample XML
Attribute Name |
Type |
Length |
Comments |
|
One Message element is required. |
|||
source |
alpha |
|
Identifies the source of the message. WEB indicates the message is from the web storefront. Required. |
target |
alpha |
|
Identifies the target of the message. RDC indicates the message is sent to CWSerenade. Required. |
type |
alpha |
|
Identifies the type of information in the message. CWReturn indicates the message contains a return request. Required. |
resp_qmgr |
alpha |
44 |
The queue manager (if using WebSphere MQ) or connection factory (if using HornetQ) in Working with E-Commerce Job Control (EJCT). |
resp_q |
alpha |
44 |
The queue identified for the process queue in Working with E-Commerce Job Control (EJCT). |
|
One Return element is required. |
|||
company_code |
numeric |
3 |
A code for the company where the order to return is located. Maps to the CMP company field in the Order Detail table. Required. |
order_id |
numeric |
8 |
The order number containing the item(s) to return. Maps to the Order # field in the Order Detail table. Required. |
ship_to |
numeric |
3 |
The order ship to number containing the item(s) to return. Maps to the Ship to # field in the Order Detail table. Required. |
|
The Lines element can include one ore more Line elements. |
|||
line_number |
numeric |
5 |
The order line sequence number containing the item to return. Maps to the Seq # field in the Order Detail table. Required. |
qty |
numeric |
5 |
The quantity of the item to return. Maps to the RAD Qty to return field in the RA Detail table. Required. |
reason |
numeric |
3 |
The reason for returning the item. Maps to the RTR Return reason code field in the RA Detail table. Required. |
E-Commerce Return Request Message: Sample XML
A sample of the E-Commerce Return Request Message (CWReturn) in XML format is presented below.
- <Message source="web" target="rdc" type="CWReturn">
- <Return company_code="555" order_id="7616" ship_to="1">
- <Lines>
<Line line_number="1" qty="1" reason="2" />
<Line line_number="2" qty="1" reason="1" />
</Lines>
</Return>
</Message>
E-Commerce Return Response Message (CWReturnResponse)
The EC_RETURNS job, started through Working with E-Commerce Job Control (EJCT), generates an E-Commerce Return Response message when it receives an E-Commerce Return Request Message (CWReturn) from the web storefront. The Return Response message contains information about the return that was processed and information to print on a confirmation label.
For more information: See:
• Creating Return Authorizations from the Web Storefront for an overview.
• E-Commerce Return Response Message: Sample XML
Attribute Name |
Type |
Length |
Comments |
|
One Message element is required. |
|||
source |
alpha |
|
Identifies the source of the message. RDC indicates the message is from CWSerenade. |
target |
alpha |
|
Identifies the target of the message. WEB indicates the message is sent to the web storefront. |
type |
alpha |
|
Identifies the type of information in the message. CWReturnResponse indicates the message contains a return response. |
|
One ReturnResponse element is included. |
|||
company_code |
numeric |
3 |
A code for the company where the return was processed. From the Company field in the RA Header table. |
order_id |
numeric |
8 |
The order number containing the item(s) returned. From the Order # field in the RA Header table. |
ship_to |
numeric |
3 |
The order ship to number containing the item(s) returned. From the Ship to # field in the RA Header table. |
ra_number |
alpha |
16 |
The order number + ship to number + return authorization number associated with the return. An RA number of none indicates that the return was rejected. See Creating Return Authorizations from the Web Storefront for information on why a return authorization request might be rejected. From the Order #, Ship to #, and RAH RA# field in the RA Header table. |
total_weight |
numeric |
7.3 |
The total weight of the returned items. From the Ship weight field in the SKU table or Item table. |
date_entered |
numeric |
8 |
The date the return was processed in MMDDYYYY format. From the RAH Date entered field in the RA Header table. |
name |
alpha |
30 |
The name of the warehouse where the item will be returned. From the Name field in the Warehouse table. |
address |
alpha |
32 |
The street address for the warehouse address. From the Address field in the Warehouse table. |
address2 |
alpha |
32 |
The second address line of the warehouse address. From the Address line 2 field in the Warehouse table. |
city |
alpha |
25 |
The city for the warehouse address. From the City field in the Warehouse table. |
state |
alpha |
2 |
The state code for the warehouse address. From the State field in the Warehouse table. |
zip |
alpha |
10 |
The postal code for the warehouse address. From the Zip code field in the Warehouse table. |
country |
alpha |
3 |
The country code for the warehouse address. From the RPR country field in the Warehouse table. |
phone_number |
alpha |
14 |
The warehouse’s phone number. From the Phone field in the Warehouse table. |
E-Commerce Return Response Message: Sample XML
A sample of the E-Commerce Return Response Message (CWReturnResponse) in XML format is presented below.
- <Message source="RDC" target="WEB" type="CWReturnResponse">
<ReturnResponse company_code="555" order_id="7616" ship_to="001" ra_number="7616-1-1" total_weight="12000" date_entered="07262006" name="KAB Co." address="24 EXAMPLE STREET" address2="EXAMPLE PLACE" city="WESTBOROUGH" state="MA" zip="01581" country="USA" phone_number="508 555-0100" />
</Message>
