Get Involved Parties
get
/shipmentNoSSUs/{shipmentGid}/involvedParties
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.involvedParties
Type:
Show Source
object
-
comMethodGid: string
The communication ,method for the involved party listed on the shipment.
-
domainName: string
Database domain where this data is stored.
-
involvedPartyContactGid: string
The involved party contact for the qualifier listed on the shipment.
-
involvedPartyQualGid: string
The involved party qualifier identifier.
-
links: array
links
Read Only:
true
-
overrideAddresses:
overrideAddresses
-
overrideCity: string
The location city that is to be used for this involved party on a shipment in place of (overridden) the one on the location table.
-
overrideCountryCode3Gid: string
The location country code that is to be used for this involved party on a shipment in place of (overridden) the one on the location table
-
overrideLocationName: string
The location name that is to be used for this involved party on a shipment in place of (overridden) the one on the location table.
-
overridePostalCode: string
The location postal code that is to be used for this involved party on a shipment in place of (overridden) the one on the location table
-
overrideProvince: string
The location providence that is to be used for this involved party on a shipment in place of (overridden) the one on the location table
-
overrideProvinceCode: string
The location providence code that is to be used for this involved party on a shipment in place of (overridden) the one on the location table
Nested Schema : overrideAddresses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipmentNoSSUs.involvedParties.overrideAddresses
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
lineSequence: number
(int64)
The line sequence (key) for the involved party on the shipment.
-
links: array
links
Read Only:
true
-
overrideAddressLine: string
The address line that is to be used for this involved party on a shipment in place (Overridden) of the one on the contact table for the involved party.