CustomerAddress Document (Data API 17.3)
(supports custom properties)
Document representing a customer address.
| Property | Type | Constraints | Description | 
|---|---|---|---|
address1
 | 
String | maxLength=256 | The customer's first address. | 
address2
 | 
String | maxLength=256 | The customer's second address value. | 
address_id
 | 
String | mandatory=true, maxLength=256, nullable=false | The customer address id. | 
city
 | 
String | maxLength=256 | The customer's city. | 
company_name
 | 
String | maxLength=256 | The customer's company name. | 
country_code
 | 
String | mandatory=true, maxLength=2, nullable=false | The customer's two-character country code per ISO 3166-1 alpha-2. | 
creation_date
 | 
Date | Returns the value of attribute 'creationDate'. | |
etag
 | 
String | The generated eTag representing the state of the customer address. | |
first_name
 | 
String | maxLength=256 | The customer's first name. | 
full_name
 | 
String | The concatenation of the customer's first, middle, and last names and its suffix. | |
job_title
 | 
String | maxLength=256 | The customer's job title. | 
last_modified
 | 
Date | Returns the value of attribute 'lastModified'. | |
last_name
 | 
String | mandatory=true, maxLength=256, nullable=false | The customer's last name. | 
phone
 | 
String | maxLength=32 | The customer's phone number. | 
post_box
 | 
String | maxLength=256 | The customer's post box. | 
postal_code
 | 
String | maxLength=256 | The customer's postal code. | 
salutation
 | 
String | maxLength=256 | The customer's salutation. | 
second_name
 | 
String | maxLength=256 | The customer's second name. | 
state_code
 | 
String | maxLength=256 | The customer's state. | 
suffix
 | 
String | maxLength=256 | The customer's suffix. | 
suite
 | 
String | maxLength=32 | The customer's suite. | 
title
 | 
String | maxLength=256 | The customer's title. | 
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.