Get Accessorials
get
/sellShipments/{shipmentGid}/accessorials
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 : sellShipments.accessorials
Type:
Show Source
object
-
accessorialCodeGid: string
The XID for the shipment.
-
adjustmentReasonGid: string
The reason why the accessorial was added.
-
costRefs:
costRefs
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
processAsFlowThru: boolean
The override for record to be copied to the sell side during rating.
-
remarks:
remarks
Nested Schema : costRefs
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 : sellShipments.accessorials.costRefs
Type:
Show Source
object
-
costReferenceGid: string
The cost reference GID.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
shipmentCostQualGid: string
The shipment cost qualifier GID that defines the type of cost.
Nested Schema : sellShipments.accessorials.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, which identifies the type of remark this is.
-
remarkSequence: number
(int64)
The one-up sequence for the remark, to create a unique identifier.
-
remarkText: string
The remark itself.