Skip to main content

The type that defines the shipping address fields.

Note: If the address cannot be validated, a warning message is be returned along with the response.

Types that use ShippingAddressImpl

Not used by any types.

Call that uses ShippingAddressImpl

POST
/checkout_session/{checkoutSessionId}/update_shipping_address

Fields

Field
Type
Description
addressLine1
string
The first line of the street address.

Maximun characters:
  • AU, CA, & US: 40
  • DE & GB: 35
  • All other marketplaces: 50
addressLine2
string
The second line of the street address where the item is being shipped. This optional field can be used for information such as 'Suite Number' or 'Apt Number'.
city
string
The city of the address.
country
CountryCodeEnum
The two letter code representing the country of the address.
county
string
The county of the address.
phoneNumber
string
The phone number of the person receiving the package.

Note: It is highly recommended that when entering the phone number you include the country code.

For example, if a US phone number is 4********4 you would enter +14********4. If you do not include this code, the service will use the country specified in the country field.

You can find the country code at https://countrycode.org.
postalCode
string
The postal code of the address.
recipient
string
Full name of the person receiving the purchase order.
stateOrProvince
string
The state or province of the address.

Note: For the US marketplace, this is a 2 character value. For a list of these, see US State and Canada Province Codes.