E-Commerce Catalog Request Message (CWCatRequest)

 

The E-Commerce Catalog Requests job creates a catalog request when the customer enters a request on the web storefront. The main purposes of this job:

• receive and process catalog requests for sold to customers.

• create the sold to customer if the customer does not exist.

• update the sold to customer if the customer information is updated.

Additionally, if the response_required field is 1, the system sends an E-Commerce Catalog Request Response Message (CWCatreqResponse) back to the web storefront.

For more information: See:

E-Commerce Catalog Requests for more information on processing and see Catalog Request Interface Errors for a listing of possible errors.

E-Commerce Catalog Request Message: Sample XML

Additionally, you can update or create a sold to customer using this message; see Customer Creation/Update Logic in E-Commerce Catalog Requests.

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.

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. CWCatRequest indicates the message contains a catalog request.

CatRequest

One CatRequest element is required.

company_code

numeric

3

The company associated with the catalog request.

Maps to the CMP company field in the Catalog Request table.

response_required

alpha

1

Y indicates the system sends an E-Commerce Catalog Request Response Message (CWCatreqResponse) back to the web storefront.

offer_id

alpha

3

The code for the catalog that the customer is requesting.

Maps to the Offer number field in the Catalog Request table.

source_code

alpha

9

A code that identifies a list of names for the catalog mailing.

If both a source code and offer code have not been defined for the catalog request, Order Management System defaults the source code defined in the Default Source Code for Batch Catalog Requests (D37) system control value to the catalog request.

Maps to the SRC Source code field in the Catalog Request table.

The sold_to fields represent the sold to customer. If the sold to customer does not exist in Order Management System, the system creates a new customer. If the catalog request is for an existing sold to customer and the name or address changes, such as the sold_to_email, the system updates the customer. See Creating/Updating Sold To Customers in E-Commerce Catalog Requests for more processing information.

In addition, if the Edit for Duplicate Catalog Requests (E46) system control value is selected, the system checks for duplicate catalog requests, based on match code. If a duplicate catalog request exists, the system does not create the duplicate catalog request. However, the system will still send an E-Commerce Catalog Request Response Message (CWCatreqResponse) back to the web storefront. See Checking for Duplicate Catalog Requests.

sold_to_prefix

alpha

3

The prefix of the sold to customer.

Maps to the NAM Prefix field in the Customer Sold To table.

sold_to_fname

alpha

15

The first name of the sold to customer.

Maps to the NAM First name field in the Customer Sold To table.

sold_to_initial

alpha

1

The middle initial of the sold to customer.

Maps to the NAM Initial field in the Customer Sold To table.

sold_to_lname

alpha

25

The last name of the sold to customer.

Maps to the NAM Last name field in the Customer Sold To table.

sold_to_suffix

alpha

3

The suffix of the sold to customer.

Maps to the NAM Suffix field in the Customer Sold To table.

sold_to_company

alpha

30

The company name for the sold to customer address.

Maps to the NAM Company name field in the Customer Sold To table.

sold_to_busres

alpha

1

A code that identifies the address as a business or residence.

B = Business

R = Residence

Maps to the NAM Delivery code field in the Customer Sold To table.

sold_to_address1

alpha

32

The street address of the sold to customer address.

Maps to the NAM Street address field in the Customer Sold To table.

sold_to_address2

alpha

32

The second address line of the sold to customer address.

Maps to the NAM Address line 2 field in the Customer Sold To table.

sold_to_address3

alpha

32

The third address line of the sold to customer address.

Maps to the Address line 3 field in the Customer Sold To Extended table.

sold_to_address4

alpha

32

The fourth address line of the sold to customer address.

Maps to the Address line 4 field in the Customer Sold To Extended table.

sold_to_apartment

alpha

10

The apartment/suite number of the sold to customer address.

Maps to the NAM Apartment field in the Customer Sold To table.

sold_to_city

alpha

25

The city of the sold to customer address.

Maps to the NAM City field in the Customer Sold To table.

sold_to_state

alpha

2

The state code of the sold to customer address. Required only if the Require state? flag for the country is selected.

Maps to the NAM State field in the Customer Sold To table.

sold_to_country

alpha

3

The country code of the sold to customer address.

If a country code is missing from the catalog request, Order Management System defaults the country code defined in the Default Country for Customer Address (B17) system control value to the catalog request.

Maps to the RPR Country field in the Customer Sold To table.

sold_to_zip

alpha

10

The postal code of the sold to customer address. Required only if the Require postal code? flag for the country is selected. If the postal code is required, it is validated against the Zip/City/State table.

Maps to the NAM Zip field in the Customer Sold To table.

sold_to_email

alpha

50

The email address assigned to the sold to customer.

Maps to the E-mail field in the Customer Sold To table.

allow_rent

alpha

1

Indicates whether you sell the customer’s name to other companies.

Y = Sell the customer’s name to other companies.

N = Do not sell the customer’s name to other companies.

Maps to the CST Rent name? field in the Customer Sold To table.

allow_mail

alpha

1

Indicates whether the customer wants to receive future catalog mailings.

Y = Mail catalogs to this customer.

N = Do not mail catalogs to this customer.

Maps to the CST Mail name? field in the Customer Sold To table.

sold_to_day_phone

alpha

14

The day phone number for the sold to customer.

Maps to the Phone field in the Customer Sold To Phone # table whose CS# Phone # type field is D.

sold_to_evening_phone

alpha

14

The evening phone number for the sold to customer.

Maps to the Phone field in the Customer Sold To Phone # table whose CS# Phone # type field is E.

