1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Sales Orders

Update a quote

patch

/crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}

Request

Path Parameters
Header Parameters
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Sales Orders Active Version
Type: array
Title: Sales Orders Active Version
The sales orders active versions resource lists all active sales order versions.
Show Source
Nested Schema : Quote and Order Lines
Type: array
Title: Quote and Order Lines
The quote and order lines resource is used to view, create, update, and delete a sales order line. It contains details of order lines like product, quote name, and other revenue related data.
Show Source
Nested Schema : Quote Rollups
Type: array
Title: Quote Rollups
The quote rollups resource is used to view quote rollup information.
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : salesOrders-SalesOrderActiveVersionVA-item-patch-request
Type: object
Show Source
Nested Schema : salesOrders-SalesOrderLine-item-patch-request
Type: object
Show Source
Nested Schema : salesOrders-SalesOrderRollup-item-patch-request
Type: object
Show Source
Nested Schema : salesOrders-smartActions-item-patch-request
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : salesOrders-smartActions-UserActionNavigation-item-patch-request
Type: object
Show Source
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : salesOrders-smartActions-UserActionRequestPayload-item-patch-request
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : salesOrders-smartActions-UserActionURLBinding-item-patch-request
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : salesOrders-item-response
Type: object
Show Source
Nested Schema : Sales Orders Active Version
Type: array
Title: Sales Orders Active Version
The sales orders active versions resource lists all active sales order versions.
Show Source
Nested Schema : Quote and Order Lines
Type: array
Title: Quote and Order Lines
The quote and order lines resource is used to view, create, update, and delete a sales order line. It contains details of order lines like product, quote name, and other revenue related data.
Show Source
Nested Schema : Quote Rollups
Type: array
Title: Quote Rollups
The quote rollups resource is used to view quote rollup information.
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : salesOrders-SalesOrderActiveVersionVA-item-response
Type: object
Show Source
Nested Schema : salesOrders-SalesOrderLine-item-response
Type: object
Show Source
Nested Schema : salesOrders-SalesOrderRollup-item-response
Type: object
Show Source
Nested Schema : salesOrders-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Indicates whether the action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function for smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    Indicates whether the action is seeded or custom.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique system assigned identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique system assigned smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : salesOrders-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique system assigned identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : salesOrders-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : salesOrders-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Links
OptyRenewalProcessPVO
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{RenewalProcess}%2CBindLookupType%3DORA_MOO_OPTY_RENEWAL_PROCESS
The list of values indicating the renewal process which can be manual, do not renew, or automatic renewal.

The following properties are defined on the LOV link relation:
  • Source Attribute: RenewalProcess; Target Attribute: LookupCode
  • Display Attribute: Meaning
OptyStatusZbsLookupValuesVA
Parameters:
  • finder: StatusByBUIdFinder%3BBindEnabledFlag%3DY%2CBindLookupType%3DOPTY_STATUS
The following properties are defined on the LOV link relation:
  • Source Attribute: OptyStatusCd; Target Attribute: LookupCode
  • Display Attribute: Meaning
QuoteTypeCategoryPVO
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{QuoteTypeCategory}%2CBindLookupType%3DORA_MOO_OPPORTUNITY_TYPE
The list of values indicating the different types of quotes such as new, renewal, and expansion.

The following properties are defined on the LOV link relation:
  • Source Attribute: QuoteTypeCategory; Target Attribute: LookupCode
  • Display Attribute: Meaning
SalesOrderActiveVersionVA
Parameters:
  • OrderHeaderId: $request.path.OrderHeaderId
The sales orders active versions resource lists all active sales order versions.
SalesOrderLine
Parameters:
  • OrderHeaderId: $request.path.OrderHeaderId
The quote and order lines resource is used to view, create, update, and delete a sales order line. It contains details of order lines like product, quote name, and other revenue related data.
SalesOrderRollup
Parameters:
  • OrderHeaderId: $request.path.OrderHeaderId
The quote rollups resource is used to view quote rollup information.
StatusLookupPVO
Parameters:
  • finder: LookupTypeIsEnabledFinder%3BBindLookupType%3DORA_ZCA_SO_STATUS
The list of values indicating the status of the sales order, such as Created, Cancelled etc.

The following properties are defined on the LOV link relation:
  • Source Attribute: Status; Target Attribute: LookupCode
  • Display Attribute: Meaning
WinStatusLOV
Parameters:
  • finder: LookupTypeFinder%3BBindLookupType%3DORA_ZCA_WIN_STATUS
The list of values indicating the overall status of a quote or sales order, such as Won and In progress.

The following properties are defined on the LOV link relation:
  • Source Attribute: WinStatusCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
YesNoLookupPVO
Parameters:
  • finder: LookupTypeFinder%3BBindLookupType%3DYES_NO
The list of values indicating whether the sales order is active or not, having values true and false.

The following properties are defined on the LOV link relation:
  • Source Attribute: ActiveVersionFlag; Target Attribute: LookupCode
  • Display Attribute: Meaning
smartActions
Parameters:
  • OrderHeaderId: $request.path.OrderHeaderId
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Back to Top

Examples

The following example shows how to update a quote by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesOrders/300100090895614s

Example of Request Body

The following shows an example of the request body in JSON format.

{
   "Status": "Completed"
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
"CurrencyCode": "USD",
"ExpirationDate": null,
"ExternalReferenceNumber": null,
"LastOptySyncDate": "2014-04-20T10:00:00-07:00",
"LastUpdateDate": "2016-12-19T23:33:06-08:00",
"Name": "DP_WS_AutoRuna4052376911",
"OptyId": 999997817606460,
"OrderHeaderId": 300100090895614,
"OrderTotal": 3500,
"ProposalExistFlag": true,
"SoldContactPartyId": null,
"SoldCustomerPartyId": 999997550844629,
"SoldPartySiteId": null,
"VersionNumber": 1,
"Owner": null,
"Description": "Description of order by name:DP_WS_AutoRuna4052376911",
"ExternalSystemReferenceCode": null,
"Status": "Completed",
"WinStatusCode": "ZCA_IN_PROGRESS",
"PlacedOnDate": null,
"CrmConversionRate": 1,
"SalesAccountId": 999997550844629,
...
}
Back to Top