Get Order Movements

get

/orderMovements

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 : orderMovements
Type: object
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 : documents
Type: object
Show Source
Nested Schema : earlyDeliveryDate
The earliest delivery of this order movement.
Match All
Show Source
Nested Schema : earlyPickupDate
The earliest pickup of this order movement.
Match All
Show Source
Nested Schema : expectedCost
Expected cost contains the expected cost for the leg.
Match All
Show Source
Nested Schema : expectedTransitTime
Expected transit time contains the expected time for this leg of the shipment to take.
Match All
Show Source
Nested Schema : insertDate
Read Only: true
insert date
Match All
Show Source
Nested Schema : involvedParties
Type: object
Show Source
Nested Schema : lateDeliveryDate
The latest delivery of this order movement.
Match All
Show Source
Nested Schema : latePickupDate
The latest pickup time of this order movement.
Match All
Show Source
Nested Schema : operationEarlyPickupDate
The date is calculated from upstream shipments' end time.
Match All
Show Source
Nested Schema : operationLateDeliveryDate
This date is calculated from downstream shipments' start time.
Match All
Show Source
Nested Schema : refnums
Type: object
Show Source
Nested Schema : remarks
Type: object
Show Source
Nested Schema : shipUnitDiameter
The diameter of the ship unit. This column will show value only if the order movement has one ship unit.
Match All
Show Source
Nested Schema : shipUnitHeight
The height of the ship unit. This column will show value only if the order movement has one ship unit.
Match All
Show Source
Nested Schema : shipUnitLength
The length of the ship unit. This column will show value only if the order movement has one ship unit.
Match All
Show Source
Nested Schema : shipUnitWidth
The width of the ship unit. This column will show value only if the order movement has one ship unit.
Match All
Show Source
Nested Schema : sShipUnits
Type: object
Show Source
Nested Schema : statuses
Type: object
Show Source
Nested Schema : totalVolume
The total volume for this order movement.
Match All
Show Source
Nested Schema : totalWeight
The total weight for this order movement.
Match All
Show Source
Nested Schema : updateDate
Read Only: true
update date
Match All
Show Source
Nested Schema : dateTimeType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderMovements.documents
Type: object
Show Source
Nested Schema : effectiveDate
represents effective date for a document
Match All
Show Source
Nested Schema : expirationDate
Represents expiration date for a document.
Match All
Show Source
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
Show Source
Nested Schema : uploadedAt
If attachment, date/time content was last updated
Match All
Show Source
Nested Schema : dateType
Type: object
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 : orderMovements.involvedParties
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderMovements.refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderMovements.remarks
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderMovements.sShipUnits
Type: object
Show Source
Nested Schema : accessorials
Type: object
Show Source
Nested Schema : lines
Type: object
Show Source
Nested Schema : pieces
Type: object
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 : trackingEvents
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderMovements.sShipUnits.accessorials
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderMovements.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 : items
Type: array
Show Source
Nested Schema : orderMovements.sShipUnits.lines.refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderMovements.sShipUnits.lines.remarks
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderMovements.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 : orderMovements.sShipUnits.refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderMovements.sShipUnits.remarks
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderMovements.sShipUnits.seals
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderMovements.sShipUnits.sEquipments
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderMovements.sShipUnits.specialServices
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderMovements.sShipUnits.trackingEvents
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderMovements.statuses
Type: object
Show Source
Back to Top