sold_to_third_phone

alpha

14

The third (fax or mobile) phone number for the sold to customer.

Maps to the Phone field in the Customer Sold To Phone # table whose CS# Phone # type field is F.

sold_to_opt_in

alpha

2

Determines the preferred method of correspondence for the sold to customer’s email address.

O1 (Email): Email is the preferred method of correspondence.

O2 (Order-only email): Use email for order-related correspondence only; generate a document for other correspondence.

O3 (No email): Do not use email for any correspondence; generate a document instead.

O4 (Do not ask the customer): Do not ask the customer for his/her email address.

If the catalog request does not contain a value in the sold_to_opt_in flag, the system defaults the value defined in the Default Opt In/Opt Out Flag (G97) system control value.

Maps to the CST E-mail status field in the Customer Sold To table.

CustOwnership

The CustOwnerships element, if provided, can include one or more CustOwnership elements.

To create a customer ownership record for the sold to customer, at minimum, you must enter the ownership ID in the cust_own_ID field. See Creating/Updating Sold To Customers in E-Commerce Catalog Requests for additional processing information.

cust_own_ID

alpha

10

A code that represents a product the sold to customer owns or previously owned.

If a value is not defined in this field, the system creates a customer note indicating the customer ownership record was not created/updated: Missing Ownership ID: Ownership Description. The system does not place the e-commerce catalog request in an error status because of customer ownership errors.

Maps to the Ownership ID field in the Customer Ownership table.

cust_own_desc

alpha

40

A description of the product.

Maps to the Description field in the Customer Ownership table.

cust_own_active

alpha

1

Indicates if the customer currently owns the product.

Y = The customer currently owns the product.

N = The customer previously owned the product.

Maps to the Act field in the Customer Ownership table.

cust_own_entry_date

numeric

8

The date the customer ownership record was created, in MMDDYYYY format.

Maps to the Entry date field in the Customer Ownership table.

cust_own_confirm_date

numeric

8

The most recent date when the customer confirmed ownership of the product, in MMDDYYYY format.

Maps to the Confirm date field in the Customer Ownership table.

E-Commerce Catalog Request Message: Sample XML

A sample of the E-Commerce Catalog Request Message (CWCatRequest) in XML format is presented below.

 

<Message type="CWCatRequest" target="string" source="string">

<CatRequest sold_to_opt_in="O1" sold_to_fax_phone="5085550100" sold_to_evening_phone="5085550101" sold_to_day_phone="5085550102" allow_mail="N" allow_email="N" allow_rent="N" sold_to_email="catreq@example.com" sold_to_zip="01581" sold_to_country="US" sold_to_state="MA" sold_to_city="Westborough" sold_to_apartment="1A" sold_to_address4="Address line 4" sold_to_address3="Address line 3" sold_to_address2="Address line 2" sold_to_address1="1234 Sample St" sold_to_busres="B" sold_to_company="Catalog Request" sold_to_suffix="" sold_to_lname="Brown" sold_to_initial="R" sold_to_fname="Thomas" sold_to_prefix="Mr" source_code="SOURCE" offer_id="001" response_required="Y" company_code="7">

<CustOwnerships>

<CustOwnership cust_own_confirm_date="07212015" cust_own_entry_date="07212014" cust_own_active="Y" cust_own_desc="2014 Subaru Outback" cust_own_ID="CAR"/>

<CustOwnership cust_own_confirm_date="01011986" cust_own_entry_date="12191985" cust_own_active="Y" cust_own_desc="1967 RAISED RANCH" cust_own_ID="HOUSE"/>

<CustOwnership cust_own_confirm_date="07212015" cust_own_entry_date="07212014" cust_own_active="Y" cust_own_desc="2011 SEA RAY" cust_own_ID="BOAT"/>

</CustOwnerships>

</CatRequest>

</Message>

E-Commerce Catalog Request Response Message (CWCatreqResponse)

 

The Catalog Requests e-commerce job sends a catalog request response to the web storefront if the response_required field in the e-commerce catalog request message is set to Y.

If the Edit for Duplicate Catalog Requests (E46) system control value is selected, the system checks for duplicate catalog requests, based on match code. If a duplicate catalog request exists, the system does not create the duplicate catalog request. However, the system will still send a catalog request response back to the web storefront.

For more information: See E-Commerce Catalog Request Response for more information on processing and E-Commerce Catalog Request Response Message: Sample XML.

Attribute Name

Type

Length

Comments

Message

One Message element is required.

source

alpha

 

Identifies the source of the XML message. RDC indicates the XML message is from Order Management System.

target

alpha

 

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

type

alpha

 

Identifies the type of information in the XML message. CWCatreqResponse indicates the message contains a catalog request response.

CWCatreqResponse

One CWCatreqResponse element is required.

company_code

numeric

3

A code for the company associated with the catalog request.

From the CMP Company field in the Catalog Request table.

customer_number

numeric

9

The sold to customer number associated with the catalog request. This may represent a new sold to customer or an existing sold to customer.

If this number is 000000000, the catalog request did not process correctly and needs to be corrected through Working with the Catalog Request Interface (WCRU).

From the CST Customer # field in the Catalog Request table.

E-Commerce Catalog Request Response Message: Sample XML

A sample of the E-Commerce Catalog Request Response Message (CWCatreqResponse) in XML format is presented below.

- <Message source="RDC" target="IDC" type="CWCatreqResponse">

<CWCatreqResponse company_code="555" customer_number="000000460" />

</Message>

SO10_05x OMSCS 19.0 December 2019 OHC