UPS · Schema

Address

LogisticsShippingFortune 500Supply Chain

Properties

Name Type Description
AddressLine array Street address lines
City string
StateProvinceCode string Two-letter state/province code
PostalCode string
CountryCode string Two-letter ISO country code
ResidentialAddressIndicator string Presence indicates residential address
View JSON Schema on GitHub

JSON Schema

ups-address-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Address",
  "title": "Address",
  "type": "object",
  "properties": {
    "AddressLine": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Street address lines"
    },
    "City": {
      "type": "string"
    },
    "StateProvinceCode": {
      "type": "string",
      "description": "Two-letter state/province code"
    },
    "PostalCode": {
      "type": "string"
    },
    "CountryCode": {
      "type": "string",
      "description": "Two-letter ISO country code",
      "example": "US"
    },
    "ResidentialAddressIndicator": {
      "type": "string",
      "description": "Presence indicates residential address"
    }
  }
}