Addresses

The API uses addresses to denote physical locations such as shipping or billing destinations. There are two categories of addresses available:

• Address: This provides comprehensive address details.
• AddressShort: This offers a depersonalized or redacted brief version of an address.

When setting up an address, use the information obtainable from the infoCountries API. This data specifies whether a country has provinces (or states) and zip codes (or postal codes). In the absence of provinces in a country, the country code should invariably be used as the province. If a country doesn't use zip codes, this field can be left blank; otherwise, the zip field is mandatory.

An AddressShort is a reduced or incomplete version of an address, distinct in its depersonalized form. It includes the bare minimum data needed to compute order, tax, and shipping rates, but lacks sufficient details to identify a specific individual or facilitate shipping. Some systems, like Apple Pay, opt to initially supply this redacted information, providing full details only upon finalizing the order. AddressShort can be used for order calculation processes just as regular addresses would be.

Endpoints

Types