Skip to main content
input_object

The input fields to create or update a mailing address.

•

The first line of the address. Typically the street address or PO Box number.

•

The second line of the address. Typically the number of the apartment, suite, or unit.

•

The name of the city, district, village, or town.

•

The name of the customer's company or organization.

•

The two-letter code for the country of the address.

•

The first name of the customer.

•

The last name of the customer.

•

A unique phone number for the customer.

Formatted using E.164 standard. For example, +16135551111.

•

The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.

•

The zip or postal code of the address.

Deprecated fields

•
String

The name of the country.

•
ID
•
String

The region of the address, such as the province, state, or district.


Was this section helpful?

Anchor to Input objects using this inputInput objects using this input

•
INPUT OBJECT

The addresses for a customer.

•
INPUT OBJECT

The mailing address associated with the payment method.

•
INPUT OBJECT

The mailing address to where the order will be shipped.

•
INPUT OBJECT

The new shipping address for the order. Overwrites the existing shipping address.


Was this section helpful?