Get Addresses For Customer From Customer List

Get a list of customer addresses.

GET/organizations/{organizationId}/customer-lists/{customerListId}/customers/{customerNo}/addresses

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Get Addresses For Customer From Customer List action (under Customers (Data API)).
Fill in the fields below, then reference the result from later steps as {{getAddressesForCustomerFromCustomerList.response.data}}.

Request

Path parameters

customerNostringrequired

The customer number.

customerListIdstringrequired

The customer list ID.

organizationIdstringrequired

An identifier for the organization the request is being made by

Query parameters

limitinteger (int32)

Maximum records to retrieve per request, not to exceed 50. Defaults to 25.

Default 25

offsetinteger (int32)

Used to retrieve the results based on a particular resource offset.

Default 0

Response

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

dataarray<object>

The array of customer address documents.

address1string

The customer's first address.

address2string

The customer's second address value.

addressIdstringrequired

The customer address ID.

citystring

The customer's city.

companyNamestring

The customer's company name.

countryCodestringrequired

The customer's two-character country code per ISO 3166-1 alpha-2.

creationDatestring (date-time)

Returns the value of attribute 'creationDate'.

etagstring

The generated eTag representing the state of the customer address.

firstNamestring

The customer's first name.

fullNamestring

The concatenation of the customer's first, middle, last names, and suffix.

jobTitlestring

The customer's job title.

lastModifiedstring (date-time)

Returns the value of attribute 'lastModified'.

lastNamestringrequired

The customer's last name.

phonestring

The customer's phone number.

postBoxstring

The customer's post box.

postalCodestring

The customer's postal code.

salutationstring

The customer's salutation.

secondNamestring

The customer's second name.

stateCodestring

The customer's state.

suffixstring

The customer's suffix.

suitestring

The customer's suite.

titlestring

The customer's title.

json

{
  "data": [
    {
      "addressId": "Home",
      "countryCode": "US",
      "lastName": "Leung",
      "address1": "123 Trailblazer Ave.",
      "address2": "",
      "city": "San Francisco",
      "companyName": "Ursa Major Solar",
      "creationDate": "9999-12-31T00:00:00.0Z",
      "etag": "0267dee58b0ddd9a13f27309470b84f5b2b7e00fa53dfcf400c1f7a5661f319d",
      "firstName": "Wei",
      "fullName": "Wei Leung",
      "jobTitle": ""
    }
  ]
}

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

Was this page helpful?