UPS · Schema

TimeInTransitRequest

LogisticsShippingFortune 500Supply Chain

Properties

Name	Type	Description
originCountryCode	string	ISO country code of origin
originStateProvince	string
originCityName	string
originPostalCode	string
destinationCountryCode	string
destinationStateProvince	string
destinationCityName	string
destinationPostalCode	string
weight	string	Package weight
weightUnitOfMeasure	string
shipDate	string	Scheduled ship date (YYYY-MM-DD)
shipTime	string	Ship time (HH:MM:SS)
residentialIndicator	string	1=Residential, 2=Commercial

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TimeInTransitRequest",
  "title": "TimeInTransitRequest",
  "type": "object",
  "properties": {
    "originCountryCode": {
      "type": "string",
      "description": "ISO country code of origin"
    },
    "originStateProvince": {
      "type": "string"
    },
    "originCityName": {
      "type": "string"
    },
    "originPostalCode": {
      "type": "string"
    },
    "destinationCountryCode": {
      "type": "string"
    },
    "destinationStateProvince": {
      "type": "string"
    },
    "destinationCityName": {
      "type": "string"
    },
    "destinationPostalCode": {
      "type": "string"
    },
    "weight": {
      "type": "string",
      "description": "Package weight"
    },
    "weightUnitOfMeasure": {
      "type": "string",
      "enum": [
        "LBS",
        "KGS"
      ]
    },
    "shipDate": {
      "type": "string",
      "description": "Scheduled ship date (YYYY-MM-DD)"
    },
    "shipTime": {
      "type": "string",
      "description": "Ship time (HH:MM:SS)"
    },
    "residentialIndicator": {
      "type": "string",
      "enum": [
        "1",
        "2"
      ],
      "description": "1=Residential, 2=Commercial"
    }
  }
}