1. REST API for Oracle Fusion Cloud SCMREST API for Oracle Fusion Cloud SCM
  2. Use Cases
  3. Order Management
  4. Release Hold on Large Volume of Sales Orders

Release Hold on Large Volume of Sales Orders

Oracle Order Management Fusion Cloud provides the ability to release hold on large volume of sales orders using a REST API.

You can use REST API to request for releasing order hold on multiple sales orders and get the status of the request that's submitted to release order hold. For example, required details like bill-to customer, address, customer PO attachment, contacts, have been verified on the orders by an order entry clerk or order manager. After the verification, administrative hold on these orders is released by the order manager so they can be shipped.

Here's a typical application processing flow for the scenario:

  1. In this example, you have a list of Header IDs of the orders that are on hold. You want to release hold on these orders. You can use the GET service of Sales Orders for Order Hub resource to get the Header IDs of the order numbers from which you want to release order hold. Alternatively, as described in the Submit Large Volume of Sales Order use case, you can also use filter criteria to release hold on the orders.
  2. You send a request payload using Sales Order Action Requests REST API to release order hold on the list of Header IDs.
  3. The response payload includes details of the batch process that's submitted to release order hold on the Header IDs. As this is an offline process, so the immediate response is always shown as the “PRE_PROCESSING’.
  4. You can get the summarized status of the release order hold request by calling the GET service of the Sales Order Action Requests REST API for the request.
  5. The GET service of the Sales Order Action Requests REST API for the request also provides the unique request identifiers that are spawned for each Header ID that you request to release hold. You can get the status of release hold on the order and error or warning details if any for each order using the request identifier of each Header ID.

In this example, there are three Header IDs submitted to release order hold. Two result in success and one in error.

Create One Sales Action Request

Use this resource URL format.

POST

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 Request

Here's an example of the request body in JSON format. You plan to release hold on three sales orders with Header IDs 300100608313927, 300100608314069, and 300100608314211. Specify ActionCode: ORA_FOM_RELEASE_ORDER_HOLD and HoldCode: ADMINISTRATIVE_HOLD and EXPORT_CHECK_HOLD to indicate that the sales order action request is to release the ADMINISTRATIVE_HOLD and EXPORT_CHECK_HOLD holds on all the three orders. You can specify comma separated HoldCode to release multiple holds on the orders in a request as illustrated in this example. You can also specify ReleaseReasonCode and Comments, if needed. If you must send a ReleaseReasonCode, then set the RequireReasonCodeFlag to true else it's optional for you to send a ReleaseReasonCode. The HeaderId attribute carries the unique identifier of the sales order for releasing the order hold.

{
    "ActionCode":"ORA_FOM_RELEASE_ORDER_HOLD",
    "HoldCode": "ADMINISTRATIVE_HOLD,EXPORT_CHECK_HOLD",
    "Comments": "Administrative check completed for domestic and export orders",
    "ReleaseReasonCode": "ADMINISTRATIVE_CHECK_COMPLETE",
    "RequireReasonCodeFlag": true,

    "requests": [
        {
            "HeaderId": 300100608313927
        },
        {
            "HeaderId": 300100608314069
        },
        {
            "HeaderId": 300100608314211
        }
    ]
}

Example Response

  • You can see one master request and three child action requests to release hold on three sales orders with Header IDs mentioned in the request payload. The master ActionRequestId is 300100608322602. The master action request spawned three child requests to handle processing of three individual Header IDs:
    • ActionRequestId 300100608322607 for HeaderId 300100608313927
    • ActionRequestId 300100608322608 for HeaderId 300100608314069
    • ActionRequestId 300100608322609 for HeaderId 300100608314211

The hold is released on the orders through a batch process, hence the response shows StatusCode as PRE_PROCESSING and ProcessStatus as IN_QUEUE as the batch process is yet to start processing.

Note:

  • TotalRecords: 3
  • TotalFailed: 0
  • TotalPassed: 0

Here's an example of the response body in JSON format.

