Get Bulk Plans

get

/bulkPlans

Request

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 : bulkPlans
Type: object
Show Source
Nested Schema : byModes
Type: object
Show Source
Nested Schema : continuousMoves
Type: object
Show Source
Nested Schema : endTime
No description.
Match All
Show Source
Nested Schema : insertDate
Read Only: true
insert date
Match All
Show Source
Nested Schema : partitions
Type: object
Show Source
Nested Schema : serviceProviders
Type: object
Show Source
Nested Schema : since
No description.
Match All
Show Source
Nested Schema : startTime
No description.
Match All
Show Source
Nested Schema : terminationTime
No description.
Match All
Show Source
Nested Schema : totalActualCost
No description.
Match All
Show Source
Nested Schema : totalBestDirectCost
No description.
Match All
Show Source
Nested Schema : totalCost
No description.
Match All
Show Source
Nested Schema : totalDistance
No description.
Match All
Show Source
Nested Schema : totalShipmentTimeSecs
No description.
Match All
Show Source
Nested Schema : totalVolume
No description.
Match All
Show Source
Nested Schema : totalVolumeCapacity
No description.
Match All
Show Source
Nested Schema : totalWeight
No description.
Match All
Show Source
Nested Schema : totalWeightCapacity
No description.
Match All
Show Source
Nested Schema : updateDate
Read Only: true
update date
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : bulkPlans.byModes
Type: object
Show Source
Nested Schema : totalCost
No description.
Match All
Show Source
Nested Schema : totalDistance
No description.
Match All
Show Source
Nested Schema : totalShipmentTimeSecs
No description.
Match All
Show Source
Nested Schema : totalVolume
No description.
Match All
Show Source
Nested Schema : totalVolumeCapacity
No description.
Match All
Show Source
Nested Schema : totalWeight
No description.
Match All
Show Source
Nested Schema : totalWeightCapacity
No description.
Match All
Show Source
Nested Schema : currencyType
Type: object
Show Source
Nested Schema : amountType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : bulkPlans.continuousMoves
Type: object
Show Source
Nested Schema : endTime
No description.
Match All
Show Source
Nested Schema : startTime
No description.
Match All
Show Source
Nested Schema : totalCostAfter
No description.
Match All
Show Source
Nested Schema : totalCostBefore
No description.
Match All
Show Source
Nested Schema : totalDistanceAfter
No description.
Match All
Show Source
Nested Schema : totalDistanceBefore
No description.
Match All
Show Source
Nested Schema : totalEmptyDistance
No description.
Match All
Show Source
Nested Schema : totalLoadedDistance
No description.
Match All
Show Source
Nested Schema : totalTimeForAllCm
No description.
Match All
Show Source
Nested Schema : dateTimeType
Type: object
Show Source
Nested Schema : dateType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : bulkPlans.partitions
Type: object
Show Source
Nested Schema : byModes
Type: object
Show Source
Nested Schema : endTime
No description.
Match All
Show Source
Nested Schema : serviceProviders
Type: object
Show Source
Nested Schema : since
No description.
Match All
Show Source
Nested Schema : startTime
No description.
Match All
Show Source
Nested Schema : submitTime
No description.
Match All
Show Source
Nested Schema : totalBestDirectCost
No description.
Match All
Show Source
Nested Schema : totalCost
No description.
Match All
Show Source
Nested Schema : totalDistance
No description.
Match All
Show Source
Nested Schema : totalShipmentTimeSecs
No description.
Match All
Show Source
Nested Schema : totalVolume
No description.
Match All
Show Source
Nested Schema : totalVolumeCapacity
No description.
Match All
Show Source
Nested Schema : totalWeight
No description.
Match All
Show Source
Nested Schema : totalWeightCapacity
No description.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : bulkPlans.partitions.byModes
Type: object
Show Source
Nested Schema : totalCost
No description.
Match All
Show Source
Nested Schema : totalDistance
No description.
Match All
Show Source
Nested Schema : totalShipmentTimeSecs
No description.
Match All
Show Source
Nested Schema : totalVolume
No description.
Match All
Show Source
Nested Schema : totalVolumeCapacity
No description.
Match All
Show Source
Nested Schema : totalWeight
No description.
Match All
Show Source
Nested Schema : totalWeightCapacity
No description.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : bulkPlans.partitions.serviceProviders
Type: object
Show Source
Nested Schema : totalCost
No description.
Match All
Show Source
Nested Schema : totalDistance
No description.
Match All
Show Source
Nested Schema : totalShipmentTimeSecs
No description.
Match All
Show Source
Nested Schema : totalVolume
No description.
Match All
Show Source
Nested Schema : totalVolumeCapacity
No description.
Match All
Show Source
Nested Schema : totalWeight
No description.
Match All
Show Source
Nested Schema : totalWeightCapacity
No description.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : bulkPlans.serviceProviders
Type: object
Show Source
Nested Schema : totalCost
No description.
Match All
Show Source
Nested Schema : totalDistance
No description.
Match All
Show Source
Nested Schema : totalShipmentTimeSecs
No description.
Match All
Show Source
Nested Schema : totalVolume
No description.
Match All
Show Source
Nested Schema : totalVolumeCapacity
No description.
Match All
Show Source
Nested Schema : totalWeight
No description.
Match All
Show Source
Nested Schema : totalWeightCapacity
No description.
Match All
Show Source
Back to Top