Sample Customer API XML Messages
• Customer Message: Successful Add Request
• Customer Message: Duplicate Add Request
• Customer Message: Failure Add Request
• Customer Message: Successful Change Request
• Customer Message: Failure Change Request
• Customer Message: Failure Delete Request
Customer Message: Successful Add Request
A sample CWCustomerIn Add request that successfully creates a customer is presented below. See Adding a Customer using the Customer API for more information.
CWCustomerIn: See Inbound Customer Message (CWCustomerIn) for message details.
<Message source="CWIntegrate" target="CUST35" type="CWCustomerIn" resp_qmgr="QM_CWINTEGRATE_QA4">
<CustSoldTo cst_company="007" cst_action_type="K" cst_send_response="Y" cst_duplicate="N" cst_cust_nbr="" cst_salesman_nbr="" cst_interface_cust_nbr="" cst_language="ENG" cst_job_title="" cst_relate_id="" cst_prefix="" cst_fname="Helen" cst_minitial="" cst_lname="Smith" cst_suffix="" cst_company_name="" cst_street_addr="10 Walnut Street" cst_addr_line_2="Line 2" cst_addr_line_3="" cst_addr_line_4="" cst_apt="" cst_city="Westborough" cst_state="MA" cst_zip="01581" cst_country="USA" cst_day_phone="(508)555-0100" cst_day_ext="1234" cst_eve_phone="(508)555-0102" cst_eve_ext="5678" cst_fax_phone="5085550103" cst_fax_ext="9012" cst_mail_name="" cst_rent_name="" cst_seed_name="" cst_rent_email="" cst_original_source="" cst_current_source="" cst_hold_bypass_fraud="" cst_orig_mail_type="S" cst_curr_mail_type="B" cst_tax_exempt="" cst_exempt_certificate="" cst_exempt_expiry="" cst_associate="K" cst_cancel_bo="K" cst_commercial="N" cst_cust_type="" cst_discount_pct="" cst_entry_date="10112009" cst_inactive="N" cst_bypass_reservation="N" cst_pop_window_1="POP1" cst_pop_window_2="POP2" cst_pop_window_3="" cst_pop_window_4="" cst_price_column="" cst_item_hist_tracking="2" cst_vat_nbr="" cst_do_not_fax="N" cst_deliverable="" cst_delivery_type="" cst_email_status="O1" cst_account_nbr="" cst_cust_class="" cst_cust_company="" cst_mail_code="" cst_call_code="" cst_change_user="" cst_create_user="" cst_currency="USD" cust_po_box="" cst_warehouse="2" cst_user_field_1="USER1" cst_user_field_2="USER2" cst_user_field_3="USER3" cst_user_field_4="USER4" cst_reserve_warehouse="11" cst_van_route="" cst_van_route_seq="" cst_price_group="">
<CustEmails>
<CustEmail cst_email_seq="1" cst_email_address="kbottger@example.com" cst_email_primary="Y" cst_email_status="O1" cst_email_format="" cst_display_name="1Tyne Kwan" />
<CustEmail cst_email_seq="2" cst_email_address="ssullivan@example.com" cst_email_primary="N" cst_email_status="O2" cst_email_format="" cst_display_name="2Tyne Kwan" />
</CustEmails>
<CustUserDefinedFields>
<CustUserDefinedField cst_udf_seq="" cst_udf_text="" cst_udf_nbr="" cst_udf_date="" />
</CustUserDefinedFields>
<CustProfiles>
<CustProfile cst_profile_code="" cst_profile_value="" />
</CustProfiles>
</CustSoldTo>
</Message>
CWCustomerOut: See Outbound Customer Response Message (CWCustomerOut) for message details.
<Message source="CWSerenade" target="CUST35" type="CWCustomerOut" date_created="2011-10-20" time_created="09:47:42">
<CustSoldTo cst_company="7" cst_cust_nbr="139" cst_action_type="A" cst_action_result="Success" cst_fname="HELEN" cst_lname="SMITH" cst_street_name="10 SULLIVAN STREET" cst_addr_line_2="LINE 2" cst_city="WESTBOROUGH" cst_state="MA" cst_zip="01581" cst_country="USA" cst_match_code="HELSMI10S015" cst_ghost="N" />
</Message>
Customer Message: Duplicate Add Request
A sample CWCustomerIn Add request where the system finds a duplicate customer is presented below. The cst_duplicate tag defines how the system performs duplicate checking; see Duplicate Checking for Add Requests for more information.
CWCustomerIn: See Inbound Customer Message (CWCustomerIn) for message details.
<Message source="CWIntegrate" target="CUST35" type="CWCustomerIn" resp_qmgr="QM_CWINTEGRATE_QA4">
<CustSoldTo cst_company="007" cst_action_type="K" cst_send_response="Y" cst_duplicate="S" cst_cust_nbr="" cst_salesman_nbr="" cst_interface_cust_nbr="" cst_language="ENG" cst_job_title="" cst_relate_id="" cst_prefix="" cst_fname="Hellen" cst_minitial="" cst_lname="Smith" cst_suffix="" cst_company_name="" cst_street_addr="10 Walnut St" cst_addr_line_2="" cst_addr_line_3="" cst_addr_line_4="" cst_apt="" cst_city="Westborough" cst_state="MA" cst_zip="01581" cst_country="USA" cst_day_phone="(508)555-0100" cst_day_ext="1234" cst_eve_phone="(508)555-0102" cst_eve_ext="5678" cst_fax_phone="5085550103" cst_fax_ext="9012" cst_mail_name="" cst_rent_name="" cst_seed_name="" cst_rent_email="" cst_original_source="" cst_current_source="" cst_hold_bypass_fraud="" cst_orig_mail_type="S" cst_curr_mail_type="B" cst_tax_exempt="" cst_exempt_certificate="" cst_exempt_expiry="" cst_associate="" cst_cancel_bo="K" cst_commercial="N" cst_cust_type="" cst_discount_pct="" cst_entry_date="10112009" cst_inactive="N" cst_bypass_reservation="N" cst_pop_window_1="POP1" cst_pop_window_2="POP2" cst_pop_window_3="" cst_pop_window_4="" cst_price_column="" cst_item_hist_tracking="2" cst_vat_nbr="" cst_do_not_fax="N" cst_deliverable="" cst_delivery_type="" cst_email_status="O1" cst_account_nbr="" cst_cust_class="" cst_cust_company="" cst_mail_code="" cst_call_code="" cst_change_user="" cst_create_user="" cst_currency="USD" cust_po_box="" cst_warehouse="2" cst_user_field_1="USER1" cst_user_field_2="USER2" cst_user_field_3="USER3" cst_user_field_4="USER4" cst_reserve_warehouse="11" cst_van_route="" cst_van_route_seq="" cst_price_group="">
<CustEmails>
<CustEmail cst_email_seq="1" cst_email_address="kbottger@example.com" cst_email_primary="Y" cst_email_status="O1" cst_email_format="" cst_display_name="1HSmith" />
<CustEmail cst_email_seq="2" cst_email_address="ssullivan@example.com" cst_email_primary="N" cst_email_status="O2" cst_email_format="" cst_display_name="2HSmith" />
</CustEmails>
<CustUserDefinedFields>
<CustUserDefinedField cst_udf_seq="" cst_udf_text="" cst_udf_nbr="" cst_udf_date="" />
</CustUserDefinedFields>
<CustProfiles>
<CustProfile cst_profile_code="" cst_profile_value="" />
</CustProfiles>
</CustSoldTo>
</Message>
CWCustomerOut: See Outbound Customer Response Message (CWCustomerOut) for message details.
<Message source="CWSerenade" target="CUST35" type="CWCustomerOut" date_created="2011-10-20" time_created="10:04:46">
<CustSoldTo cst_company="7" cst_cust_nbr="141" cst_action_type="DUP" cst_action_result="Duplicate" cst_fname="HELLEN" cst_lname="SMITH" cst_street_name="10 SULLIVAN ST" cst_city="WESTBOROUGH" cst_state="MA" cst_zip="01581" cst_country="USA" cst_match_code="HELSMI10S015" cst_ghost="N">
<Duplicates>
<Duplicate dup_cust_nbr="140" dup_fname="HELEN" dup_lname="SMITH" dup_street_name="10 SULLIVAN ST" dup_city="WESTBOROUGH" dup_state="MA" dup_zip="01581" dup_country="USA" dup_match_code="HELSMI10S015" dup_ghost="N" />
</Duplicates>
</CustSoldTo>
</Message>
Customer Message: Failure Add Request
A sample CWCustomerIn Add request that is placed in error in Working with Customer API (WCAI) is presented below. See Adding a Customer using the Customer API for more information.
CWCustomerIn: See Inbound Customer Message (CWCustomerIn) for message details.
<Message source="CWIntegrate" target="CUST35" type="CWCustomerIn" resp_qmgr="QM_CWINTEGRATE_QA4">
<CustSoldTo cst_company="007" cst_action_type="" cst_send_response="Y" cst_duplicate="S" cst_cust_nbr="" cst_salesman_nbr="" cst_interface_cust_nbr="" cst_language="ENG" cst_job_title="" cst_relate_id="" cst_prefix="" cst_fname="Helen" cst_minitial="R" cst_lname="Smith" cst_suffix="" cst_company_name="" cst_street_addr="10 Rose Street" cst_addr_line_2="" cst_addr_line_3="" cst_addr_line_4="" cst_apt="" cst_city="Westboro" cst_state="MASS" cst_zip="01581" cst_country="US" cst_day_phone="(508)555-0100" cst_day_ext="1234" cst_eve_phone="(508)555-0101" cst_eve_ext="5678" cst_fax_phone="5085550102" cst_fax_ext="9012" cst_mail_name="" cst_rent_name="" cst_seed_name="" cst_rent_email="" cst_original_source="" cst_current_source="" cst_hold_bypass_fraud="" cst_orig_mail_type="S" cst_curr_mail_type="B" cst_tax_exempt="" cst_exempt_certificate="" cst_exempt_expiry="" cst_associate="" cst_cancel_bo="K" cst_commercial="N" cst_cust_type="" cst_discount_pct="" cst_entry_date="" cst_inactive="N" cst_bypass_reservation="N" cst_pop_window_1="POP1" cst_pop_window_2="POP2" cst_pop_window_3="" cst_pop_window_4="" cst_price_column="" cst_item_hist_tracking="2" cst_vat_nbr="" cst_do_not_fax="N" cst_deliverable="" cst_delivery_type="" cst_email_status="O1" cst_account_nbr="" cst_cust_class="" cst_cust_company="" cst_mail_code="" cst_call_code="" cst_change_user="" cst_create_user="" cst_currency="USD" cust_po_box="" cst_warehouse="2" cst_user_field_1="USER1" cst_user_field_2="USER2" cst_user_field_3="USER3" cst_user_field_4="USER4" cst_reserve_warehouse="11" cst_van_route="" cst_van_route_seq="" cst_price_group="">
<CustEmails>
<CustEmail cst_email_seq="1" cst_email_address="kbottger@example.com" cst_email_primary="Y" cst_email_status="O1" cst_email_format="" cst_display_name="1H Smith" />
<CustEmail cst_email_seq="2" cst_email_address="aluna@example.com" cst_email_primary="N" cst_email_status="O2" cst_email_format="" cst_display_name="2H Smith" />
</CustEmails>
<CustUserDefinedFields>
<CustUserDefinedField cst_udf_seq="1" cst_udf_text="date" cst_udf_nbr="101112" cst_udf_date="101112" />
</CustUserDefinedFields>
<CustProfiles>
<CustProfile cst_profile_code="" cst_profile_value="" />
</CustProfiles>
</CustSoldTo>
</Message>
CWCustomerOut: See Outbound Customer Response Message (CWCustomerOut) for message details.
<Message source="CWSerenade" target="CUST35" type="CWCustomerOut" date_created="2011-10-20" time_created="10:12:43">
<CustSoldTo cst_company="7" cst_action_type="A" cst_action_result="Failure" />
</Message>
Customer Message: Successful Change Request
A sample CWCustomerIn Change request that successfully updates a customer is presented below. See Changing a Customer using the Customer API for more information.
CWCustomerIn: See Inbound Customer Message (CWCustomerIn) for message details.
<Message source="CWIntegrate" target="CUST35" type="CWCustomerIn" resp_qmgr="QM_CWINTEGRATE_QA4">
<CustSoldTo cst_company="007" cst_action_type="" cst_send_response="Y" cst_duplicate="S" cst_cust_nbr="111" cst_salesman_nbr="" cst_interface_cust_nbr="" cst_language="ENG" cst_job_title="" cst_relate_id="" cst_prefix="" cst_fname="James" cst_minitial="R" cst_lname="Jones" cst_suffix="" cst_company_name="" cst_street_addr="10 River St" cst_addr_line_2="" cst_addr_line_3="" cst_addr_line_4="" cst_apt="" cst_city="Templeton" cst_state="MA" cst_zip="01581" cst_country="USA" cst_day_phone="(508)555-0100" cst_day_ext="1234" cst_eve_phone="(508)555-0101" cst_eve_ext="5678" cst_fax_phone="5085550102" cst_fax_ext="9012" cst_mail_name="" cst_rent_name="" cst_seed_name="" cst_rent_email="" cst_original_source="" cst_current_source="" cst_hold_bypass_fraud="" cst_orig_mail_type="S" cst_curr_mail_type="B" cst_tax_exempt="" cst_exempt_certificate="" cst_exempt_expiry="" cst_associate="" cst_cancel_bo="K" cst_commercial="N" cst_cust_type="" cst_discount_pct="" cst_entry_date="" cst_inactive="N" cst_bypass_reservation="N" cst_pop_window_1="POP1" cst_pop_window_2="POP2" cst_pop_window_3="" cst_pop_window_4="" cst_price_column="" cst_item_hist_tracking="2" cst_vat_nbr="" cst_do_not_fax="N" cst_deliverable="" cst_delivery_type="" cst_email_status="O1" cst_account_nbr="" cst_cust_class="" cst_cust_company="" cst_mail_code="" cst_call_code="" cst_change_user="" cst_create_user="" cst_currency="USD" cust_po_box="" cst_warehouse="2" cst_user_field_1="USER1" cst_user_field_2="USER2" cst_user_field_3="USER3" cst_user_field_4="USER4" cst_reserve_warehouse="11" cst_van_route="" cst_van_route_seq="" cst_price_group="">
<CustEmails>
<CustEmail cst_email_seq="1" cst_email_address="jamesJ@example.com" cst_email_primary="Y" cst_email_status="O1" cst_email_format="" cst_display_name="1J Jones" />
<CustEmail cst_email_seq="2" cst_email_address="jjones@example.com" cst_email_primary="N" cst_email_status="O2" cst_email_format="" cst_display_name="2J Jones" />
</CustEmails>
<CustUserDefinedFields>
<CustUserDefinedField cst_udf_seq="1" cst_udf_text="date" cst_udf_nbr="101112" cst_udf_date="101112" />
</CustUserDefinedFields>
<CustProfiles>
<CustProfile cst_profile_code="" cst_profile_value="" />
</CustProfiles>
</CustSoldTo>
</Message>
CWCustomerOut: See Outbound Customer Response Message (CWCustomerOut) for message details.
<Message source="CWSerenade" target="CUST35" type="CWCustomerOut" date_created="2011-10-20" time_created="10:25:29">
<CustSoldTo cst_company="7" cst_cust_nbr="111" cst_action_type="C" cst_action_result="Success" cst_prefix="MR." cst_fname="JAMES" cst_minitial="R" cst_lname="JONES cst_street_name="10 RIVER ST" cst_city="TEMPLETON" cst_state="MA" cst_zip="01581" cst_country="USA" cst_match_code="JAMCRO10D015" cst_ghost="N" />
</Message>
Customer Message: Failure Change Request
A sample CWCustomerIn Change request that is placed in error in Working with Customer API (WCAI) is presented below. See Changing a Customer using the Customer API for more information.
CWCustomerIn: See Inbound Customer Message (CWCustomerIn) for message details.
<Message source="CWIntegrate" target="CUST35" type="CWCustomerIn" resp_qmgr="QM_CWINTEGRATE_QA4">
<CustSoldTo cst_company="007" cst_action_type="" cst_send_response="Y" cst_duplicate="S" cst_cust_nbr="111" cst_salesman_nbr="" cst_interface_cust_nbr="" cst_language="ENG" cst_job_title="" cst_relate_id="" cst_prefix="" cst_fname="James" cst_minitial="R" cst_lname="Jones" cst_suffix="" cst_company_name="" cst_street_addr="10 River St" cst_addr_line_2="" cst_addr_line_3="" cst_addr_line_4="" cst_apt="" cst_city="Templeton" cst_state="MA" cst_zip="01581" cst_country="US" cst_day_phone="(508)555-0100" cst_day_ext="1234" cst_eve_phone="(508)555-0101" cst_eve_ext="5678" cst_fax_phone="5085550102" cst_fax_ext="9012" cst_mail_name="" cst_rent_name="" cst_seed_name="" cst_rent_email="" cst_original_source="" cst_current_source="" cst_hold_bypass_fraud="" cst_orig_mail_type="S" cst_curr_mail_type="B" cst_tax_exempt="" cst_exempt_certificate="" cst_exempt_expiry="" cst_associate="" cst_cancel_bo="K" cst_commercial="N" cst_cust_type="" cst_discount_pct="" cst_entry_date="" cst_inactive="N" cst_bypass_reservation="N" cst_pop_window_1="POP1" cst_pop_window_2="POP2" cst_pop_window_3="" cst_pop_window_4="" cst_price_column="" cst_item_hist_tracking="2" cst_vat_nbr="" cst_do_not_fax="N" cst_deliverable="" cst_delivery_type="" cst_email_status="O1" cst_account_nbr="" cst_cust_class="" cst_cust_company="" cst_mail_code="" cst_call_code="" cst_change_user="" cst_create_user="" cst_currency="USD" cust_po_box="" cst_warehouse="2" cst_user_field_1="USER1" cst_user_field_2="USER2" cst_user_field_3="USER3" cst_user_field_4="USER4" cst_reserve_warehouse="11" cst_van_route="" cst_van_route_seq="" cst_price_group="">
<CustEmails>
<CustEmail cst_email_seq="1" cst_email_address="jjones@example.com" cst_email_primary="Y" cst_email_status="O1" cst_email_format="" cst_display_name="1J Jones" />
<CustEmail cst_email_seq="2" cst_email_address="jamesj@example.com" cst_email_primary="N" cst_email_status="O2" cst_email_format="" cst_display_name="2J Jones" />
</CustEmails>
<CustUserDefinedFields>
<CustUserDefinedField cst_udf_seq="1" cst_udf_text="date" cst_udf_nbr="101112" cst_udf_date="101112" />
</CustUserDefinedFields>
<CustProfiles>
<CustProfile cst_profile_code="" cst_profile_value="" />
</CustProfiles>
</CustSoldTo>
</Message>
CWCustomerOut: See Outbound Customer Response Message (CWCustomerOut) for message details.
<Message source="CWSerenade" target="CUST35" type="CWCustomerOut" date_created="2011-10-20" time_created="10:35:50">
<CustSoldTo cst_company="7" cst_cust_nbr="111" cst_action_type="C" cst_action_result="Failure" />
</Message>
Customer Message: Failure Delete Request
A sample CWCustomerIn Delete request that is placed in error in Working with Customer API (WCAI) is presented below.
Note: If the cst_action_type in an Inbound Customer Message (CWCustomerIn) is D, the system places the message in error in Working with Customer API (WCAI) with the error reason Invalid Type. You cannot delete a customer through the Generic Customer API.
CWCustomerIn: See Inbound Customer Message (CWCustomerIn) for message details.
<Message source="CWIntegrate" target="CUST35" type="CWCustomerIn" resp_qmgr="QM_CWINTEGRATE_QA4">
<CustSoldTo cst_company="007" cst_action_type="D" cst_send_response="Y" cst_duplicate="S" cst_cust_nbr="111" cst_salesman_nbr="" cst_interface_cust_nbr="" cst_language="ENG" cst_job_title="" cst_relate_id="" cst_prefix="" cst_fname="James" cst_minitial="R" cst_lname="Jones" cst_suffix="" cst_company_name="" cst_street_addr="10 River St" cst_addr_line_2="" cst_addr_line_3="" cst_addr_line_4="" cst_apt="" cst_city="Templeton" cst_state="MA" cst_zip="01581" cst_country="USA" cst_day_phone="(508)555-0100" cst_day_ext="1234" cst_eve_phone="(508)555-0101" cst_eve_ext="5678" cst_fax_phone="5085550102" cst_fax_ext="9012" cst_mail_name="" cst_rent_name="" cst_seed_name="" cst_rent_email="" cst_original_source="" cst_current_source="" cst_hold_bypass_fraud="" cst_orig_mail_type="S" cst_curr_mail_type="B" cst_tax_exempt="" cst_exempt_certificate="" cst_exempt_expiry="" cst_associate="" cst_cancel_bo="K" cst_commercial="N" cst_cust_type="" cst_discount_pct="" cst_entry_date="" cst_inactive="N" cst_bypass_reservation="N" cst_pop_window_1="POP1" cst_pop_window_2="POP2" cst_pop_window_3="" cst_pop_window_4="" cst_price_column="" cst_item_hist_tracking="2" cst_vat_nbr="" cst_do_not_fax="N" cst_deliverable="" cst_delivery_type="" cst_email_status="O1" cst_account_nbr="" cst_cust_class="" cst_cust_company="" cst_mail_code="" cst_call_code="" cst_change_user="" cst_create_user="" cst_currency="USD" cust_po_box="" cst_warehouse="2" cst_user_field_1="USER1" cst_user_field_2="USER2" cst_user_field_3="USER3" cst_user_field_4="USER4" cst_reserve_warehouse="11" cst_van_route="" cst_van_route_seq="" cst_price_group="">
<CustEmails>
<CustEmail cst_email_seq="1" cst_email_address="jjones@example.com" cst_email_primary="Y" cst_email_status="O1" cst_email_format="" cst_display_name="1J Jones" />
<CustEmail cst_email_seq="2" cst_email_address="jamesj@example.com" cst_email_primary="N" cst_email_status="O2" cst_email_format="" cst_display_name="2J Jones" />
</CustEmails>
<CustUserDefinedFields>
<CustUserDefinedField cst_udf_seq="1" cst_udf_text="date" cst_udf_nbr="101112" cst_udf_date="101112" />
</CustUserDefinedFields>
<CustProfiles>
<CustProfile cst_profile_code="" cst_profile_value="" />
</CustProfiles>
</CustSoldTo>
</Message>
CWCustomerOut: See Outbound Customer Response Message (CWCustomerOut) for message details.
<Message source="CWSerenade" target="CUST35" type="CWCustomerOut" date_created="2011-10-20" time_created="10:41:34">
<CustSoldTo cst_company="7" cst_cust_nbr="111" cst_action_type="D" cst_action_result="Failure" />
</Message>
