Update Large Volume of Sales Order Lines Across Orders

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

You can use a REST resource to request update of the attribute values on multiple sales order lines across orders and get the status of the request that's submitted for update. For example, few high value customers placed urgent orders. However, the requested items are not available in the warehouse on the requested date. The order manager works with the warehouse manager to prioritise these orders, and then overrides the schedules dates on these orders to schedule and ship them 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 update with a new value for some of the attributes. 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 update. 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 update.
  2. You send a request payload using Sales Order Action Requests REST resource to update the new value of the attributes on the list of Fulfill Line IDs.
  3. The response payload includes details of the batch process that's submitted to update 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 update 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 update. You can get the status of update 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 update a new value of four attributes on them. The update on the two Fulfill Line IDs results 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 submit a sales order action request for three fulfillment lines with Fulfill Line IDs 300100615865777, 300100615865893, and 300100619008728. Specify ActionCode ORA_FOM_UPDATE_LINE and the values for OverrideScheduleDateFlag, ScheduleShipDate, ScheduleArrivalDate, and DemandClassCode attributes to indicate that the sales order action request is to update the new value of these attributes on all the three fulfillment lines. You can specify a new value for any attribute that's enabled for the ORA_FOM_UPDATE_LINE action to update. If you want to remove the value of an attribute on a fulfillment line, then set the attribute value to null. You can also specify OrderRevisionReasonCode and OrderRevisionComments, if needed. The FulfillLineId attribute carries the unique identifier of the lines to be updated.

{
    "ActionCode": "ORA_FOM_UPDATE_LINE",
    "OverrideScheduleDateFlag": true,
    "ScheduleArrivalDate": "2024-08-23T20:49:12+00:00",
    "ScheduleShipDate": "2024-08-20T20:49:12+00:00",
    "DemandClassCode": "East-GOP",
    "OrderRevisionReasonCode": "ORA_CUST_REQUEST",
    "OrderRevisionComments": "Schedule change requested by customer.",
    "requests": [
        {
            "FulfillLineId": 300100615865777
        },
        {
            "FulfillLineId": 300100615865893
        },
        {
            "FulfillLineId": 300100619008728
        }
    ]
}

Example Response

  • You can see one master request and three child action requests to update three Fulfill Line IDs mentioned in the request payload. The master ActionRequestId is 300100619048861. The master action request spawned three child requests to handle processing of three individual Fulfill Line IDs:
    • ActionRequestId 300100619048868 for FulfillLineId 300100615865777
    • ActionRequestId 300100619048869 for FulfillLineId 300100615865893
    • ActionRequestId 300100619048870 for FulfillLineId 300100619008728

The order lines are updated through a batch process, so the response shows StatusCode as PRE_PROCESSING and ProcessStatus as IN_QUEUE as 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_UPDATE_LINE",
    "ActionRequestId": 300100619048861,
    "ActionRequestTrackingId": 312708,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2024-07-30T17:02:03.001+00:00",
    "FulfillLineId": null,
    "HeaderId": -1,
    "LastUpdateDate": "2024-07-30T17:02:03.460+00:00",
    "MassActionFlag": true,
    "OutcomeCode": null,
    "StatusCode": "PRE_PROCESSING",
    "Action": null,
    "ProcessId": 209700,
    "TotalRecords": 3,
    "TotalFailed": 0,
    "TotalPassed": 0,
    "ProcessStatus": "IN_QUEUE",
    "FilterCriteria": null,
    "Comments": null,
    "CancelReasonCode": null,
    "HoldCode": null,
    "ReleaseReasonCode": null,
    "RequireReasonCodeFlag": null,
    "OverrideScheduleDateFlag": "true",
    "ShippingModeCode": null,
    "SupplierSiteId": null,
    "SupplierId": null,
    "RequestedFulfillmentOrganizationId": null,
    "ShippingCarrierId": null,
    "ShippingServiceLevelCode": null,
    "ScheduleShipDate": "2024-08-20T20:49:12+00:00",
    "ScheduleArrivalDate": "2024-08-23T20:49:12+00:00",
    "DemandClassCode": "East-GOP",
    "OrderRevisionReasonCode": "ORA_CUST_REQUEST",
    "OrderRevisionComments": "Schedule change requested by customer.",
    "requests": [
        {
            "ActionCode": "ORA_FOM_UPDATE_LINE",
            "ActionRequestId": 300100619048868,
            "ActionRequestTrackingId": 312708,
            "FulfillLineId": 300100615865777,
            "HeaderId": 300100615865752,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048868",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048868",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048868/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048868/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048868/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_UPDATE_LINE",
            "ActionRequestId": 300100619048869,
            "ActionRequestTrackingId": 312708,
            "FulfillLineId": 300100615865893,
            "HeaderId": 300100615865891,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048869",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048869",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048869/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048869/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048869/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_UPDATE_LINE",
            "ActionRequestId": 300100619048870,
            "ActionRequestTrackingId": 312708,
            "FulfillLineId": 300100619008728,
            "HeaderId": 300100619008722,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048870",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048870",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048870/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048870/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048870/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861",
            "name": "salesOrderActionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861",
            "name": "salesOrderActionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/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/300100619048861"

Example Response

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

StatusCode indicates the status of the update 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 update line request. It's set to SUCCESS if all the lines are updated successfully with the new attribute values. Otherwise it's set to ERROR. In this example, notice that StatusCode is COMPLETE and OutcomeCode is ERROR. This means the update line request has been processed for all the lines, and at least one line is not updated successfully.

Note:

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

ProcessStatus indicates the combined status of StatusCode and OutcomeCode. COMPLETED_WITH_ERRORS indicates that the update 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_UPDATE_LINE",
    "ActionRequestId": 300100619048861,
    "ActionRequestTrackingId": 312708,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2024-07-30T17:02:03.001+00:00",
    "FulfillLineId": null,
    "HeaderId": -1,
    "LastUpdateDate": "2024-07-30T17:02:03.460+00:00",
    "MassActionFlag": true,
    "OutcomeCode": "ERROR",
    "StatusCode": "COMPLETE",
    "Action": "Update Line",
    "ProcessId": 209700,
    "TotalRecords": 3,
    "TotalFailed": 1,
    "TotalPassed": 2,
    "ProcessStatus": "COMPLETED_WITH_ERRORS",
    "FilterCriteria": null,
    "Comments": null,
    "CancelReasonCode": null,
    "HoldCode": null,
    "ReleaseReasonCode": null,
    "RequireReasonCodeFlag": null,
    "OverrideScheduleDateFlag": "true",
    "ShippingModeCode": null,
    "SupplierSiteId": null,
    "SupplierId": null,
    "RequestedFulfillmentOrganizationId": null,
    "ShippingCarrierId": null,
    "ShippingServiceLevelCode": null,
    "ScheduleShipDate": "2024-08-20T20:49:12+00:00",
    "ScheduleArrivalDate": "2024-08-23T20:49:12+00:00",
    "DemandClassCode": "East-GOP",
    "OrderRevisionReasonCode": "ORA_CUST_REQUEST",
    "OrderRevisionComments": "Schedule change requested by customer.",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861",
            "name": "salesOrderActionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861",
            "name": "salesOrderActionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/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/300100619048861/child/requests"

Example Response

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

StatusCode indicates the status of the update 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 lines. Keep checking the status until the StatusCode is marked COMPLETE. OutcomeCode indicates the outcome of the update line request for each line. It's set to SUCCESS if the line is updated successfully with the new attribute values. Otherwise it's set to ERROR.

  • You can see that for the FulfillLineId 300100615865777 and 300100615865893 associated with ActionRequestId 300100619048868 and 300100619048869 respectively, StatusCode = COMPLETE and OutcomeCode = SUCCESS, which means the new attributes values are successfully updated on these lines.
  • For the FulfillLineId 300100619008728 associated with ActionRequestId 300100619048870, StatusCode = COMPLETE and OutcomeCode = ERROR. This means the request is completed but the attribute values are not updated on the line. You can see the SummaryMessageText = "The scheduled arrival date cannot be updated because the fulfillment line was fulfilled. Source Order Information: MIB_489_240730181316948-1-1". This indicates the line is already fulfilled, so the new value of the attributes weren't updated on the line.

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

{
    "items": [
        {
            "ActionCode": "ORA_FOM_UPDATE_LINE",
            "ActionRequestId": 300100619048868,
            "ActionRequestTrackingId": 312708,
            "FulfillLineId": 300100615865777,
            "HeaderId": 300100615865752,
            "MassActionFlag": false,
            "OutcomeCode": "SUCCESS",
            "StatusCode": "COMPLETE",
            "SummaryMessageText": null,
            "RequestStatus": "COMPLETED",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048868",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048868",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048868/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048868/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048868/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_UPDATE_LINE",
            "ActionRequestId": 300100619048869,
            "ActionRequestTrackingId": 312708,
            "FulfillLineId": 300100615865893,
            "HeaderId": 300100615865891,
            "MassActionFlag": false,
            "OutcomeCode": "SUCCESS",
            "StatusCode": "COMPLETE",
            "SummaryMessageText": null,
            "RequestStatus": "COMPLETED",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048869",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048869",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048869/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048869/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048869/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_UPDATE_LINE",
            "ActionRequestId": 300100619048870,
            "ActionRequestTrackingId": 312708,
            "FulfillLineId": 300100619008728,
            "HeaderId": 300100619008722,
            "MassActionFlag": false,
            "OutcomeCode": "ERROR",
            "StatusCode": "COMPLETE",
            "SummaryMessageText": "The scheduled arrival date cannot be updated because the fulfillment line was fulfilled. Source Order Information: MIB_489_240730181316948-1-1",
            "RequestStatus": "FAILED",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048870",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048870",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048870/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048870/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048870/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 3,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/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/300100619048861/child/requests/300100619048870/child/messageDetails"

Example Response

If your update 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 that one message with MessageId 300100619072458 has been logged for the ActionRequestId 300100619048870 that contains Fulfill LIne ID 300100619008728. 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": 300100619072458,
            "ActionRequestId": 300100619048870,
            "MessageType": "ERROR",
            "MessageText": "The scheduled arrival date cannot be updated because the fulfillment line was fulfilled. Source Order Information: MIB_489_240730181316948-1-1",
            "LastUpdateDate": "2024-07-30T17:02:26.016+00:00",
            "EntityType": "LINE",
            "EntityDisplayNumber": "1",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048870/child/messageDetails/300100619072458",
                    "name": "messageDetails",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048870/child/messageDetails/300100619072458",
                    "name": "messageDetails",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048870",
                    "name": "requests",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100619048861/child/requests/300100619048870/child/messageDetails",
            "name": "messageDetails",
            "kind": "collection"
        }
    ]
}