Unschedule Large Volume of Sales Order Lines Across Orders

Oracle Order Management Fusion Cloud provides the ability to unschedule large volume of sales order lines using a REST resource.

You can use a REST resource to request unscheduling of multiple sales order lines across orders and get the status of the request that's submitted for unscheduling. For example, a high priority customer requests an urgent shipment for an item but enough supply is not available for the requested items. There are several orders for other customers that are scheduled for the same item but those can be shipped a few days later. The order manager unschedules the order lines for other customers so that the order lines for the high priority customer can be scheduled and shipped on time.

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 unschedule. 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 unschedule. Alternatively, as described in the Submit Large Volume of Sales Order use case, you can use filter criteria in the Sales Order Action Requests resource to get the order lines to unschedule.
  2. You send a request payload using Sales Order Action Requests REST resource to unschedule the list of Fulfill Line IDs.
  3. The response payload includes details of the batch process that's submitted to unschedule the Fulfill Line IDs. As this is an offline process, the immediate response is always shown as PRE_PROCESSING.
  4. You can get the summarized status of the unschedule line request by calling the GET service of the Sales Order Action Requests REST resource for the request.
  5. The GET service of the Sales Order Action Requests REST resource for the request also provides the unique request identifiers that are spawned for each Fulfill Line ID that you request to unschedule. You can get the status of unscheduling 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 unschedule. 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 unschedule three fulfillment lines with Fulfill Line IDs 300100615865811, 300100615865895, and 300100615865992. Specify ActionCode ORA_FOM_UNSCHEDULE_LINE to indicate that the sales order action request is to unschedule all the three lines. The FulfillLineId attribute carries the unique identifier of the lines to be unscheduled.

{
    "ActionCode": "ORA_FOM_UNSCHEDULE_LINE",
    "requests": [
        {
            "FulfillLineId": 300100615865811
        },
        {
            "FulfillLineId": 300100615865895
        },
        {
            "FulfillLineId": 300100615865992
        }
    ]
}

Example Response

  • You can see one master request and three child action requests to unschedule three Fulfill Line IDs mentioned in the request payload. The master ActionRequestId is 300100619038592. The master action request spawned three child requests to handle processing of three individual Fulfill line IDs:
    • ActionRequestId 300100619038593 for FulfillLineID 300100615865811
    • ActionRequestId 300100619038594 for FulfillLineID 300100615865895
    • ActionRequestId 300100619038595 for FulfillLineID 300100615865992

The order lines are unscheduled through a batch process, so the response shows StatusCode as PRE_PROCESSING and ProcessStatus as IN_QUEUE because the batch process is yet to start.

Note:

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

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

