Address

Get addresses

Get the shipping addresses associated with the current user.

get/address

Response

Shipping addresses.

Example response

{
  "data": [
    {
      "id": "shp_XXXXXXXXXXXXXXXXXXXXXXXXX",
      "name": "John Doe",
      "street1": "123 Main St",
      "street2": "Apt 1",
      "city": "Anytown",
      "province": "CA",
      "zip": "12345",
      "country": "US",
      "phone": "5555555555",
      "created": "2024-06-29T19:36:19.000Z"
    }
  ]
}

Changes

Changed in 6 of the 41 revisions of this API.424

    • added the required property data/items/created to the response with the 200 status

      response-required-property-added

  • 1c6726b12e29318See the full diff
    • 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 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 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 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 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 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 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

    • 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

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation

    • 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