Get Tenders
get
/shipments/{shipmentGid}/tenders
Request
Path Parameters
-
shipmentGid(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 : shipments.tenders
Type:
Show Source
object
-
deliveryTime:
deliveryTime
No description.
-
destinationLocation: string
A unique identifier to define the locations withing GC3. The gid contains the domain portion.
-
domainName: string
No description.
-
expectedResponse:
expectedResponse
No description.
-
expectedRespUpdated: boolean
Determines whether the expected response for the tender is updated.
-
isStepTender: string
No description.
-
isTenderCount: boolean
No description.
-
iTransactionNo: number
(int64)
No description.
-
links: array
links
Read Only:
true
-
marketCost:
marketCost
Market cost based on the shipment.
-
originalPickupTime:
originalPickupTime
No description.
-
originLocation: string
A unique identifier to define the locations withing GC3. The gid contains the domain portion.
-
plannedCost:
plannedCost
Copied planning cost from shipment.
-
processControlRequestId: number
(int64)
No description.
-
rateGeoGid: string
References the rate record that that is associated with the tender.
-
shipmentTime:
shipmentTime
No description.
-
stepResponseTime:
stepResponseTime
No description.
-
stepResponseTimeBase: number
(int64)
No description.
-
stepResponseTimeUomCode: string
No description.
-
stepTenderPcrId: number
(int64)
No description.
-
tenderType: string
Defines the type of tender. Values are 'Ordinary', 'Broadcast Tender', and 'Spot Bid'
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 : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount