Post V2 Customer Address

Create a Customer Address

POST/v2/customers/{customerID}/addresses

Use it in a workflow

Add a step and choose the Elastic Path connector.
Pick the Post V2 Customer Address action (under Customer Addresses).
Fill in the fields below, then reference the result from later steps as {{postV2CustomerAddress.response.data}}.

Request

Path parameters

customerIDstringrequired

The ID of the customer you want to create an address for.

Request body

Enter the body as JSON in the step's Body field.

dataobjectrequired

typestring

Specifies the the type of object. Set this value to `address`.

Default "address"

first_namestring

The first name of the recipient on this address.

last_namestring

The last name of the recipient on this address.

namestring

The name for the address saved, such as `home`, `work` or `wife’s office`.

phone_numberstring

A phone number for this address.

instructionsstring

Any delivery instructions for this address.

company_namestring

The company name at this address.

line_1string

The first portion of the address, usually the street address.

line_2string

The second portion of the address, usually an apartment or unit number.

citystring

The city for this address.

countystring

The county for this address.

regionstring

The state, province, territory, etc. for this address.

postcodestring

The ZIP Code, Postcode, or other postal reference string for this delivery address.

countrystring

A two digit code for the country this address is in, expressed as per the ISO 3166-2 standard.

json

{
  "data": {
    "type": "address",
    "first_name": "Ron",
    "last_name": "Swanson",
    "name": "Home",
    "phone_number": "(555) 555-1234",
    "instructions": "Leave behind bin",
    "company_name": "Ron Swanson Enterprises",
    "line_1": "1 Sunny Street",
    "line_2": "Unit 101",
    "city": "Sunny Town",
    "county": "Sunnyville",
    "region": "acc-legal-name"
  }
}

Response

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

dataany

json

{
  "data": null
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.

Was this page helpful?