Get Stops
get
/shipmentNoSSUs/{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 TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Nested Schema : shipmentNoSSUs.stops
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 : shipmentNoSSUs.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 : shipmentNoSSUs.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.
-
sShipUnits:
sShipUnits
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 : sShipUnits
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipmentNoSSUs.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 : shipmentNoSSUs.stops.details.sShipUnits
Type:
Show Source
object
-
accessorials:
accessorials
-
coreDiameter:
coreDiameter
For cylindrical objects, this defines the diameter of the core.
-
domainName: string
Database domain where this data is stored.
-
earlyPickupDate:
earlyPickupDate
The early pickup date defined for the ship unit
-
flexCommodityCode: string
The user-defined commodity code for the item. For example HTS, SITC, STCC, NMFC, etc.
-
flexCommodityQualGid: string
A GID to define the type of the commodity code. For example HTS, SITC, STCC, NMFC etc.
-
isAllowRepack: boolean
If this flag is set to false, when planning order movement that contains this ship unit or combine shipments that contains this shipment ship unit, the shipment ship unit building process will not repack this ship unit.
-
isCountSplittable: boolean
Indicates whether the ship unit can be split on the count boundaries when planning during container optimization.
-
isFixedEruCount: boolean
Indicates whether the ERU defined on shipment ship unit is used or the ERU is derived from the order. A null value means N.
-
isSplitable: boolean
A true or false value to define whether the ship unit can be split when creating the shipments.
-
lines:
lines
-
links: array
links
Read Only:
true
-
pieces:
pieces
-
priority: number
(int32)
Defines the priority associated with ship unit.
-
rangeEnd: number
(int32)
The range end value associated with the ship unit to handle the case where the ship unit count is >1 signifying that there are multiple instances of this record.
-
rangeStart: number
(int32)
The range start value associated with the ship unit to handle the case where the ship unit count is >1 signifying that there are multiple instances of this record.
-
receivedNetVolume:
receivedNetVolume
The received net volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
receivedNetWeight:
receivedNetWeight
The received net weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
receivedShipUnitCount: number
(double)
The received item package count. It can be entered as a stop debrief.
-
receivedVolume:
receivedVolume
The received volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
receivedWeight:
receivedWeight
The received gross weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
refnums:
refnums
-
releaseMethodGid: string
The release method (order configuration identifier) associated with defining this ship unit. It specifies such attributes as if the ship unit weight is calculated from the ship unit line weight.
-
remarks:
remarks
-
seals:
seals
-
sEquipments:
sEquipments
-
shipUnitCount: number
(int64)
Ship units that have the same dimension/weight and contents are represented as one row in the SHIP_UNIT table. SHIP_UNIT_COUNT is the number of these ship units.
-
shipUnitGid: string
The GID for the order release ship unit that is associated to this shipment ship unit.
-
specialServices:
specialServices
-
sShipUnitGid: string
The GID for the ship unit associated to a shipment.
-
sShipUnitXid: string
The XID for the ship unit associated to a shipment.
-
tag1: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
tag2: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
tag3: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
tag4: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
totalGrossVolume:
totalGrossVolume
The total gross volume of the shipment ship unit (transport handling unit + lines).
-
totalGrossWeight:
totalGrossWeight
The total gross weight of the shipment ship unit (transport handling unit + lines).
-
totalLoadingSplitVolume:
totalLoadingSplitVolume
Defines the total loading split volume if the ship unit can be split to load into the equipment.
-
totalLoadingSplitWeight:
totalLoadingSplitWeight
Defines the total loading split weight if the ship unit can be split to load into the equipment.
-
transportHandlingUnitGid: string
The transport handling unit identifier defined for the ship unit. Examples are a box and a pallet.
-
tShipUnitGid: string
A GID for the order release ship unit.
-
unitDiameter:
unitDiameter
For cylindrical objects, this defines the diameter of the ship unit.
-
unitHeight:
unitHeight
The height of each shipment ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.
-
unitLength:
unitLength
The length of each shipment ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.
-
unitNetVolume:
unitNetVolume
The unit net volume of the goods contained in the shipment ship unit.
-
unitNetWeight:
unitNetWeight
The unit net weight of the goods contained in the shipment ship unit.
-
unitVolume:
unitVolume
The volume of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the volume of this shipment ship unit is computed as the total of container volume from its ship unit specification and the volume of its shipment ship unit lines.
-
unitWeight:
unitWeight
The weight of the ship unit.
-
unitWidth:
unitWidth
The width of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the weight of this shipment ship unit is computed as the total of container weight from its ship unit specification and the weight of its shipment ship unit lines.
Nested Schema : accessorials
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : coreDiameter
For cylindrical objects, this defines the diameter of the core.
Match All
Show Source
Nested Schema : earlyPickupDate
The early pickup date defined for the ship unit
Match All
Show Source
Nested Schema : lines
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : pieces
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : receivedNetVolume
The received net volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : receivedNetWeight
The received net weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : receivedVolume
The received volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : receivedWeight
The received gross weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
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 : seals
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : sEquipments
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : specialServices
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : totalGrossVolume
The total gross volume of the shipment ship unit (transport handling unit + lines).
Match All
Show Source
Nested Schema : totalGrossWeight
The total gross weight of the shipment ship unit (transport handling unit + lines).
Match All
Show Source
Nested Schema : totalLoadingSplitVolume
Defines the total loading split volume if the ship unit can be split to load into the equipment.
Match All
Show Source
Nested Schema : totalLoadingSplitWeight
Defines the total loading split weight if the ship unit can be split to load into the equipment.
Match All
Show Source
Nested Schema : unitDiameter
For cylindrical objects, this defines the diameter of the ship unit.
Match All
Show Source
Nested Schema : unitHeight
The height of each shipment ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.
Match All
Show Source
Nested Schema : unitLength
The length of each shipment ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.
Match All
Show Source
Nested Schema : unitNetVolume
The unit net volume of the goods contained in the shipment ship unit.
Match All
Show Source
Nested Schema : unitNetWeight
The unit net weight of the goods contained in the shipment ship unit.
Match All
Show Source
Nested Schema : unitVolume
The volume of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the volume of this shipment ship unit is computed as the total of container volume from its ship unit specification and the volume of its shipment ship unit lines.
Match All
Show Source
Nested Schema : unitWidth
The width of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the weight of this shipment ship unit is computed as the total of container weight from its ship unit specification and the weight of its shipment ship unit lines.
Match All
Show Source
Nested Schema : shipmentNoSSUs.stops.details.sShipUnits.accessorials
Type:
Show Source
object
-
accessorialCodeGid: string
The accessorial code GID.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
Nested Schema : shipmentNoSSUs.stops.details.sShipUnits.lines
Type:
Show Source
object
-
countPerShipUnit: number
(int64)
The count per ship unit.
-
declaredValue:
declaredValue
The declared value of the packaged item quantity being shipped.
-
domainName: string
Database domain where this data is stored.
-
hazmatItemGid: string
The GID for the hazmat item.
-
hotIndicator: boolean
A Y/N indicator if the shipment line item is hot.
-
itemPackageCount: number
(int64)
The number of packages in this shipment ship unit line for one ship unit. Its shipment ship unit may represent more than one same ship units. E.g., for 20 ship units that contains 4 cases of 24 cans of cocoa, each shipment ship unit line row will have an item GID: cocoa, item count 4x24, item package specification: case-of-24-cans, item package count: 4. The ship unit count will be 20.
-
links: array
links
Read Only:
true
-
marinePollutantIndicator: boolean
A Y/N indicator if the shipment line item is a marine pollutant.
-
orderBaseGid: string
Read Only:
true
The GID for the order base that is related to the shipment line. -
orderReleaseGid: string
A unique identifier created by the system for the order release. The GID contains the domain portion.
-
orLineGid: string
A unique identifier to define the multiple order release lines per order release. The GID has the domain portion.
-
packagedItemGid: string
The GID for the packaged item.
-
packagingUnitCount: number
(int64)
The packaging unit count for the packaged unit that is being shipped.
-
packagingUnitGid: string
The GID for the packaging unit that is related to the shipment line.
-
receivedCountPerShipUnit: number
(int64)
The received count per ship unit. It can be entered as stop debrief. Used for reporting purposes.
-
receivedItemPackageCount: number
(double)
The received item package count. It can be entered as a stop debrief.
-
receivedPackagingUnitCount: number
(int64)
The received packaging unit count of the shipment line. It can be entered as stop debrief. Used for reporting purposes.
-
receivedVolume:
receivedVolume
The received volume of the shipment line. It can be entered as a stop debrief. Used for reporting purposes.
-
receivedWeight:
receivedWeight
The received weight of the shipment line. It can be entered as a stop debrief. Used for reporting purposes.
-
refnums:
refnums
-
remarks:
remarks
-
shipUnitGid: string
The GID for the ship unit that contains this shipping line.
-
shipUnitLineNo: number
(int32)
The ship unit line number defined for this shipping line.
-
sShipUnitLineNo: number
(int64)
The unique sequence within the ship unit to define the individual line items.
-
tOrderReleaseGid: string
Used as a non-foreign key reference to the order release.
-
tOrLineGid: string
Used as a non-foreign key reference to the order release line.
-
trackingTag1: string
Additional information about the item. This could be any tracking numbers, SKU codes, SPLC codes etc.
-
trackingTag2: string
Additional information about the item. This could be any tracking numbers, SKU codes, SPLC codes etc.
-
trackingTag3: string
Additional information about the item. This could be any tracking numbers, SKU codes, SPLC codes etc.
-
trackingTag4: string
Additional information about the item. This could be any tracking numbers, SKU codes, SPLC codes etc.
-
tShipUnitGid: string
Used as a non-foreign key reference to the order release ship unit line.
-
tShipUnitLineNo: number
(int32)
Used as a non-foreign key reference to the order release ship unit line.
-
userDefined1IconGid: string
Stores a user-defined icon that will appear within the user interface to help visually identify attributes for the ship unit line.
-
userDefined2IconGid: string
Stores a user-defined icon that will appear within the user interface to help visually identify attributes for the ship unit line.
-
userDefined3IconGid: string
Stores a user-defined icon that will appear within the user interface to help visually identify attributes for the ship unit line.
-
userDefinedCommodityGid: string
Read Only:
true
The user defined commodity identifier associated with the item that is being shipped. -
volume:
volume
The volume of the item.
-
volumePer:
volumePer
The weight per shipping line count to handle shipping a multiple count.
-
weight:
weight
The weight of the item.
-
weightPer:
weightPer
The weight per shipping line count to handle shipping a multiple count.
Nested Schema : declaredValue
The declared value of the packaged item quantity being shipped.
Match All
Show Source
Nested Schema : receivedVolume
The received volume of the shipment line. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : receivedWeight
The received weight of the shipment line. It can be entered as a stop debrief. Used for reporting purposes.
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 : volumePer
The weight per shipping line count to handle shipping a multiple count.
Match All
Show Source
Nested Schema : weightPer
The weight per shipping line count to handle shipping a multiple count.
Match All
Show Source
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency
Nested Schema : shipmentNoSSUs.stops.details.sShipUnits.lines.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
refnumValue: string
The text associated to the remark code.
-
sSulRefnumQualGid: string
The reference number qualifier identifier defining the reference code.
Nested Schema : shipmentNoSSUs.stops.details.sShipUnits.lines.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The remark qualifier identifier defining the remark code.
-
remarkSequence: number
(int64)
The sequence identifier for the remark associated with the shipment.
-
remarkText: string
The text associated to the remark code.
Nested Schema : shipmentNoSSUs.stops.details.sShipUnits.pieces
Type:
Show Source
object
-
domainName: string
No description.
-
height:
height
No description.
-
isSplit: boolean
To indicate if this is a loading split from the original SSU.
-
length:
length
No description.
-
links: array
links
Read Only:
true
-
loadConfig3dPatternGid: string
Corresponding user defined 3d pattern. If the piece is placed using user defined 3d pattern, this indicates the pattern used.
-
loadingSequence: number
(int32)
The loading sequence of the SSU singleton.
-
orientationGid: string
Orientation of the ship unit piece.
-
patternInstanceCount: number
(int32)
Instance of the user pattern used
-
pieceNumber: number
(int32)
A unique number given to a piece of SSU for the same S_SHIP_UNIT_GID with multiple counts.
-
stackingLayer: number
(int32)
Stacking layers of the unit. If multiple units are underneath, this is the maximum number of layers underneath added by 1.
-
totalTopWeight:
totalTopWeight
This is the summation of all weights on the top distributed according to the area touching the pieces
-
volume:
volume
No description.
-
weight:
weight
No description.
-
width:
width
No description.
-
xCoordinate:
xCoordinate
The x-coordinate of the unit using container's front lower left corner as the origin.
-
yCoordinate:
yCoordinate
The y-coordinate of the unit using container's front lower left corner as the origin.
-
zCoordinate:
zCoordinate
The z-coordinate of the unit using container's front lower left corner as the origin.
Nested Schema : totalTopWeight
This is the summation of all weights on the top distributed according to the area touching the pieces
Match All
Show Source
Nested Schema : xCoordinate
The x-coordinate of the unit using container's front lower left corner as the origin.
Match All
Show Source
Nested Schema : yCoordinate
The y-coordinate of the unit using container's front lower left corner as the origin.
Match All
Show Source
Nested Schema : zCoordinate
The z-coordinate of the unit using container's front lower left corner as the origin.
Match All
Show Source
Nested Schema : shipmentNoSSUs.stops.details.sShipUnits.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
refnumValue: string
The text associated to the remark code.
-
sShipUnitRefnumQualGid: string
The reference number qualifier identifier defining the reference code.
Nested Schema : shipmentNoSSUs.stops.details.sShipUnits.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The remark qualifier identifier defining the remark code.
-
remarkSequence: number
(int64)
The sequence identifier for the remark associated with the shipment.
-
remarkText: string
The text associated to the remark code.
Nested Schema : shipmentNoSSUs.stops.details.sShipUnits.seals
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
equipmentSeal: string
The equipment seal number for the shipment ship unit.
-
links: array
links
Read Only:
true
Nested Schema : shipmentNoSSUs.stops.details.sShipUnits.sEquipments
Type:
Show Source
object
-
compartmentNum: number
(int32)
The number associated with the compartment in a multi-compartment equipment. (View Only)
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
loadingPatternGid: string
The loading pattern used to place ship unit into equipment if load configuration algorithm used is pattern based. (View Only)
-
loadingSequence: number
(int32)
The sequence that the shipment ship unit is loaded into the equipment. (View Only)
-
numLoadingRows: number
(int32)
The number associated with the row the ship unit is placed in. (View Only)
-
numStackingLayers: number
(int32)
The number associated with the layer stacked for ship unit. (View Only)
-
sEquipmentGid: string
The GID for the shipment equipment.
Nested Schema : shipmentNoSSUs.stops.details.sShipUnits.specialServices
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
specialServiceGid: string
The special service identifier defining the service to be performed.
Nested Schema : shipmentNoSSUs.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 : shipmentNoSSUs.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 : shipmentNoSSUs.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.