Create an Involved Party
post
/sellShipments/{shipmentGid}/involvedParties
Request
Path Parameters
-
shipmentGid(required): string
Resource ID
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
- application/vnd.oracle.resource+json;type=collection
Nested Schema : schema
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 : sellShipments.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.
Root Schema : schema
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 : sellShipments.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.
Response
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Root Schema : schema
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 : sellShipments.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.