Add an address

POST

/store/v1/customers/me/addresses

const url = 'https://your-store.example.com/store/v1/customers/me/addresses';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"type":"shipping","isDefault":false,"name":"example","company":"example","line1":"example","line2":"example","city":"example","postalCode":"example","region":"example","country":"example","phone":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://your-store.example.com/store/v1/customers/me/addresses \
  --header 'Content-Type: application/json' \
  --data '{ "type": "shipping", "isDefault": false, "name": "example", "company": "example", "line1": "example", "line2": "example", "city": "example", "postalCode": "example", "region": "example", "country": "example", "phone": "example" }'

Request Body^required

application/json

object

type

required

string

Allowed values: shipping billing

isDefault

boolean

name

required

string

>= 1 characters <= 255 characters

company

Any of:

string
null

string

>= 1 characters <= 255 characters

line1

required

string

>= 1 characters <= 512 characters

line2

Any of:

string
null

string

>= 1 characters <= 512 characters

city

required

string

>= 1 characters <= 255 characters

postalCode

required

string

>= 1 characters <= 32 characters

region

Any of:

string
null

string

>= 1 characters <= 255 characters

country

required

string

/^[A-Za-z]{2}$/

phone

Any of:

string
null

string

>= 1 characters <= 64 characters

Add an address

Request Body^required

Responses

201

Add an address

Request Body required

Responses

201

Request Body^required