ShipStation · Schema

Address

EcommerceLabelsLogisticsOrder ManagementShippingWarehousing

Properties

Name	Type	Description
name	string	Name of person
company	string	Company
street1	string	First line of address
street2	string	Second line of address
street3	string	Third line of address
city	string
state	string
postalCode	string
country	string
phone	string
residential	boolean	Whether the address is residential

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Address",
  "title": "Address",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of person"
    },
    "company": {
      "type": "string",
      "description": "Company"
    },
    "street1": {
      "type": "string",
      "description": "First line of address"
    },
    "street2": {
      "type": "string",
      "description": "Second line of address"
    },
    "street3": {
      "type": "string",
      "description": "Third line of address"
    },
    "city": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "postalCode": {
      "type": "string"
    },
    "country": {
      "type": "string"
    },
    "phone": {
      "type": "string"
    },
    "residential": {
      "type": "boolean",
      "description": "Whether the address is residential"
    }
  }
}