{
    "ActionCode": "ORA_FOM_UNSCHEDULE_LINE",
    "ActionRequestId": 300100619038592,
    "ActionRequestTrackingId": 310773,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2024-07-30T16:13:02.007+00:00",
    "FulfillLineId": null,
    "HeaderId": -1,
    "LastUpdateDate": "2024-07-30T16:13:07.147+00:00",
    "MassActionFlag": true,
    "OutcomeCode": null,
    "StatusCode": "PRE_PROCESSING",
    "Action": null,
    "ProcessId": 209438,
    "TotalRecords": 3,
    "TotalFailed": 0,
    "TotalPassed": 0,
    "ProcessStatus": "IN_QUEUE",
    "FilterCriteria": null,
    "Comments": null,
    "CancelReasonCode": null,
    "HoldCode": null,
    "ReleaseReasonCode": null,
    "RequireReasonCodeFlag": null,
    "OverrideScheduleDateFlag": null,
    "ShippingModeCode": null,
    "SupplierSiteId": null,
    "SupplierId": null,
    "RequestedFulfillmentOrganizationId": null,
    "ShippingCarrierId": null,
    "ShippingServiceLevelCode": null,
    "ScheduleShipDate": null,
    "ScheduleArrivalDate": null,
    "DemandClassCode": null,
    "OrderRevisionReasonCode": null,
    "OrderRevisionComments": null,
    "requests": [
        {
            "ActionCode": "ORA_FOM_UNSCHEDULE_LINE",
            "ActionRequestId": 300100619038593,
            "ActionRequestTrackingId": 310773,
            "FulfillLineId": 300100615865811,
            "HeaderId": 300100615865752,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038593",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038593",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038593/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038593/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038593/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_UNSCHEDULE_LINE",
            "ActionRequestId": 300100619038594,
            "ActionRequestTrackingId": 310773,
            "FulfillLineId": 300100615865895,
            "HeaderId": 300100615865891,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038594",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038594",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038594/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038594/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038594/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_UNSCHEDULE_LINE",
            "ActionRequestId": 300100619038595,
            "ActionRequestTrackingId": 310773,
            "FulfillLineId": 300100615865992,
            "HeaderId": 300100615865990,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038595",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038595",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038595/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038595/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038595/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592",
            "name": "salesOrderActionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592",
            "name": "salesOrderActionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/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/300100619038592"

Example Response

You can review the summarized status of the unschedule line request.

StatusCode indicates the status of the unschedule line request for all the Fulfill line IDs. It can be COMPLETE, PRE_PROCESSING, or PROCESSING. Unless the StatusCode is COMPLETE, the request is still being processed. Keep checking the status until the StatusCode is marked COMPLETE. OutcomeCode indicates the outcome of the unschedule line request. It's set to SUCCESS if all the lines are unscheduled successfully. Otherwise it's set to ERROR. In this example, notice that StatusCode is COMPLETE and OutcomeCode is ERROR. This means the unschedule line request has been processed for all the lines, and at least one line is not unscheduled.

Note:

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

ProcessStatus indicates the combined status of StatusCode and OutcomeCode. COMPLETED_WITH_ERRORS indicates that unschedule line 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_UNSCHEDULE_LINE",
    "ActionRequestId": 300100619038592,
    "ActionRequestTrackingId": 310773,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2024-07-30T16:13:02.007+00:00",
    "FulfillLineId": null,
    "HeaderId": -1,
    "LastUpdateDate": "2024-07-30T16:19:09+00:00",
    "MassActionFlag": true,
    "OutcomeCode": "ERROR",
    "StatusCode": "COMPLETE",
    "Action": "Unschedule Line",
    "ProcessId": 209438,
    "TotalRecords": 3,
    "TotalFailed": 1,
    "TotalPassed": 2,
    "ProcessStatus": "COMPLETED_WITH_ERRORS",
    "FilterCriteria": null,
    "Comments": null,
    "CancelReasonCode": null,
    "HoldCode": null,
    "ReleaseReasonCode": null,
    "RequireReasonCodeFlag": null,
    "OverrideScheduleDateFlag": null,
    "ShippingModeCode": null,
    "SupplierSiteId": null,
    "SupplierId": null,
    "RequestedFulfillmentOrganizationId": null,
    "ShippingCarrierId": null,
    "ShippingServiceLevelCode": null,
    "ScheduleShipDate": null,
    "ScheduleArrivalDate": null,
    "DemandClassCode": null,
    "OrderRevisionReasonCode": null,
    "OrderRevisionComments": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592",
            "name": "salesOrderActionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592",
            "name": "salesOrderActionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/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/300100619038592/child/requests"

Example Response

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

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

  • You can see that for the FulfillLineId 300100615865811 and 300100615865895 associated with ActionRequestId 300100619038593 and 300100619038594 respectively, StatusCode = COMPLETE and OutcomeCode = SUCCESS, which means these lines were unscheduled successfully.
  • For the FulfillLineId 300100615865992 associated with ActionRequestId 300100619038595, StatusCode = COMPLETE and OutcomeCode = ERROR. This means the request is completed but the line is not scheduled. You can see that the SummaryMessageText = "Order line isn't scheduled. (FOM-4515766) Details: The orchestration process of the order line has no schedule task, or the order line isn't scheduled yet.". This indicates that the line isn't scheduled, hence it wasn't unscheduled.

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

{
    "items": [
        {
            "ActionCode": "ORA_FOM_UNSCHEDULE_LINE",
            "ActionRequestId": 300100619038593,
            "ActionRequestTrackingId": 310773,
            "FulfillLineId": 300100615865811,
            "HeaderId": 300100615865752,
            "MassActionFlag": false,
            "OutcomeCode": "SUCCESS",
            "StatusCode": "COMPLETE",
            "SummaryMessageText": null,
            "RequestStatus": "COMPLETED",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038593",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038593",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038593/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038593/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038593/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_UNSCHEDULE_LINE",
            "ActionRequestId": 300100619038594,
            "ActionRequestTrackingId": 310773,
            "FulfillLineId": 300100615865895,
            "HeaderId": 300100615865891,
            "MassActionFlag": false,
            "OutcomeCode": "SUCCESS",
            "StatusCode": "COMPLETE",
            "SummaryMessageText": null,
            "RequestStatus": "COMPLETED",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038594",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038594",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038594/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038594/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038594/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_UNSCHEDULE_LINE",
            "ActionRequestId": 300100619038595,
            "ActionRequestTrackingId": 310773,
            "FulfillLineId": 300100615865992,
            "HeaderId": 300100615865990,
            "MassActionFlag": false,
            "OutcomeCode": "ERROR",
            "StatusCode": "COMPLETE",
            "SummaryMessageText": "Order line isn't scheduled. (FOM-4515766) Details: The orchestration process of the order line has no schedule task, or the order line isn't scheduled yet.",
            "RequestStatus": "FAILED",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038595",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038595",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038595/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038595/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038595/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 3,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/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/300100619038592/child/requests/3300100619038595/child/messageDetails"

Example Response

If your unschedule line 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 300100619046595 has been logged for the ActionRequestId 300100619038595 that contains Fulfill LIne ID 300100615865992. 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": 300100619046595,
            "ActionRequestId": 300100619038595,
            "MessageType": "ERROR",
            "MessageText": "Order line isn't scheduled. (FOM-4515766) Details: The orchestration process of the order line has no schedule task, or the order line isn't scheduled yet.",
            "LastUpdateDate": "2024-07-30T16:14:28.702+00:00",
            "EntityType": "LINE",
            "EntityDisplayNumber": "1",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038595/child/messageDetails/300100619046595",
                    "name": "messageDetails",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038595/child/messageDetails/300100619046595",
                    "name": "messageDetails",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038595",
                    "name": "requests",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619038592/child/requests/300100619038595/child/messageDetails",
            "name": "messageDetails",
            "kind": "collection"
        }
    ]
}