Working with Customer API (WCAI)
Purpose: Use this menu option to review, work with, delete, or resubmit customer API requests that are in error.
The CWCustomer or CWMessageIn Web Service receives and processes the Inbound Customer Message (CWCustomerIn) and creates or updates a customer, based on the information in the inbound message. If the request is in error for any reason, the system saves the information from the request in the Customer API Work table. If the request also includes email or user-defined field information, this additional information is stored in the Customer API E-mail Work table and the Customer API UDF Work table.
Error reasons: See Error Checking for Add Requests.
For more information: See Generic Customer API, including Adding a Customer using the Customer API, Changing a Customer using the Customer API, and the Inbound Customer Message (CWCustomerIn).
In this chapter:
• Work with Customer API Screen
• Work with Customer API User Field Screen
• Change Customer API User Field Screen
• Work with Customer API Email Screen
• Change Customer API Email Screen
How to display this screen: Enter WCAI in the Fast path field at the top of any menu, or select Work with Customer API from a menu.
Field |
Description |
Date |
The date when the Customer API Work table record was created. Numeric, 6 positions (in user date format); optional. |
Time |
The time when the Customer API Work table record was created. Numeric, 6 positions (HHMMSS format); optional. |
Act (Action) |
The requested action from the cst_action_type in the Inbound Customer Message (CWCustomerIn). If the cst_action_type is D, the system places the message in error with the error reason Invalid Action Type. The system ignores any other value; see Determining Whether to Add or Change a Customer for more information on the logic the system uses to determine whether to create a new customer or change an existing one. Display-only. |
Status |
The status of the request. E (error) = The Customer request is in error. blank = The Customer request is ready to reprocess. Alphanumeric, 1 position; display-only. |
Customer# |
The customer number affected by the request. Note: • If an Add request is in error, the customer number displayed here does not yet exist in the Customer Sold To table. • If a Change request is in error because the customer could not be identified, the customer number displayed here is zero. Numeric, 9 positions; display-only. |
Alternate# |
The cst_interface_cust_nbr, if any, specified in the Inbound Customer Message (CWCustomerIn). No alternate customer number is displayed if the Assign Alternate Customer # (I88) system control value is selected; in this situation, the system assigns the alternate customer number when it actually creates the customer. Alphanumeric, 15 positions; display-only. |
Not currently implemented. Select Change for the customer API record to advance to the Change Customer API Screen; when you select OK on this screen, the system displays a message indicating the reason why the Customer API record is in error. Alphanumeric, 1 position; display-only. |
Option |
Procedure |
Change a customer API request record |
Select Change for a customer API request record to advance to the Change Customer API Screen. |
Delete a customer API request record. |
Select Delete for a customer API request record to delete it. |
Work with user-defined fields for a customer API request record |
Select User defined fields for a customer API request record to advance to the Work with Customer API User Field Screen. |
Work with email information for a customer API request record |
Select Email for a customer API request record to advance to the Work with Customer API Email Screen. |
Reprocess a customer API request record |
Select Reprocess for a customer API request record to submit it for processing. The system reprocesses the record only if it is error-free. See Adding a Customer using the Customer API for more information. |
Reprocess all customer API requests |
Select Reprocess to submit all eligible request records for processing. See Adding a Customer using the Customer API for more information. |
Purpose: Use this screen to work with customer API requests that are in error based on the information passed in the CustSoldTo element of the Inbound Customer Message (CWCustomerIn).
How to display this screen: Select Change for a customer API record in error.
Field |
Description |
Date |
The date when the Customer API Work table record was created. Numeric, 6 positions (in user date format); display-only. |
Action |
The requested action from the cst_action_type in the Inbound Customer Message (CWCustomerIn). Possible actions are: • Add = Add a customer • Change = Change an existing customer • Delete = Delete an existing customer Note: You can only create or update a customer; the system does not allow you to delete a customer through the Generic Customer API. See Determining Whether to Add or Change a Customer or the logic the system uses to determine whether to create a new customer or change an existing one. Display-only. |
Entered on |
The cst_entry_date from the Inbound Customer Message (CWCustomerIn). Numeric, 6 positions (in user date format); optional. |
Lng (Language) |
The cst_language from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 3 positions; optional. |
Class |
The cst_cust_class from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 2 positions; optional (required if the Require Customer Class in OE, WCAT, and WCST (H85) system control value is selected). |
Time |
The time when the Customer API Work table record was created. Numeric, 6 positions (HHMMSS format); display-only. |
Status |
The status of the customer API request. Possible statuses are: • Error = The Customer request is in error. • No Error = The Customer request is ready to reprocess. Display-only. |
Created by |
The cst_create_user from the Inbound Customer Message (CWCustomerIn). Note: Regardless of the user you select for this field, the system defaults the user ID of the user updating the Customer API record. Alphanumeric, 10 positions; optional. |
Cur (Currency) |
The cst_currency from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 3 positions; optional. |
Comp Cd (Company code) |
The cst_cust_company from the Inbound Customer Message (CWCustomerIn). Numeric, 3 positions; optional. |
Customer# |
The cst_cust_nbr from the Inbound Customer Message (CWCustomerIn), or assigned by the system if this is an Add request. Note: • If an Add request is in error, the customer number displayed here does not yet exist in the Customer Sold To table. • If a Change request is in error because the customer could not be identified, the customer number displayed here is zero. Numeric, 9 positions; display-only. |
Changed by |
The cst_change_user from the Inbound Customer Message (CWCustomerIn). Note: Regardless of the user you select for this field, the system defaults the user ID of the user updating the Customer API record. Alphanumeric, 10 positions; required. |
Typ (Type) |
The cst_cust_type from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 3 positions; optional. |
Mail Cd (Mail code) |
The cst_mail_code from the Inbound Customer Message (CWCustomerIn). Not to be confused with the Mail flag. Alphanumeric, 3 positions; optional. |
Account# |
The cst_account_nbr from the Inbound Customer Message (CWCustomerIn). Numeric, 7 positions; optional. |
Commer (Commercial) |
The cst_commercial flag from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 1 position; optional. |
Alt# (Alternate customer #) |
The cst_interface_cust_nbrcst_interface_cust_nbr from the Inbound Customer Message (CWCustomerIn). Note: No alternate customer number is displayed if the Assign Alternate Customer # (I88) system control value is selected; in this situation, the system assigns the alternate customer number when it actually creates the customer. Alphanumeric, 15 positions; optional. |
Call Cd (Call code) |
The cst_call_code from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 3 positions; optional. |
Name |
The customer’s name from the Inbound Customer Message (CWCustomerIn), consisting of: Alphanumeric, 47 positions; optional. |
Inact (Inactive) |
The cst_inactive flag from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 1 position; optional. |
Company |
The cst_company_name from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 30 positions; required if no last name is specified. |
Apt |
The cst_apt from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 7 positions; optional. |
PO Box |
The cust_po_box flag from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 1 position; optional. |
Suppr Sls Email (Suppress salesman email) |
The cst_suppress_sales_rep_email from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 1 position; optional. |
Street |
The cst_street_addr from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 32 positions; required. |
Delivery code |
The cst_delivery_type from the Inbound Customer Message (CWCustomerIn). Valid values: • Business • Residential • No Distinction Required. |
The cst_mail_name flag from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 1 position; optional. |
|
Address |
The cst_addr_line_2, cst_addr_line_3, and cst_addr_line_4 from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 32 positions each; optional. |
Deliverable cde (Deliverable code) |
The cst_deliverable flag from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 1 position; optional. |
Rent |
The cst_rent_name flag from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 1 position; optional. |
Orig mail type (Original mail type) |
The cst_orig_mail_type from the Inbound Customer Message (CWCustomerIn). Valid values: • Buyer • Catalog Request • Recipient • Rental • Suspect/Prospect Optional. |
Seed |
The cst_seed_name flag from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 1 position; optional. |
Curr mail type (Current mail type) |
The cst_curr_mail_type from the Inbound Customer Message (CWCustomerIn). Valid values: • Buyer • Catalog Request • Recipient • Rental • Suspect/Prospect Optional. |
H/B/F |
The cst_hold_bypass_fraud flag from the Inbound Customer Message (CWCustomerIn). Valid values: • Hold • Bypass • Fraud Optional. |
Postal code |
The cst_zip from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 10 positions; required. |
City |
The cst_city from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 25 positions; required. |
State |
The cst_state from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 10 positions; required if specified for country. |
Country |
The cst_country from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 3 positions; required. |
Job title |
The cst_job_title flag from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 10 positions; optional. |
Exempt status |
The cst_tax_exempt flag from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 1 positions optional. |
Cert# (Certificate number) |
The cst_exempt_certificate from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 15 positions; optional. |
Day phone |
The cst_day_phone and cst_day_ext from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 14 positions (phone number) and 4 positions (extension); optional. |
Expiry date |
The cst_exempt_expiry from the Inbound Customer Message (CWCustomerIn). Numeric, 8 positions; optional. |
VAT |
The cst_vat_nbr from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 20 positions; optional. |
Eve phone (Evening phone) |
The cst_eve_phone and cst_eve_ext from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 14 positions (phone number) and 4 positions (extension); optional. |
Orig source (Original source) |
The cst_original_source from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 9 positions; optional. |
Email sts (Email status) |
The cst_email_status from the Inbound Customer Message (CWCustomerIn). The value specified in the Default Opt In/Opt Out Flag (G97) system control value defaults here if no status was specified in the inbound message. Note: The system displays an error message at this screen if the email status is missing or invalid for the email address specified for the Add or Change request. See Work with Customer API Email Screen. Alphanumeric, 2 positions; optional. |
Assoc (Associate) |
The cst_associate flag from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 1 position; optional. |
Fax |
The cst_fax_phone and cst_fax_ext from the Inbound Customer Message (CWCustomerIn). Note: The Third Phone Number Type (L53) system control value determines whether the third phone number is labeled the Fax or Mobile number here, and on reports and other screens. Alphanumeric, 14 positions (phone number) and 4 positions (extension); optional. |
Curr source (Current source) |
The cst_current_source from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 9 positions; optional. |
Rent email |
The cst_rent_email flag from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 1 position; optional. |
Can BO (Cancel backorder) |
The cst_cancel_bo flag from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 1 position; optional. |
Byp rsv (Bypass reservation) |
The cst_bypass_reservation flag from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 1 position; optional. |
Discount% |
The cst_discount_pct from the Inbound Customer Message (CWCustomerIn). Numeric, 5 positions with a 2-place decimal; optional. |
Sls # (Salesrep #) |
The cst_salesman_nbr from the Inbound Customer Message (CWCustomerIn). Numeric, 7 positions; optional. |
Do not fax |
The cst_do_not_fax flag from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 1 position; optional. |
Col (Column) |
The cst_price_column from the Inbound Customer Message (CWCustomerIn). Numeric, 2 positions; optional. |
Item track |
The cst_item_hist_tracking flag from the Inbound Customer Message (CWCustomerIn). Valid values: • No Item Tracking • Sold To Tracking Only • Sold To + Ship To Tracking Optional. |
User 1-4 |
The cst_user_field_1, cst_user_field_2, cst_user_field_3, and cst_user_field_4 from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 10 positions each; optional. |
Relate Id |
The cst_relate_id from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 32 positions; display-only. |
Pop up 1-2 |
The cst_pop_window_1and cst_pop_window_2 from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 20 positions each; optional. |
Reserve Warehouse |
The cst_reserve_warehouse from the Inbound Customer Message (CWCustomerIn).The warehouse must be an allocatable warehouse (the Allocatable flag for the warehouse is selected). Warehouse codes are defined in and validated against the Warehouse table. See Creating and Maintaining Warehouses (WWHS). Numeric, 3 positions; optional. |
Pop up 3-4 |
The cst_pop_window_3 and cst_pop_window_4 from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 20 positions each; optional. |
Van Route |
The cst_van_route from the Inbound Customer Message (CWCustomerIn).The van route must be a valid van route for the Reserve warehouse. You cannot enter a van route if a Reserve warehouse is not specified. Van routes are defined in and validated against the Warehouse Van Route table.See Work with Van Routes Screen. Alphanumeric, 4 positions; optional. |
Van Sequence # |
The cst_van_route_seq from the Inbound Customer Message (CWCustomerIn). You cannot enter a van sequence number if a Van route is not specified. Numeric, 4 positions; optional. |
Completing this screen: Complete or correct each required field. See Inbound Customer Message (CWCustomerIn) for more information on how each field is derived and validated.
Note:
• The system displays an error message at this screen if there is an error with the Customer API UDF Work table or the Customer API E-mail Work table. See below for more information on how to advance to the correct screens to correct these errors.
• The system displays the Display Duplicate Sold To window if the customer information in an Add request matches an existing customer. See Adding a Customer using the Customer API for more information.
Option |
Procedure |
Work with user-defined fields for the customer API request |
Select User fields to advance to the Work with Customer API User Field Screen. |
Work with email addresses for the customer API request |
Select Email to advance to the Work with Customer API Email Screen. |
Work with Customer API User Field Screen
Purpose: Use this screen to review or work with customer user-defined field information passed in the CustUserDefinedField element of the Inbound Customer Message (CWCustomerIn).
How to display this screen: Select User defined fields for a record at the Work with Customer API Screen, or select User fields at the Change Customer API Screen.
Field |
Description |
Customer |
The cst_cust_nbr from the Inbound Customer Message (CWCustomerIn), or assigned by the system if this is an Add request. The name of the customer is displayed to the right. Number: numeric, 9 positions; display-only. Name: alphanumeric, 41 positions; display-only. |
Seq |
The cst_udf_seq from the CustUserDefinedField element of the Inbound Customer Message (CWCustomerIn). This sequence number identifies the type of user-defined field required. See Work with User Fields Screen for more information. Numeric, 9 positions; display-only. |
Text |
The cst_udf_text from the CustUserDefinedField element of the Inbound Customer Message (CWCustomerIn). Alphanumeric, 30 positions; display-only. |
Number |
The cst_udf_nbr from the CustUserDefinedField element of the Inbound Customer Message (CWCustomerIn). Alphanumeric, 30 positions; display-only. |
Date |
The cst_udf_date from the CustUserDefinedField element of the Inbound Customer Message (CWCustomerIn). Alphanumeric, 30 positions; display-only. |
Option |
Procedure |
Change user-defined field information |
Select Change for a user-defined field to advance to the Change Customer API User Field Screen. |
Delete user-defined field information |
Select Delete for a user-defined field to delete it. |
Change Customer API User Field Screen
Purpose: Use this screen to review or change the user-defined field information in a customer API Add or Change request.
Correcting user-defined field information: The user-defined field information passed in the Inbound Customer Message (CWCustomerIn) must match the type (text, number, or date) based on the sequence number for the user-defined field detail, or the customer API Add or Change request will be in error. Each customer API user field record must include one of these types of data.See Work with User Fields Screen for more information.
How to display this screen: Select Change for a record at the Work with Customer API User Field Screen.
Field |
Description |
Customer |
The cst_cust_nbr from the Inbound Customer Message (CWCustomerIn), or assigned by the system if this is an Add request. The name of the customer is displayed to the right. Number: numeric, 9 positions; display-only. Name: alphanumeric, 41 positions; display-only. |
Just one of the following fields must be completed. The type of field must match the sequence number for the user-defined field detail. See Work with User Fields Screen for more information. |
|
Text |
The cst_udf_text from the CustUserDefinedField element of the Inbound Customer Message (CWCustomerIn). Alphanumeric, 30 positions; optional. |
Number |
The cst_udf_nbr from the CustUserDefinedField element of the Inbound Customer Message (CWCustomerIn). Alphanumeric, 30 positions; optional. |
Date |
The cst_udf_date from the CustUserDefinedField element of the Inbound Customer Message (CWCustomerIn). Alphanumeric, 30 positions; optional. |
Work with Customer API Email Screen
Purpose: Use this screen to review the email addresses included in the CustEmail element of the Inbound Customer Message (CWCustomerIn), or to select an email address for review or update.
How to display this screen: Select Email for an Add or Change request at the Work with Customer API Screen or select Email at the Change Customer API Screen.
Field |
Description |
Customer |
The cst_cust_nbr from the Inbound Customer Message (CWCustomerIn), or assigned by the system if this is an Add request. The name of the customer is displayed to the right. Number: numeric, 9 positions; display-only. Name: alphanumeric, 41 positions; display-only. |
Email address |
The cst_email_address from the CustEmail element of the Inbound Customer Message (CWCustomerIn). Alphanumeric, 50 positions; display-only. |
Status |
The cst_email_status from the CustEmail element of the Inbound Customer Message (CWCustomerIn). Alphanumeric, 2 positions; display-only. |
Fmt (Format) |
The cst_email_format from the CustEmail element of the Inbound Customer Message (CWCustomerIn). Alphanumeric, 1 position; display-only. |
Prm (Primary) |
The cst_email_primary flag from the CustEmail element of the Inbound Customer Message (CWCustomerIn). Alphanumeric, 1 position; display-only. |
Option |
Procedure |
Change an email address in an Add or Change request |
Select Change for an email address to advance to the Change Customer API Email Screen. |
Delete an email address in an Add or Change request |
Select Delete for an email address to delete the email address from the Add or Change request. |
Change Customer API Email Screen
Purpose: Use this screen to review or change the email address information included in a customer API Add or Change request.
How to display this screen: Select Change for an email address at the Work with Customer API Email Screen.
Field |
Description |
Customer |
The cst_cust_nbr from the Inbound Customer Message (CWCustomerIn), or assigned by the system if this is an Add request. The name of the customer is displayed to the right. Number: numeric, 9 positions; display-only. Name: alphanumeric, 41 positions; display-only. |
Email address |
The cst_email_address from the CustEmail element of the Inbound Customer Message (CWCustomerIn). Subject to the email address format edits described under Email Address Validation. Alphanumeric, 50 positions; required. |
Email status |
The cst_email_status from the CustEmail element of the Inbound Customer Message (CWCustomerIn). If no status is specified here, the cst_email_status from the CustSoldTo element defaults; and if no status is specified there, then the value from the Default Opt In/Opt Out Flag (G97) system control value defaults to both. Alphanumeric, 2 positions; required. |
Email format |
The cst_email_format from the CustEmail element of the Inbound Customer Message (CWCustomerIn). Alphanumeric, 1 position; optional. |
Display name |
The cst_display_name from the CustEmail element of the Inbound Customer Message (CWCustomerIn). Alphanumeric, 50 positions; optional. |
Primary |
The cst_email_primary flag from the CustEmail element of the Inbound Customer Message (CWCustomerIn). Alphanumeric, 1 position; optional. |
| Generic Customer API | Contents | SCVs | Search | Glossary | Reports | Solutions | XML | Index | Customer Engagement Customer Integration |
CS03_24 OROMS 17.0 2018 OTN