Create an Customer Address

POST 
/v2/customers/:customerID/addresses/:addressID

Create an Customer Address

Request

Path Parameters

customerID stringrequired

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

application/json

Body

data Addressrequired

type string

Default value: address

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

first_name string

The first name of the recipient on this address.

last_name string

The last name of the recipient on this address.

name string

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

phone_number string

A phone number for this address.

instructions string

Any delivery instructions for this address.

company_name string

The company name at this address.

line_1 string

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

line_2 string

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

city string

The city for this address.

county string

The county for this address.

region string

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

postcode string

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

country string

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

Responses

200

OK

application/json

Schema

Schema

data object

type string

Default value: address

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

first_name string

The first name of the recipient on this address.

last_name string

The last name of the recipient on this address.

name string

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

phone_number string

A phone number for this address.

instructions string

Any delivery instructions for this address.

company_name string

The company name at this address.

line_1 string

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

line_2 string

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

city string

The city for this address.

county string

The county for this address.

region string

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

postcode string

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

country string

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

id string

The unique identifier for an Address.

meta object

timestamps object

created_at string

The date the address is created.

updated_at string

The date the address is updated.

links object

self string

A URL to the specific resource.

relationships object

customer object

id string

The ID of the customer.

type string

The type of object being returned.

Example (from schema)

{
  "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",
    "postcode": "SU33 1YY",
    "country": "GB",
    "id": "5f8da740-6680-463e-b31c-190b2db4bf9d",
    "meta": {
      "timestamps": {
        "created_at": "2021-02-23T09:40:33.882Z",
        "updated_at": "2021-02-23T09:40:33.882Z"
      }
    },
    "links": {
      "self": "https://useast.api.elasticpath.com/v2/customers/deb6b25f-8451-4211-9a22-95610333df23/addresses"
    },
    "relationships": {
      "customer": {
        "id": "11afcf9b-971b-4fdb-8e10-f2ecf970718e",
        "type": "customer"
      }
    }
  }
}

400

Bad Request

application/json

Schema

Schema

errors Error[]required
Array [
status string
The HTTP response code of the error.
title string
A brief summary of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": "string",
      "title": "string",
      "detail": "string"
    }
  ]
}

bad-request-error

{
  "errors": [
    {
      "status": "400",
      "title": "Bad Request",
      "detail": "Validation failed: field 'Name' on the 'min' tag."
    }
  ]
}

404

Not Found

application/json

Schema

Schema

errors Error[]required
Array [
status string
The HTTP response code of the error.
title string
A brief summary of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": "string",
      "title": "string",
      "detail": "string"
    }
  ]
}

not-found-error

{
  "errors": [
    {
      "status": "404",
      "title": "Not Found",
      "detail": "customer not found"
    }
  ]
}

Loading...