customer

This topic applies to

Applies to

SuiteCommerce Web Stores

This object contains information about the logged in customer.

Field Name

Field Type

Description

In Get Functions?

In Set Functions?

addressbook

List of JSON address objects

Address information

yes

no

balance

string

Customer's accounts receivable balance due, shown in customer's currency.

yes

no

campaignsubscriptions

List of JSON subscription objects

Information on campaign subscriptions for the given customer.

yes

yes

companyname

string

Customer company name

yes
(for Checkout and Shopping domains)

yes

(for Checkout domain only)

creditcards

List of JSON creditcard objects

Credit card information

yes

no

creditholdoverride

string

Customer's credit hold status.

yes

no

creditlimit

string

Maximum currency amount the customer is allowed to accrue in outstanding receivables.

yes

no

email

string

Customer email address

Required in Set function for customer registration, guest registration, and login.

no

yes

emailsubscribe

string

Email subscription

Value should be T or F.

yes

yes

firstname

string

Customer first name

yes

yes

internalid

string

Internal ID

yes

no

isperson

boolean

If false this customer is of customer type. If true this customer is of the type individual.

yes

no

lastname

string

Customer last name

yes

yes

middlename

string

Customer middle name

yes

yes

name

string

Customer name

Important

As of Version 2013 Release 1, this field is deprecated and included for backwards compatibility only. The firstname, lastname, and middlename fields are the preferred fields for getting and setting customer names.


yes

yes

partner

string

Partner

yes

yes

password

string

Password

Required in Set function for customer registration and login.

no

yes

password hint

string

Hint

no

yes

paymentterms

JSON object of fields

Payment terms associated with the customer

yes

no

phoneinfo

JSONobject of fields

Returns or sets the phone number information for a customer.
For example: {"phone":"65460780", "fax" : "40540", "altphone" : null}

yes

yes