v1

latestOpenAPI 3.1.02026-07-2277219695.0 KB
Address Book

Retrieve addresses

Returns a list of addresses based on search criteria

get/v2/addresses

Query parameters

offsetinteger
limitinteger
searchstring

Response

Successful Response

offsetinteger nullable
limitinteger nullable
countinteger required
nextstring nullable
prevstring nullable

Example response

{
  "offset": 1,
  "limit": 1,
  "count": 1,
  "next": "/addresses?offset=2&limit=1",
  "prev": "/addresses?offset=0&limit=1",
  "results": [
    {
      "id": "e9f1f6fd20f84982afe471ff06c5a80f",
      "address": {
        "name": "Shwan Ippotle",
        "company": "Shippo",
        "street1": "215 Clayton St.",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94117",
        "country": "US",
        "phone": "+1 555 341 9393",
        "email": "shippotle@shippo.com",
        "is_residential": true,
        "metadata": "Customer ID 123456",
        "is_complete": true,
        "object_created": "2014-07-09T02:19:13.174Z",
        "object_id": "d799c2679e644279b59fe661ac8fa488",
        "object_owner": "shippotle@shippo.com",
        "object_updated": "2014-07-09T02:19:13.174Z",
        "validation_results": {
          "messages": [
            {
              "code": "Unknown Street",
              "source": "Shippo Address Validator",
              "text": "City, State and ZIP Code are valid, but street address is not a match.",
              "type": "address_warning"
            }
          ]
        }
      }
    }
  ]
}
All 77 operations