Apply Hold on Large Volume of Sales Order Lines Across Orders

Oracle Order Management Fusion Cloud provides the ability to apply hold on large volume of sales order lines using a REST API. You can apply hold on the fulfillment line entity, you can't apply hold on the order line entity.

You can use a REST API to request for applying hold on multiple sales order lines, that's fulfillment lines across orders, and get the status of the request that's submitted to apply line hold. For example, there is an issue with a specific lot of the Item AS54888 that requires further review of the batch before processing the order lines. The quality check hold is applied by the order manager on the open orders lines with item AS54888 to stop further processing till a complete review is done for the stock to find out the defective lot.

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

  1. In this example, you have a list of Fulfill Line IDs across orders that you want to hold. You can use the GET service of Sales Orders for Order Hub resource to get the Fulfill Line IDs of the lines that you want to hold. Alternatively, as described in the Submit Large Volume of Sales Order use case, you can also use filter criteria to apply hold on the lines.
  2. You send a request payload using Sales Order Action Requests REST API to apply hold on the list of Fulfill Line IDs.
  3. The response payload includes details of the batch process that's submitted to apply hold on the Fulfill Line 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 apply line 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 Fulfill Line ID that you request to apply hold. You can get the status of hold application on the line and error or warning details if any for each line using the request identifier of each Fulfill Line ID.

In this example, there are three Fulfill Line IDs submitted to apply 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 apply hold on three fulfillment lines with Fulfill Line IDs 300100608313952, 300100608314073, and 300100608314213. Specify ActionCode: ORA_FOM_APPLY_LINE_HOLD and HoldCode: QUALITY_CHECK_HOLD to indicate that the sales order action request is to apply the QUALITY_CHECK_HOLD hold on all the three fulfillment lines. You can specify only one HoldCode in a request. You can also specify Comments if needed. The FulfillLineId attribute carries the unique identifier of the order line for applying the line hold. You can apply hold on the fulfillment line entity, you can't apply hold on the order line entity.

{
    "ActionCode": "ORA_FOM_APPLY_LINE_HOLD",
    "HoldCode": "QUALITY_CHECK_HOLD", 
    "Comments": "Item Lot Requires Quality Check",
    "requests": [
        {
            "FulfillLineId": 300100608313952
        },
        {
            "FulfillLineId": 300100608314073
        },
        {
            "FulfillLineId": 300100608314213
        }
    ]
}

Example Response

  • You can see one master request and three child action requests to apply hold on three lines with Fulfill line IDs mentioned in the request payload. The master ActionRequestId is 300100611832170. The master action request spawned three child requests to handle processing of three individual Fulfill line IDs:
    • ActionRequestId 300100611832173 for FulfillLineID 300100608313952
    • ActionRequestId 300100611832174 for FulfillLineID 300100608314073
    • ActionRequestId 300100611832175 for FulfillLineID 300100608314213
  • The hold is applied on the lines 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 the following:
    • TotalRecords: 3
    • TotalFailed: 0
    • TotalPassed: 0

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

