Customer document (Data API 23.2)
(supports custom properties)
Document representing a customer.
| Property | Type | Constraints | Description |
|---|---|---|---|
birthday |
LocalDate | The customer's birthday. | |
company_name |
String | maxLength=256 | The customer's company name. |
creation_date |
Date | Returns the value of attribute 'creationDate'. | |
credentials |
Credentials | The customer's credentials. | |
customer_id |
String | maxLength=28 | The customer's id. Both registered and guest customers have a customer id. |
customer_no |
String | maxLength=100 | The customer's number. |
email |
String | maxLength=256 | The customer's email address. |
fax |
String | maxLength=32 | The fax number to use for the customer. The length is restricted to 32 characters. |
first_name |
String | maxLength=256 | The customer's first name. |
gender |
Integer | The customer's gender. | |
global_party_id |
String | The Global Party ID is set by Customer 360 and identifies a person across multiple systems. | |
job_title |
String | maxLength=256 | The customer's job title. |
last_login_time |
Date | The last login time of the customer. | |
last_modified |
Date | Returns the value of attribute 'lastModified'. | |
last_name |
String | maxLength=256 | The customer's last name. |
last_visit_time |
Date | The last visit time of the customer. | |
phone_business |
String | maxLength=32 | The customer's business phone number. |
phone_home |
String | maxLength=32 | The customer's home phone number. |
phone_mobile |
String | maxLength=32 | The customer's mobile phone number. |
preferred_locale |
String | The customer's preferred locale, formatted with a hyphen. (For example: en-US) If the request uses an underscore, as with the Java locale format, the stored value is converted to a hyphen. (For example: en_US is stored as en-US) | |
previous_login_time |
Date | The time when the customer logged in previously. | |
previous_visit_time |
Date | The time when the customer previously visited the store. | |
primary_address |
CustomerAddress | The customers primary or default address. | |
salutation |
String | maxLength=256 | The customer's salutation. |
second_name |
String | maxLength=256 | The customer's second name. |
suffix |
String | maxLength=256 | The customer's suffix (for example, "Jr." or "Sr."). |
title |
String | maxLength=256 | The customer's title (for example, "Mrs" or "Mr"). |
X
OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
