Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This object represents a customer profile.

boolean taxExempt

Field

Type

Description

integer customerProfileOid

The customer profile object id. This is provided to make debugging easier by UltraCart premium support.

String email

Email address associated with the customer profile

address1

string

Address line 1

address2

string

Address line 2

allow3rdPartyBilling

boolean

True if the customer is tax exemptallowed to bill the shipping to their 3rd party account number.

allowCod

boolean allowPurchaseOrder

True if the customer is allowed to use a purchase orderCOD

boolean autoApprovePurchaseOrder

True if the purchase order will automaticall be approved

boolean allowCodallowPurchaseOrder

boolean

True if the customer is allowed to use a CODpurchase order

autoApproveCod

boolean autoApproveCod

True if the COD will automatically be approved

autoApprovePurchaseOrder

boolean freeShipping

True if the customer receives free shipping

Number freeShippingMinimum

Amount required to qualify for free shipping. Value will be null if there is no threshold specified

String firstName

First name

String lastName

Last Name

String title

Title

String company

Company

String address1

Address line 1

String address2

Address line 2

String city

City

String postalCode

Postal Codew

String country

Country

String dayPhone

Day phone

String eveningPhone

Evening phone

String fax

Fax

String taxId

Tax ID

Number minimumSubtotal

Minimum subtotal the customer is required to purchase. Will be null if no threshold is specified

Integer minimumItemCount

purchase order will automaticall be approved

billingAddresses

CustomerProfileAddress [ ]

Addresses in this customer's billing address book

city

string

City

creditCardsCustomerProfileCreditCard [ ]

An array of credit cards belonging to the customer.

Warning

Only available in version 3+ (REST based) javascript checkout.

company

string

Company

country

string

Country

customerProfileOid

integer

The customer profile object id. This is provided to make debugging easier by UltraCart premium support.

dayPhone

string

Day phone

dhlAccountNumber

string

3rd party account number to bill the DHL shipping to

email

string

Email address associated with the customer profile

eveningPhone

string

Evening phone

exemptShippingHandlingCharge

boolean

True if the customer is exempt from shipping and handling charges

fax

string

Fax

fedexAccountNumber

string

3rd party account number to bill the FedEx shipping to

firstName

string

First name

freeShipping

boolean

True if the customer receives free shipping

freeShippingMinimum

number

Amount required to qualify for free shipping. Value will be null if there is no threshold specified

lastName

string

Last Name

minimumItemCount

integer

Minimum item count the customer is required to purchase. Wil be null if no threshold is specified.

boolean noRealtimeCharge

True if the customer credit card will not be charged real-time during the checkout process.

boolean exemptShippingHandlingChargeminimumSubtotal

number

Minimum subtotal the customer is required to purchase. Will be null if no threshold is specified

noCoupons

boolean

True if the customer is exempt from shipping and handling chargesnot allowed to use coupons

noFreeShipping

boolean noFreeShipping

True if the customer is prevented from standard retail customer free shipping

noRealtimeCharge

boolean allow3rdPartyBilling

True if the customer is allowed to bill the shipping to their 3rd party account number.

boolean noCoupons

True if the customer is not allowed to use coupons

String upsAccountNumber

3rd party account number to bill the UPS shipping to

String fedexAccountNumber

3rd party account number to bill the FedEx shipping to

String dhlAccountNumber

3rd party account number to bill the DHL shipping to

String[] pricingTierscredit card will not be charged real-time during the checkout process.

password

string

New password for the customer profile. Can only be set before a call to updateCustomerProfile.

postalCode

string

Postal Codew

pricingTiers

string [ ]

Array of all the pricing tiers this customer has been granted

CustomerProfileAddress [] billingAddresses

Addresses in this customer's billing address bookshippingAddresses

CustomerProfileAddress [ ] shippingAddresses

Addresses in this customer's shipping address book

CustomerProfileCreditCard [] creditCards

An array of credit cards belonging to the customer.

Warning

Only available in version 3+ (REST based) javascript checkout.

String password

New password for the customer profile. Can only be set before a call to updateCustomerProfile.

taxExempt

boolean

True if the customer is tax exempt

taxId

string

Tax ID

title

string

Title

upsAccountNumber

string

3rd party account number to bill the UPS shipping to