Create one order preference
post
/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHubRequests/{OrderKey}/child/orderPreferences
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.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CreateCustomerInformationFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the application creates the customer related information even if the customer, site, or contacts don't exist in the customer model while creating the order. If false, then the application doesn't create the customer related information if there is no matching customer, site, or contact and order validation will fail. The default value is false. -
SubmitFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the application validates and submits the sales order. If false, then the application doesn't validate and submit and the sales order is in the draft status. The default value is false.
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-orderPreferences-item-response
Type:
Show Source
object
-
CreateCustomerInformationFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the application creates the customer related information even if the customer, site, or contacts don't exist in the customer model while creating the order. If false, then the application doesn't create the customer related information if there is no matching customer, site, or contact and order validation will fail. The default value is false. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SubmitFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the application validates and submits the sales order. If false, then the application doesn't validate and submit and the sales order is in the draft status. The default value is false.
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.