Inbound Customer Message (CWCustomerIn) | Contents | SCVs | Search | Glossary | Reports | Database | Solutions | XML | Index | Working with Customer API (WCAI) |
Outbound Customer Response Message (CWCustomerOut)
The CWCustomer or CWMessageIn Web Service generates this message as a response to the Inbound Customer Message (CWCustomerIn) if the cst_send_response is selected. See Adding a Customer using the Customer API and Changing a Customer using the Customer API for more information.
Special characters: Certain special characters cannot be defined for an attribute of an XML message except through the use of replacement text strings. See Translating Special Characters for a list of special characters and their corresponding replacement text string.
Sample message: See Sample Customer API XML Messages.
Attribute Name |
Type |
Length |
Comments |
source |
alpha |
20 |
Informational. |
target |
alpha |
20 |
Informational. |
type |
alpha |
20 |
CWCustomerOut |
resp_qmgr |
alpha |
48 |
Informational. |
resp_q |
alpha |
48 |
Informational. |
cst_company |
numeric |
3 |
The company indicated in the Inbound Customer Message (CWCustomerIn). |
numeric |
9 |
The customer number affected by the Inbound Customer Message (CWCustomerIn). In the case of a successful Add request, this is the customer number assigned by the system to the new customer. From Customer # in the Customer Sold To table. |
|
cst_action_type |
alpha |
1 |
Defines whether the system considered the Inbound Customer Message (CWCustomerIn) to be an Add or Change request. A = Add request. C = Change request. |
alpha |
9 |
The result of the requested action. Possible results are: • Success = The update was completed successfully. • Failure = The request could not be completed due to errors. The response indicates the element and tag that caused the error. • Duplicate = The request could not be completed because the system found one or more duplicate customers. Used only for Add requests. |
|
The customer name and address information included in the CustSoldTo element of the response message varies, based on whether the response is to an Add or Change request, and whether the request was successful: • Successful creation or change: This is the information sent in the Inbound Customer Message (CWCustomerIn). If the system performed any address standardization, the updated address is included. • Duplicate: This is the customer information for the duplicate customer if the system found one or more duplicate customers for an Add request. See Adding a Customer using the Customer API for a discussion. Note: If there are multiple duplicate customers, additional duplicates are listed in the Duplicate element. • Change failure: The customer number identified for the Change request is included, but no additional customer information. • Add failure: No customer information is included. See the Sample Customer API XML Messages for examples of each. |
|||
cst_prefix |
alpha |
3 |
The Prefix, if any, for the customer. From Prefix in the Customer Sold To table. |
cst_fname |
alpha |
15 |
The First Name, if any, for the customer. From First Name in the Customer Sold To table. |
cst_minitial |
alpha |
1 |
The Initial, if any, for the customer. From Initial in the Customer Sold To table. |
cst_lname |
alpha |
25 |
The Last Name, if any, for the customer. From Last Name in the Customer Sold To table. |
cst_suffix |
alpha |
3 |
The Suffix, if any, for the customer. From Suffix in the Customer Sold To table. |
cst_company_name |
alpha |
30 |
The Company, if any, for the customer. From Company name in the Customer Sold To table. |
cst_street_name |
alpha |
32 |
The Street for the customer. From Street Address in the Customer Sold To table. |
cst_addr_line_2 |
alpha |
32 |
The three additional Address lines, if any, for the customer. From Address line 2 in the Customer Sold To table and Address line 3 and Address line 4 in the Customer Sold To Extended table. |
cst_addr_line_3 |
alpha |
32 |
|
cst_addr_line_4 |
alpha |
32 |
|
cst_apt |
alpha |
10 |
The Apt/suite (Apartment/suite), if any, for the customer. From Apartment in the Customer Sold To table. |
cst_city |
alpha |
25 |
The City for the customer. From City in the Customer Sold To table. |
cst_state |
alpha |
2 |
The St (State) for the customer. From State in the Customer Sold To table. |
cst_zip |
alpha |
10 |
The Postal code for the customer. From Zip in the Customer Sold To table. |
cst_country |
alpha |
3 |
The Country for the customer. From Country in the Customer Sold To table. |
cst_match_code |
alpha |
15 |
The Match code for the customer. From Match Code in the Customer Sold To table. |
cst_ghost |
alpha |
1 |
Indicates whether this customer record is a ghost, or a customer record that you can retain on the system after you purge duplicates. See the discussion of the Ghost flag for more information. Valid values are: Y = The record is a ghost. N = The record is not a ghost. From Ghost? in the Customer Sold To table. |
cst_interface_cust_nbr |
alpha |
15 |
From Alternate customer # in the Customer Sold To XRef table. Each alternate customer number for the customer is included. |
This information is included only if there are multiple duplicates for an Add request. See Adding a Customer using the Customer API for a discussion. |
|||
dup_cust_nbr |
numeric |
9 |
From Customer # in the Customer Sold To table. |
dup_prefix |
alpha |
3 |
From Prefix in the Customer Sold To table. |
dup_fname |
alpha |
15 |
From First Name in the Customer Sold To table. |
dup_minitial |
alpha |
1 |
From Initial in the Customer Sold To table. |
dup_lname |
alpha |
25 |
From Last Name in the Customer Sold To table. |
dup_suffix |
alpha |
3 |
From Suffix in the Customer Sold To table. |
dup_company_name |
alpha |
30 |
From Company name in the Customer Sold To table. |
dup_street_name |
alpha |
32 |
From Street Address in the Customer Sold To table. |
dup_addr_line_2 |
alpha |
32 |
From Address line 2 in the Customer Sold To table. |
dup_addr_line_3 |
alpha |
32 |
From Address line 3 in the Customer Sold To Extended table. |
dup_addr_line_4 |
alpha |
32 |
From Address line 4 in the Customer Sold To Extended table. |
dup_apt |
alpha |
10 |
From Apartment in the Customer Sold To table. |
dup_city |
alpha |
25 |
From City in the Customer Sold To table. |
dup_state |
alpha |
2 |
From State in the Customer Sold To table. |
dup_zip |
alpha |
10 |
From Zip in the Customer Sold To table. |
dup_country |
alpha |
3 |
From Country in the Customer Sold To table. |
dup_match_code |
alpha |
15 |
From Match Code in the Customer Sold To table. |
dup_ghost |
alpha |
1 |
Indicates whether this customer record is a ghost, or a customer record that you can retain on the system after you purge duplicates. See the discussion of the Ghost flag for more information. Valid values are: Y = The record is a ghost. N = The record is not a ghost. From Ghost? in the Customer Sold To table. |