Jump to

• Request
• Response

Get Stops

get

/shipments/{shipmentGid}/stops

Request

Path Parameters

• shipmentGid(required): string
  Resource ID

Query Parameters

• expand: string
  Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
• fields: string
  Comma-delimited string of field names that you wanted returned in a GET request.
• limit: integer(int32)
  Positive integer value that specifies the maximum number of items returned by the server.
• offset: integer(int32)
  Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
• orderBy: string
  Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
• q: string
  Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
• totalResults: boolean
  Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=collection

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• items(required): array items
• links: array links

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.stops"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.stops

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.stops"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    }
}

Nested Schema : shipments.stops

Type: object

Show Source

• accessorialTime: accessorialTime
  The sum of the fixed accessorial time for a particular stop.
• activityTime: activityTime
  The time spent at the stop for pickup or delivery.
• actualArrival: actualArrival
  A Y/N indicator defining the arrival time as fixed and will not be changed on subsequent modification.
• actualDeparture: actualDeparture
  The actual departure date and time at the stop.
• appointmentDelivery: appointmentDelivery
  A Y/N indicator defining if the stop requires a delivery appointment.
• appointmentDuration: appointmentDuration
  The total appointment duration at the stop.
• appointmentPickup: appointmentPickup
  A Y/N indicator defining if the stop requires a pickup appointment.
• appointmentWindowEnd: appointmentWindowEnd
  The appointment window end.
• appointmentWindowStart: appointmentWindowStart
  The appointment window start.
• arbitraryType: string
  SOURCE or DEST to indicate the type of arbitrary. If null, this stop is not an arbitrary.
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• debriefs: debriefs
• details: details
• distanceType: string
  Read Only: true

  L - Loaded, B- Bobtail, D - Deadhead
• distFromPrevStop: distFromPrevStop
  The distance from the last stop.
• domainName: string
  Database domain where this data is stored.
• driverNonPayable: boolean
  Allows the user to specify that stop is payable or not.
• driveTime: driveTime
  The drive time to the stop from the last stop.
• estimatedArrival: estimatedArrival
  The estimated time of arrival at the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to delivery. It represents to the best of our knowledge, when we expect the shipment to arrive.
• estimatedDeparture: estimatedDeparture
  The estimated time of departure for the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to departure. It represents to the best of our knowledge, when we expect the shipment to depart from the stop.
• externalVoyageCode: string
  Specifies the number of the voyage as assigned by the carrier that transports the shipments from this stop.
• extSeqNo: number (int32)
  The external sequence number for the stop.
• flightInstanceId: number (int64)
  Read Only: true

  The flight instance GID.
• fwdLengthOog: fwdLengthOog
  Read Only: true

  The forward length-wise out of gauge.
• involvedParties: involvedParties
• isDepot: boolean
  A Y/N indicator used to define if the stop is a depot. This attribute is marked as Create-Only.
• isFixedArrival: boolean
  A Y/N indicator defining the arrival time as fixed and will not be changed on subsequent modification.
• isFixedDeparture: boolean
  A Y/N indicator defining the departure time as fixed and will not be changed on subsequent modification.
• isFixedDistance: boolean
  When set to Y, indicates the existence of a user-entered value for the distance from previous stop field.
• isMotherVessel: boolean
  Designates a leg as mother vessel to automatically populated header.
• isPermanent: boolean
  A Y/N indicator defining the stop as permanent and will not be changed on subsequent modifications.
• leftWidthOog: leftWidthOog
  Read Only: true

  The left width-wise out of gauge.
• links: array links
  Read Only: true
• locationGid: string
  The location GID for the shipment stop.
• locationOverrideGid: string
  The location GID defining the location to be used to override the actual location on the stop record.
• locationRoleGid: string
  The location role GID for the shipment stop (such as port, cross dock, etc.).
• parentLocationGid: string
  If an operational location, such as terminal at a port, is chosen for this stop, the location GID will be copied to this field and the location GID field will contain the operational location.
• plannedArrival: plannedArrival
  The planned date and time of arrival at the stop.
• plannedDeparture: plannedDeparture
  The planned departure date and time at the stop.
• predictedArrival: predictedArrival
  Read Only: true

  Denotes the predicted arrival time at the stop.
