Get Profits
get
/shippingAgentContacts/{shippingAgentContactGid}/profits
Request
Path Parameters
-
shippingAgentContactGid(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 : shippingAgentContacts.profits
Type:
Show Source
object
-
consigneeLocationProfileGid: string
No description.
-
consolTypeProfileGid: string
No description.
-
domainName: string
No description.
-
jobType: string
No description.
-
links: array
links
Read Only:
true
-
primaryLegModeProfileGid: string
No description.
-
profitSplitAmt:
profitSplitAmt
No description.
-
profitSplitPercentage: number
(double)
No description.
-
shipperLocationProfileGid: string
No description.
-
shippingAgentContProfitGid: string
No description.
-
shippingAgentContProfitXid: string
No description.
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency