Create one sales action request

post

/fscmRestApi/resources/11.13.18.05/salesOrderActionRequests

Request

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 : 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 : schema
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-post-request
Type: object
Show Source
Nested Schema : salesOrderActionRequests-requests-orderDetails-item-post-request
Type: object
Show Source
Nested Schema : salesOrderActionRequests-requests-orderLineDetails-item-post-request
Type: object
Show Source
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
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 saler order header.
  • Links
  • Title: Orchestration Order
    Read Only: true
    Maximum Length: 50
    Default Value: -1
    Identifer 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 saler 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
Back to Top

Examples

These examples describe how to create a sales order action request to apply different actions on multiple orders or lines.

Table -

Example Number Description
Example 1 Create a sales order action request to submit multiple orders.
Example 2 Create a sales order action request to cancel multiple orders.
Example 3 Create a sales order action request to cancel multiple order lines.
Example 4 Create a sales order action request to reprice multiple orders.

Example cURL Command

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

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/salesOrderActionRequests"

Example 1

In this example we submit sales order action requests for three sales orders.

Example 1 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. In this example we submit sales order action request for three sales orders with Header IDs 300100608434819, 300100608434932, and 300100608434934. We specify ActionCode: ORA_FOM_SUBMIT_ORDER to indicate that the sales order action request is for order submission. HeaderId attribute carries the unique identifier of the sales order to be submitted.

{
    "ActionCode": "ORA_FOM_SUBMIT_ORDER",
    "requests": [
        {
            "HeaderId": 300100608434819
        },
        {
            "HeaderId": 300100608434932
        },
        {
            "HeaderId": 300100608434934
        }
    ]
}

Example 1 Response Body

The following example includes the contents of the response body in JSON format. We can see one master request and 3 child action requests for sumitting 3 sales orders with header IDs mentioned in the request payload. The order is submitted through a batch process. The response shows StatusCode as PRE_PROCESSING and ProcessStatus as IN_QUEUE as the batch process is yet to start processing. You can use the Get operation to check the status of the sales order action request.

{
    "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": null,
    "StatusCode": "PRE_PROCESSING",
    "Action": null,
    "ProcessId": 474122,
    "TotalRecords": 3,
    "TotalFailed": 0,
    "TotalPassed": 0,
    "ProcessStatus": "IN_QUEUE",
    "FilterCriteria": null,
    "requests": [
        {
            "ActionCode": "ORA_FOM_SUBMIT_ORDER",
            "ActionRequestId": 300100608436028,
            "ActionRequestTrackingId": 427736,
            "FulfillLineId": null,
            "HeaderId": 300100608434819,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027/child/requests/300100608436028",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027/child/requests/300100608436028",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027/child/requests/300100608436028/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_SUBMIT_ORDER",
            "ActionRequestId": 300100608436029,
            "ActionRequestTrackingId": 427736,
            "FulfillLineId": null,
            "HeaderId": 300100608434932,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027/child/requests/300100608436029",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027/child/requests/300100608436029",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027/child/requests/300100608436029/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_SUBMIT_ORDER",
            "ActionRequestId": 300100608436030,
            "ActionRequestTrackingId": 427736,
            "FulfillLineId": null,
            "HeaderId": 300100608434934,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027/child/requests/300100608436030",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027/child/requests/300100608436030",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027/child/requests/300100608436030/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027",
            "name": "salesOrderActionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027",
            "name": "salesOrderActionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027/child/requests",
            "name": "requests",
            "kind": "collection"
        }
    ]
}

Example 2

This example describes how to create a sales order action request to cancel multiple orders.

Example 2 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. In this example you submit a sales order action request for three sales orders with Header IDs 300100608647565, 300100609916691, and 300100608453169. You specify ActionCode: ORA_FOM_CANCEL_ORDER to indicate that the sales order action request is for order cancellation. You can also specify CancelReasonCode and Comments, if needed. The HeaderId attribute carries the unique identifier of the sales order to be cancelled.

{
    "ActionCode": "ORA_FOM_CANCEL_ORDER",
    "CancelReasonCode": "LATE",
    "Comments": "Canceled as per customer request",
    "requests": [
        {
            "HeaderId": 300100608647565
        },
        {
            "HeaderId": 300100609916691
        },
        {
            "HeaderId": 300100608453169
        }
    ]
}

Example 2 Response Body

The following example includes the contents of the response body in JSON format. You can see one master request and three child action requests for cancelling three sales orders with header IDs mentioned in the request payload. The order is cancelled through a batch process. The response shows StatusCode as PRE_PROCESSING and ProcessStatus as IN_QUEUE as the batch process is yet to start processing. You can use the Get operation to check the status of the sales order action request. It provides you the overall status of the order cancellation request. You can also use the Get operation to check the status of the child request action requests. It provides the status of the order cancellation and the error or warning details if any for each order.

For details, see the use cases for Order Management.

{
    "ActionCode": "ORA_FOM_CANCEL_ORDER",
    "ActionRequestId": 300100609916275,
    "ActionRequestTrackingId": 347710,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2024-02-08T06:59:11.002+00:00",
    "FulfillLineId": null,
    "HeaderId": -1,
    "LastUpdateDate": "2024-02-08T06:59:11.234+00:00",
    "MassActionFlag": true,
    "OutcomeCode": null,
    "StatusCode": "PRE_PROCESSING",
    "Action": null,
    "ProcessId": 300945,
    "TotalRecords": 3,
    "TotalFailed": 0,
    "TotalPassed": 0,
    "ProcessStatus": "IN_QUEUE",
    "FilterCriteria": null,
    "Comments": "Canceled as per customer request",
    "CancelReasonCode": "LATE",
    "HoldCode": null,
    "ReleaseReasonCode": null,
    "requests": [
        {
            "ActionCode": "ORA_FOM_CANCEL_ORDER",
            "ActionRequestId": 300100609916279,
            "ActionRequestTrackingId": 347710,
            "FulfillLineId": null,
            "HeaderId": 300100608647565,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916279",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916279",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916279/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916279/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916279/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_CANCEL_ORDER",
            "ActionRequestId": 300100609916280,
            "ActionRequestTrackingId": 347710,
            "FulfillLineId": null,
            "HeaderId": 300100609916691,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916280",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916280",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916280/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916280/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916280/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_CANCEL_ORDER",
            "ActionRequestId": 300100609916281,
            "ActionRequestTrackingId": 347710,
            "FulfillLineId": null,
            "HeaderId": 300100608453169,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916281",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916281",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916281/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916281/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916281/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275",
            "name": "salesOrderActionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275",
            "name": "salesOrderActionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests",
            "name": "requests",
            "kind": "collection"
        }
    ]
}

Example 3

This example describes how to create a sales order action request to cancel multiple order lines.

Example 3 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. In this example you submit sales order action request for three fulfillment lines with Fulfill Line IDs 300100610023895, 300100610023690, and 300100610023731. You specify ActionCode: ORA_FOM_CANCEL_LINE to indicate that the sales order action request is for order line cancellation. You can also specify CancelReasonCode and Comments if needed. The FulfillLineId attribute carries the unique identifier of the sales order line to be cancelled.

 {
    "ActionCode": "ORA_FOM_CANCEL_LINE",
    "CancelReasonCode": "ORA_WRONG_ITEM",
    "Comments": "Incorrect Item ordered",
    "requests": [
        {
            "FulfillLineId": 300100610023895
        },
        {
            "FulfillLineId": 300100610023690
        },
        {
            "FulfillLineId": 300100610023731
        }
    ]
}

Example 3 Response Body

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

You can see one master request and three child action requests for cancelling three sales order lines with Fulfill Line IDs mentioned in the request payload. The order line is cancelled through a batch process. The response shows StatusCode as PRE_PROCESSING and ProcessStatus as IN_QUEUE as the batch process is yet to start processing. You can use the Get operation to check the status of the sales order action request. It provides you the overall status of the order line cancellation request. You can also use the Get operation to check the status of the child request action requests. It provides you status of the order line cancellation and the error or warning details if any for each order line.

For details, see the use cases for Order Management.

