Skip to main content

The type that defines the fields for a shipping address. For restrictions, see Shipping restrictions.

Note: If the address cannot be validated, a warning message will be returned.

Types that use ShippingAddress

CheckoutSessionResponseCreateSignInCheckoutSessionRequestPurchaseOrder

Calls that use ShippingAddress

POST
/checkout_session/{checkoutSessionId}/apply_coupon
GET
/checkout_session/{checkoutSessionId}
POST
/checkout_session/initiate
POST
/checkout_session/{checkoutSessionId}/remove_coupon
POST
/checkout_session/{checkoutSessionId}/update_add_on_services_status
POST
/checkout_session/{checkoutSessionId}/update_payment_info
POST
/checkout_session/{checkoutSessionId}/update_quantity
POST
/checkout_session/{checkoutSessionId}/update_shipping_address
POST
/checkout_session/{checkoutSessionId}/update_shipping_option
GET
/purchase_order/{purchaseOrderId}

Fields

Field
Type
Description
addressLine1
string
The first line of the street address where the item is being shipped.

Maximum 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'.

Maximum characters:
  • AU, CA, & US: 40
  • DE & GB: 35
  • All other marketplaces: 50
city
string
The city of the address where the item is being shipped.
country
CountryCodeEnum
The two letter code representing the country of the address.
county
string
The county of the address where the item is being shipped.
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 where the item is being shipped.

Note: This is optional when shipping to EBAY_HK - Hong Kong (ebay.com.hk).

recipient
string
The name of the person receiving the package.
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.