CustomerAddress document (Shop API 18.3)

(supports custom properties)

Document representing a customer address.

Property Type Constraints Description
address1 String maxLength=256 The first address.
address2 String maxLength=256 The second address.
address_id String maxLength=256 The id of the address as specified by account owner.
city String maxLength=256 The city.
company_name String maxLength=256 The company name.
country_code String maxLength=2 The two-letter ISO 3166-1 (Alpha-2) country code.
creation_date Date   Returns the value of attribute 'creationDate'.
first_name String maxLength=256 The first name.
full_name String maxLength=256 The full name.
job_title String maxLength=256 The job title.
last_modified Date   Returns the value of attribute 'lastModified'.
last_name String maxLength=256 The last name.
phone String maxLength=32 The phone number.
post_box String maxLength=256 The post box.
postal_code String maxLength=256 The postal code.
preferred Boolean   The preferred attribute.
salutation String maxLength=256 The salutation.
second_name String maxLength=256 The second name.
state_code String maxLength=256 The state code.
suffix String maxLength=256 The suffix.
suite String maxLength=32 The suite.
title String maxLength=256 The title.

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.

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.