{
    "ActionCode": "ORA_FOM_CANCEL_LINE",
    "ActionRequestId": 300100610036489,
    "ActionRequestTrackingId": 349735,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2024-02-08T17:11:48.001+00:00",
    "FulfillLineId": null,
    "HeaderId": -1,
    "LastUpdateDate": "2024-02-08T17:11:48.162+00:00",
    "MassActionFlag": true,
    "OutcomeCode": null,
    "StatusCode": "PRE_PROCESSING",
    "Action": null,
    "ProcessId": 308326,
    "TotalRecords": 3,
    "TotalFailed": 0,
    "TotalPassed": 0,
    "ProcessStatus": "IN_QUEUE",
    "FilterCriteria": null,
    "Comments": "Incorrect Item ordered",
    "CancelReasonCode": "ORA_WRONG_ITEM",
    "HoldCode": null,
    "ReleaseReasonCode": null,
    "requests": [
        {
            "ActionCode": "ORA_FOM_CANCEL_LINE",
            "ActionRequestId": 300100610036493,
            "ActionRequestTrackingId": 349735,
            "FulfillLineId": 300100610023895,
            "HeaderId": 300100610023843,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036493",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036493",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036493/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036493/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036493/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_CANCEL_LINE",
            "ActionRequestId": 300100610036494,
            "ActionRequestTrackingId": 349735,
            "FulfillLineId": 300100610023690,
            "HeaderId": 300100610023665,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036494",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036494",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036494/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036494/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036494/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_CANCEL_LINE",
            "ActionRequestId": 300100610036495,
            "ActionRequestTrackingId": 349735,
            "FulfillLineId": 300100610023731,
            "HeaderId": 300100610023665,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036495",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036495",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036495/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036495/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036495/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489",
            "name": "salesOrderActionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489",
            "name": "salesOrderActionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests",
            "name": "requests",
            "kind": "collection"
        }
    ]
}

Example 4

This example describes how to create a sales order action request to reprice multiple orders.

Example 4 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. In this example you submit sales order action request for three sales orders with Header IDs 300100609979963, 300100610845045, and 300100601830766. You specify ActionCode: ORA_FOM_REPRICE_ORDER to indicate that the sales order action request is for reprice order. The HeaderId attribute carries the unique identifier of the sales order to be repriced.

{
    "ActionCode": "ORA_FOM_REPRICE_ORDER",
    "requests": [
        {
            "HeaderId": 300100609979963
        },
        {
            "HeaderId": 300100610845045
        },
        {
            "HeaderId": 300100601830766
        }
    ]
}

Example 4 Response Body

The following example includes the contents of the response body in JSON format. You can see one master request and three child action requests for repricing 3 sales orders with header IDs mentioned in the request payload. The order is repriced through a batch process. The response shows StatusCode as PRE_PROCESSING and ProcessStatus as IN_QUEUE as the batch process is yet to start processing. You can use the Get operation to check the status of the sales order action request. It provides you the overall status of the reprice order request. You can also use the Get operation to check the status of the child request action requests. It provides you status of the reprice order and the error or warning details if any for each order.

For details, see the use cases for Order Management.

{
    "ActionCode": "ORA_FOM_REPRICE_ORDER",
    "ActionRequestId": 300100610889715,
    "ActionRequestTrackingId": 353752,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2024-02-09T11:28:25.028+00:00",
    "FulfillLineId": null,
    "HeaderId": -1,
    "LastUpdateDate": "2024-02-09T11:28:25.063+00:00",
    "MassActionFlag": true,
    "OutcomeCode": null,
    "StatusCode": "PRE_PROCESSING",
    "Action": null,
    "ProcessId": 313824,
    "TotalRecords": 3,
    "TotalFailed": 0,
    "TotalPassed": 0,
    "ProcessStatus": "IN_QUEUE",
    "FilterCriteria": null,
    "Comments": null,
    "CancelReasonCode": null,
    "HoldCode": null,
    "ReleaseReasonCode": null,
    "RequireReasonCodeFlag": null,
    "requests": [
        {
            "ActionCode": "ORA_FOM_REPRICE_ORDER",
            "ActionRequestId": 300100610889716,
            "ActionRequestTrackingId": 353752,
            "FulfillLineId": null,
            "HeaderId": 300100609979963,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889716",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889716",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889716/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889716/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889716/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_REPRICE_ORDER",
            "ActionRequestId": 300100610889717,
            "ActionRequestTrackingId": 353752,
            "FulfillLineId": null,
            "HeaderId": 300100610845045,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889717",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889717",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889717/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889717/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889717/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_REPRICE_ORDER",
            "ActionRequestId": 300100610889718,
            "ActionRequestTrackingId": 353752,
            "FulfillLineId": null,
            "HeaderId": 300100601830766,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889718",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889718",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889718/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889718/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889718/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715",
            "name": "salesOrderActionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715",
            "name": "salesOrderActionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests",
            "name": "requests",
            "kind": "collection"
        }
    ]
}
Back to Top