WEBCentralizedShoppingCartGet

Initial Build

2008.01

xWEB

Web Method

Response Type

object

This method returns a new shopping cart object (CentralizedOrderEntryType) for the specified customer. Many of the other eCommerce web methods require passing this Object as a parameter, and the method will the updated Cart back to you.

Therefore, any new shopping experiences will generally begin by calling this method.

Parameters

Name Type Occurs Description
CustomerKey guid 1..1 The Customer Key of the customer who will be making the purchase.

Response

CentralizedOrderEntryType

A new Shopping Cart Object will be returned with the customer's information and default values populated.

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>b5d786b7-ff47-42ba-bebe-bcb8e1479cee
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBCentralizedShoppingCartGet>
<ns:CustomerKey>6bf9cb1f-d761-403b-8106-a341c4363b49</ns:CustomerKey>
</ns:WEBCentralizedShoppingCartGet>
</soapenv:Body>
</soapenv:Envelope>

Sample Response

This method returns a Shopping Cart Object.

JSON Method

Creates a new cart for the customer.

Identical functionality to WEBCentralizedShoppingCartGetNew.

 

GET /JSON/WEBCentralizedShoppingCartGet?CustomerKey=ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1

POST /xweb/JSON/WEBCentralizedShoppingCartGet

Copy
DATA - JSON
{
    "WEBCentralizedShoppingCartGet": {
        "CustomerKey": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1"
    }
}

 

