GOgoshippo
Addresses

List all addresses

Changed on

Returns a list of all address objects that have been created in this account.

get/addresses

Request

  • Base URL
    https://api.goshippo.com
  • URL
    https://api.goshippo.com/addresses
  • Auth
    API key in header Authorization

Query parameters

pageinteger

The page number you want to select

resultsinteger

The number of results to return per page (max 100, default 5)

Headers

SHIPPO-API-VERSIONstring
Example:2018-02-08

Optional string used to pick a non-default API version to use. See our API version guide.

SHIPPO-ACCOUNT-IDstring

Optional. The object ID of a Managed Shippo Account. Platform accounts set this to make the request on behalf of one of their managed accounts. See the Platform accounts guide.

Response

Paginated list of addresses

nextstring
previousstring

Example response

{
  "next": "baseurl?page=3&results=10",
  "previous": "baseurl?page=1&results=10",
  "results": [
    {
      "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"
          }
        ]
      }
    }
  ]
}

Changes