Update one customer details for an order
patch
/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHubRequests/{OrderKey}/child/shipToCustomer/{shipToCustomerUniqID}
Request
Path Parameters
-
OrderKey(required): string
Value that uniquely identifies the sales order. This value is derived by concatenating the value of SourceOrderSystem, a colon, and the value of SourceOrderId. For orders created through the Oracle Order Management Cloud work area, the SourceOrderId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceOrderId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order.
-
shipToCustomerUniqID(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Address1: string
Maximum Length:
240
First line of the ship-to customer address. -
Address2: string
Maximum Length:
240
Second line of the ship-to customer address. -
Address3: string
Maximum Length:
240
Third line of the ship-to customer address. -
Address4: string
Maximum Length:
240
Fourth line of the ship-to customer address. -
AddressOrigSystemReference: string
Maximum Length:
255
Value that uniquely identifies the ship-to party address in the source application that captures the transaction. -
City: string
Maximum Length:
60
City of the ship-to customer address. -
ContactFirstName: string
Maximum Length:
150
First name of the person to contact at the ship-to party site. -
ContactId: integer
(int64)
Value that uniquely identifies the contact at the ship-to party site.
-
ContactLastName: string
Maximum Length:
150
Last name of the person to contact at the ship-to party site. -
ContactMiddleName: string
Maximum Length:
60
Middle name of the person to contact at the ship-to party site. -
ContactName: string
Maximum Length:
360
Name of the person to contact at the ship-to party site. -
ContactNameSuffix: string
Maximum Length:
30
Name suffix of the person to contact at the ship-to party site. -
ContactNumber: string
Maximum Length:
30
Telephone number of the person to contact at the ship-to party site. -
ContactOrigSystemReference: string
Maximum Length:
255
Value that uniquely identifies the ship-to party contact in the source application that captures the transaction. -
ContactTitle: string
Maximum Length:
60
Title of the person to contact at the ship-to party site. -
Country: string
Maximum Length:
60
Country of the ship-to customer address. -
County: string
Maximum Length:
60
County of the ship-to customer address. -
PartyContactEmail: string
Maximum Length:
320
Email address of the primary contact at the ship-to customer site. -
PartyId: integer
(int64)
Value that uniquely identifies the ship-to party.
-
PartyName: string
Maximum Length:
360
Name of the ship-to party. -
PartyNumber: string
Maximum Length:
30
Telephone number of the ship-to party. -
PartyOrganizationEmail: string
Maximum Length:
320
Email address of the organization at the ship-to customer site. -
PartyPersonEmail: string
Maximum Length:
320
Email address of the person to contact at the ship-to customer site. -
PartyType: string
Maximum Length:
30
Type of the ship-to party. Acceptable values are PERSON or ORGANIZATION. -
PersonFirstName: string
Maximum Length:
150
First name of the person to contact at the ship-to customer site. -
PersonLastName: string
Maximum Length:
150
Last name of the person to contact at the ship-to customer site. -
PersonMiddleName: string
Maximum Length:
60
Middle name of the person to contact at the ship-to customer site. -
PersonNameSuffix: string
Maximum Length:
30
Name suffix of the person to contact at the ship-to customer site. -
PersonTitle: string
Maximum Length:
60
Title of the person to contact at the ship-to customer site. -
PostalCode: string
Maximum Length:
60
Postal code of the ship-to customer address. -
PreferredContactPointId: integer
(int64)
Value that uniquely identifies the email for the preferred person to contact at the ship-to party site.
-
PreferredContactPointOrigSystemReference: string
Maximum Length:
240
Value that uniquely identifies the preferred contact point of the ship-to party in the source application that captures the transaction. -
Province: string
Maximum Length:
60
Province of the ship-to customer address. -
ShipToRequestRegion: string
Maximum Length:
255
Region of the ship-to party. It is used by Oracle Global Order Promising Cloud. -
SiteId: integer
(int64)
Value that uniquely identifies the ship-to customer address.
-
SourceTransactionLineId: string
Maximum Length:
50
Value that uniquely identifies the transaction line in the source application. -
SourceTransactionScheduleId: string
Maximum Length:
50
Value that uniquely identifies the schedule, shipment, or subline. The source application assigns this value. -
SourceTransactionSystem: string
Maximum Length:
30
Source application that created the order. Review and update the value for this attribute using the Manage Trading Community Source Systems, Manage Upstream and Fulfillment Source Systems tasks. -
State: string
Maximum Length:
60
State of the ship-to customer address.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : salesOrdersForOrderHubRequests-shipToCustomer-item-response
Type:
Show Source
object
-
Address1: string
Maximum Length:
240
First line of the ship-to customer address. -
Address2: string
Maximum Length:
240
Second line of the ship-to customer address. -
Address3: string
Maximum Length:
240
Third line of the ship-to customer address. -
Address4: string
Maximum Length:
240
Fourth line of the ship-to customer address. -
AddressOrigSystemReference: string
Maximum Length:
255
Value that uniquely identifies the ship-to party address in the source application that captures the transaction. -
AddressUseType: string
Maximum Length:
30
Type of address. Valid value is SHIP_TO. -
City: string
Maximum Length:
60
City of the ship-to customer address. -
ContactFirstName: string
Maximum Length:
150
First name of the person to contact at the ship-to party site. -
ContactId: integer
(int64)
Value that uniquely identifies the contact at the ship-to party site.
-
ContactLastName: string
Maximum Length:
150
Last name of the person to contact at the ship-to party site. -
ContactMiddleName: string
Maximum Length:
60
Middle name of the person to contact at the ship-to party site. -
ContactName: string
Maximum Length:
360
Name of the person to contact at the ship-to party site. -
ContactNameSuffix: string
Maximum Length:
30
Name suffix of the person to contact at the ship-to party site. -
ContactNumber: string
Maximum Length:
30
Telephone number of the person to contact at the ship-to party site. -
ContactOrigSystemReference: string
Maximum Length:
255
Value that uniquely identifies the ship-to party contact in the source application that captures the transaction. -
ContactTitle: string
Maximum Length:
60
Title of the person to contact at the ship-to party site. -
Country: string
Maximum Length:
60
Country of the ship-to customer address. -
County: string
Maximum Length:
60
County of the ship-to customer address. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyContactEmail: string
Maximum Length:
320
Email address of the primary contact at the ship-to customer site. -
PartyId: integer
(int64)
Value that uniquely identifies the ship-to party.
-
PartyName: string
Maximum Length:
360
Name of the ship-to party. -
PartyNumber: string
Maximum Length:
30
Telephone number of the ship-to party. -
PartyOrganizationEmail: string
Maximum Length:
320
Email address of the organization at the ship-to customer site. -
PartyPersonEmail: string
Maximum Length:
320
Email address of the person to contact at the ship-to customer site. -
PartyType: string
Maximum Length:
30
Type of the ship-to party. Acceptable values are PERSON or ORGANIZATION. -
PersonFirstName: string
Maximum Length:
150
First name of the person to contact at the ship-to customer site. -
PersonLastName: string
Maximum Length:
150
Last name of the person to contact at the ship-to customer site. -
PersonMiddleName: string
Maximum Length:
60
Middle name of the person to contact at the ship-to customer site. -
PersonNameSuffix: string
Maximum Length:
30
Name suffix of the person to contact at the ship-to customer site. -
PersonTitle: string
Maximum Length:
60
Title of the person to contact at the ship-to customer site. -
PostalCode: string
Maximum Length:
60
Postal code of the ship-to customer address. -
PreferredContactPointId: integer
(int64)
Value that uniquely identifies the email for the preferred person to contact at the ship-to party site.
-
PreferredContactPointOrigSystemReference: string
Maximum Length:
240
Value that uniquely identifies the preferred contact point of the ship-to party in the source application that captures the transaction. -
Province: string
Maximum Length:
60
Province of the ship-to customer address. -
ShipToRequestRegion: string
Maximum Length:
255
Region of the ship-to party. It is used by Oracle Global Order Promising Cloud. -
SiteId: integer
(int64)
Value that uniquely identifies the ship-to customer address.
-
SourceTransactionId: string
Maximum Length:
50
Value that uniquely identifies the transaction in the source application. -
SourceTransactionLineId: string
Maximum Length:
50
Value that uniquely identifies the transaction line in the source application. -
SourceTransactionScheduleId: string
Maximum Length:
50
Value that uniquely identifies the schedule, shipment, or subline. The source application assigns this value. -
SourceTransactionSystem: string
Maximum Length:
30
Source application that created the order. Review and update the value for this attribute using the Manage Trading Community Source Systems, Manage Upstream and Fulfillment Source Systems tasks. -
State: string
Maximum Length:
60
State of the ship-to customer address.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.