• predictedArrivalHigh: predictedArrivalHigh
  Read Only: true

  Denotes the predicted arrival time high value at the stop.
• predictedArrivalLow: predictedArrivalLow
  Read Only: true

  Denotes the predicted arrival time low value at the stop.
• rateDistanceGid: string
  The rate distance to be used when finding distance from this stop to next stop. This is done mainly for arbitrary case.
• rateServiceGid: string
  The rate service GID set if the stop times were calculated using the rate service engine.
• rearLengthOog: rearLengthOog
  Read Only: true

  The rear length-wise out of gauge.
• refnums: refnums
• remarks: remarks
• repetitionSchedStopNumber: number (int32)
  Read Only: true

  The repetition schedule stop GID if the stop times were calculated from a repetition schedule.
• repetitionScheduleGid: string
  Read Only: true

  The repetition schedule GID if the stop times were calculated from a repetition schedule.
• restTime: restTime
  The time the truck or the transportation mode should take for rest at the stop.
• rightWidthOog: rightWidthOog
  Read Only: true

  The right width-wise out of gauge.
• routeCodeGid: string
  The route code to be used when finding distance from this stop to next stop This is done mainly for handling arbitrary case.
• runningHeight: runningHeight
  Read Only: true

  The running total height from current stop to next stop.
• runningLength: runningLength
  Read Only: true

  The running total length from current stop to next stop.
• runningWeight: runningWeight
  Read Only: true

  The running total weight from current stop to next stop.
• runningWidth: runningWidth
  Read Only: true

  The running total width from current stop to next stop.
• rushHourTime: rushHourTime
  The amount of time that the drive time defined on the stop in inside the rush hour window.
• slackVariance: number (double)
  Read Only: true

  The slack variance.
• stopNum: number (int32)
  The stop number within the shipment. Stop number = 1 is the pickup stop, and the max (stop number) for a shipment is the delivery stop. This attribute is marked as Create-Only.
• stopRequirementType: string
  Used only for trips.
• stopType: string
  Define the type of this stop.
• voyageGid: string
  Read Only: true

  The voyage GID.
• waitTime: waitTime
  The time the truck or the transportation mode has to wait at the stop.

