E-Commerce Order List Message (CWOrderList)

 

The EC_CST_ORD job, started through Working with E-Commerce Job Control (EJCT), receives e-commerce order list messages from the web storefront. The order list message indicates a request for a list of orders of any status, including suspended orders. The system sends an E-Commerce Order List Response Message (CWListResponse) message back to the web storefront; this message includes the order number and order date for up to 10 orders that match the request criteria, in reverse chronological order.

For more information: See:

E-Commerce Order List Processing for additional processing information.

E-Commerce Order List Message: Sample XML

E-Commerce Order List Message: Sample NVP

XML Messages for a table that provides links to the DTD, schema, and a sample XML layout for each XML message.

Name/Value Pair layout: The e-commerce order list (EC_CST_INQ) name/value pair message uses the following layout: name=value.

Example:

companycode=555

customer_number=204

ind_number=1

The Attribute Name column in the table below indicates the name part of the name/value pair. The Comments column indicates the data to enter in the value part of the name/value pair. A note displays in the Comments column if the field is only available in the XML message.

Note: If a field is included in the name/value pair message, the field must be included in the order shown below. However, if the field is empty, the field does not need to be sent.

Attribute Name

Type

Length

Comments

Message

One Message element is required.

Available in version: The Message element and all of its attributes is available for XML only.

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

Required.

type

alpha

 

Identifies the type of information in the message. CWOrderList indicates the message contains an order list request.

Required.

resp_qmgr

alpha

44

The MQ Series queue manager identified for the process queue in Working with E-Commerce Job Control (EJCT).

resp_q

alpha

44

The MQ Series queue identified for the process queue in Working with E-Commerce Job Control (EJCT).

OrderList

One OrderList element is required.

company_code

numeric

3

A code for the company where the orders are located.

Maps to the CMP Company field in the Order Header file.

Required.

customer_number

numeric

9

The sold to customer on the order.

Maps to the Cust # field in the Order Header file.

Required.

ind_number

numeric

3

The individual number of the placer of the order.

Maps to the OHE Placer field in the Order Header Extended file.

Available in version: 6.0 or later of CWDirect.

start_date

numeric

8

The most recent date to include in the order list, in MMDDYYYY format.

Note: If you do not specify a start date, the system defaults 00/00/1900 as the start date. However, the system will retrieve the 10 most recent orders for the customer.

Maps to the OHD Order date field in the Order Header file.

E-Commerce Order List Message: Sample XML

A sample of the E-Commerce Order List Message (CWOrderList) in XML format is presented below.

- <Message source="WEB" target="RDC" type="CWOrderList">

<OrderList company_code="555" customer_number="6" start_date="05012004" />

</Message>

E-Commerce Order List Message: Sample NVP

A sample of the E-Commerce Order List Message (CWOrderList) in name/value pair format is presented below. Each name/value pair is separated by a semi-colon (;).

company_code=555;customer_number=6;start_date=04012004;

E-Commerce Order List Response Message (CWListResponse)

 

The EC_CST_ORD job, started through Working with E-Commerce Job Control (EJCT), generates an e-commerce order list response message when an E-Commerce Order List Message (CWOrderList) is received from the web storefront. The order list response message includes the order number and order date for up to 10 orders that match the request criteria, in reverse chronological order.

For more information: See:

E-Commerce Order List Processing for additional processing information.

E-Commerce Order List Response Message: Sample XML

E-Commerce Order List Response Message: Sample NVP

XML Messages for a table that provides links to the DTD, schema, and a sample XML layout for each XML message.

Name/Value Pair layout: The e-commerce order list response (EC_CST_INQ) name/value pair message uses the following layout: name=value.

Example:

companycode=555

customer_number=204

ind_number=1

The Attribute Name column in the table below indicates the name part of the name/value pair. The Comments column indicates the data to enter in the value part of the name/value pair. A note displays in the Comments column if the field is only available in the XML message.

Attribute Name

Type

Length

Comments

Message

One Message element is required.

Available in version: The Message element and all of its attributes is available for XML only.

source

alpha

 

Identifies the source of the message. RDC indicates the message is from CWDirect.

Required.

target

alpha

 

Identifies the target of the message. WEB indicates the message is sent to the web storefront.

Required.

type

alpha

 

Identifies the type of information in the message. CWListResponse indicates the message contains an order list response.

Required.

Header

One Header element is required.

company_code

numeric

3

A code for the company where the orders are located.

From the CMP Company field in the Order Header file.

Required.

customer_number

numeric

9

The sold to customer on the order.

From the Cust # field in the Order Header file.

Required.

ind_number

numeric

3

The individual number of the placer of the order.

From the OHE Placer field in the Order Header Extended file.

start_date

numeric

8

The most recent date to include in the order list.

Note: If you do not specify a start date, the system defaults 00/00/1900 as the start date. However, the system will retrieve the 10 most recent orders for the customer.

From the OHD Order date field in the Order Header file.

Order

The Orders element can include up to 10 Order elements.

order_number

numeric

9

The CWDirect order number.

From the Order # field in the Order Header file.

Required.

order_date

numeric

8

The date the order was placed.

From the OHD Order date field in the Order Header file.

Required.

E-Commerce Order List Response Message: Sample XML

A sample of the E-Commerce Order List Response Message (CWListResponse) in XML format is presented below.

- <Message source="RDC" target="WEB" type="CWListResponse">

<Header company_code="555" customer_number="6" ind_number="" start_date="05012004" />

- <Orders>

<Order order_number="7415" order_date="05012004" />

<Order order_number="7413" order_date="05012004" />

<Order order_number="7412" order_date="05012004" />

<Order order_number="7560" order_date="04012004" />

<Order order_number="7359" order_date="04012004" />

<Order order_number="7358" order_date="04012004" />

<Order order_number="7357" order_date="03312004" />

<Order order_number="7351" order_date="03292004" />

<Order order_number="7350" order_date="03292004" />

<Order order_number="7347" order_date="03292004" />

</Orders>

</Message>

E-Commerce Order List Response Message: Sample NVP

A sample of the E-Commerce Order List Response Message (CWListResponse) in name/value pair format is presented below. Each name/value pair is separated by a semi-colon (;).

company_code=555;customer_number=6;ind_number=;start_date=04012004;order_number=7560;order_date=04012004;order_number=7359;order_date=04012004;order_number=7358;order_date=04012004;order_number=7357;order_date=03312004;order_number=7351;order_date=03292004;order_number=7350;order_date=03292004;order_number=7347;order_date=03292004;order_number=7345;order_date=03292004;order_number=7344;order_date=03292004;order_number=7338;order_date=03242004;

SO10_06x CWDirect 18.0 August 2015 OTN