Sign in

v41

latestOpenAPI 3.1.0raw.githubusercontent.com2025-08-053715199.1 KB
Address

Create address

Create and add a shipping address to the current user.

post/address

Request body

namestring required

The recipient's name.

street1string required

Street of the address.

street2string

Apartment, suite, etc. of the address.

citystring required

City of the address.

provincestring

Province or state of the address.

countrystring required

ISO 3166-1 alpha-2 country code of the address.

zipstring required

Zip code of the address.

phonestring

Phone number of the recipient.

Example request

{
  "name": "John Doe",
  "street1": "123 Main St",
  "street2": "Apt 1",
  "city": "Anytown",
  "province": "CA",
  "zip": "12345",
  "country": "US",
  "phone": "5555555555"
}

Response

Shipping address ID.

datastring required

Shipping address ID.

Example response

{
  "data": "shp_XXXXXXXXXXXXXXXXXXXXXXXXX"
}