Customer Address Input
The input fields to create or update a mailing address.
Anchor to FieldsFields
- address1 (String)
- address2 (String)
- city (String)
- company (String)
- countryCode (CountryCode)
- firstName (String)
- lastName (String)
- phoneNumber (String)
- zip (String)
- zoneCode (String)
- territoryCode (String): deprecated
- Anchor to address1address1•String
The first line of the address. Typically the street address or PO Box number.
- Anchor to address2address2•String
The second line of the address. Typically the apartment, suite, or unit number.
- Anchor to citycity•String
The name of the city, district, village, or town.
- Anchor to companycompany•String
The name of the customer's company or organization.
- Anchor to countryCodecountry•Country
Code Code The two-letter code for the country of the address.
- Anchor to firstNamefirst•String
Name The first name of the customer.
- Anchor to lastNamelast•String
Name The last name of the customer.
- Anchor to phoneNumberphone•String
Number The customer's unique phone number, formatted using E.164 standard. For example, +16135551111.
- •String
The zip or postal code of the address.
- Anchor to zoneCodezone•String
Code The alphanumeric code for the region of the address, such as the province, state, or district. For example, 'ON' for Ontario, Canada.
- Anchor to territoryCodeterritory•String
Code Deprecated
Anchor to Input objects using this inputInput objects using this input
- Anchor to SubscriptionDeliveryMethodLocalDeliveryInput.deliveryAddressSubscription•INPUT OBJECT
Delivery Method Local Delivery Input.deliveryAddress The input fields for a local delivery method.
- Anchor to SubscriptionDeliveryMethodShippingInput.shippingAddressSubscription•INPUT OBJECT
Delivery Method Shipping Input.shippingAddress The input fields for a shipping delivery method.