E-Commerce Catalog Requests | Contents | SCVs | Search | Glossary | Reports | Database | Solutions | XML | Index | E-Commerce Order Status Processing |
E-Commerce Catalog Request Message (CWCatRequest)
The EC_CAT_REQ job, started through E-Commerce Job Control (EJCT), 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 or individual customers.
• create the sold to customer or individual customer if the customer does not exist.
• update the sold to customer or individual 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 and individual using this message; see Customer Creation/Update Logic in E-Commerce Catalog Requests.
Attribute Name |
Type |
Length |
Comments |
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 CWSerenade. |
type |
alpha |
|
Identifies the type of information in the XML message. CWCatRequest indicates the message contains a catalog request. |
One CatRequest element is required. |
|||
numeric |
3 |
The company associated with the catalog request. Maps to the CMP company field in the Catalog Request table. |
|
response_required |
alpha |
1 |
1 indicates the system sends an E-Commerce Catalog Request Response Message (CWCatreqResponse) back to the web storefront. |
alpha |
3 |
The code for the catalog that the customer is requesting. Maps to the Offer number field in the Catalog Request table. |
|
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 table. |
|
The bill_to fields represent the sold to customer. If the sold to customer does not exist in CWSerenade, 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 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. |
|||
bill_to_prefix |
alpha |
3 |
The prefix of the sold to customer. Maps to the NAM Prefix field in the Customer Sold To table. |
alpha |
15 |
The first name of the sold to customer. Maps to the NAM First name field in the Customer Sold To table. |
|
alpha |
1 |
The middle initial of the sold to customer. Maps to the NAM Initial field in the Customer Sold To table. |
|
alpha |
25 |
The last name of the sold to customer. Maps to the NAM Last name field in the Customer Sold To table. |
|
bill_to_suffix |
alpha |
3 |
The suffix of the sold to customer. Maps to the NAM Suffix field in the Customer Sold To table. |
alpha |
30 |
The company name for the sold to customer address. Maps to the NAM Company name field in the Customer Sold To table. |
|
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. |
|
alpha |
32 |
The street address of the sold to customer address. Maps to the NAM Street address field in the Customer Sold To table. |
|
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. |
|
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. |
|
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. |
|
alpha |
10 |
The apartment/suite number of the sold to customer address. Maps to the NAM Apartment field in the Customer Sold To table. |
|
alpha |
25 |
The city of the sold to customer address. Maps to the NAM City field in the Customer Sold To table. |
|
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. |
|
alpha |
3 |
The country code of the sold to customer address. Maps to the RPR Country field in the Customer Sold To table. |
|
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. |
|
alpha |
50 |
The email address assigned to the sold to customer. Maps to the E-mail field in the Customer Sold To table. |
|
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. |
|
alpha |
1 |
This field is not currently implemented. Maps to the CST Rent e-mail field in the Customer Sold To table. |
|
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. |
|
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. |
|
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. |
|
bill_to_fax_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. |
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. Maps to the CST E-mail status field in the Customer Sold To table. |
|
The indiv fields represent the individual customer. The Enable Catalog Request at Customer Individual Level (H81) system control value controls whether you can specify an individual on a catalog request. This system control value must be selected to enter a catalog request at the individual level; if this system control value is unselected, 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 table, 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 table. |
alpha |
15 |
The first name of the individual customer. Maps to the CIF First name field in the Customer Individual table. |
|
alpha |
25 |
The last name of the individual customer. Maps to the CIF Last name field in the Customer Individual table. |
|
alpha |
1 |
The middle initial of the individual customer. Maps to the CIF Middle initial field in the Customer Individual table. |
|
indiv_suffix |
alpha |
3 |
The suffix of the individual customer. Maps to the CIF Name suffix field in the Customer Individual table. |
alpha |
14 |
The day phone number for the individual customer. Maps to the Day phone field in the Customer Individual table. |
|
alpha |
14 |
The evening phone number of the individual customer. Maps to the Eve phone field in the Customer Individual table. |
|
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 table. |
alpha |
50 |
The email address assigned to the individual customer. Maps to the CIF E-Mail address field in the Customer Individual table. |
|
indiv_mailstop |
alpha |
32 |
The individual’s delivery address within the organization. Maps to the CIF Mail stop field in the Customer Individual table. |
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 table. |
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 table. |
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 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. Maps to the CIF Opt in/opt out field in the Customer Individual table. |
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 source="WEB" target="RDC" type="CWCatRequest">
- <CatRequest company_code="555" response_required="1" offer_id="204" source_code="2006" bill_to_fname="BERNADETTE" bill_to_initial="T" bill_to_lname="MIRANDA" bill_to_busres="R" bill_to_address1="109 EXAMPLE LN" bill_to_city="TEMPLETON" bill_to_state="MA" bill_to_country="USA" bill_to_zip="01468" bill_to_email="BMIRANDA@EXAMPLE.COM" allow_rent="Y" allow_email="Y" allow_mail="Y" bill_to_day_phone="9786233344" bill_to_evening_phone="6663334444" bill_to_fax_phone="4443335555" bill_to_opt_in="O2">
- <CustOwnerships>
<CustOwnership />
</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 |
One Message element is required. |
|||
source |
alpha |
|
Identifies the source of the XML message. RDC indicates the XML message is from CWSerenade. |
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. |
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. |
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 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" individual_number="000" />
</Message>