{
    "ActionCode": "ORA_FOM_RELEASE_ORDER_HOLD",
    "ActionRequestId": 300100608322602,
    "ActionRequestTrackingId": 320716,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2024-04-26T15:42:10.004+00:00",
    "FulfillLineId": null,
    "HeaderId": -1,
    "LastUpdateDate": "2024-04-26T15:42:10.304+00:00",
    "MassActionFlag": true,
    "OutcomeCode": null,
    "StatusCode": "PRE_PROCESSING",
    "Action": null,
    "ProcessId": 214485,
    "TotalRecords": 3,
    "TotalFailed": 0,
    "TotalPassed": 0,
    "ProcessStatus": "IN_QUEUE",
    "FilterCriteria": null,
    "Comments": "Administrative check completed for domestic and export orders",
    "CancelReasonCode": null,
    "HoldCode": "ADMINISTRATIVE_HOLD,EXPORT_CHECK_HOLD",
    "ReleaseReasonCode": "ADMINISTRATIVE_CHECK_COMPLETE",
    "RequireReasonCodeFlag": "true",
    "requests": [
        {
            "ActionCode": "ORA_FOM_RELEASE_ORDER_HOLD",
            "ActionRequestId": 300100608322607,
            "ActionRequestTrackingId": 320716,
            "FulfillLineId": null,
            "HeaderId": 300100608313927,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322607",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322607",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322607/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322607/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322607/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_RELEASE_ORDER_HOLD",
            "ActionRequestId": 300100608322608,
            "ActionRequestTrackingId": 320716,
            "FulfillLineId": null,
            "HeaderId": 300100608314069,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322608",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322608",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322608/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322608/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322608/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_RELEASE_ORDER_HOLD",
            "ActionRequestId": 300100608322609,
            "ActionRequestTrackingId": 320716,
            "FulfillLineId": null,
            "HeaderId": 300100608314211,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322609",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322609",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322609/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322609/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322609/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602",
            "name": "salesOrderActionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602",
            "name": "salesOrderActionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests",
            "name": "requests",
            "kind": "collection"
        }
    ]
}

GET One Sales Order Action Request

Use this resource URL format.

GET

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

For example:

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

Example Response

You can review the summarized status of the release order hold request.

StatusCode indicates the status of the release order hold request for all the Header IDs or orders. It can be COMPLETE, PRE_PROCESSING, or PROCESSING. Unless the StatusCode is COMPLETE, request is still being processed. Keep checking the status until the StatusCode is marked as COMPLETE. OutcomeCode indicates the outcome of the release order hold request. It's set to SUCCESS, if hold is released on all the orders successfully, otherwise it's set to ERROR. In this example, notice that StatusCode is COMPLETE and OutcomeCode is ERROR. This means the release order hold request has been processed for all the orders, and hold is not released on at least one order.

Note:

  • TotalRecords: 3
  • TotalFailed: 1
  • TotalPassed: 2

ProcessStatus indicates the combined status of StatusCode and OutcomeCode. COMPLETED_WITH_ERRORS indicates that release order hold request is processed for all the orders but there are errors.

Here's an example of the response body in JSON format.

{
    "ActionCode": "ORA_FOM_RELEASE_ORDER_HOLD",
    "ActionRequestId": 300100608322602,
    "ActionRequestTrackingId": 320716,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2024-04-26T15:42:10.004+00:00",
    "FulfillLineId": null,
    "HeaderId": -1,
    "LastUpdateDate": "2024-04-26T15:42:10.304+00:00",
    "MassActionFlag": true,
    "OutcomeCode": "ERROR",
    "StatusCode": "COMPLETE",
    "Action": "Release Order Hold",
    "ProcessId": 214485,
    "TotalRecords": 3,
    "TotalFailed": 1,
    "TotalPassed": 2,
    "ProcessStatus": "COMPLETED_WITH_ERRORS",
    "FilterCriteria": null,
    "Comments": "Administrative check completed for domestic and export orders",
    "CancelReasonCode": null,
    "HoldCode": "ADMINISTRATIVE_HOLD,EXPORT_CHECK_HOLD",
    "ReleaseReasonCode": "ADMINISTRATIVE_CHECK_COMPLETE",
    "RequireReasonCodeFlag": "true",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602",
            "name": "salesOrderActionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602",
            "name": "salesOrderActionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests",
            "name": "requests",
            "kind": "collection"
        }
    ]
}

GET All Requests

Use this resource URL format.

GET

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

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests"

Example Response

If your release order hold request has completed with errors, then you can review the status of the release order hold request for each order along with the error or warning details.

