1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Order Management
  4. Sales Order Action Requests

Get one sales order action request

get

/fscmRestApi/resources/11.13.18.05/salesOrderActionRequests/{ActionRequestId}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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.

There's no request body for this operation.

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 : salesOrderActionRequests-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 255
    Value attribute for the action such as Submit Order, Cancel Order, Reprice Order, or Cancel Line.
  • Maximum Length: 30
    Code such as ORA_FOM_SUBMIT_ORDER to identify the action.
  • Unique identifier for the master action request.
  • Identifier to track action requests.
  • Code to indicate the reason for the cancelation.
  • Contains user comments for the cancelation.
  • Read Only: true
    Maximum Length: 64
    User who created the action request.
  • Read Only: true
    Date on which action request is created.
  • Maximum Length: 255
    Abbreviation that identifies the demand class. A list of accepted values is defined in the lookup ORA_DOO_DEMAND_CLASS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
  • Contains the filter criterion of the sales orders to be submitted for the Select All action. This criterion is used to get the sales order numbers as specific sales order numbers are not sent by the application.
  • Unique identifier for fulfillment line.
  • Unique identifier for the sales order header.
  • Abbreviation that identifies the hold.
  • Read Only: true
    Date on which action request was last updated.
  • Links
  • Maximum Length: 1
    Default Value: false
    Indicates that the action is a mass action.
  • Maximum Length: 255
    Comments that detail the reason for revising the sales order.
  • Maximum Length: 255
    Abbreviation that identifies the reason to revise the sales order. A list of accepted values is defined in the lookup DOO_CHANGE_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Order Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
  • Maximum Length: 30
    Code to indicate the outcome of the master action request. It can be SUCCESS or ERROR.
  • Maximum Length: 255
    Contains one of the following values: true or false. If true, then the user can manually override the scheduled date. If false, then the user can't override it. The default value is false.
  • Read Only: true
    Unique identifier for the process to initiate the process in the request resource.
  • Read Only: true
    Maximum Length: 255
    Status of the process initiated by the action request to process the action such as COMPLETED, IN_QUEUE, IN_PROGRESS, or COMPLETED_WITH_ERRORS.
  • Reason for releasing the hold.
  • Value that uniquely identifies the organization that fulfills the item. If the item is shippable, then this value references the warehouse that ships the item. A contract or an agreement is an example of an item that isn't shippable.
  • Requests
    Title: Requests
    The request executes the action performed on the sales order. It's a child of the action request.
  • Contains one of the following values: true or false. If true, then you must send a reason code. If false, then it's optional for you to send a reason code. The default value is false.
  • Date when the application scheduled the shipment to arrive.
  • Date when the application scheduled the shipment to ship.
  • Value that uniquely identifies the carrier that delivered the item.
  • Maximum Length: 255
    Abbreviation that identifies the mode of shipping that delivers the shipment. A list of accepted values is defined in the lookup WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
  • Maximum Length: 255
    Abbreviation that identifies the shipping level of service to use to deliver the shipment. A list of accepted values is defined in the lookup WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
  • Maximum Length: 30
    Default Value: PRE_PROCESSING
    Code to indicate the status of the master action request such as COMPLETE, PRE_PROCESSING, or PROCESSING.
  • Value that uniquely identifies the supplier for the purchase order.
  • Value that uniquely identifies the supplier site for the purchase order.
  • Read Only: true
    Total number of records failed to process by the action request.
  • Read Only: true
    Total number of records successfully processed by the action request.
  • Read Only: true
    Total number of records processed by the action request.
Nested Schema : Requests
Type: array
Title: Requests
The request executes the action performed on the sales order. It's a child of the action request.
Show Source
Nested Schema : salesOrderActionRequests-requests-item-response
Type: object
Show Source
Nested Schema : Message Details
Type: array
Title: Message Details
The Message Details resource fetches the details of the messages logged for the action request.
Show Source
Nested Schema : Order Details
Type: array
Title: Order Details
Order Details resource fetches the order details of the sales order processed by the request.
Show Source
Nested Schema : Order Line Details
Type: array
Title: Order Line Details
The Order Line Details resource fetches the order line details of the sales order processed by the request.
Show Source
Nested Schema : salesOrderActionRequests-requests-messageDetails-item-response
Type: object
Show Source
Nested Schema : salesOrderActionRequests-requests-orderDetails-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 255
    Sold-to party name of the customer on the sales order.
  • Read Only: true
    Maximum Length: 30
    Identifies the interface using which the order was captured such as OrderImport, REST_salesOrdersForOrderHub, REST_omSalesOrders, or UI.
  • Title: Purchase Order
    Read Only: true
    Maximum Length: 50
    Customer purchase order of the sales order processed by the action request.
  • Read Only: true
    Unique identifier for the sales order header.
  • Links
  • Title: Orchestration Order
    Read Only: true
    Maximum Length: 50
    Default Value: -1
    Identifier of the sales order number.
  • Read Only: true
    Value that identifies the revision number of the order.
  • Read Only: true
    Unique identifier of the sold-to party on the sales order.
  • Title: Source Order
    Read Only: true
    Maximum Length: 50
    Unique identifier for the sales order in the source system.
  • Read Only: true
    Maximum Length: 255
    Status of the sales order.
  • Read Only: true
    Maximum Length: 30
    Default Value: OPEN
    Code to identify the status of the sales order such as DRAFT, PROCESSING, or CLOSED.
Nested Schema : salesOrderActionRequests-requests-orderLineDetails-item-response
Type: object
Show Source
Links
requests
Parameters:
  • ActionRequestId: $request.path.ActionRequestId
The request executes the action performed on the sales order. It's a child of the action request.
Back to Top

Examples

This example describes how to get details of one master action request.

We can see the details of the master action request ID 300100608436027. ActionCode denotes that the request is for the order submission. This master request displays TotalRecords 3, TotalFailed 2 and TotalPassed 1, indicating that it processed 3 child requests out of which 2 failed and one has passed.

StatusCode displays that the process has completed and OutcomeCode denotes that some child action requests may be in ERROR. Based on this the ProcessStatus indicates the status of the master action request is set as COMPLETED WITH ERRORS.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/ActionRequestId"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "ActionCode": "ORA_FOM_SUBMIT_ORDER",
    "ActionRequestId": 300100608436027,
    "ActionRequestTrackingId": 427736,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2023-10-20T06:19:28.001+00:00",
    "FulfillLineId": null,
    "HeaderId": -1,
    "LastUpdateDate": "2023-10-20T06:19:28.102+00:00",
    "MassActionFlag": true,
    "OutcomeCode": "ERROR",
    "StatusCode": "COMPLETE",
    "Action": "Submit Order",
    "ProcessId": 474122,
    "TotalRecords": 3,
    "TotalFailed": 2,
    "TotalPassed": 1,
    "ProcessStatus": "COMPLETED_WITH_ERRORS",
    "FilterCriteria": null
}
Back to Top