Copy
SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
{
    "CentralizedOrderEntryType": {
        "Invoice": {
            "inv_key": "fa24d6a7-2c0c-4e92-8afd-5be283bc3b57",
            "inv_cst_key": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
            "inv_print_count": "0",
            "inv_ship_priority": "3",
            "inv_orig_trans_type": "prepaid",
            "inv_cxa_key": "3fffea6a-7c1c-4ea2-bb0c-6b8d74e4dc06",
            "inv_eml_key": "089afd74-3495-4fce-94a0-72188210299a",
            "inv_cst_billing_key": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
            "inv_AutoRefund": "0",
            "inv_eweb_credit_available": "0.00",
            "inv_eweb_apply_credit_amount": "0.00",
            "inv_first_installment_amount": "0.00",
            "inv_cst_first_last_name": "JasonTest1 D WattsTest1",
            "inv_total": "0.00",
            "inv_amount": "0.00",
            "inv_balance": "0.00",
            "inv_Donation_in_cart": "0",
            "inv_payment_to_apply_distributed": "0.00",
            "inv_batch_total": "$0.00",
            "inv_batch_total_diff": "$0.00",
            "inv_close_opportunity": "0",
            "inv_credit_to_apply_distributed": "0.00",
            "inv_batch_count": "0",
            "inv_batch_count_diff": "0",
            "inv_distributable_credit_total": "0.00",
            "inv_bat_control_total_display": "0.00",
            "inv_distributable_credit_balance": "0.00",
            "inv_invoice_to_pay_count": "0",
            "inv_paid_by_liability_balance": "0.00",
            "inv_payment_detail_count": "0",
            "inv_payment_to_apply": "0.00",
            "inv_nettotal": "0.00",
            "inv_netpayment": "0.00",
            "inv_credit_to_apply": "0.00",
            "inv_netbalance": "0.00",
            "inv_netcredit": "0.00",
            "inv_net_amount_due": "0.00",
            "inv_netunpaidbalance": "0.00",
            "inv_netwriteoff": "0.00",
            "inv_writeoff_to_apply": "0.00",
            "inv_netreturn": "0.00",
            "inv_return_to_apply": "0.00",
            "inv_netapplied": "0.00",
            "inv_previous_netapplied": "0.00",
            "inv_previous_netpayment": "0.00",
            "inv_total_to_apply": "0.00",
            "inv_allow_recurring": "1",
            "inv_allow_payment_with_frozen_payment_method": "0",
            "inv_select_all": "0",
            "inv_autoapply": "1",
            "inv_autoapplypayment": "1",
            "inv_installment_flag": "0",
            "inv_coe_flag": "0",
            "inv_shippable_total": "0.00",
            "inv_unapplied_shipping_total": "0.00",
            "inv_shippable_items_flag": "0",
            "inv_autoapplycredit": "0",
            "inv_invoice_detail_count": "0",
            "inv_bill_me": "0",
            "inv_HasNewLineItems": "0",
            "inv_HasOldLineItems": "0",
            "inv_total_weight": "0.00",
            "inv_discount": "0.00",
            "inv_shipping": "0.00",
            "inv_tax": "0.00",
            "inv_prd_keys": "NULL",
            "inv_Show_Popup": "0",
            "inv_convert_to_installmentpayments": "0",
            "inv_allow_installment": "0"
        },
        "Invoice_Detail": {
            "ivd_parity": "1",
            "ivd_cxa_key": "3fffea6a-7c1c-4ea2-bb0c-6b8d74e4dc06",
            "ivd_type": "Product"
        },
        "Invoice_Detail_Term": null,
        "Claim": {
            "cld_claim_status": "Approved"
        },
        "Default_Shipping_Address": {
            "cxs__cxa_cst_key": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
            "cxs__cxa_adr_key": "c95a666a-bee2-4dbf-82a2-3ddee254af4d",
            "cxs__cxa_add_date": "2020-03-27T00:06:00-05:00",
            "cxs__cxa_add_user": "jwatts",
            "cxs__cxa_change_date": "2020-03-29T22:37:00-05:00",
            "cxs__cxa_change_user": "jwatts",
            "cxs__cxa_delete_flag": "0",
            "cxs__cxa_key": "3fffea6a-7c1c-4ea2-bb0c-6b8d74e4dc06",
            "cxs__cxa_key_ext": "3fffea6a-7c1c-4ea2-bb0c-6b8d74e4dc06",
            "cxs__cxa_on_hold_flag": "0",
            "cxs__cxa_adt_key": "e09fc2cf-5f86-46cd-9c31-f215018ba99f",
            "cxs__cxa_mailing_label": "Mr. JasonTest1 D WattsTest1 Mr. JasonTest1 WattsTest1 125 Main St. Houston, TX 77433",
            "cxs__cxa_mailing_label_html": "Mr. JasonTest1 D WattsTest1<br>Mr. JasonTest1 WattsTest1<br>125 Main St.<br>Houston, TX 77433"
        },
        "Payment": {
            "pay_cst_key": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1"
        },
        "Payment_Info": {
            "pin_cst_key": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
            "pin_street": "125 Main St.",
            "pin_city": "Houston",
            "pin_state": "TX",
            "pin_zip": "77433",
            "pin_email": "jwatts1980+Test1@gmail.com",
            "pin_cty_iso_number": "840",
            "pin_hosted_page_available": "0",
            "pin_mobile_app_available": "0",
            "pin_hosted_payment": "0",
            "pin_isvault": "0",
            "pin_tax_amt": "0.00",
            "pin_billing_info_required_for_ach_flag": "0",
            "pin_allow_online_payment_flag": "0",
            "pin_preferred_flag": "0"
        },
        "Payment_Method": null,
        "Customer": {
            "cst_key": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
            "cst_type": "Individual",
            "cst_name_cp": "Mr. JasonTest1 D WattsTest1",
            "cst_sort_name_dn": "WattsTest1 JasonTest1 D",
            "cst_ind_full_name_dn": "Mr. JasonTest1 D WattsTest1",
            "cst_ixo_title_dn": "Mr. JasonTest1 WattsTest1",
            "cst_add_date": "2020-03-27T00:06:00-05:00",
            "cst_add_user": "jwatts",
            "cst_change_date": "2020-03-29T22:37:00-05:00",
            "cst_change_user": "jwatts",
            "cst_delete_flag": "0",
            "cst_recno": "240656",
            "cst_id": "000240656I",
            "cst_key_ext": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
            "cst_email_text_only": "0",
            "cst_tax_exempt_flag": "0",
            "cst_cxa_key": "3fffea6a-7c1c-4ea2-bb0c-6b8d74e4dc06",
            "cst_no_email_flag": "0",
            "cst_eml_address_dn": "jwatts1980+Test1@gmail.com",
            "cst_eml_key": "089afd74-3495-4fce-94a0-72188210299a",
            "cst_no_phone_flag": "0",
            "cst_no_fax_flag": "0",
            "cst_no_web_flag": "0",
            "cst_member_flag": "0",
            "cst_no_msg_flag": "0",
            "cst_web_password": "38ykB5HAqV/4arY2uJE7UbViRTA8qHhF",
            "cst_no_mail_flag": "0",
            "cst_web_force_password_change": "0",
            "cst_web_login_disabled_flag": "0",
            "cst_credit_hold_flag": "0",
            "cst_web_forgot_password_status": "0",
            "cst_no_publish_flag": "0",
            "cst_salutation_1": "Mr.. JasonTest1 D WattsTest1 ",
            "cst_salutation_2": "",
            "cst_default_recognize_as": "Mr.. JasonTest1 D WattsTest1 ",
            "cst_exclude_from_social_flag": "0",
            "cst_salt": "vp76fl6vim1pvBY9v5FOn9bOt1rdmzu1",
            "cst_iterations": "5000",
            "cst_web_password_change_date": "2020-03-28T18:21:00-05:00",
            "cst_web_login_locked_flag": "0",
            "cst_credit_available": "0.00"
        },
        "CustomerIndividual": {
            "ind_cst_key": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
            "ind_prf_code": "Mr.",
            "ind_first_name": "JasonTest1",
            "ind_mid_name": "D",
            "ind_last_name": "WattsTest1",
            "ind_full_name_cp": "Mr. JasonTest1 D WattsTest1",
            "ind_salutation_cp": "Mr. WattsTest1",
            "ind_cst_key_ext": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
            "ind_badge_name": "Mr. JasonTest1 WattsTest1",
            "ind_deceased_flag": "0",
            "ind_add_date": "2020-03-27T00:06:00-05:00",
            "ind_add_user": "jwatts",
            "ind_delete_flag": "0",
            "ind_position_classification_ext": "Other",
            "ind_department_ext": "IT"
        },
        "Billing_Address": {
            "cxa_cst_key": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
            "cxa_adr_key": "c95a666a-bee2-4dbf-82a2-3ddee254af4d",
            "cxa_add_date": "2020-03-27T00:06:00-05:00",
            "cxa_add_user": "jwatts",
            "cxa_change_date": "2020-03-29T22:37:00-05:00",
            "cxa_change_user": "jwatts",
            "cxa_delete_flag": "0",
            "cxa_key": "3fffea6a-7c1c-4ea2-bb0c-6b8d74e4dc06",
            "cxa_key_ext": "3fffea6a-7c1c-4ea2-bb0c-6b8d74e4dc06",
            "cxa_on_hold_flag": "0",
            "cxa_adt_key": "e09fc2cf-5f86-46cd-9c31-f215018ba99f",
            "cxa_mailing_label": "Mr. JasonTest1 D WattsTest1 Mr. JasonTest1 WattsTest1 125 Main St. Houston, TX 77433",
            "cxa_mailing_label_html": "Mr. JasonTest1 D WattsTest1<br>Mr. JasonTest1 WattsTest1<br>125 Main St.<br>Houston, TX 77433"
        },
        "Billing_Adr": {
            "adr_key": "c95a666a-bee2-4dbf-82a2-3ddee254af4d",
            "adr_cst_key_owner": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
            "adr_line1": "125 Main St.",
            "adr_city": "Houston",
            "adr_state": "TX",
            "adr_post_code": "77433",
            "adr_city_state_code": "Houston, TX 77433",
            "adr_country": "UNITED STATES",
            "adr_add_date": "2020-03-27T00:06:27-05:00",
            "adr_add_user": "jwatts",
            "adr_change_date": "2020-03-29T22:36:31-05:00",
            "adr_change_user": "jwatts",
            "adr_delete_flag": "0",
            "adr_key_ext": "c95a666a-bee2-4dbf-82a2-3ddee254af4d",
            "adr_bad_address_flag": "0",
            "adr_no_validation_flag": "0"
        },
        "Price": {
            "prc_price": "0.00",
            "prc_deferred_flag": "0",
            "prc_renew_unpaid_orders_flag": "1",
            "prc_allow_unpaid_orders_flag": "1"
        },
        "Batch": {
            "bat_control_total": "0.00",
            "bat_control_trx_count": "0",
            "bat_post_flag": "0",
            "bat_export_flag": "0",
            "bat_atc_key": "7697205e-876a-436a-ae35-9ba3abf05a22",
            "bat_make_default_flag": "0"
        },
        "BillToCustomer": {
            "bcs__cst_key": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
            "bcs__cst_type": "Individual",
            "bcs__cst_name_cp": "Mr. JasonTest1 D WattsTest1",
            "bcs__cst_sort_name_dn": "WattsTest1 JasonTest1 D",
            "bcs__cst_ind_full_name_dn": "Mr. JasonTest1 D WattsTest1",
            "bcs__cst_ixo_title_dn": "Mr. JasonTest1 WattsTest1",
            "bcs__cst_add_date": "2020-03-27T00:06:00-05:00",
            "bcs__cst_add_user": "jwatts",
            "bcs__cst_change_date": "2020-03-29T22:37:00-05:00",
            "bcs__cst_change_user": "jwatts",
            "bcs__cst_delete_flag": "0",
            "bcs__cst_recno": "240656",
            "bcs__cst_id": "000240656I",
            "bcs__cst_key_ext": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
            "bcs__cst_email_text_only": "0",
            "bcs__cst_tax_exempt_flag": "0",
            "bcs__cst_cxa_key": "3fffea6a-7c1c-4ea2-bb0c-6b8d74e4dc06",
            "bcs__cst_no_email_flag": "0",
            "bcs__cst_eml_address_dn": "jwatts1980+Test1@gmail.com",
            "bcs__cst_eml_key": "089afd74-3495-4fce-94a0-72188210299a",
            "bcs__cst_no_phone_flag": "0",
            "bcs__cst_no_fax_flag": "0",
            "bcs__cst_no_web_flag": "0",
            "bcs__cst_member_flag": "0",
            "bcs__cst_no_msg_flag": "0",
            "bcs__cst_web_password": "38ykB5HAqV/4arY2uJE7UbViRTA8qHhF",
            "bcs__cst_no_mail_flag": "0",
            "bcs__cst_web_force_password_change": "0",
            "bcs__cst_web_login_disabled_flag": "0",
            "bcs__cst_credit_hold_flag": "0",
            "bcs__cst_web_forgot_password_status": "0",
            "bcs__cst_no_publish_flag": "0",
            "bcs__cst_salutation_1": "Mr.. JasonTest1 D WattsTest1 ",
            "bcs__cst_salutation_2": "",
            "bcs__cst_default_recognize_as": "Mr.. JasonTest1 D WattsTest1 ",
            "bcs__cst_exclude_from_social_flag": "0",
            "bcs__cst_salt": "vp76fl6vim1pvBY9v5FOn9bOt1rdmzu1",
            "bcs__cst_iterations": "5000",
            "bcs__cst_web_password_change_date": "2020-03-28T18:21:00-05:00",
            "bcs__cst_web_login_locked_flag": "0"
        },
        "BillToCustomerIndividual": {
            "bin__ind_cst_key": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
            "bin__ind_prf_code": "Mr.",
            "bin__ind_first_name": "JasonTest1",
            "bin__ind_mid_name": "D",
            "bin__ind_last_name": "WattsTest1",
            "bin__ind_full_name_cp": "Mr. JasonTest1 D WattsTest1",
            "bin__ind_salutation_cp": "Mr. WattsTest1",
            "bin__ind_cst_key_ext": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
            "bin__ind_badge_name": "Mr. JasonTest1 WattsTest1",
            "bin__ind_deceased_flag": "0",
            "bin__ind_add_date": "2020-03-27T00:06:00-05:00",
            "bin__ind_add_user": "jwatts",
            "bin__ind_delete_flag": "0",
            "bin__ind_position_classification_ext": "Other",
            "bin__ind_department_ext": "IT"
        },
        "Billing_Contact": null,
        "InstallmentBilling": {
            "ord_proforma": "0"
        },
        "Company-Business_Unit": {
            "atc_code": "ACC",
            "atc_name": "National Institute of Governmental Purchasing",
            "atc_asn_code": "ACC",
            "atc_add_user": "av_Bwoehrle",
            "atc_add_date": "2008-02-25T13:41:44-06:00",
            "atc_change_user": "user",
            "atc_change_date": "2017-03-20T10:20:19-05:00",
            "atc_delete_flag": "0",
            "atc_key": "7697205e-876a-436a-ae35-9ba3abf05a22",
            "atc_key_ext": "7697205e-876a-436a-ae35-9ba3abf05a22",
            "atc_gla_overpayment_key": "c6ce750a-c916-4f8a-9406-fdbcecc198a5",
            "atc_ait_key": "aa8965fb-42ef-494c-8d92-03b0571865bc",
            "atc_tax_id": "53-0196623"
        },
        "Credit_Available": {
            "caa_cst_key": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
            "caa_cst_credit_available": "0.00"
        },
        "source_code": null,
        "Sales_Opportunity": {
            "sfo_quantity": "1.0000",
            "sfo_amount": "0.00"
        },
        "currency": {
            "cur_separator": ",",
            "cur_calc_method": "multiply",
            "cur_fraction_separator": "."
        },
        "Invoice_DetailCollection": null,
        "Additional_Invoice_DetailCollection": null,
        "MembershipCollection": null,
        "RegistrantCollection": null,
        "Group_RegistrantionCollection": null,
        "GiftCollection": null,
        "InvoiceToPayCollection": null,
        "ExhibitorCollection": null,
        "Accreditation_ApplicantCollection": null
    }
}