Addresses
=========

Technically, an address is not a resource, but it is often used within our API and has the following structure:

====================  =======  ================================  ===========
Attribute             Type     Required                          Description
====================  =======  ================================  ===========
street_1              string   ✓                                 First address line.
street_2              string                                     Second address line.
street_number         integer                                    House number
street_number_suffix  string                                     House number suffix
postal_code           string                                     Postal code
city                  string   ✓                                 City
state_code            string   For the United States or Canada.  The country subdivision code (second part of the ISO 3166-2 format)
country_code          string   ✓                                 Country code in `ISO 3166-1 alpha-2 <https://www.iso.org/obp/ui/#search/code/>`_ format
company               string                                     Company name
first_name            string   ✓                                 First name of optionally related contact
last_name             string   ✓                                 Last name of optionally related contact, including any insertions
email                 string                                     Email address of optionally related contact
phone_number          string                                     Phone number of optionally related contact
====================  =======  ================================  ===========

.. warning::
    Different carriers have different requirements for address data. More attributes might be required or limited to a certain length. Have a look at the :doc:`carrier specific requirements </api/create-a-shipment/carrier-specific-requirements>` for the carrier you are implementing.