ShippingAddressImpl

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ShippingAddressImpl",
  "title": "ShippingAddressImpl",
  "type": "object",
  "properties": {
    "addressLine1": {
      "type": "string",
      "description": "The first line of the street address where the item is being shipped.<br><br><b>Maximum:</b><ul><li>40 characters for AU, CA, and US marketplaces</li><li>35 characters for DE and GB marketplaces</li><li>50 characters for all other marketplaces</li></ul>"
    },
    "addressLine2": {
      "type": "string",
      "description": "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'.<br><br><b>Maximum:</b><ul><li>40 characters for AU, CA, and US marketplaces</li><li>35 characters for DE and GB marketplaces</li><li>50 characters for all other marketplaces</li></ul>"
    },
    "city": {
      "type": "string",
      "description": "The city of the address where the item is being shipped."
    },
    "country": {
      "type": "string",
      "description": "The two letter code representing the country of the address. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/order/types/bas:CountryCodeEnum'>eBay API documentation</a>"
    },
    "county": {
      "type": "string",
      "description": "The county of the address where the item is being shipped."
    },
    "phoneNumber": {
      "type": "string",
      "description": "The phone number of the person receiving the package.<br><br><span class=\"tablenote\"><b>Note:</b> It is highly recommended that when entering the phone number you include the country code.<br><br>For example, if a US phone number is <code>4********4</code>, you would enter <code>+14********4</code>. If you do not include this code, the service will use the country specified in the <b>country</b> field.<br><br>You can find the country code at <a href=\"https://countrycode.org/\">https://countrycode.org</a>.</span>"
    },
    "postalCode": {
      "type": "string",
      "description": "The postal code of the address where the item is being shipped.<br><br><span class=\"tablenote\"><b>Note:</b> This is optional when shipping to EBAY_HK (Hong Kong).</span>"
    },
    "recipient": {
      "description": "The name of the person receiving the package.",
      "$ref": "#/components/schemas/Recipient"
    },
    "stateOrProvince": {
      "type": "string",
      "description": "The state or province of the address.<br><br><span class=\"tablenote\"><b>Note:</b> For the US marketplace, this is a two-character value. For a list of valid values, see <a href=\"https://www.ups.com/worldshiphelp/WS15/ENU/AppHelp/Codes/State_Province_Codes.htm\">US State and Canada Province Codes</a>. </span>"
    }
  },
  "description": "A type that defines the shipping address fields.<br><br><span class=\"tablenote\"><b>Note:</b> If the address cannot be validated, a warning message is returned along with the response.</span>"
}