Get Shipments
get
/quotes/{quoteGid}/costOptions/{costOptionSequence}/shipments
Request
Path Parameters
-
costOptionSequence(required): string
Resource ID
-
quoteGid(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 : quotes.costOptions.shipments
Type:
Show Source
object
-
actualCost:
actualCost
Actual cost.
-
costs:
costs
-
destinationAddressLine1: string
Destination location address line 1 value.
-
destinationAddressLine2: string
Destination location address line 2 value.
-
destinationAddressLine3: string
Destination location address line 3 value.
-
destinationCity: string
Destination location city value.
-
destinationCountryCode3Gid: string
Destination Location country code value.
-
destinationPostalCode: string
Destination location postal code value.
-
destinationProvince: string
Destination location province value.
-
destLocationGid: string
The GID for the Destination location.
-
destLocationName: string
Destination location name.
-
destViaLocationGid: string
The GID for the destination via location.
-
distance:
distance
Distance.
-
domainName: string
Database domain where this data is stored.
-
endTime:
endTime
The Start Time and End Time fields specify when the shipment must leave and arrive by.
-
flightGid: string
The GID for the flight that must be used.
-
isPrimary: boolean
The Primary check box is used to specify if this is the primary leg of the shipment.
-
links: array
links
Read Only:
true
-
nfrcRuleGid: string
The NFRC rule used to create this shipment if it is an NFRC and was created by the system.
-
perspective: string
Perspective - Buy or Sell.
-
rateExpiration:
rateExpiration
Expiration data of the rate.
-
rateFromLocationGid: string
The GID for the rating from location.
-
rateGeoGid: string
The GID for the rate record that should be used. This rates the cost option leg for the given rate record.
-
rateOfferingGid: string
The GID for the rate offering that should be used.
-
rateToLocationGid: string
The GID for the rating to location.
-
servprovGid: string
The GID for the service provider that should be used.
-
shipmentSequence: number
(int32)
Internal sequence number for shipment information provide as part of the quote option.
-
shipmentTypeGid: string
Indicates the shipment type for this quote cost option shipment.
-
sourceAddressLine1: string
Source location address line 1 value.
-
sourceAddressLine2: string
Source location address line 2 value.
-
sourceAddressLine3: string
Source location address line 3 value.
-
sourceCity: string
Source location city value.
-
sourceCountryCode3Gid: string
Source Location country code value.
-
sourceLocationGid: string
The GID for the source location.
-
sourceLocationName: string
Source location name.
-
sourcePostalCode: string
Source location postal code value.
-
sourceProvince: string
Source location province value.
-
sourceViaLocationGid: string
The GID for the source via location.
-
startTime:
startTime
The Start Time and End Time fields specify when the shipment must leave and arrive by.
-
transportModeGid: string
The GID for the transport mode that should be used.
-
voyageGid: string
The GID for the voyage that must be used.
Nested Schema : costs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : endTime
The Start Time and End Time fields specify when the shipment must leave and arrive by.
Match All
Show Source
Nested Schema : startTime
The Start Time and End Time fields specify when the shipment must leave and arrive by.
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 : quotes.costOptions.shipments.costs
Type:
Show Source
object
-
accessorialCodeGid: string
The GID for the accessorial cost (if any) on the quote cost option.
-
cost:
cost
Cost.
-
costExplanation: string
Explanation for cost.
-
costSequence: number
(int32)
Cost sequence number for different cost provided for the quote cost option.
-
costType: string
Cost type - e.g., Base Cost, Accessorial etc.
-
description: string
Description.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
paymentMethodCodeGid: string
Indicates the payment method that applies to this quote shipment cost.
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