Update one customer details for an order
/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/billToCustomer/{AddressId}
Request
-
AddressId(required): integer(int64)
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=
-
OrderKey(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=
-
Metadata-Context: string
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: string
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.
- application/json
object-
AccountNumber: string
Maximum Length:
255Number of the customer account who's legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party. -
Address1: string
Maximum Length:
255First line of the bill-to customer address. -
Address2: string
Maximum Length:
255Second line of the bill-to customer address. -
Address3: string
Maximum Length:
255Third line of the bill-to customer address. -
Address4: string
Maximum Length:
255Fourth line of the bill-to customer address. -
City: string
Maximum Length:
255City of the bill-to customer address. -
ContactFirstName: string
Maximum Length:
255First name of the person to contact at the bill-to customer site. -
ContactId: integer
(int64)
Value that uniquely identifies the contact for the billing account.
-
ContactLastName: string
Maximum Length:
255Last name of the person to contact at the bill-to customer site. -
ContactMiddleName: string
Maximum Length:
255Middle name of the person to contact at the bill-to customer site. -
ContactName: string
Maximum Length:
255Person to contact at the bill-to customer site. -
ContactNameSuffix: string
Maximum Length:
255Name suffix of the person to contact at the bill-to customer site. -
ContactNumber: string
Maximum Length:
255Phone number of the person to contact at the bill-to customer site. -
ContactTitle: string
Maximum Length:
255Title of the person to contact at the bill-to customer site. -
Country: string
Maximum Length:
255Country of the bill-to customer address. -
County: string
Maximum Length:
255County of the bill-to customer address. -
CustomerAccountId: integer
(int64)
Value that uniquely identifies the account that's legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.
-
PartyName: string
Maximum Length:
255Name of the party who's legally responsible for payment. -
PersonFirstName: string
Maximum Length:
255If a person is legally responsible for payment, then this attribute contains the first name of the person. -
PersonLastName: string
Maximum Length:
255If a person is legally responsible for payment, then this attribute contains the last name of the person. -
PersonMiddleName: string
Maximum Length:
255If a person is legally responsible for payment, then this attribute contains the middle name of the person. -
PersonNameSuffix: string
Maximum Length:
255If a person is legally responsible for payment, then this attribute contains the name suffix of the person. -
PersonTitle: string
Maximum Length:
255If a person is legally responsible for payment, then this attribute contains the title of the person. -
PostalCode: string
Maximum Length:
255Postal code of the bill-to customer address. -
PreferredContactPointId: integer
(int64)
Value that uniquely identifies the email for the preferred contact point for the contact at the account who's responsible for payment.
-
Province: string
Maximum Length:
255Province of the bill-to customer address. -
SiteUseId: integer
(int64)
Value that uniquely identifies the account site that's legally responsible for payment.
-
SourceAddressId: string
Maximum Length:
255Value that uniquely identifies the bill-to customer address. Value is 1. -
State: string
Maximum Length:
255State of the bill-to customer address.
Response
- application/json
Default Response
-
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.
object-
AccountNumber: string
Maximum Length:
255Number of the customer account who's legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party. -
Address1: string
Maximum Length:
255First line of the bill-to customer address. -
Address2: string
Maximum Length:
255Second line of the bill-to customer address. -
Address3: string
Maximum Length:
255Third line of the bill-to customer address. -
Address4: string
Maximum Length:
255Fourth line of the bill-to customer address. -
AddressId: integer
(int64)
Read Only:
trueValue that uniquely identifies the bill-to customer address. -
City: string
Maximum Length:
255City of the bill-to customer address. -
ContactFirstName: string
Maximum Length:
255First name of the person to contact at the bill-to customer site. -
ContactId: integer
(int64)
Value that uniquely identifies the contact for the billing account.
-
ContactLastName: string
Maximum Length:
255Last name of the person to contact at the bill-to customer site. -
ContactMiddleName: string
Maximum Length:
255Middle name of the person to contact at the bill-to customer site. -
ContactName: string
Maximum Length:
255Person to contact at the bill-to customer site. -
ContactNameSuffix: string
Maximum Length:
255Name suffix of the person to contact at the bill-to customer site. -
ContactNumber: string
Maximum Length:
255Phone number of the person to contact at the bill-to customer site. -
ContactTitle: string
Maximum Length:
255Title of the person to contact at the bill-to customer site. -
Country: string
Maximum Length:
255Country of the bill-to customer address. -
County: string
Maximum Length:
255County of the bill-to customer address. -
CustomerAccountId: integer
(int64)
Value that uniquely identifies the account that's legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PartyName: string
Maximum Length:
255Name of the party who's legally responsible for payment. -
PersonFirstName: string
Maximum Length:
255If a person is legally responsible for payment, then this attribute contains the first name of the person. -
PersonLastName: string
Maximum Length:
255If a person is legally responsible for payment, then this attribute contains the last name of the person. -
PersonMiddleName: string
Maximum Length:
255If a person is legally responsible for payment, then this attribute contains the middle name of the person. -
PersonNameSuffix: string
Maximum Length:
255If a person is legally responsible for payment, then this attribute contains the name suffix of the person. -
PersonTitle: string
Maximum Length:
255If a person is legally responsible for payment, then this attribute contains the title of the person. -
PostalCode: string
Maximum Length:
255Postal code of the bill-to customer address. -
PreferredContactPointId: integer
(int64)
Value that uniquely identifies the email for the preferred contact point for the contact at the account who's responsible for payment.
-
Province: string
Maximum Length:
255Province of the bill-to customer address. -
SiteUseId: integer
(int64)
Value that uniquely identifies the account site that's legally responsible for payment.
-
SourceAddressId: string
Maximum Length:
255Value that uniquely identifies the bill-to customer address. Value is 1. -
State: string
Maximum Length:
255State of the bill-to customer address.
arrayLinksobject-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to update one customer details for an order.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/OrderKey/child/billToCustomer/AddressId"
For example, use the following command:
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Std_Item_03/child/billToCustomer/300100185804709"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
You can achieve the same result with Create sales orders using the upsert-mode header parameter. Refer to the examples in the Create sales orders section to see how to update child resource in the existing order.
{
"PartyName":"Computer Service and Rentals",
"AccountNumber":"1006",
"Address1":"301 Summit Hill Drive",
"City":"CHATTANOOGA",
"State":"TN",
"PostalCode":"37401",
"County":"Hamilton",
"Province":null,
"Country":"US",
"ContactName":"Evelyn Dunbar",
"ContactFirstName":"Evelyn",
"ContactLastName":"Dunbar",
"SourceAddressId":1
}
Example Response Body
The following example includes the contents of the response body in JSON format:
{
}