Get a Stop
get
/shipments/{shipmentGid}/stops/{stopNum}
Request
Path Parameters
-
shipmentGid(required): string
Resource ID
-
stopNum(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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
Default Response
Default Response.
Root Schema : schema
Type:
Show Source
object
-
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.
Nested Schema : accessorialTime
The sum of the fixed accessorial time for a particular stop.
Match All
Show Source
Nested Schema : activityTime
The time spent at the stop for pickup or delivery.
Match All
Show Source
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
Nested Schema : actualDeparture
The actual departure date and time at the stop.
Match All
Show Source
Nested Schema : appointmentDelivery
A Y/N indicator defining if the stop requires a delivery appointment.
Match All
Show Source
Nested Schema : appointmentDuration
The total appointment duration at the stop.
Match All
Show Source
Nested Schema : appointmentPickup
A Y/N indicator defining if the stop requires a pickup appointment.
Match All
Show Source
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate11
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate12
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate13
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate14
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate15
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate16
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate17
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate18
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate19
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate20
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : debriefs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : details
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
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
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
Nested Schema : fwdLengthOog
Read Only:
true
The forward length-wise out of gauge.
Match All
Show Source
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : leftWidthOog
Read Only:
true
The left width-wise out of gauge.
Match All
Show Source
Nested Schema : plannedArrival
The planned date and time of arrival at the stop.
Match All
Show Source
Nested Schema : plannedDeparture
The planned departure date and time at the stop.
Match All
Show Source
Nested Schema : predictedArrival
Read Only:
true
Denotes the predicted arrival time at the stop.
Match All
Show Source
Nested Schema : predictedArrivalHigh
Read Only:
true
Denotes the predicted arrival time high value at the stop.
Match All
Show Source
Nested Schema : predictedArrivalLow
Read Only:
true
Denotes the predicted arrival time low value at the stop.
Match All
Show Source
Nested Schema : rearLengthOog
Read Only:
true
The rear length-wise out of gauge.
Match All
Show Source
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : restTime
The time the truck or the transportation mode should take for rest at the stop.
Match All
Show Source
Nested Schema : rightWidthOog
Read Only:
true
The right width-wise out of gauge.
Match All
Show Source
Nested Schema : runningHeight
Read Only:
true
The running total height from current stop to next stop.
Match All
Show Source
Nested Schema : runningLength
Read Only:
true
The running total length from current stop to next stop.
Match All
Show Source
Nested Schema : runningWeight
Read Only:
true
The running total weight from current stop to next stop.
Match All
Show Source
Nested Schema : runningWidth
Read Only:
true
The running total width from current stop to next stop.
Match All
Show Source
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
Nested Schema : waitTime
The time the truck or the transportation mode has to wait at the stop.
Match All
Show Source
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : shipments.stops.debriefs
Type:
Show Source
object
-
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.
Nested Schema : shipments.stops.details
Type:
Show Source
object
-
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.
Nested Schema : activityTime
The time spent performing the activity at the shipment stop.
Match All
Show Source
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipUnitDwellTime
The ship unit dwell time at the stop location as entered.
Match All
Show Source
Nested Schema : shipments.stops.details.involvedParties
Type:
Show Source
object
-
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
Nested Schema : shipments.stops.involvedParties
Type:
Show Source
object
-
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
Nested Schema : shipments.stops.refnums
Type:
Show Source
object
-
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.
Nested Schema : shipments.stops.remarks
Type:
Show Source
object
-
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.