StatusCode indicates the status of the release order hold request for each Header ID or order. It can be COMPLETE, PRE_PROCESSING, or PROCESSING. Unless the StatusCode is COMPLETE, request is still being processed for the order. Keep checking the status until the StatusCode is marked as COMPLETE. OutcomeCode indicates the outcome of the release order hold request for each order. It's set to SUCCESS, if hold is released on the order successfully, otherwise it's set to ERROR.

  • You can see that for the HeaderId 300100608313927 and 300100608314211 associated with ActionRequestId 300100608322607 and 300100608322609 respectively, StatusCode = COMPLETE and OutcomeCode = SUCCESS, which means hold was released successfully on these orders.
  • For the HeaderId 300100608314069 associated with ActionRequestId 300100608322608, StatusCode = COMPLETE and OutcomeCode = ERROR. This means the request is completed but hold hasn't been released on the order. You see that the SummaryMessageText = "The selected holds don't exist on the Order level or were already released, so no hold was released. (FOM-4515739) Details: Select a hold that's applied on the Order level but not yet released, then apply Release Hold action to release the hold.". This indicates that the ADMINISTRATIVE_HOLD and EXPORT_CHECK_HOLD holds that were selected to release aren't an active hold on the order, hence no hold was released on the

Here's an example of the response body in JSON format.

{
    "items": [
        {
            "ActionCode": "ORA_FOM_RELEASE_ORDER_HOLD",
            "ActionRequestId": 300100608322607,
            "ActionRequestTrackingId": 320716,
            "FulfillLineId": null,
            "HeaderId": 300100608313927,
            "MassActionFlag": false,
            "OutcomeCode": "SUCCESS",
            "StatusCode": "COMPLETE",
            "SummaryMessageText": null,
            "RequestStatus": "COMPLETED",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322607",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322607",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322607/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322607/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322607/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_RELEASE_ORDER_HOLD",
            "ActionRequestId": 300100608322608,
            "ActionRequestTrackingId": 320716,
            "FulfillLineId": null,
            "HeaderId": 300100608314069,
            "MassActionFlag": false,
            "OutcomeCode": "ERROR",
            "StatusCode": "COMPLETE",
            "SummaryMessageText": "The selected holds don't exist on the Order level or were already released, so no hold was released. (FOM-4515739) Details: Select a hold that's applied on the Order level but not yet released, then apply Release Hold action to release the hold.",
            "RequestStatus": "FAILED",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322608",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322608",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322608/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322608/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322608/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_RELEASE_ORDER_HOLD",
            "ActionRequestId": 300100608322609,
            "ActionRequestTrackingId": 320716,
            "FulfillLineId": null,
            "HeaderId": 300100608314211,
            "MassActionFlag": false,
            "OutcomeCode": "SUCCESS",
            "StatusCode": "COMPLETE",
            "SummaryMessageText": null,
            "RequestStatus": "COMPLETED",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322609",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322609",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322609/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322609/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322609/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 3,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests",
            "name": "requests",
            "kind": "collection"
        }
    ]
}

GET Details of All Messages for an Action Request

Use this resource URL format.

GET

curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/ActionRequestId/child/requests/ActionRequestId2/child/messageDetails"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322608/child/messageDetails"

Example Response

If your release order hold request for an order has completed with one or more errors, then you can get the details of all the errors logged for the order. You can see here that one message with MessageId 300100608318973 has been logged for the ActionRequestId 300100608322608 that contains Header ID 300100608314069. The MessageType indicates that the message is of type ERROR, MessageText contains the error message for the MessageId, LastUpdateDate shows when the error message was logged, EntityType ORDER indicates that the error message is logged on the order.

Here's an example of the response body in JSON format.

{
    "items": [
        {
            "MessageId": 300100608318973,
            "ActionRequestId": 300100608322608,
            "MessageType": "ERROR",
            "MessageText": "The selected holds don't exist on the Order level or were already released, so no hold was released. (FOM-4515739) Details: Select a hold that's applied on the Order level but not yet released, then apply Release Hold action to release the hold.",
            "LastUpdateDate": "2024-04-26T15:42:30.265+00:00",
            "EntityType": "ORDER",
            "EntityDisplayNumber": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322608/child/messageDetails/300100608318973",
                    "name": "messageDetails",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322608/child/messageDetails/300100608318973",
                    "name": "messageDetails",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322608",
                    "name": "requests",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608322602/child/requests/300100608322608/child/messageDetails",
            "name": "messageDetails",
            "kind": "collection"
        }
    ]
}