customer
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 |
c |
List of JSON subscription objects |
Information about campaign subscriptions for the given customer. |
yes |
yes |
companyname |
string |
Customer company name |
|
yes (for Checkout domain only) |
cookieoptions |
boolean |
Returns a list of cookies for which the customer selected to opt in or out. These are returned only when the SuiteCommerce Analytics Data feature is enabled. For example: "cookieoptions": {"ANALYTICS": false, "PERFORMANCE": true} |
yes |
yes |
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 |
|
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 no longer used and is included for backward 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. These are returned only if the website sales order type is set to Per Customer Basis. |
yes |
no |
phoneinfo |
JSONobject of fields |
|
yes |
yes |