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"
}

Changes

Changed in 5 of the 41 revisions of this API.530

Mar 19, 20251c6726b12e29424See the full diff
- ▲
  the response's body type/format changed from / to object/ for status 400
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 401
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 429
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 500
  response-body-type-changed
- ○
  removed ErrorResponse from the response body allOf list for the response status 400
  response-body-all-of-removed
- ○
  removed ErrorResponse from the response body allOf list for the response status 401
  response-body-all-of-removed
- ○
  removed ErrorResponse from the response body allOf list for the response status 429
  response-body-all-of-removed
- ○
  removed ErrorResponse from the response body allOf list for the response status 500
  response-body-all-of-removed
- ○
  added the optional property details to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property param to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property param to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property param to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property param to the response with the 500 status
  response-optional-property-added
- ○
  added the required property code to the response with the 400 status
  response-required-property-added
- ○
  added the required property code to the response with the 401 status
  response-required-property-added
- ○
  added the required property code to the response with the 429 status
  response-required-property-added
- ○
  added the required property code to the response with the 500 status
  response-required-property-added
- ○
  added the required property message to the response with the 400 status
  response-required-property-added
- ○
  added the required property message to the response with the 401 status
  response-required-property-added
- ○
  added the required property message to the response with the 429 status
  response-required-property-added
- ○
  added the required property message to the response with the 500 status
  response-required-property-added
- ○
  added the required property type to the response with the 400 status
  response-required-property-added
- ○
  added the required property type to the response with the 401 status
  response-required-property-added
- ○
  added the required property type to the response with the 429 status
  response-required-property-added
- ○
  added the required property type to the response with the 500 status
  response-required-property-added
Mar 7, 2025979a6c40552c4See the full diff
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  added the non-success response with the status 429
  response-non-success-status-added
- ○
  added the non-success response with the status 500
  response-non-success-status-added
Dec 16, 202456a8a6f18e6c1See the full diff
- ○
  endpoint added
  endpoint-added
Dec 16, 2024021e5a9aa9e21See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
Dec 13, 2024916cf9100f681See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history