E-Commerce Order Status Processing

Purpose: The EC_STS_INQ job, started through Working with E-Commerce Job Control (EJCT), receives an E-Commerce Order Status Message (CWOrderStatus) from the web storefront, based on company, sold-to customer, order number, and, optionally, individual and/or bill-to customer. The E-Commerce Order Status Response Message (CWStatusResponse) returned to the web storefront includes order summary information.

Note: You can also inquire about a customer’s order history or detailed information about a single order, using the Generic Customer History API.

What is order status used for? Typically, customers request order summary information before performing:

• maintenance on an order; see E-Commerce Maintenance and Cancel Process Overview.

• cancelling the order or an order line on the order; see E-Commerce Maintenance and Cancel Process Overview.

• returning the order; see Creating Return Authorizations from the Web Storefront.

In this topic:

• Registered Customer?

• Include Complete Ship To Address Information?

• Order Status Response Includes Response Type?

• E-Commerce Order Status Message (CWOrderStatus)

• E-Commerce Order Status Response Message (CWStatusResponse)

Registered Customer?

If the customer is not registered at the web storefront and you are using name-value pair (NVP), set the ship_to_details flag in the E-Commerce Order Status Message (CWOrderStatus) to 0 to indicate not to include ship-to detail; the E-Commerce Order Status Response Message (CWStatusResponse) does not include the ship-to information, and all items on the order are listed together regardless of ship-to address.

If the customer is registered and you are using name-value pair (NVP), set the ship_to_details flag in the E-Commerce Order Status Message (CWOrderStatus) to 1 to indicate to include ship-to information in the E-Commerce Order Status Response Message (CWStatusResponse). In this situation, the message includes a listing of all the customer’s e-commerce orders and all ship-tos. This message also includes a status flag indicating whether the order is eligible for maintenance, and the quantity of each item that is eligible for cancellation or return, if any. Once the customer selects an order for review, all the order ship-to detail is available for display on the web storefront.

If you are using XML messages rather than NVP, then the setting of the ship_to_details flag is not applicable. The E-Commerce Order Status Response Message (CWStatusResponse) always includes the ship-to information.

Include Complete Ship To Address Information?

The Pass Ship To Address in E-Commerce Status Inquiry (J33) system control value controls whether the complete ship-to name and address information is included in the E-Commerce Order Status Response Message (CWStatusResponse).

If the Pass Ship To Address in E-Commerce Status Inquiry (J33) system control value is set to Y, the system includes the following tags in the ShipTo element of the message:

• ship_to_number

• ship_to_fname

• ship_to_lname

• ship_to_street_addr

• ship_to_addr_line_2

• ship_to_addr_line_3

• ship_to_addr_line_4

• ship_to_city

• ship_to_state

• ship_to_zip

• ship_to_country

If the Pass Ship To Address in E-Commerce Status Inquiry (J33) system control value is set to N, the system includes just the following tags in the ShipTo element of the message:

• ship_to_number

• ship_to_fname

• ship_to_lname

Order Status Response Includes Response Type?

If the Pass E-Commerce Order Status Response Type (H68) system control value is set to Y, the E-Commerce Order Status Response Message (CWStatusResponse) includes a response type code indicating if an order was found that matches the order status inquiry.

• 01 indicates an order was found that matches the order status inquiry. The Order Status Response message includes order information.

• 02 indicates an order was found that matches the order status inquiry, but the last name defined for the inquiry (bill_to_lname, ind_lname, or company_name) does not match the last name on the order. In this situation, however, the Order Status Response message does includes order information.

• 03 indicates an order was not found that matches the order status inquiry. The Order Status Response message includes the company, order number, and a response type of 03, but does not include order information.

If this system control value is set to N, the system sends an Order Status Response message to the web storefront on if an order number is found that matches the order_id in the Order Status message and a match is found on at least one of the name fields in the request (bill_to_lname, ind_lname, or company_name).

Order Status Response Includes Set Item Components?

If the Include Set Components in Order Status Response Message (J83) system control value is set to Y, the E-Commerce Order Status Response Message (CWStatusResponse) includes both the set master item and each of its component items. This setting is useful if you apply pricing to set items at the component level, so that the price of each components (and the total price of the set) is provided by the response message.

If this system control value is set to N, the response message includes just the set master item and not its components. This setting is more useful if you apply pricing to set items at the master item level.

See the Include Set Components in Order Status Response Message (J83) for a discussion and samples, and see Entering Set Information (WSET) for more information on working with sets.