Sign in

v1

latestOpenAPI 3.1.02026-07-2277219695.0 KB
Address Book

Create a new address

Stores a new address to your address book

post/v2/addresses

Request body

namestring required

The name of the addressee

organizationstring nullable

The organization of the addressee

emailstring email nullable

The email of the addressee

phonestring nullable

The phone number of the addressee

address_line_1string required

The first line of the address

address_line_2string nullable

The second line of the address. Must be percent encoded when passed as a query parameter (e.g. #200 → %23200).

city_localitystring nullable

The city or locality of the address

state_provincestring nullable

The state, province, county, or municipal division

postal_codestring nullable

The postal code or zip code

country_codestring required

The ISO 3166 country code

address_type'unknown' | 'residential' | 'commercial' | 'po_box' | 'military'

The residential/commercial type of the address from the delivery/pickup standpoint

unknown At the moment it is not possible to establish if the address is of any known type

residential The address is a residence

commercial The address is associated with a business

po_box The address is a PO Box

military The address is a military address

Example request

{
  "name": "Wilson",
  "organization": "Shippo",
  "email": "user@shippo.com",
  "phone": "+1-4155550132",
  "address_line_1": "731 Market Street",
  "address_line_2": "#200",
  "city_locality": "San Francisco",
  "state_province": "CA",
  "postal_code": "94103",
  "country_code": "US"
}

Response

Successful Response

OR
object required

Example response

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