CustomerProfile

This object represents a customer profile.

Field

Type

Description

address1

string

Address line 1

address2

string

Address line 2

allow3rdPartyBilling

boolean

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

allowCod

boolean

True if the customer is allowed to use a COD

allowPurchaseOrder

boolean

True if the customer is allowed to use a purchase order

autoApproveCod

boolean

True if the COD will automatically be approved

autoApprovePurchaseOrder

boolean

True if the 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.

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.

minimumSubtotal

number

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

noCoupons

boolean

True if the customer is not allowed to use coupons

noFreeShipping

boolean

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

noRealtimeCharge

boolean

True if the customer credit 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

shippingAddresses

CustomerProfileAddress [ ]

Addresses in this customer's shipping address book

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