Get Stops

get

/sellShipments/{shipmentGid}/stops

Request

Path Parameters
Query Parameters
  • 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.
  • Comma-delimited string of field names that you wanted returned in a GET request.
  • Positive integer value that specifies the maximum number of items returned by the server.
  • 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.
  • Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
  • Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
  • 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

Default Response

Default Response.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : sellShipments.stops
Type: object
Show Source
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 : appointmentWindowEnd
The appointment window end.
Match All
Show Source
Nested Schema : appointmentWindowStart
The appointment window start.
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: object
Show Source
Nested Schema : details
Type: object
Show Source
Nested Schema : distFromPrevStop
The distance from the last stop.
Match All
Show Source
Nested Schema : driveTime
The drive time to the stop from the last stop.
Match All
Show Source
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: object
Show Source
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
Denotes the predicted arrival time high value at the stop.
Match All
Show Source
Nested Schema : predictedArrivalLow
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: object
Show Source
Nested Schema : remarks
Type: object
Show Source
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: object
Show Source
Nested Schema : dateTimeType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : sellShipments.stops.debriefs
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : sellShipments.stops.details
Type: object
Show Source
Nested Schema : activityTime
The time spent performing the activity at the shipment stop.
Match All
Show Source
Nested Schema : involvedParties
Type: object
Show Source
Nested Schema : shipUnitDwellTime
The ship unit dwell time at the stop location as entered.
Match All
Show Source
Nested Schema : sShipUnits
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : sellShipments.stops.details.involvedParties
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : sellShipments.stops.details.sShipUnits
Type: object
Show Source
Nested Schema : accessorials
Type: object
Show Source
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: object
Show Source
Nested Schema : pieces
Type: object
Show Source
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: object
Show Source
Nested Schema : remarks
Type: object
Show Source
Nested Schema : seals
Type: object
Show Source
Nested Schema : sEquipments
Type: object
Show Source
Nested Schema : specialServices
Type: object
Show Source
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 : unitWeight
The weight of the ship unit.
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 : items
Type: array
Show Source
Nested Schema : sellShipments.stops.details.sShipUnits.accessorials
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : sellShipments.stops.details.sShipUnits.lines
Type: object
Show Source
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: object
Show Source
Nested Schema : remarks
Type: object
Show Source
Nested Schema : volume
The volume of the item.
Match All
Show Source
Nested Schema : volumePer
The weight per shipping line count to handle shipping a multiple count.
Match All
Show Source
Nested Schema : weight
The weight of the item.
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: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : sellShipments.stops.details.sShipUnits.lines.refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : sellShipments.stops.details.sShipUnits.lines.remarks
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : sellShipments.stops.details.sShipUnits.pieces
Type: object
Show Source
Nested Schema : height
No description.
Match All
Show Source
Nested Schema : length
No description.
Match All
Show Source
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 : volume
No description.
Match All
Show Source
Nested Schema : weight
No description.
Match All
Show Source
Nested Schema : width
No description.
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 : items
Type: array
Show Source
Nested Schema : sellShipments.stops.details.sShipUnits.refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : sellShipments.stops.details.sShipUnits.remarks
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : sellShipments.stops.details.sShipUnits.seals
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : sellShipments.stops.details.sShipUnits.sEquipments
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : sellShipments.stops.details.sShipUnits.specialServices
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : sellShipments.stops.involvedParties
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : sellShipments.stops.refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : sellShipments.stops.remarks
Type: object
Show Source
Back to Top