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 XML message is from the web storefront.

target

alpha

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

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

response_required

alpha

1

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

Available in version: 7.0 or later of CWDirect for XML only.

offer_id

alpha

3

The code for the catalog that the customer is requesting.

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

source_code

alpha

9

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

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

The bill_to fields represent the sold to customer. If the sold to customer does not exist in CWDirect, 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 bill_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 set to Y, 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.

bill_to_prefix

alpha

3

The prefix of the sold to customer.

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

Available in version: 7.0 or later of CWDirect for XML only.

bill_to_fname

alpha

15

The first name of the sold to customer.

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

bill_to_initial

alpha

1

The middle initial of the sold to customer.

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

Available in version: 6.0 or later of CWDirect.

bill_to_lname

alpha

25

The last name of the sold to customer.

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

bill_to_suffix

alpha

3

The suffix of the sold to customer.

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

Available in version: 7.0 or later of CWDirect for XML only.

bill_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 file.

bill_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 file.

bill_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 file.

bill_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 file.

bill_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 file.

bill_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 file.

bill_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 file.

Available in version: 6.0 or later of CWDirect.

bill_to_city

alpha

25

The city of the sold to customer address.

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

bill_to_state

alpha

2

The state code of the sold to customer address.

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

bill_to_country

alpha

3

The country code of the sold to customer address.

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

bill_to_zip

alpha

10

The postal code of the sold to customer address.

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

bill_to_email

alpha

50

The email address assigned to the sold to customer.

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

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

allow_email

alpha

1

This field is not currently implemented.

Maps to the CST Rent e-mail field in the Customer Sold To file.

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

bill_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 # file whose CS# Phone # type field is D.

Available in version: 6.0 or later of CWDirect.

bill_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 # file whose CS# Phone # type field is E.

Available in version: 6.0 or later of CWDirect.

bill_to_fax_phone

alpha

14

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

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

Available in version: 7.0 or later of CWDirect for XML only.

bill_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 spool file for other correspondence.

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

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

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

Available in version: 6.0 or later of CWDirect.

The indiv fields represent the individual customer. The Enable Catalog Request at Individual Level (H81) system control value controls whether you can specify an individual on a catalog request. This system control value must be set to Y to enter a catalog request at the individual level; if this system control value is set to N, the system places catalog requests containing individual information in an error status in the Working with the Catalog Request Interface (WCRU) menu option.

If a new individual is defined for the sold to customer on the catalog request message, the system creates the new individual for the customer in the Customer Individual file, using the next sequential number. The individual’s Original mail type and Current mail type will be C, the Mail and Rent flags will default from the sold to customer’s, and the Mail code will default from the Mail flag.

If an existing individual is defined for the sold to customer on the catalog request message, the system updates the individual’s address, mail flag, and opt-in/opt-out flag if you have changed them.

indiv_prefix

alpha

3

The prefix of the individual customer.

Maps to the CIF Name prefix field in the Customer Individual file.

Available in version: 7.0 or later of CWDirect for XML only.

indiv_fname

alpha

15

The first name of the individual customer.

Maps to the CIF First name field in the Customer Individual file.

Available in version: 6.0 or later of CWDirect.

indiv_lname

alpha

25

The last name of the individual customer.

Maps to the CIF Last name field in the Customer Individual file.

Available in version: 6.0 or later of CWDirect.

indiv_initial

alpha

1

The middle initial of the individual customer.

Maps to the CIF Middle initial field in the Customer Individual file.

Available in version: 6.0 or later of CWDirect.

indiv_suffix

alpha

3

The suffix of the individual customer.

Maps to the CIF Name suffix field in the Customer Individual file.

Available in version: 7.0 or later of CWDirect for XML only.

indiv_day_phone

alpha

14

The day phone number for the individual customer.

Maps to the Day phone field in the Customer Individual file.

Available in version: 6.0 or later of CWDirect.

indiv_eve_phone

alpha

14

The evening phone number of the individual customer.

Maps to the Eve phone field in the Customer Individual file.

Available in version: 6.0 or later of CWDirect.

indiv_fax_phone

alpha

14

The third (fax or mobile) number of the individual customer.

Maps to the Fax phone field in the Customer Individual file.

Available in version: 7.0 or later of CWDirect for XML only.

indiv_email

alpha

50

The email address assigned to the individual customer.

Maps to the CIF E-Mail address field in the Customer Individual file.

Available in version: 6.0 or later of CWDirect.

indiv_mailstop

alpha

32

The individual’s delivery address within the organization.

Maps to the CIF Mail stop field in the Customer Individual file.

Available in version: 6.0 or later of CWDirect.

indiv_position

alpha

3

A code that represents the individual’s position within the organization.

Maps to the CIF Position field in the Customer Individual file.

Available in version: 6.0 or later of CWDirect.

indiv_department

alpha

3

A code the represents the individual’s department within the organization.

Maps to the CIF Department field in the Customer Individual file.

Available in version: 6.0 or later of CWDirect.

indiv_opt_in

alpha

2

Determines the preferred method of correspondence for the individual 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 spool file for other correspondence.

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

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

Maps to the CIF Opt in/opt out field in the Customer Individual file.

Available in version: 7.0 or later of CWDirect for XML only.

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.

Available in version: The CustOwnership element and all of its attributes is available in version 8.0 or later of CWDirect for XML only.

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

cust_own_desc

alpha

40

A description of the product.

Maps to the Description field in the Customer Ownership file.

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

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

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

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

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

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

individual_number

numeric

3

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

If this number is 000, an individual is not associated with the catalog request.

If this number is 000 and the customer_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 CIF Customer individual # field in the Catalog Request Cust Indv file.