{
    "ActionCode": "ORA_FOM_APPLY_LINE_HOLD",
    "ActionRequestId": 300100611832170,
    "ActionRequestTrackingId": 331038,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2024-04-29T09:01:09.002+00:00",
    "FulfillLineId": null,
    "HeaderId": -1,
    "LastUpdateDate": "2024-04-29T09:01:09.264+00:00",
    "MassActionFlag": true,
    "OutcomeCode": null,
    "StatusCode": "PRE_PROCESSING",
    "Action": null,
    "ProcessId": 312634,
    "TotalRecords": 3,
    "TotalFailed": 0,
    "TotalPassed": 0,
    "ProcessStatus": "IN_QUEUE",
    "FilterCriteria": null,
    "Comments": "Item Lot Requires Quality Check",
    "CancelReasonCode": null,
    "HoldCode": "QUALITY_CHECK_HOLD",
    "ReleaseReasonCode": null,
    "RequireReasonCodeFlag": null,
    "requests": [
        {
            "ActionCode": "ORA_FOM_APPLY_LINE_HOLD",
            "ActionRequestId": 300100611832173,
            "ActionRequestTrackingId": 331038,
            "FulfillLineId": 300100608313952,
            "HeaderId": 300100608313927,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832173",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832173",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832173/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832173/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832173/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_APPLY_LINE_HOLD",
            "ActionRequestId": 300100611832174,
            "ActionRequestTrackingId": 331038,
            "FulfillLineId": 300100608314073,
            "HeaderId": 300100608314069,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832174",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832174",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832174/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832174/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832174/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_APPLY_LINE_HOLD",
            "ActionRequestId": 300100611832175,
            "ActionRequestTrackingId": 331038,
            "FulfillLineId": 300100608314213,
            "HeaderId": 300100608314211,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832175",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832175",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832175/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832175/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832175/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170",
            "name": "salesOrderActionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170",
            "name": "salesOrderActionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/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/300100611832170"

Example Response

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

StatusCode indicates the status of the apply line hold request for all the Fulfill line IDs. 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 apply line hold request. It's set to SUCCESS, if hold is applied on all the lines successfully, otherwise it's set to ERROR. In this example, notice that StatusCode is COMPLETE and OutcomeCode is ERROR. This means the apply line hold request has been processed for all the lines, and hold is not applied on at least one line.

Note:

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

ProcessStatus indicates the combined status of StatusCode and OutcomeCode. COMPLETED_WITH_ERRORS indicates that apply line hold request is processed for all the lines but there are errors.

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

{
    "ActionCode": "ORA_FOM_APPLY_LINE_HOLD",
    "ActionRequestId": 300100611832170,
    "ActionRequestTrackingId": 331038,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2024-04-29T09:01:09.002+00:00",
    "FulfillLineId": null,
    "HeaderId": -1,
    "LastUpdateDate": "2024-04-29T09:01:09.264+00:00",
    "MassActionFlag": true,
    "OutcomeCode": "ERROR",
    "StatusCode": "COMPLETE",
    "Action": "Apply Line Hold",
    "ProcessId": 312634,
    "TotalRecords": 3,
    "TotalFailed": 1,
    "TotalPassed": 2,
    "ProcessStatus": "COMPLETED_WITH_ERRORS",
    "FilterCriteria": null,
    "Comments": "Item Lot Requires Quality Check",
    "CancelReasonCode": null,
    "HoldCode": null,
    "ReleaseReasonCode": null,
    "RequireReasonCodeFlag": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170",
            "name": "salesOrderActionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170",
            "name": "salesOrderActionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/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/300100611832170/child/requests"

Example Response

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

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

  • You can see that for the FulfillLineId 300100608313952 and 300100608314213 associated with ActionRequestId 300100611832173 and 300100611832175 respectively, StatusCode = COMPLETE and OutcomeCode = SUCCESS, which means hold was applied successfully on these lines.
  • For the FulfillLineId 300100608314073 associated with ActionRequestId 300100611832174, StatusCode = COMPLETE and OutcomeCode = ERROR. This means the request is completed but hold hasn't been applied on the line. You see that the SummaryMessageText = "You can't apply the QUALITY_CHECK_HOLD hold because order management is currently processing the order line. (FOM-4515574) Details: Try again in a few minutes.". This indicates that the line is already being processed by an action, hence hold wasn't applied on the line. You can try again after sometime when the processing is completed on the line.

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

{
    "items": [
        {
            "ActionCode": "ORA_FOM_APPLY_LINE_HOLD",
            "ActionRequestId": 300100611832173,
            "ActionRequestTrackingId": 331038,
            "FulfillLineId": 300100608313952,
            "HeaderId": 300100608313927,
            "MassActionFlag": false,
            "OutcomeCode": "SUCCESS",
            "StatusCode": "COMPLETE",
            "SummaryMessageText": null,
            "RequestStatus": "COMPLETED",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832173",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832173",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832173/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832173/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832173/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_APPLY_LINE_HOLD",
            "ActionRequestId": 300100611832174,
            "ActionRequestTrackingId": 331038,
            "FulfillLineId": 300100608314073,
            "HeaderId": 300100608314069,
            "MassActionFlag": false,
            "OutcomeCode": "ERROR",
            "StatusCode": "COMPLETE",
            "SummaryMessageText": "You can't apply the QUALITY_CHECK_HOLD hold because order management is currently processing the order line. (FOM-4515574) Details: Try again in a few minutes.",
            "RequestStatus": "FAILED",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832174",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832174",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832174/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832174/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832174/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_APPLY_LINE_HOLD",
            "ActionRequestId": 300100611832175,
            "ActionRequestTrackingId": 331038,
            "FulfillLineId": 300100608314213,
            "HeaderId": 300100608314211,
            "MassActionFlag": false,
            "OutcomeCode": "SUCCESS",
            "StatusCode": "COMPLETE",
            "SummaryMessageText": null,
            "RequestStatus": "COMPLETED",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832175",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832175",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832175/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832175/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832175/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 3,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/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/300100611832170/child/requests/300100611832174/child/messageDetails"

Example Response

If your apply line hold request for a line has completed with one or more errors, then you can get the details of all the errors logged for the line. You can see here that one message with MessageId 300100611832186 has been logged for the ActionRequestId 300100611832174 that contains Fulfill LIne ID 300100608314073. 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 LINE indicates that the error message is logged on the line, and EntityDisplayNumber indicates the line number on which the error is logged.

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

{
    "items": [
        {
            "MessageId": 300100611832186,
            "ActionRequestId": 300100611832174,
            "MessageType": "ERROR",
            "MessageText": "You can't apply the QUALITY_CHECK_HOLD hold because order management is currently processing the order line. (FOM-4515574) Details: Try again in a few minutes.",
            "LastUpdateDate": "2024-04-29T09:01:27.012+00:00",
            "EntityType": "LINE",
            "EntityDisplayNumber": "2",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832174/child/messageDetails/300100611832186",
                    "name": "messageDetails",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832174/child/messageDetails/300100611832186",
                    "name": "messageDetails",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832174",
                    "name": "requests",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611832170/child/requests/300100611832174/child/messageDetails",
            "name": "messageDetails",
            "kind": "collection"
        }
    ]
}