Get Informational Costs
get
/shipmentNoSSUs/{shipmentGid}/informationalCosts
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 : shipmentNoSSUs.informationalCosts
Type:
Show Source
object
-
cost:
cost
The cost amount.
-
detail: string
Generated text that details the calculation of the cost.
-
details:
details
-
domainName: string
Database domain where this data is stored.
-
infCostType: string
Type of informational cost. O = Original, D = Display
-
links: array
links
Read Only:
true
-
remarks:
remarks
-
shipmentInfCostQualGid: string
The shipment informational cost qualifier GID for this cost.
-
shipmentInfCostSeqno: number
(int64)
The shipment informational cost sequence number.
Nested Schema : details
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 : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency
Nested Schema : shipmentNoSSUs.informationalCosts.details
Type:
Show Source
object
-
accessorialCodeGid: string
The accessorial code identifier associated to the cost record if it was calculated from the rate accessorial.
-
accessorialCostGid: string
The accessorial cost identifier associated to the cost record if it was calculated from the rate accessorial.
-
adjustmentReasonGid: string
An adjustment reason code GID that categorizes the cost element as an adjustment and the type.
-
cost:
cost
The cost value. Examples are base and accessorial.
-
costType: string
The cost type for this shipment cost record.
-
detailSeqno: number
(int64)
The detail sequence number (key).
-
domainName: string
Database domain where this data is stored.
-
generalLedgerGid: string
The general ledger GID associated with the cost element and sent to financial systems.
-
isCostFixed: boolean
A Y/N indicator defining the cost element as permanent and not to recalculate it based on shipment modifications.
-
links: array
links
Read Only:
true
-
processAsFlowThru: boolean
A Y/N indicator defining the cost element as a flow through cost when sent to the financial systems.
-
rateGeoCostGroupGid: string
The rate detail cost group identifier that was used in calculating this cost value.
-
rateGeoCostSeq: number
(int64)
The rate detail cost sequence that was used in calculating this cost value.
-
specialServiceGid: string
The special service identifier associated to the cost record if it was calculated from a special service.
Nested Schema : shipmentNoSSUs.informationalCosts.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The remark qualifier identifier defining the remark code.
-
remarkSeq: number
(int64)
The remark sequence number (key).
-
remarkText: string
The text associated to the remark code.