Get Order Releases

get

/shipments/{shipmentGid}/orderReleases

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 : shipments.orderReleases
Type: object
Show Source
Nested Schema : attributeCurrency1
The attribute currency of the shipment.
Match All
The attribute currency of the shipment.
Show Source
Nested Schema : attributeCurrency2
The attribute currency of the shipment.
Match All
The attribute currency of the shipment.
Show Source
Nested Schema : attributeCurrency3
The attribute currency of the shipment.
Match All
The attribute currency of the shipment.
Show Source
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate11
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate12
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate13
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate14
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate15
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate16
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate17
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate18
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate19
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate20
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : bestDirectCostBuy
The buy side best direct cost that was calculated if the order travels from the plan from to the plan to as a single direct order.
Match All
The buy side best direct cost that was calculated if the order travels from the plan from to the plan to as a single direct order.
Show Source
Nested Schema : bestDirectCostSell
The sell side best direct cost that was calculated if the order travels from the plan from to the plan to as a single direct order.
Match All
The sell side best direct cost that was calculated if the order travels from the plan from to the plan to as a single direct order.
Show Source
Nested Schema : earliestEstPickupDate
The earliest estimated pickup that was calculated if the order travels from the plan from to the plan to as a single estimated order.
Match All
The earliest estimated pickup that was calculated if the order travels from the plan from to the plan to as a single estimated order.
Show Source
Nested Schema : earlyDeliveryDate
The early delivery date and time defined for the order release; can be null.
Match All
The early delivery date and time defined for the order release; can be null.
Show Source
Nested Schema : earlyPickupDate
The early pickup date and time defined for the order release; can be null.
Match All
The early pickup date and time defined for the order release; can be null.
Show Source
Nested Schema : earlySailDate
No description.
Match All
No description.
Show Source
Nested Schema : importLicenseExpirationDate
The date the import license will expire.
Match All
The date the import license will expire.
Show Source
Nested Schema : importLicenseIssueDate
The import license issue date.
Match All
The import license issue date.
Show Source
Nested Schema : importLicenseReceiveDate
The import license received date.
Match All
The import license received date.
Show Source
Nested Schema : inspectionDate
The inspection actual date associated with the inspection number.
Match All
The inspection actual date associated with the inspection number.
Show Source
Nested Schema : inspectionScheduleDate
The inspection scheduled date associated with the inspection number.
Match All
The inspection scheduled date associated with the inspection number.
Show Source
Nested Schema : lateDeliveryDate
The late delivery date and time defined for the order release; can be null.
Match All
The late delivery date and time defined for the order release; can be null.
Show Source
Nested Schema : latePickupDate
The latest pickup date and time defined for the order release; can be null.
Match All
The latest pickup date and time defined for the order release; can be null.
Show Source
Nested Schema : lateSailDate
No description.
Match All
No description.
Show Source
Nested Schema : latestEstDeliveryDate
The latest estimate delivery date calculated from the last leg shipments.
Match All
The latest estimate delivery date calculated from the last leg shipments.
Show Source
Nested Schema : latestEstPickupDate
The latest estimated pickup date calculated from the first leg shipments.
Match All
The latest estimated pickup date calculated from the first leg shipments.
Show Source
Nested Schema : locAmount
The letter of credit amount.
Match All
The letter of credit amount.
Show Source
Nested Schema : locExpirationDate
The letter of credit expiration date.
Match All
The letter of credit expiration date.
Show Source
Nested Schema : locIssueDate
The letter of credit issue date.
Match All
The letter of credit issue date.
Show Source
Nested Schema : locLatestShippingDate
The letter of credit latest shipping date.
Match All
The letter of credit latest shipping date.
Show Source
Nested Schema : locReceivedDate
The letter of credit received date.
Match All
The letter of credit received date.
Show Source
Nested Schema : secondaryTVolume
The secondary total volume for the order that sums up the secondary weight values from the order release lines.
Match All
The secondary total volume for the order that sums up the secondary weight values from the order release lines.
Show Source
Nested Schema : secondaryTWeight
The secondary total weight for the order that sums up secondary weight values from the order release line.
Match All
The secondary total weight for the order that sums up secondary weight values from the order release line.
Show Source
Nested Schema : shipUnitDiameter
The diameter of the ship unit for cyclindrical objects. This column will show value only if the order release has one ship unit.
Match All
The diameter of the ship unit for cyclindrical objects. This column will show value only if the order release has one ship unit.
Show Source
Nested Schema : shipUnitHeight
The height of the ship unit. This column will show value only if the order release has one ship unit.
Match All
The height of the ship unit. This column will show value only if the order release has one ship unit.
Show Source
Nested Schema : shipUnitLength
The length of the ship unit. This column will show value only if the order release has one ship unit.
Match All
The length of the ship unit. This column will show value only if the order release has one ship unit.
Show Source
Nested Schema : shipUnitWidth
The width of the ship unit. This will show a value only if the order release has one ship unit.
Match All
The width of the ship unit. This will show a value only if the order release has one ship unit.
Show Source
Nested Schema : surveyLayCanDate
The survey lay can date for the order release.
Match All
The survey lay can date for the order release.
Show Source
Nested Schema : totalDeclaredValue
The total declared value calculated from the order release lines.
Match All
The total declared value calculated from the order release lines.
Show Source
Nested Schema : totalNetVolume
The total net volume calculated from the order release lines.
Match All
The total net volume calculated from the order release lines.
Show Source
Nested Schema : totalNetWeight
The total net weight calculated from the order release lines.
Match All
The total net weight calculated from the order release lines.
Show Source
Nested Schema : totalVolume
The total volume calculated from the order release lines.
Match All
The total volume calculated from the order release lines.
Show Source
Nested Schema : totalWeight
The total weight calculated from the order release lines.
Match All
The total weight calculated from the order release lines.
Show Source
Nested Schema : currencyType
Type: object
Show Source
Nested Schema : dateTimeType
Type: object
Show Source
Nested Schema : dateType
Type: object
Show Source
Nested Schema : amountType
Type: object
Show Source
Back to Top