{
    "properties":{
        "stopNum":{
            "description":"The stop number within the shipment. Stop number = 1 is the pickup stop, and the max (stop number) for a shipment is the delivery stop. This attribute is marked as Create-Only.",
            "type":"number",
            "format":"int32"
        },
        "locationGid":{
            "description":"The location GID for the shipment stop.",
            "type":"string"
        },
        "locationRoleGid":{
            "description":"The location role GID for the shipment stop (such as port, cross dock, etc.).",
            "type":"string"
        },
        "plannedArrival":{
            "description":"The planned date and time of arrival at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "estimatedArrival":{
            "description":"The estimated time of arrival at the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to delivery. It represents to the best of our knowledge, when we expect the shipment to arrive.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "isFixedArrival":{
            "description":"A Y/N indicator defining the arrival time as fixed and will not be changed on subsequent modification.",
            "type":"boolean"
        },
        "actualArrival":{
            "description":"A Y/N indicator defining the arrival time as fixed and will not be changed on subsequent modification.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "plannedDeparture":{
            "description":"The planned departure date and time at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "estimatedDeparture":{
            "description":"The estimated time of departure for the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to departure. It represents to the best of our knowledge, when we expect the shipment to depart from the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "isFixedDeparture":{
            "description":"A Y/N indicator defining the departure time as fixed and will not be changed on subsequent modification.",
            "type":"boolean"
        },
        "actualDeparture":{
            "description":"The actual departure date and time at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "waitTime":{
            "description":"The time the truck or the transportation mode has to wait at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "restTime":{
            "description":"The time the truck or the transportation mode should take for rest at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "driveTime":{
            "description":"The drive time to the stop from the last stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "distFromPrevStop":{
            "description":"The distance from the last stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "activityTime":{
            "description":"The time spent at the stop for pickup or delivery.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isPermanent":{
            "description":"A Y/N indicator defining the stop as permanent and will not be changed on subsequent modifications.",
            "type":"boolean"
        },
        "isDepot":{
            "description":"A Y/N indicator used to define if the stop is a depot. This attribute is marked as Create-Only.",
            "type":"boolean"
        },
        "appointmentPickup":{
            "description":"A Y/N indicator defining if the stop requires a pickup appointment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "appointmentDelivery":{
            "description":"A Y/N indicator defining if the stop requires a delivery appointment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "accessorialTime":{
            "description":"The sum of the fixed accessorial time for a particular stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "parentLocationGid":{
            "description":"If an operational location, such as terminal at a port, is chosen for this stop, the location GID will be copied to this field and the location GID field will contain the operational location.",
            "type":"string"
        },
        "locationOverrideGid":{
            "description":"The location GID defining the location to be used to override the actual location on the stop record.",
            "type":"string"
        },
        "stopRequirementType":{
            "description":"Used only for trips.",
            "type":"string"
        },
        "rateServiceGid":{
            "description":"The rate service GID set if the stop times were calculated using the rate service engine.",
            "type":"string"
        },
        "arbitraryType":{
            "description":"SOURCE or DEST to indicate the type of arbitrary. If null, this stop is not an arbitrary.",
            "type":"string"
        },
        "isFixedDistance":{
            "description":"When set to Y, indicates the existence of a user-entered value for the distance from previous stop field.",
            "type":"boolean"
        },
        "extSeqNo":{
            "description":"The external sequence number for the stop.",
            "type":"number",
            "format":"int32"
        },
        "rushHourTime":{
            "description":"The amount of time that the drive time defined on the stop in inside the rush hour window.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "voyageGid":{
            "description":"The voyage GID.",
            "type":"string",
            "readOnly":true
        },
        "isMotherVessel":{
            "description":"Designates a leg as mother vessel to automatically populated header.",
            "type":"boolean"
        },
        "flightInstanceId":{
            "description":"The flight instance GID.",
            "type":"number",
            "format":"int64",
            "readOnly":true
        },
        "repetitionScheduleGid":{
            "description":"The repetition schedule GID if the stop times were calculated from a repetition schedule.",
            "type":"string",
            "readOnly":true
        },
        "stopType":{
            "description":"Define the type of this stop.",
            "type":"string"
        },
        "slackVariance":{
            "description":"The slack variance.",
            "type":"number",
            "format":"double",
            "readOnly":true
        },
        "driverNonPayable":{
            "description":"Allows the user to specify that stop is payable or not.",
            "type":"boolean"
        },
        "repetitionSchedStopNumber":{
            "description":"The repetition schedule stop GID if the stop times were calculated from a repetition schedule.",
            "type":"number",
            "format":"int32",
            "readOnly":true
        },
        "distanceType":{
            "description":"L - Loaded, B- Bobtail, D - Deadhead",
            "type":"string",
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "appointmentWindowStart":{
            "description":"The appointment window start.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "appointmentWindowEnd":{
            "description":"The appointment window end.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "rateDistanceGid":{
            "description":"The rate distance to be used when finding distance from this stop to next stop. This is done mainly for arbitrary case. ",
            "type":"string"
        },
        "routeCodeGid":{
            "description":"The route code to be used when finding distance from this stop to next stop This is done mainly for handling arbitrary case. ",
            "type":"string"
        },
        "runningWeight":{
            "description":"The running total weight from current stop to next stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "runningLength":{
            "description":"The running total length from current stop to next stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "runningWidth":{
            "description":"The running total width from current stop to next stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "runningHeight":{
            "description":"The running total height from current stop to next stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "leftWidthOog":{
            "description":"The left width-wise out of gauge.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "rightWidthOog":{
            "description":"The right width-wise out of gauge.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "fwdLengthOog":{
            "description":"The forward length-wise out of gauge.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "rearLengthOog":{
            "description":"The rear length-wise out of gauge.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "predictedArrival":{
            "description":"Denotes the predicted arrival time at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ],
            "readOnly":true
        },
        "predictedArrivalLow":{
            "description":"Denotes the predicted arrival time low value at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ],
            "readOnly":true
        },
        "predictedArrivalHigh":{
            "description":"Denotes the predicted arrival time high value at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ],
            "readOnly":true
        },
        "externalVoyageCode":{
            "description":"Specifies the number of the voyage as assigned by the carrier that transports the shipments from this stop.",
            "type":"string"
        },
        "appointmentDuration":{
            "description":"The total appointment duration at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "debriefs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.stops.debriefs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.stops.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.stops.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.stops.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.stops.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : accessorialTime

The sum of the fixed accessorial time for a particular stop.

Match All

Show Source

• object amountType

{
    "description":"The sum of the fixed accessorial time for a particular stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : activityTime

The time spent at the stop for pickup or delivery.

Match All

Show Source

• object amountType

{
    "description":"The time spent at the stop for pickup or delivery.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualArrival

A Y/N indicator defining the arrival time as fixed and will not be changed on subsequent modification.

Match All

Show Source

• object dateTimeType

{
    "description":"A Y/N indicator defining the arrival time as fixed and will not be changed on subsequent modification.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : actualDeparture

The actual departure date and time at the stop.

Match All

Show Source

• object dateTimeType

{
    "description":"The actual departure date and time at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : appointmentDelivery

A Y/N indicator defining if the stop requires a delivery appointment.

Match All

Show Source

• object dateTimeType

{
    "description":"A Y/N indicator defining if the stop requires a delivery appointment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : appointmentDuration

The total appointment duration at the stop.

Match All

Show Source

• object amountType

{
    "description":"The total appointment duration at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : appointmentPickup

A Y/N indicator defining if the stop requires a pickup appointment.

Match All

Show Source

• object dateTimeType

{
    "description":"A Y/N indicator defining if the stop requires a pickup appointment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : appointmentWindowEnd

The appointment window end.

Match All

Show Source

• object dateTimeType

{
    "description":"The appointment window end.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : appointmentWindowStart

The appointment window start.

Match All

Show Source

• object dateTimeType

{
    "description":"The appointment window start.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : debriefs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.stops.debriefs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : details

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.stops.details"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : distFromPrevStop

The distance from the last stop.

Match All

Show Source

• object amountType

{
    "description":"The distance from the last stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : driveTime

The drive time to the stop from the last stop.

Match All

Show Source

• object amountType

{
    "description":"The drive time to the stop from the last stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : estimatedArrival

The estimated time of arrival at the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to delivery. It represents to the best of our knowledge, when we expect the shipment to arrive.

Match All

Show Source

• object dateTimeType

{
    "description":"The estimated time of arrival at the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to delivery. It represents to the best of our knowledge, when we expect the shipment to arrive.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : estimatedDeparture

The estimated time of departure for the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to departure. It represents to the best of our knowledge, when we expect the shipment to depart from the stop.

Match All

Show Source

• object dateTimeType

{
    "description":"The estimated time of departure for the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to departure. It represents to the best of our knowledge, when we expect the shipment to depart from the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : fwdLengthOog

Read Only: true

The forward length-wise out of gauge.

Match All

Show Source

• object amountType

{
    "description":"The forward length-wise out of gauge.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.stops.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : leftWidthOog

Read Only: true

The left width-wise out of gauge.

Match All

Show Source

• object amountType

{
    "description":"The left width-wise out of gauge.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : plannedArrival

The planned date and time of arrival at the stop.

Match All

Show Source

• object dateTimeType

{
    "description":"The planned date and time of arrival at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : plannedDeparture

The planned departure date and time at the stop.

Match All

Show Source

• object dateTimeType

{
    "description":"The planned departure date and time at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : predictedArrival

Read Only: true

Denotes the predicted arrival time at the stop.

Match All

Show Source

• object dateTimeType

{
    "description":"Denotes the predicted arrival time at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ],
    "readOnly":true
}

Nested Schema : predictedArrivalHigh

Read Only: true

Denotes the predicted arrival time high value at the stop.

Match All

Show Source

• object dateTimeType

{
    "description":"Denotes the predicted arrival time high value at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ],
    "readOnly":true
}

Nested Schema : predictedArrivalLow

Read Only: true

Denotes the predicted arrival time low value at the stop.

Match All

Show Source

• object dateTimeType

{
    "description":"Denotes the predicted arrival time low value at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ],
    "readOnly":true
}

Nested Schema : rearLengthOog

Read Only: true

The rear length-wise out of gauge.

Match All

Show Source

• object amountType

{
    "description":"The rear length-wise out of gauge.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.stops.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.stops.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : restTime

The time the truck or the transportation mode should take for rest at the stop.

Match All

Show Source

• object amountType

{
    "description":"The time the truck or the transportation mode should take for rest at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : rightWidthOog

Read Only: true

The right width-wise out of gauge.

Match All

Show Source

• object amountType

{
    "description":"The right width-wise out of gauge.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : runningHeight

Read Only: true

The running total height from current stop to next stop.

Match All

Show Source

• object amountType

{
    "description":"The running total height from current stop to next stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : runningLength

Read Only: true

The running total length from current stop to next stop.

Match All

Show Source

• object amountType

{
    "description":"The running total length from current stop to next stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : runningWeight

Read Only: true

The running total weight from current stop to next stop.

Match All

Show Source

• object amountType

{
    "description":"The running total weight from current stop to next stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : runningWidth

Read Only: true

The running total width from current stop to next stop.

Match All

Show Source

• object amountType

{
    "description":"The running total width from current stop to next stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : rushHourTime

The amount of time that the drive time defined on the stop in inside the rush hour window.

Match All

Show Source

• object amountType

{
    "description":"The amount of time that the drive time defined on the stop in inside the rush hour window.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : waitTime

The time the truck or the transportation mode has to wait at the stop.

Match All

Show Source

• object amountType

{
    "description":"The time the truck or the transportation mode has to wait at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.stops.debriefs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.stops.debriefs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : shipments.stops.debriefs

Type: object

Show Source

• activity: string
  Specifies the activity (pickup, drop off) for the stop and the debrief values.
• domainName: string
  Database domain where this data is stored.
• itemGid: string
  The item GID for the stop debrief.
• itemPackageCount: number (int64)
  The count of the package item count.
• links: array links
  Read Only: true
• matchType: string
  The match type code for linking the stop debrief data.
• nonConfReasonCodeGid: string
  The non conformance reason code GID associated with the stop debrief recording.
• orderReleaseLineGid: string
  The order release line GID linked to the stop debrief.
• packagingUnitCount: number (int64)
  The packaging unit count for the packing unit contained in the packaged item.
• packagingUnitGid: string
  The packaging unit GID for the packaging unit count that is contained in the packaged item.
• sequenceNo: string
  The sequence number (key).
• sEquipmentGid: string
  The equipment GID linked to the stop debrief.
• shipUnitGid: string
  The ship unit GID linked to the stop debrief.
• sShipUnitGid: string
  The GID for ship unit for the shipment.
• sShipUnitLineNo: number (int64)
  The GID for ship unit line number for the shipment.
• transportHandlingUnitCount: number (int64)
  The transport handling count GID for the stop debrief.
• transportHandlingUnitGid: string
  The transport handling unit GID associated with the transport handling unit.

{
    "properties":{
        "activity":{
            "description":"Specifies the activity (pickup, drop off) for the stop and the debrief values.",
            "type":"string"
        },
        "sequenceNo":{
            "description":"The sequence number (key).",
            "type":"string"
        },
        "sShipUnitGid":{
            "description":"The GID for ship unit for the shipment.",
            "type":"string"
        },
        "sShipUnitLineNo":{
            "description":"The GID for ship unit line number for the shipment.",
            "type":"number",
            "format":"int64"
        },
        "itemPackageCount":{
            "description":"The count of the package item count.",
            "type":"number",
            "format":"int64"
        },
        "packagingUnitGid":{
            "description":"The packaging unit GID for the packaging unit count that is contained in the packaged item.",
            "type":"string"
        },
        "packagingUnitCount":{
            "description":"The packaging unit count for the packing unit contained in the packaged item.",
            "type":"number",
            "format":"int64"
        },
        "transportHandlingUnitGid":{
            "description":"The transport handling unit GID associated with the transport handling unit.",
            "type":"string"
        },
        "transportHandlingUnitCount":{
            "description":"The transport handling count GID for the stop debrief.",
            "type":"number",
            "format":"int64"
        },
        "itemGid":{
            "description":"The item GID for the stop debrief.",
            "type":"string"
        },
        "nonConfReasonCodeGid":{
            "description":"The non conformance reason code GID associated with the stop debrief recording.",
            "type":"string"
        },
        "shipUnitGid":{
            "description":"The ship unit GID linked to the stop debrief.",
            "type":"string"
        },
        "sEquipmentGid":{
            "description":"The equipment GID linked to the stop debrief.",
            "type":"string"
        },
        "matchType":{
            "description":"The match type code for linking the stop debrief data.",
            "type":"string"
        },
        "orderReleaseLineGid":{
            "description":"The order release line GID linked to the stop debrief.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.stops.details

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.stops.details"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : shipments.stops.details

Type: object

Show Source

• activity: string
  The activity performed at the stop. For example: pickup, delivery, etc.
• activityTime: activityTime
  The time spent performing the activity at the shipment stop.
• domainName: string
  Date and time of the most recent data update.
• involvedParties: involvedParties
• isPermanent: boolean
  A Y/N indicator to define the stop as permanent. Any subsequent actions and modifications to the shipment will retain this record.
• links: array links
  Read Only: true
• shipUnitDwellTime: shipUnitDwellTime
  The ship unit dwell time at the stop location as entered.
• sShipUnitGid: string
  A GID to define the shipment ship unit.

{
    "properties":{
        "sShipUnitGid":{
            "description":"A GID to define the shipment ship unit.",
            "type":"string"
        },
        "activity":{
            "description":"The activity performed at the stop. For example: pickup, delivery, etc.",
            "type":"string"
        },
        "activityTime":{
            "description":"The time spent performing the activity at the shipment stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isPermanent":{
            "description":"A Y/N indicator to define the stop as permanent. Any subsequent actions and modifications to the shipment will retain this record.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Date and time of the most recent data update.",
            "type":"string"
        },
        "shipUnitDwellTime":{
            "description":"The ship unit dwell time at the stop location as entered.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.stops.details.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : activityTime

The time spent performing the activity at the shipment stop.

Match All

Show Source

• object amountType

{
    "description":"The time spent performing the activity at the shipment stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.stops.details.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : shipUnitDwellTime

The ship unit dwell time at the stop location as entered.

Match All

Show Source

• object amountType

{
    "description":"The ship unit dwell time at the stop location as entered.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.stops.details.involvedParties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.stops.details.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : shipments.stops.details.involvedParties

Type: object

Show Source

• comMethodGid: string
  The communication method ID for the involved party.
• domainName: string
  Database domain where this data is stored.
• involvedPartyContactGid: string
  The contact ID for the involved party.
• involvedPartyQualGid: string
  The qualifier ID for the involved party.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The qualifier ID for the involved party.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The contact ID for the involved party.",
            "type":"string"
        },
        "comMethodGid":{
            "description":"The communication method ID for the involved party.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.stops.involvedParties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.stops.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : shipments.stops.involvedParties

Type: object

Show Source

• comMethodGid: string
  The communication method for the involved party.
• domainName: string
  Database domain where this data is stored.
• involvedPartyContactGid: string
  The contact ID for the involved party.
• involvedPartyQualGid: string
  The qualifier ID for the involved party.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The qualifier ID for the involved party.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The contact ID for the involved party.",
            "type":"string"
        },
        "comMethodGid":{
            "description":"The communication method for the involved party.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.stops.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.stops.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : shipments.stops.refnums

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• shipmentStopRefnumQualGid: string
  The shipment reference qualifier GID defining the reference type.
• shipmentStopRefnumValue: string
  The shipment stop reference value.

{
    "properties":{
        "shipmentStopRefnumQualGid":{
            "description":"The shipment reference qualifier GID defining the reference type.",
            "type":"string"
        },
        "shipmentStopRefnumValue":{
            "description":"The shipment stop reference value.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.stops.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.stops.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : shipments.stops.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  A pointer to the remark type. For example: Service provider assigned equipment number, service provider tender decline reason code, etc.
• remarkSequence: number (int64)
  The sequence (key) for the remark.
• remarkText: string
  User entered remark.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence (key) for the remark.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"A pointer to the remark type. For example: Service provider assigned equipment number,  service provider tender decline reason code, etc.",
            "type":"string"
        },
        "remarkText":{
            "description":"User entered remark.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Back to Top