younifyd
Menu

Get Customer Address

Get Customer Address

GET/organizations/{organizationId}/customers/{customerId}/addresses/{addressName}

Use it in a workflow

  1. Add a step and choose the Salesforce Commerce Cloud connector.
  2. Pick the Get Customer Address action (under Shopper Customers).
  3. Fill in the fields below, then reference the result from later steps as {{getCustomerAddress.response.data}}.

Request

Path parameters

addressNamestringrequired

The name of the address to update.

customerIdstringrequired

The customer ID.

organizationIdstringrequired

An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).

Query parameters

siteIdstringrequired

The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.

Response

Returns 200 with an object. Read it in later steps with {{getCustomerAddress.response.data.<field>}}.

address1string

The first address.

address2string

The second address.

addressIdstring

The ID of the address as specified by account owner.

citystring

The city.

companyNamestring

The company name.

countryCodestring

The two-letter ISO 3166-1 (Alpha-2) country code.

creationDatestring (date-time)

Returns the value of attribute 'creationDate'.

firstNamestring

The first name.

fullNamestring

The full name.

jobTitlestring

The job title.

lastModifiedstring (date-time)

Returns the value of attribute 'lastModified'.

lastNamestring

The last name.

phonestring

The phone number.

postBoxstring

The post box.

postalCodestring

The postal code.

preferredboolean

The preferred attribute.

salutationstring

The salutation.

secondNamestring

The second name.

stateCodestring

The state code.

suffixstring

The suffix.

suitestring

The suite.

titlestring

The title.

json
{
  "addressId": "Home",
  "countryCode": "US",
  "lastName": "Smith",
  "address1": "10 Presidential Way",
  "address2": "Apt-616",
  "city": "New York",
  "companyName": "Acme Inc",
  "creationDate": "9999-12-31T17:12:56.670Z",
  "firstName": "John",
  "fullName": "John Smith",
  "jobTitle": "Supervisor",
  "lastModified": "9999-12-31T17:12:56.670Z"
}

Need more? See the Salesforce Commerce Cloud guide for connection setup and behaviour shared by every action.