Get Quotes
get
/quotes
Request
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
Type:
Show Source
object
-
attribute1: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute10: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute11: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute12: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute13: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute14: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute15: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute16: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute17: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute18: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute19: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute2: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute20: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute3: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute4: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute5: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute6: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute7: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute8: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute9: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attributeDate1:
attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate10:
attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate2:
attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate3:
attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate4:
attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate5:
attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate6:
attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate7:
attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate8:
attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate9:
attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeNumber1: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber10: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber2: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber3: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber4: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber5: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber6: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber7: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber8: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber9: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
availableByDate:
availableByDate
The date the freight will be available by if the shipment will not be available to ship until a certain date.
-
consolidationTypeGid: string
Job consolidation type to be used when determining the NFRC rules that may apply to this quote rate inquiry.
-
costOptions:
costOptions
-
deliverByDate:
deliverByDate
The date the freight must be delivered by if the shipment must be delivered by a certain date.
-
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.
-
destinationLocationGid: string
The GID for the destination location.
-
destinationLocationType: string
Type of location for the destination location - equivalent to location role. Examples would include: Port, Rail Ramp etc. This limits the location search to these specific types of locations. The default Location Type is Location Code for both the Destination and Destination.
-
destinationPostalCode: string
Destination location postal code value.
-
destinationProvince: string
Destination location province value.
-
destinationSearchValue: string
Destination rate search value.
-
documents:
documents
-
domainName: string
Database domain where this data is stored.
-
equipmentGroups:
equipmentGroups
-
expirationDate:
expirationDate
Identifies the last day the quote is valid.
-
incoTermGid: string
The GID for the Incoterm for the shipment. This can limit the itineraries considered.
-
insertDate:
insertDate
Read Only:
true
insert date -
involvedParties:
involvedParties
-
isCustomerRatesOnly: boolean
Flag to limit search to customer specific rates only.
-
isHazardous: boolean
Flag indicating if the quote is for a shipment that contains hazardous material.
-
issueDate:
issueDate
The date the quote was sent to the customer.
-
links: array
links
Read Only:
true
-
originAddressLine1: string
Origin location address line 1 value.
-
originAddressLine2: string
Origin location address line 2 value.
-
originAddressLine3: string
Origin location address line 3 value.
-
originCity: string
Origin location city value.
-
originCountryCode3Gid: string
Origin location country code value.
-
originLocationGid: string
The GID for the origin/source location.
-
originLocationType: string
Type of location for the source location - equivalent to location role. Examples would include: Port, Rail Ramp etc. This limits the location search to these specific types of locations. The default Location Type is Location Code for both the Origin and Destination.
-
originPostalCode: string
Origin location postal code value.
-
originProvince: string
Origin location province value.
-
originSearchValue: string
Origin rate search value.
-
perspective: string
Perspective - buy or sell side.
-
quoteGid: string
The GID for the quote.
-
quoteOption: string
Select Optimize, Equipment Groups, or Equipment Configuration.
Optimize returns quotes that match the search criteria. This is the default setting.
Equipment Groups limit the search to specific Equipment Groups. When you select this option, an Equipment Group field appears where you can enter or search for an Equipment Group. Use the Save button to enter multiple Equipment Groups.
Equipment Configuration works like the Equipment Groups option, but it provides you with a field to enter the number of Equipment Groups you require. -
quoteXid: string
The XID for the quote.
-
refnums:
refnums
-
remarks:
remarks
-
requestDate:
requestDate
The date that you received the request for the quote from the customer. If you leave this field blank, it defaults to the date that the quote is created.
-
servprovGid: string
The GID for the service provider for the quote. Enter the service provider that you want to use for the master leg of the shipment. The values available in this field match what is defined in the Service Provider Manager.
-
shipUnits:
shipUnits
-
statuses:
statuses
-
texts:
texts
-
transportModeGid: string
The GID for the transport mode to for the quote. Select the mode that you want the master leg of the shipment to be transported on. The values in this drop-down list match the Transport Modes defined in Power Data.
-
updateDate:
updateDate
Read Only:
true
update date -
viaDestinationLocationGid: string
Job consolidation type to be used when determining the NFRC rules that may apply to this quote rate inquiry.
-
viaOriginLocationGid: string
If applicable, the GID for the origin via location.
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 : attributeDate2
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 : availableByDate
The date the freight will be available by if the shipment will not be available to ship until a certain date.
Match All
Show Source
Nested Schema : costOptions
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : deliverByDate
The date the freight must be delivered by if the shipment must be delivered by a certain date.
Match All
Show Source
Nested Schema : documents
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : equipmentGroups
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : requestDate
The date that you received the request for the quote from the customer. If you leave this field blank, it defaults to the date that the quote is created.
Match All
Show Source
Nested Schema : shipUnits
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : statuses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : texts
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : quotes.costOptions
Type:
Show Source
object
-
buyItineraryGid: string
Database base amount for total non-transport costs for sell side of this quote option.
-
buyNonTransCost:
buyNonTransCost
Total non-transport costs for buy side of this quote option.
-
buyTransCost:
buyTransCost
Total non-transport costs for buy side of this quote option.
-
costOptionSequence: number
(int32)
Option Number: Each possible cost option is assigned an Option Number.
-
domainName: string
Database domain where this data is stored.
-
equipments:
equipments
-
isFeasibleBuy: boolean
Currency for total non-transport costs for sell side of this quote option.
-
isFeasibleSell: boolean
Indicates if the buy side option is feasible.
-
isLateBuy: boolean
Total non-transport costs for sell side of this quote option.
-
isLateSell: boolean
Indicates if the buy side option is late.
-
links: array
links
Read Only:
true
-
remarks:
remarks
-
sellItineraryGid: string
Itinerary used for the buy side option.
-
sellNonTransCost:
sellNonTransCost
Total non-transport costs for sell side of this quote option.
-
sellTransCost:
sellTransCost
Total buy side transport cost for this quote option
-
shipments:
shipments
Nested Schema : buyNonTransCost
Total non-transport costs for buy side of this quote option.
Match All
Show Source
Nested Schema : buyTransCost
Total non-transport costs for buy side of this quote option.
Match All
Show Source
Nested Schema : equipments
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : sellNonTransCost
Total non-transport costs for sell side of this quote option.
Match All
Show Source
Nested Schema : sellTransCost
Total buy side transport cost for this quote option
Match All
Show Source
Nested Schema : shipments
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
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.equipments
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
equipmentGroupCount: number
(int32)
Count for the equipment group assigned to the cost option.
-
equipmentGroupGid: string
The GID for the equipment group for this option.
-
links: array
links
Read Only:
true
Nested Schema : quotes.costOptions.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The GID for the remark qualifier.
-
remarkSequence: number
(int32)
Internal sequence number for the remark.
-
remarkText: string
Remark text related to the remark qualifier.
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 : 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 : quotes.documents
Type:
Show Source
object
-
contentManagementSystemGid: string
No description.
-
documentCmsId: string
A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
-
documentDefGid: string
No description.
-
documentFilename: string
No description.
-
documentGid: string
No description.
-
documentMimeType: string
No description.
-
documentTrackingNum: string
No description.
-
documentType: string
No description.
-
documentUrl: string
No description.
-
documentXid: string
No description.
-
domainName: string
No description.
-
effectiveDate:
effectiveDate
represents effective date for a document
-
expirationDate:
expirationDate
Represents expiration date for a document.
-
generatedAt:
generatedAt
If preparation, date/time content was last generated
-
links: array
links
Read Only:
true
-
ownerDataQueryTypeGid: string
No description.
- relatedDocumentGid: string
-
reportGid: string
The report associated with the document attachment, if content was generated by the report subsystem.
-
uploadedAt:
uploadedAt
If attachment, date/time content was last updated
-
usedAs: string
Represents the classification of a document.(C/I/L/T)
-
userDefined1IconGid: string
No description.
-
userDefined2IconGid: string
No description.
-
userDefined3IconGid: string
No description.
-
userDefined4IconGid: string
No description.
-
userDefined5IconGid: string
No description.
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
Show Source
Nested Schema : quotes.equipmentGroups
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
equipmentGroupCount: number
(int64)
Count for the equipment group assigned to the cost option.
-
equipmentGroupGid: string
The GID for the equipment group for this option.
-
links: array
links
Read Only:
true
Nested Schema : quotes.involvedParties
Type:
Show Source
object
-
comMethodGid: string
Communication method.
-
domainName: string
Database domain where this data is stored.
-
involvedPartyContactGid: string
Involved party related to the qualifier.
-
involvedPartyQualGid: string
The GID for the involved party qualifier.
-
links: array
links
Read Only:
true
Nested Schema : quotes.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
quoteRefnumQualGid: string
The GID for the reference number qualifier.
-
quoteRefnumValue: string
Reference number value related to the reference number qualifier.
Nested Schema : quotes.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualifierGid: string
A qualifier for the remark.
-
remarkSequence: number
(int64)
The sequence to keep remarks unique. It allows multiple of the same qualifier.
-
remarkText: string
The text of the remark.
Nested Schema : quotes.shipUnits
Type:
Show Source
object
-
commodityGid: string
The unique identifier for the commodity.
-
commodityType: string
The type of commodity.
-
declaredValue:
declaredValue
Declared value.
-
domainName: string
Database domain where this data is stored.
-
exportHtsGid: string
The unique identifier for the export Harmonized Tariff System (HTS).
-
height:
height
Height.
-
htsGid: string
The GID for the Harmonized Tariff Schedule (HTS). Not used by OTM - all cross border compliance related classifications are handled by GTM.
-
iataScrCodeGid: string
n/a
-
isSplitable: boolean
Flag to indicate if the quantity for this item is splittable.
-
itemGid: string
The GID for the item.
-
length:
length
Length.
-
links: array
links
Read Only:
true
-
nmfcClassGid: string
The GID for the National Motor Freight Classification (NMFC). The NMFC is a critical piece of information used for rating Less-Than-Truckload shipments in North America. If you intend to rate shipments using RATEWAREXL or RATEWAREXL WITH CARRIERCONNECT it's important that the NMFC class information entered is a standard NMFC freight class - for example, 50, 55, 60, 65, 70, 77.5 etc.
-
sequence: number
(int32)
Sequence number for the ship unit.
-
shipUnitCount: number
(int32)
Count of transport handling units.
-
sitcGid: string
The GID for the Standard International Trade Classification (SITC) is a classification of goods used to classify the exports and imports of a country to enable comparing different countries and years. The classification system is maintained by the United Nations. Not used by OTM - all cross border compliance related classifications are handled by GTM.
-
stccGid: string
The GID for the Standard Transportation Commodity Code (STCC).
-
transportHandlingUnitGid: string
The GID for the transport handling unit.
-
udcClassificationListGid: string
The GID for the user defined commodity code list.
-
userDefinedCommodityGid: string
The GID for the user defined commodity code.
-
volume:
volume
Volume.
-
weight:
weight
Weight.
-
width:
width
Width.
Nested Schema : quotes.statuses
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
statusTypeGid: string
The GID for the status type.
-
statusValueGid: string
Value of status type
Nested Schema : quotes.texts
Type:
Show Source
object
-
documentDefGid: string
Document that should hold text.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
textOverride: string
Transactional override for the template on the specific document.
-
textTemplateGid: string
The GID for text template. A Text Template is a predefined, formatted selection of text that is identified by an Oracle Transportation Management business object. Use text templates to attach a short paragraph of text to a document, XML transmission, or notification (via XSL stylesheet).