Inventory Staged Reservations

This topic discusses how to create, update, and delete inventory reservation interface records.

Let's discuss these scenarios briefly.

  1. Create a single reservation interface record.
  2. Create multiple reservation interface records that belong to different batches.
  3. Update a reservation quantity on a reservation interface record.
  4. Delete a reservation interface record.
  5. Retrieve reservation interface records using a search criteria.
  6. Create multiple reservation interface records that form a shipset

Create a Single Reservation Interface Record

In this scenario, the warehouse manager provides information about the Item, Organization, Demand, Supply, Process Mode Code, and so on in the request payload.

When the warehouse manager enters 1 as the process mode, the reservation interface record is created and picked up for processing.

Example URL

Use this resource URL format:

POST

 http://server/fscmRestApi/resources/version/inventoryStagedReservations

Example Request

Here's an example of the request body in JSON format:
{ 
    "ReservationBatchId":12341,
    "ReservationActionCode": "1",
    "ProcessModeCode":"1",
    "ItemNumber": "AS54888",
    "OrganizationName": "Seattle Manufacturing",
    "DemandSourceTypeName": "User Defined",
    "DemandSourceName": "REST DOCUMENTATION TESTING",
    "DemandSourceHeaderNumber": null,
    "DemandSourceLineNumber": null,
    "ReservationQuantity": 1,
    "ReservationUnitOfMeasure": "Each",
    "SupplySourceTypeName": "On hand",
    "SupplySourceHeaderNumber": null,
    "SupplySourceLineNumber": null,
    "Revision": null,
    "SubinventoryCode": "Stores",
    "Locator": null,
    "LotNumber": null,
    "SupplyProjectNumber": null,
    "SupplyTaskNumber": null,
    "ToOrganizationName": null,
    "ToDemandSourceTypeName": null,
    "ToDemandSourceName": null,
    "ToDemandSourceHeaderNumber": null,
    "ToDemandSourceLineNumber": null,
    "ToSupplySourceTypeName": null,
    "ToSupplySourceHeaderNumber": null,
    "ToSupplySourceLineNumber": null,
    "ToRevision": null,
    "ToSubinventoryCode": null,
    "ToLocator": null,
    "ToLotNumber": null,
    "ToSupplyProjectNumber": null,
    "ToSupplyTaskNumber": null,
    "RowStatusCode":"1",
    "LockCode":"2"
}

Example Response

Here's an example of the response body in JSON format:
{
    "ReservationInterfaceId": 21008,
    "ReservationBatchId": 12341,
    "ReservationActionCode": "1",
    "ProcessMode": null,
    "ProcessModeCode": "1",
    "RequirementDate": "2022-04-20",
    "ItemNumber": "AS54888",
    "InventoryItemId": null,
    "OrganizationName": "Seattle Manufacturing",
    "OrganizationCode": null,
    "OrganizationId": 207,
    "DemandSourceTypeName": "User Defined",
    "DemandSourceTypeId": null,
    "DemandSourceName": "REST DOCUMENTATION TESTING",
    "DemandSourceHeaderNumber": null,
    "DemandSourceHeaderId": null,
    "DemandSourceLineNumber": null,
    "DemandSourceLineId": null,
    "SourceFulfillmentLineId": null,
    "ReservationQuantity": 1,
    "ReservationUnitOfMeasure": "Each",
    "ReservationUOMCode": null,
    "PrimaryReservationQuantity": null,
    "PrimaryUnitOfMeasure": null,
    "PrimaryUOMCode": null,
    "SecondaryReservationQuantity": null,
    "SecondaryUnitOfMeasure": null,
    "SecondaryUOMCode": null,
    "SupplySourceTypeName": "On hand",
    "SupplySourceTypeId": null,
    "SupplySourceHeaderNumber": null,
    "SupplySourceHeaderId": null,
    "SupplySourceLineNumber": null,
    "SupplySourceLineId": null,
    "Revision": null,
    "SubinventoryCode": "Stores",
    "Locator": null,
    "LocatorId": null,
    "LotNumber": null,
    "SupplyProjectNumber": null,
    "SupplyProjectId": null,
    "SupplyTaskNumber": null,
    "SupplyTaskId": null,
    "ToOrganizationName": null,
    "ToOrganizationId": null,
    "ToDemandSourceTypeName": null,
    "ToDemandSourceTypeId": null,
    "ToDemandSourceName": null,
    "ToDemandSourceHeaderNumber": null,
    "ToDemandSourceHeaderId": null,
    "ToDemandSourceLineNumber": null,
    "ToDemandSourceLineId": null,
    "ToSupplySourceTypeName": null,
    "ToSupplySourceTypeId": null,
    "ToSupplySourceHeaderNumber": null,
    "ToSupplySourceHeaderId": null,
    "ToSupplySourceLineNumber": null,
    "ToSupplySourceLineId": null,
    "ToRevision": null,
    "ToSubinventoryCode": null,
    "ToLocator": null,
    "ToLocatorId": null,
    "ToLotNumber": null,
    "ToSupplyProjectNumber": null,
    "ToSupplyProjectId": null,
    "ToSupplyTaskNumber": null,
    "ToSupplyTaskId": null,
    "LockCode": "2",
    "RowStatusCode": "1",
    "ErrorCode": null,
    "ErrorExplanationCode": null,
    "ErrorExplanation": null,
    "links": [
        {
            "rel": "self",
            "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052100000000EACED000577080000000000003035",
            "name": "inventoryStagedReservations",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052100000000EACED000577080000000000003035",
            "name": "inventoryStagedReservations",
            "kind": "item"
        }
    ]
}

After the POST operation is successful, the warehouse manager needs to perform a GET operation using the reservation batch ID on the resource to find out the status of the processing. If it is processed successfully, no records will be found, and corresponding reservation records will be created. If it isn't processed successfully, then the records will contain error information.

Example URL

Use this resource URL format:

GET

 http://server/fscmRestApi/resources/version/inventoryStagedReservations?q=ReservationBatchId=12341

Example Response

Here's an example of the response body in JSON format:
{
    "items": [],
    "count": 0,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations",
            "name": "inventoryStagedReservations",
            "kind": "collection"
        }
    ]
}               

Create Multiple Reservation Interface Records That Belong to Different Batches

In this scenario, the warehouse manager provides information about the Item, Organization, Demand, Supply, Process Mode Code, and so on, in parts in the input payload.

Use the payload to create reservation for records that aren't in the same reservation batch, that is, for records that aren't shipped together.

Example URL

Use this resource URL format:

POST

 http://server/fscmRestApi/resources/version/

Example Request

Here's an example of the request body in JSON format:
{"parts":
[
{"id":"part1","path":"/inventoryStagedReservations","operation":"create",
    "payload":
    {"ReservationBatchId":11111,
    "ReservationActionCode": "1",
    "ProcessModeCode":"3",
    "ItemNumber": "AS54888",
    "OrganizationName": "Seattle Manufacturing",
    "DemandSourceTypeName": "User Defined",
    "DemandSourceName": "REST DOCUMENTATION TESTING",
    "DemandSourceHeaderNumber": null,
    "DemandSourceLineNumber": null,
    "ReservationQuantity": 1,
    "ReservationUnitOfMeasure": "Each",
    "SupplySourceTypeName": "On hand",
    "SupplySourceHeaderNumber": null,
    "SupplySourceLineNumber": null,
    "Revision": null,
    "SubinventoryCode": "Stores",
    "Locator": null,
    "LotNumber": null,
    "SupplyProjectNumber": null,
    "SupplyTaskNumber": null,
    "ToOrganizationName": null,
    "ToDemandSourceTypeName": null,
    "ToDemandSourceName": null,
    "ToDemandSourceHeaderNumber": null,
    "ToDemandSourceLineNumber": null,
    "ToSupplySourceTypeName": null,
    "ToSupplySourceHeaderNumber": null,
    "ToSupplySourceLineNumber": null,
    "ToRevision": null,
    "ToSubinventoryCode": null,
    "ToLocator": null,
    "ToLotNumber": null,
    "ToSupplyProjectNumber": null,
    "ToSupplyTaskNumber": null,
    "RowStatusCode":"1",
    "LockCode":"2"}},
{"id":"part2","path":"/inventoryStagedReservations","operation":"create",
    "payload":
    {"ReservationBatchId":11112,
    "ReservationActionCode": "1",
    "ProcessModeCode":"3",
    "ItemNumber": "AS54888",
    "OrganizationName": "Seattle Manufacturing",
    "DemandSourceTypeName": "Sales order",
    "DemandSourceName": null,
    "DemandSourceHeaderNumber": "HK-SO-TEST",
    "DemandSourceLineNumber": "1",
    "ReservationQuantity": 1,
    "ReservationUnitOfMeasure": "Each",
    "SupplySourceTypeName": "On hand",
    "SupplySourceHeaderNumber": null,
    "SupplySourceLineNumber": null,
    "Revision": null,
    "SubinventoryCode": null,
    "Locator": null,
    "LotNumber": null,
    "SupplyProjectNumber": null,
    "SupplyTaskNumber": null,
    "ToOrganizationName": null,
    "ToDemandSourceTypeName": null,
    "ToDemandSourceName": null,
    "ToDemandSourceHeaderNumber": null,
    "ToDemandSourceLineNumber": null,
    "ToSupplySourceTypeName": null,
    "ToSupplySourceHeaderNumber": null,
    "ToSupplySourceLineNumber": null,
    "ToRevision": null,
    "ToSubinventoryCode": null,
    "ToLocator": null,
    "ToLotNumber": null,
    "ToSupplyProjectNumber": null,
    "ToSupplyTaskNumber": null,
    "RowStatusCode":"1",
    "LockCode":"2"}},
{"id":"part3","path":"/inventoryStagedReservations","operation":"create",
    "payload":
    {"ReservationBatchId":11113,
    "ReservationActionCode": "1",
    "ProcessModeCode":"3",
    "ItemNumber": "AS54888",
    "OrganizationName": "Seattle Manufacturing",
    "DemandSourceTypeName": "Transfer order",
    "DemandSourceName": null,
    "DemandSourceHeaderNumber": "12345",
    "DemandSourceLineNumber": "1",
    "ReservationQuantity": 1,
    "ReservationUnitOfMeasure": "Each",
    "SupplySourceTypeName": "Purchase order",
    "SupplySourceHeaderNumber": "87654",
    "SupplySourceLineNumber": "1",
    "Revision": null,
    "SubinventoryCode": null,
    "Locator": null,
    "LotNumber": null,
    "SupplyProjectNumber": null,
    "SupplyTaskNumber": null,
    "ToOrganizationName": null,
    "ToDemandSourceTypeName": null,
    "ToDemandSourceName": null,
    "ToDemandSourceHeaderNumber": null,
    "ToDemandSourceLineNumber": null,
    "ToSupplySourceTypeName": null,
    "ToSupplySourceHeaderNumber": null,
    "ToSupplySourceLineNumber": null,
    "ToRevision": null,
    "ToSubinventoryCode": null,
    "ToLocator": null,
    "ToLotNumber": null,
    "ToSupplyProjectNumber": null,
    "ToSupplyTaskNumber": null,
    "RowStatusCode":"1",
    "LockCode":"2"}}
]}

Example Response

Here's an example of the response body in JSON format:
{
    "parts": [
        {
            "id": "part1",
            "path": "https://server/fscmRestApi/resources/version/inventoryStagedReservations",
            "operation": "create",
            "payload": {
                "ReservationInterfaceId": 21009,
                "ReservationBatchId": 11111,
                "ReservationActionCode": "1",
                "ProcessMode": null,
                "ProcessModeCode": null,
                "RequirementDate": "2022-04-20",
                "ItemNumber": "AS54888",
                "InventoryItemId": null,
                "OrganizationName": "Seattle Manufacturing",
                "OrganizationCode": null,
                "OrganizationId": 207,
                "DemandSourceTypeName": "User Defined",
                "DemandSourceTypeId": null,
                "DemandSourceName": "REST DOCUMENTATION TESTING",
                "DemandSourceHeaderNumber": null,
                "DemandSourceHeaderId": null,
                "DemandSourceLineNumber": null,
                "DemandSourceLineId": null,
                "SourceFulfillmentLineId": null,
                "ReservationQuantity": 1,
                "ReservationUnitOfMeasure": "Each",
                "ReservationUOMCode": null,
                "PrimaryReservationQuantity": null,
                "PrimaryUnitOfMeasure": null,
                "PrimaryUOMCode": null,
                "SecondaryReservationQuantity": null,
                "SecondaryUnitOfMeasure": null,
                "SecondaryUOMCode": null,
                "SupplySourceTypeName": "On hand",
                "SupplySourceTypeId": null,
                "SupplySourceHeaderNumber": null,
                "SupplySourceHeaderId": null,
                "SupplySourceLineNumber": null,
                "SupplySourceLineId": null,
                "Revision": null,
                "SubinventoryCode": "Stores",
                "Locator": null,
                "LocatorId": null,
                "LotNumber": null,
                "SupplyProjectNumber": null,
                "SupplyProjectId": null,
                "SupplyTaskNumber": null,
                "SupplyTaskId": null,
                "ToOrganizationName": null,
                "ToOrganizationId": null,
                "ToDemandSourceTypeName": null,
                "ToDemandSourceTypeId": null,
                "ToDemandSourceName": null,
                "ToDemandSourceHeaderNumber": null,
                "ToDemandSourceHeaderId": null,
                "ToDemandSourceLineNumber": null,
                "ToDemandSourceLineId": null,
                "ToSupplySourceTypeName": null,
                "ToSupplySourceTypeId": null,
                "ToSupplySourceHeaderNumber": null,
                "ToSupplySourceHeaderId": null,
                "ToSupplySourceLineNumber": null,
                "ToSupplySourceLineId": null,
                "ToRevision": null,
                "ToSubinventoryCode": null,
                "ToLocator": null,
                "ToLocatorId": null,
                "ToLotNumber": null,
                "ToSupplyProjectNumber": null,
                "ToSupplyProjectId": null,
                "ToSupplyTaskNumber": null,
                "ToSupplyTaskId": null,
                "LockCode": "2",
                "RowStatusCode": "1",
                "ErrorCode": null,
                "ErrorExplanationCode": null,
                "ErrorExplanation": null,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052110000000EACED000577080000000000002B67",
                        "name": "inventoryStagedReservations",
                        "kind": "item",
                        "properties": {
                            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                        }
                    },
                    {
                        "rel": "canonical",
                        "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052110000000EACED000577080000000000002B67",
                        "name": "inventoryStagedReservations",
                        "kind": "item"
                    }
                ]
            }
        },
        {
            "id": "part2",
            "path": "https://server/fscmRestApi/resources/version/inventoryStagedReservations",
            "operation": "create",
            "payload": {
                "ReservationInterfaceId": 21010,
                "ReservationBatchId": 11112,
                "ReservationActionCode": "1",
                "ProcessMode": null,
                "ProcessModeCode": null,
                "RequirementDate": "2022-04-20",
                "ItemNumber": "AS54888",
                "InventoryItemId": null,
                "OrganizationName": "Seattle Manufacturing",
                "OrganizationCode": null,
                "OrganizationId": 207,
                "DemandSourceTypeName": "Sales order",
                "DemandSourceTypeId": null,
                "DemandSourceName": null,
                "DemandSourceHeaderNumber": "HK-SO-TEST",
                "DemandSourceHeaderId": null,
                "DemandSourceLineNumber": "1",
                "DemandSourceLineId": null,
                "SourceFulfillmentLineId": null,
                "ReservationQuantity": 1,
                "ReservationUnitOfMeasure": "Each",
                "ReservationUOMCode": null,
                "PrimaryReservationQuantity": null,
                "PrimaryUnitOfMeasure": null,
                "PrimaryUOMCode": null,
                "SecondaryReservationQuantity": null,
                "SecondaryUnitOfMeasure": null,
                "SecondaryUOMCode": null,
                "SupplySourceTypeName": "On hand",
                "SupplySourceTypeId": null,
                "SupplySourceHeaderNumber": null,
                "SupplySourceHeaderId": null,
                "SupplySourceLineNumber": null,
                "SupplySourceLineId": null,
                "Revision": null,
                "SubinventoryCode": null,
                "Locator": null,
                "LocatorId": null,
                "LotNumber": null,
                "SupplyProjectNumber": null,
                "SupplyProjectId": null,
                "SupplyTaskNumber": null,
                "SupplyTaskId": null,
                "ToOrganizationName": null,
                "ToOrganizationId": null,
                "ToDemandSourceTypeName": null,
                "ToDemandSourceTypeId": null,
                "ToDemandSourceName": null,
                "ToDemandSourceHeaderNumber": null,
                "ToDemandSourceHeaderId": null,
                "ToDemandSourceLineNumber": null,
                "ToDemandSourceLineId": null,
                "ToSupplySourceTypeName": null,
                "ToSupplySourceTypeId": null,
                "ToSupplySourceHeaderNumber": null,
                "ToSupplySourceHeaderId": null,
                "ToSupplySourceLineNumber": null,
                "ToSupplySourceLineId": null,
                "ToRevision": null,
                "ToSubinventoryCode": null,
                "ToLocator": null,
                "ToLocatorId": null,
                "ToLotNumber": null,
                "ToSupplyProjectNumber": null,
                "ToSupplyProjectId": null,
                "ToSupplyTaskNumber": null,
                "ToSupplyTaskId": null,
                "LockCode": "2",
                "RowStatusCode": "1",
                "ErrorCode": null,
                "ErrorExplanationCode": null,
                "ErrorExplanation": null,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052120000000EACED000577080000000000002B68",
                        "name": "inventoryStagedReservations",
                        "kind": "item",
                        "properties": {
                            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                        }
                    },
                    {
                        "rel": "canonical",
                        "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052120000000EACED000577080000000000002B68",
                        "name": "inventoryStagedReservations",
                        "kind": "item"
                    }
                ]
            }
        },
        {
            "id": "part3",
            "path": "https://server/fscmRestApi/resources/version/inventoryStagedReservations",
            "operation": "create",
            "payload": {
                "ReservationInterfaceId": 21011,
                "ReservationBatchId": 11113,
                "ReservationActionCode": "1",
                "ProcessMode": null,
                "ProcessModeCode": null,
                "RequirementDate": "2022-04-20",
                "ItemNumber": "AS54888",
                "InventoryItemId": null,
                "OrganizationName": "Seattle Manufacturing",
                "OrganizationCode": null,
                "OrganizationId": 207,
                "DemandSourceTypeName": "Transfer order",
                "DemandSourceTypeId": null,
                "DemandSourceName": null,
                "DemandSourceHeaderNumber": "12345",
                "DemandSourceHeaderId": null,
                "DemandSourceLineNumber": "1",
                "DemandSourceLineId": null,
                "SourceFulfillmentLineId": null,
                "ReservationQuantity": 1,
                "ReservationUnitOfMeasure": "Each",
                "ReservationUOMCode": null,
                "PrimaryReservationQuantity": null,
                "PrimaryUnitOfMeasure": null,
                "PrimaryUOMCode": null,
                "SecondaryReservationQuantity": null,
                "SecondaryUnitOfMeasure": null,
                "SecondaryUOMCode": null,
                "SupplySourceTypeName": "Purchase order",
                "SupplySourceTypeId": null,
                "SupplySourceHeaderNumber": "87654",
                "SupplySourceHeaderId": null,
                "SupplySourceLineNumber": "1",
                "SupplySourceLineId": null,
                "Revision": null,
                "SubinventoryCode": null,
                "Locator": null,
                "LocatorId": null,
                "LotNumber": null,
                "SupplyProjectNumber": null,
                "SupplyProjectId": null,
                "SupplyTaskNumber": null,
                "SupplyTaskId": null,
                "ToOrganizationName": null,
                "ToOrganizationId": null,
                "ToDemandSourceTypeName": null,
                "ToDemandSourceTypeId": null,
                "ToDemandSourceName": null,
                "ToDemandSourceHeaderNumber": null,
                "ToDemandSourceHeaderId": null,
                "ToDemandSourceLineNumber": null,
                "ToDemandSourceLineId": null,
                "ToSupplySourceTypeName": null,
                "ToSupplySourceTypeId": null,
                "ToSupplySourceHeaderNumber": null,
                "ToSupplySourceHeaderId": null,
                "ToSupplySourceLineNumber": null,
                "ToSupplySourceLineId": null,
                "ToRevision": null,
                "ToSubinventoryCode": null,
                "ToLocator": null,
                "ToLocatorId": null,
                "ToLotNumber": null,
                "ToSupplyProjectNumber": null,
                "ToSupplyProjectId": null,
                "ToSupplyTaskNumber": null,
                "ToSupplyTaskId": null,
                "LockCode": "2",
                "RowStatusCode": "1",
                "ErrorCode": null,
                "ErrorExplanationCode": null,
                "ErrorExplanation": null,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052130000000EACED000577080000000000002B69",
                        "name": "inventoryStagedReservations",
                        "kind": "item",
                        "properties": {
                            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                        }
                    },
                    {
                        "rel": "canonical",
                        "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052130000000EACED000577080000000000002B69",
                        "name": "inventoryStagedReservations",
                        "kind": "item"
                    }
                ]
            }
        }
    ]
}

Note:

As the process mode is 3, background mode, go to the Schedule Processes UI and launch the Manage Reservations Interface job to process the records created.

Update Reservation Quantity on a Reservation Interface Record

In this scenario, the warehouse manager retrieves the reservation interface record that needs to be updated and then performs a PATCH operation with the attributes that need to be updated on that record.

Example URL

Use this resource URL format:

GET

 http://server/fscmRestApi/resources/version/inventoryStagedReservations?q=ReservationBatchId=11112

Example Response

Here's an example of the response body in JSON format:
{
                "ReservationInterfaceId": 21010,
                "ReservationBatchId": 11112,
                "ReservationActionCode": "1",
                "ProcessMode": null,
                "ProcessModeCode": null,
                "RequirementDate": "2022-04-20",
                "ItemNumber": "AS54888",
                "InventoryItemId": null,
                "OrganizationName": "Seattle Manufacturing",
                "OrganizationCode": null,
                "OrganizationId": 207,
                "DemandSourceTypeName": "Sales order",
                "DemandSourceTypeId": null,
                "DemandSourceName": null,
                "DemandSourceHeaderNumber": "HK-SO-TEST",
                "DemandSourceHeaderId": null,
                "DemandSourceLineNumber": "1",
                "DemandSourceLineId": null,
                "SourceFulfillmentLineId": null,
                "ReservationQuantity": 1,
                "ReservationUnitOfMeasure": "Each",
                "ReservationUOMCode": null,
                "PrimaryReservationQuantity": null,
                "PrimaryUnitOfMeasure": null,
                "PrimaryUOMCode": null,
                "SecondaryReservationQuantity": null,
                "SecondaryUnitOfMeasure": null,
                "SecondaryUOMCode": null,
                "SupplySourceTypeName": "On hand",
                "SupplySourceTypeId": null,
                "SupplySourceHeaderNumber": null,
                "SupplySourceHeaderId": null,
                "SupplySourceLineNumber": null,
                "SupplySourceLineId": null,
                "Revision": null,
                "SubinventoryCode": null,
                "Locator": null,
                "LocatorId": null,
                "LotNumber": null,
                "SupplyProjectNumber": null,
                "SupplyProjectId": null,
                "SupplyTaskNumber": null,
                "SupplyTaskId": null,
                "ToOrganizationName": null,
                "ToOrganizationId": null,
                "ToDemandSourceTypeName": null,
                "ToDemandSourceTypeId": null,
                "ToDemandSourceName": null,
                "ToDemandSourceHeaderNumber": null,
                "ToDemandSourceHeaderId": null,
                "ToDemandSourceLineNumber": null,
                "ToDemandSourceLineId": null,
                "ToSupplySourceTypeName": null,
                "ToSupplySourceTypeId": null,
                "ToSupplySourceHeaderNumber": null,
                "ToSupplySourceHeaderId": null,
                "ToSupplySourceLineNumber": null,
                "ToSupplySourceLineId": null,
                "ToRevision": null,
                "ToSubinventoryCode": null,
                "ToLocator": null,
                "ToLocatorId": null,
                "ToLotNumber": null,
                "ToSupplyProjectNumber": null,
                "ToSupplyProjectId": null,
                "ToSupplyTaskNumber": null,
                "ToSupplyTaskId": null,
                "LockCode": "2",
                "RowStatusCode": "1",
                "ErrorCode": null,
                "ErrorExplanationCode": null,
                "ErrorExplanation": null,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052120000000EACED000577080000000000002B68",
                        "name": "inventoryStagedReservations",
                        "kind": "item",
                        "properties": {
                            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                        }
                    },
                    {
                        "rel": "canonical",
                        "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052120000000EACED000577080000000000002B68",
                        "name": "inventoryStagedReservations",
                        "kind": "item"
                    }
                ]
            }
After the GET operation is successful, a PATCH operation needs to be performed using the self-link of the record.

Example URL

Use this resource URL format:

PATCH

 http://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052120000000EACED000577080000000000002B68

Example Request

Here's an example of the request body in JSON format:
{
    "ReservationQuantity":10
}
       Output Payload :
{
    "ReservationInterfaceId": 21010,
    "ReservationBatchId": 11112,
    "ReservationActionCode": "1",
    "ProcessMode": null,
    "ProcessModeCode": null,
    "RequirementDate": "2022-04-20",
    "ItemNumber": "AS54888",
    "InventoryItemId": null,
    "OrganizationName": "Seattle Manufacturing",
    "OrganizationCode": null,
    "OrganizationId": 207,
    "DemandSourceTypeName": "Sales order",
    "DemandSourceTypeId": null,
    "DemandSourceName": null,
    "DemandSourceHeaderNumber": "HK-SO-TEST",
    "DemandSourceHeaderId": null,
    "DemandSourceLineNumber": "1",
    "DemandSourceLineId": null,
    "SourceFulfillmentLineId": null,
    "ReservationQuantity": 10,
    "ReservationUnitOfMeasure": "Each",
    "ReservationUOMCode": null,
    "PrimaryReservationQuantity": null,
    "PrimaryUnitOfMeasure": null,
    "PrimaryUOMCode": null,
    "SecondaryReservationQuantity": null,
    "SecondaryUnitOfMeasure": null,
    "SecondaryUOMCode": null,
    "SupplySourceTypeName": "On hand",
    "SupplySourceTypeId": null,
    "SupplySourceHeaderNumber": null,
    "SupplySourceHeaderId": null,
    "SupplySourceLineNumber": null,
    "SupplySourceLineId": null,
    "Revision": null,
    "SubinventoryCode": null,
    "Locator": null,
    "LocatorId": null,
    "LotNumber": null,
    "SupplyProjectNumber": null,
    "SupplyProjectId": null,
    "SupplyTaskNumber": null,
    "SupplyTaskId": null,
    "ToOrganizationName": null,
    "ToOrganizationId": null,
    "ToDemandSourceTypeName": null,
    "ToDemandSourceTypeId": null,
    "ToDemandSourceName": null,
    "ToDemandSourceHeaderNumber": null,
    "ToDemandSourceHeaderId": null,
    "ToDemandSourceLineNumber": null,
    "ToDemandSourceLineId": null,
    "ToSupplySourceTypeName": null,
    "ToSupplySourceTypeId": null,
    "ToSupplySourceHeaderNumber": null,
    "ToSupplySourceHeaderId": null,
    "ToSupplySourceLineNumber": null,
    "ToSupplySourceLineId": null,
    "ToRevision": null,
    "ToSubinventoryCode": null,
    "ToLocator": null,
    "ToLocatorId": null,
    "ToLotNumber": null,
    "ToSupplyProjectNumber": null,
    "ToSupplyProjectId": null,
    "ToSupplyTaskNumber": null,
    "ToSupplyTaskId": null,
    "LockCode": "2",
    "RowStatusCode": "1",
    "ErrorCode": null,
    "ErrorExplanationCode": null,
    "ErrorExplanation": null,
    "links": [
        {
            "rel": "self",
            "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052120000000EACED000577080000000000002B68",
            "name": "inventoryStagedReservations",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052120000000EACED000577080000000000002B68",
            "name": "inventoryStagedReservations",
            "kind": "item"
        }
    ]
}

Delete a Reservation Interface Record

In this scenario, the warehouse manager needs to find the reservation interface record that needs to be deleted. So first a GET operation needs to be performed using the reservation batch ID and then a DELETE operation using the self-link of the record. You can verify that the record is deleted using the GET operation.

Example URL

Use this resource URL format:

GET

 http://server/fscmRestApi/resources/version/inventoryStagedReservations?q=ReservationBatchId=11111

Example Response

Here's an example of the response body in JSON format:
{
    "ReservationInterfaceId": 21010,
    "ReservationBatchId": 11112,
    "ReservationActionCode": "1",
    "ProcessMode": null,
    "ProcessModeCode": null,
    "RequirementDate": "2022-04-20",
    "ItemNumber": "AS54888",
    "InventoryItemId": null,
    "OrganizationName": "Seattle Manufacturing",
    "OrganizationCode": null,
    "OrganizationId": 207,
    "DemandSourceTypeName": "Sales order",
    "DemandSourceTypeId": null,
    "DemandSourceName": null,
    "DemandSourceHeaderNumber": "HK-SO-TEST",
    "DemandSourceHeaderId": null,
    "DemandSourceLineNumber": "1",
    "DemandSourceLineId": null,
    "SourceFulfillmentLineId": null,
    "ReservationQuantity": 10,
    "ReservationUnitOfMeasure": "Each",
    "ReservationUOMCode": null,
    "PrimaryReservationQuantity": null,
    "PrimaryUnitOfMeasure": null,
    "PrimaryUOMCode": null,
    "SecondaryReservationQuantity": null,
    "SecondaryUnitOfMeasure": null,
    "SecondaryUOMCode": null,
    "SupplySourceTypeName": "On hand",
    "SupplySourceTypeId": null,
    "SupplySourceHeaderNumber": null,
    "SupplySourceHeaderId": null,
    "SupplySourceLineNumber": null,
    "SupplySourceLineId": null,
    "Revision": null,
    "SubinventoryCode": null,
    "Locator": null,
    "LocatorId": null,
    "LotNumber": null,
    "SupplyProjectNumber": null,
    "SupplyProjectId": null,
    "SupplyTaskNumber": null,
    "SupplyTaskId": null,
    "ToOrganizationName": null,
    "ToOrganizationId": null,
    "ToDemandSourceTypeName": null,
    "ToDemandSourceTypeId": null,
    "ToDemandSourceName": null,
    "ToDemandSourceHeaderNumber": null,
    "ToDemandSourceHeaderId": null,
    "ToDemandSourceLineNumber": null,
    "ToDemandSourceLineId": null,
    "ToSupplySourceTypeName": null,
    "ToSupplySourceTypeId": null,
    "ToSupplySourceHeaderNumber": null,
    "ToSupplySourceHeaderId": null,
    "ToSupplySourceLineNumber": null,
    "ToSupplySourceLineId": null,
    "ToRevision": null,
    "ToSubinventoryCode": null,
    "ToLocator": null,
    "ToLocatorId": null,
    "ToLotNumber": null,
    "ToSupplyProjectNumber": null,
    "ToSupplyProjectId": null,
    "ToSupplyTaskNumber": null,
    "ToSupplyTaskId": null,
    "LockCode": "2",
    "RowStatusCode": "1",
    "ErrorCode": null,
    "ErrorExplanationCode": null,
    "ErrorExplanation": null,
    "links": [
        {
            "rel": "self",
            "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052120000000EACED000577080000000000002B68",
            "name": "inventoryStagedReservations",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052120000000EACED000577080000000000002B68",
            "name": "inventoryStagedReservations",
            "kind": "item"
        }
    ]
}

After the GET operation is successful, a DELETE operation needs to be performed using the self-link of the record.

Example URL

Use this resource URL format:

DELETE

 http://server/fscmRestApi/resources/version/inventoryStagedReservations/ /00020000000EACED0005770800000000000052110000000EACED000577080000000000002B67

You can verify that the record is deleted using the GET operation.

Example URL

Use this resource URL format:

GET

 http://server/fscmRestApi/resources/version/inventoryStagedReservations?q=ReservationBatchId=11111

Example Response

Here's an example of the response body in JSON format:
{
    "items": [],
    "count": 0,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations",
            "name": "inventoryStagedReservations",
            "kind": "collection"
        }
    ]
}

Retrieve the Reservation Interface Records Using a Search Criteria

In this scenario, the warehouse manager provides a specific search criteria in the form of q parameters to retrieve the results.

Example URL

Use this resource URL format:

GET

 http://server/fscmRestApi/resources/version/inventoryStagedReservations?OrganizationName=’Seattle Manufacturing’;ItemNumber=’AS54888’;DemandSourceTypeName=’Sales order’
cURL Command

Example Response

Here's an example of the response body in JSON format:
{
    "items": [
        {
            "ReservationInterfaceId": 21010,
            "ReservationBatchId": 11112,
            "ReservationActionCode": "1",
            "ProcessMode": null,
            "ProcessModeCode": null,
            "RequirementDate": "2022-04-20",
            "ItemNumber": "AS54888",
            "InventoryItemId": null,
            "OrganizationName": "Seattle Manufacturing",
            "OrganizationCode": null,
            "OrganizationId": 207,
            "DemandSourceTypeName": "Sales order",
            "DemandSourceTypeId": null,
            "DemandSourceName": null,
            "DemandSourceHeaderNumber": "HK-SO-TEST",
            "DemandSourceHeaderId": null,
            "DemandSourceLineNumber": "1",
            "DemandSourceLineId": null,
            "SourceFulfillmentLineId": null,
            "ReservationQuantity": 10,
            "ReservationUnitOfMeasure": "Each",
            "ReservationUOMCode": null,
            "PrimaryReservationQuantity": null,
            "PrimaryUnitOfMeasure": null,
            "PrimaryUOMCode": null,
            "SecondaryReservationQuantity": null,
            "SecondaryUnitOfMeasure": null,
            "SecondaryUOMCode": null,
            "SupplySourceTypeName": "On hand",
            "SupplySourceTypeId": null,
            "SupplySourceHeaderNumber": null,
            "SupplySourceHeaderId": null,
            "SupplySourceLineNumber": null,
            "SupplySourceLineId": null,
            "Revision": null,
            "SubinventoryCode": null,
            "Locator": null,
            "LocatorId": null,
            "LotNumber": null,
            "SupplyProjectNumber": null,
            "SupplyProjectId": null,
            "SupplyTaskNumber": null,
            "SupplyTaskId": null,
            "ToOrganizationName": null,
            "ToOrganizationId": null,
            "ToDemandSourceTypeName": null,
            "ToDemandSourceTypeId": null,
            "ToDemandSourceName": null,
            "ToDemandSourceHeaderNumber": null,
            "ToDemandSourceHeaderId": null,
            "ToDemandSourceLineNumber": null,
            "ToDemandSourceLineId": null,
            "ToSupplySourceTypeName": null,
            "ToSupplySourceTypeId": null,
            "ToSupplySourceHeaderNumber": null,
            "ToSupplySourceHeaderId": null,
            "ToSupplySourceLineNumber": null,
            "ToSupplySourceLineId": null,
            "ToRevision": null,
            "ToSubinventoryCode": null,
            "ToLocator": null,
            "ToLocatorId": null,
            "ToLotNumber": null,
            "ToSupplyProjectNumber": null,
            "ToSupplyProjectId": null,
            "ToSupplyTaskNumber": null,
            "ToSupplyTaskId": null,
            "LockCode": "2",
            "RowStatusCode": "1",
            "ErrorCode": null,
            "ErrorExplanationCode": null,
            "ErrorExplanation": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052120000000EACED000577080000000000002B68",
                    "name": "inventoryStagedReservations",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052120000000EACED000577080000000000002B68",
                    "name": "inventoryStagedReservations",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations",
            "name": "inventoryStagedReservations",
            "kind": "collection"
        }
    ]
}

Create Multiple Reservation Interface Records That Form a Shipset

In this scenario, the process mode is submitted as 2, Concurrent mode. So when the request is submitted, the reservation interface records are created and the Manage Reservations Interface job is launched by the service.

Example URL

Use this resource URL format:

POST

 http://server/fscmRestApi/resources/version/

Example Request

Here's an example of the request body in JSON format:
{"parts":
[
{"id":"part1","path":"/inventoryStagedReservations","operation":"create",
    "payload":
    {"ReservationBatchId":11114,
    "ReservationActionCode": "1",
    "ProcessModeCode":"2",
    "ItemNumber": "AS54888",
    "OrganizationName": "Seattle Manufacturing",
    "DemandSourceTypeName": "Sales order",
    "DemandSourceName": null,
    "DemandSourceHeaderNumber": "SO-1",
    "DemandSourceLineNumber": "1",
    "ReservationQuantity": 1,
    "ReservationUnitOfMeasure": "Each",
    "SupplySourceTypeName": "On hand",
    "SupplySourceHeaderNumber": null,
    "SupplySourceLineNumber": null,
    "Revision": null,
    "SubinventoryCode": null,
    "Locator": null,
    "LotNumber": null,
    "SupplyProjectNumber": null,
    "SupplyTaskNumber": null,
    "ToOrganizationName": null,
    "ToDemandSourceTypeName": null,
    "ToDemandSourceName": null,
    "ToDemandSourceHeaderNumber": null,
    "ToDemandSourceLineNumber": null,
    "ToSupplySourceTypeName": null,
    "ToSupplySourceHeaderNumber": null,
    "ToSupplySourceLineNumber": null,
    "ToRevision": null,
    "ToSubinventoryCode": null,
    "ToLocator": null,
    "ToLotNumber": null,
    "ToSupplyProjectNumber": null,
    "ToSupplyTaskNumber": null,
    "RowStatusCode":"1",
    "LockCode":"2"}},
{"id":"part2","path":"/inventoryStagedReservations","operation":"create",
    "payload":
    {"ReservationBatchId":11114,
    "ReservationActionCode": "1",
    "ProcessModeCode":"2",
    "ItemNumber": "AS54888",
    "OrganizationName": "Seattle Manufacturing",
    "DemandSourceTypeName": "Sales order",
    "DemandSourceName": null,
    "DemandSourceHeaderNumber": "SO-2",
    "DemandSourceLineNumber": "1",
    "ReservationQuantity": 1,
    "ReservationUnitOfMeasure": "Each",
    "SupplySourceTypeName": "On hand",
    "SupplySourceHeaderNumber": null,
    "SupplySourceLineNumber": null,
    "Revision": null,
    "SubinventoryCode": null,
    "Locator": null,
    "LotNumber": null,
    "SupplyProjectNumber": null,
    "SupplyTaskNumber": null,
    "ToOrganizationName": null,
    "ToDemandSourceTypeName": null,
    "ToDemandSourceName": null,
    "ToDemandSourceHeaderNumber": null,
    "ToDemandSourceLineNumber": null,
    "ToSupplySourceTypeName": null,
    "ToSupplySourceHeaderNumber": null,
    "ToSupplySourceLineNumber": null,
    "ToRevision": null,
    "ToSubinventoryCode": null,
    "ToLocator": null,
    "ToLotNumber": null,
    "ToSupplyProjectNumber": null,
    "ToSupplyTaskNumber": null,
    "RowStatusCode":"1",
    "LockCode":"2"}},
{"id":"part3","path":"/inventoryStagedReservations","operation":"create",
    "payload":
    {"ReservationBatchId":11114,
    "ReservationActionCode": "1",
    "ProcessModeCode":"2",
    "ItemNumber": "AS54888",
    "OrganizationName": "Seattle Manufacturing",
    "DemandSourceTypeName": "Sales order",
    "DemandSourceName": null,
    "DemandSourceHeaderNumber": "SO-3",
    "DemandSourceLineNumber": "1",
    "ReservationQuantity": 1,
    "ReservationUnitOfMeasure": "Each",
    "SupplySourceTypeName": "On hand",
    "SupplySourceHeaderNumber": null,
    "SupplySourceLineNumber": null,
    "Revision": null,
    "SubinventoryCode": null,
    "Locator": null,
    "LotNumber": null,
    "SupplyProjectNumber": null,
    "SupplyTaskNumber": null,
    "ToOrganizationName": null,
    "ToDemandSourceTypeName": null,
    "ToDemandSourceName": null,
    "ToDemandSourceHeaderNumber": null,
    "ToDemandSourceLineNumber": null,
    "ToSupplySourceTypeName": null,
    "ToSupplySourceHeaderNumber": null,
    "ToSupplySourceLineNumber": null,
    "ToRevision": null,
    "ToSubinventoryCode": null,
    "ToLocator": null,
    "ToLotNumber": null,
    "ToSupplyProjectNumber": null,
    "ToSupplyTaskNumber": null,
    "RowStatusCode":"1",
    "LockCode":"2"}}
]}

Example Response

Here's an example of the response body in JSON format:
{
    "parts": [
        {
            "id": "part1",
            "path": "https://server/fscmRestApi/resources/version/inventoryStagedReservations",
            "operation": "create",
            "payload": {
                "ReservationInterfaceId": 21012,
                "ReservationBatchId": 11114,
                "ReservationActionCode": "1",
                "ProcessMode": null,
                "ProcessModeCode": null,
                "RequirementDate": "2022-04-20",
                "ItemNumber": "AS54888",
                "InventoryItemId": null,
                "OrganizationName": "Seattle Manufacturing",
                "OrganizationCode": null,
                "OrganizationId": 207,
                "DemandSourceTypeName": "Sales order",
                "DemandSourceTypeId": null,
                "DemandSourceName": null,
                "DemandSourceHeaderNumber": "SO-1",
                "DemandSourceHeaderId": null,
                "DemandSourceLineNumber": "1",
                "DemandSourceLineId": null,
                "SourceFulfillmentLineId": null,
                "ReservationQuantity": 1,
                "ReservationUnitOfMeasure": "Each",
                "ReservationUOMCode": null,
                "PrimaryReservationQuantity": null,
                "PrimaryUnitOfMeasure": null,
                "PrimaryUOMCode": null,
                "SecondaryReservationQuantity": null,
                "SecondaryUnitOfMeasure": null,
                "SecondaryUOMCode": null,
                "SupplySourceTypeName": "On hand",
                "SupplySourceTypeId": null,
                "SupplySourceHeaderNumber": null,
                "SupplySourceHeaderId": null,
                "SupplySourceLineNumber": null,
                "SupplySourceLineId": null,
                "Revision": null,
                "SubinventoryCode": null,
                "Locator": null,
                "LocatorId": null,
                "LotNumber": null,
                "SupplyProjectNumber": null,
                "SupplyProjectId": null,
                "SupplyTaskNumber": null,
                "SupplyTaskId": null,
                "ToOrganizationName": null,
                "ToOrganizationId": null,
                "ToDemandSourceTypeName": null,
                "ToDemandSourceTypeId": null,
                "ToDemandSourceName": null,
                "ToDemandSourceHeaderNumber": null,
                "ToDemandSourceHeaderId": null,
                "ToDemandSourceLineNumber": null,
                "ToDemandSourceLineId": null,
                "ToSupplySourceTypeName": null,
                "ToSupplySourceTypeId": null,
                "ToSupplySourceHeaderNumber": null,
                "ToSupplySourceHeaderId": null,
                "ToSupplySourceLineNumber": null,
                "ToSupplySourceLineId": null,
                "ToRevision": null,
                "ToSubinventoryCode": null,
                "ToLocator": null,
                "ToLocatorId": null,
                "ToLotNumber": null,
                "ToSupplyProjectNumber": null,
                "ToSupplyProjectId": null,
                "ToSupplyTaskNumber": null,
                "ToSupplyTaskId": null,
                "LockCode": "2",
                "RowStatusCode": "1",
                "ErrorCode": null,
                "ErrorExplanationCode": null,
                "ErrorExplanation": null,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052140000000EACED000577080000000000002B6A",
                        "name": "inventoryStagedReservations",
                        "kind": "item",
                        "properties": {
                            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                        }
                    },
                    {
                        "rel": "canonical",
                        "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052140000000EACED000577080000000000002B6A",
                        "name": "inventoryStagedReservations",
                        "kind": "item"
                    }
                ]
            }
        },
        {
            "id": "part2",
            "path": "https://server/fscmRestApi/resources/version/inventoryStagedReservations",
            "operation": "create",
            "payload": {
                "ReservationInterfaceId": 21013,
                "ReservationBatchId": 11114,
                "ReservationActionCode": "1",
                "ProcessMode": null,
                "ProcessModeCode": null,
                "RequirementDate": "2022-04-20",
                "ItemNumber": "AS54888",
                "InventoryItemId": null,
                "OrganizationName": "Seattle Manufacturing",
                "OrganizationCode": null,
                "OrganizationId": 207,
                "DemandSourceTypeName": "Sales order",
                "DemandSourceTypeId": null,
                "DemandSourceName": null,
                "DemandSourceHeaderNumber": "SO-2",
                "DemandSourceHeaderId": null,
                "DemandSourceLineNumber": "1",
                "DemandSourceLineId": null,
                "SourceFulfillmentLineId": null,
                "ReservationQuantity": 1,
                "ReservationUnitOfMeasure": "Each",
                "ReservationUOMCode": null,
                "PrimaryReservationQuantity": null,
                "PrimaryUnitOfMeasure": null,
                "PrimaryUOMCode": null,
                "SecondaryReservationQuantity": null,
                "SecondaryUnitOfMeasure": null,
                "SecondaryUOMCode": null,
                "SupplySourceTypeName": "On hand",
                "SupplySourceTypeId": null,
                "SupplySourceHeaderNumber": null,
                "SupplySourceHeaderId": null,
                "SupplySourceLineNumber": null,
                "SupplySourceLineId": null,
                "Revision": null,
                "SubinventoryCode": null,
                "Locator": null,
                "LocatorId": null,
                "LotNumber": null,
                "SupplyProjectNumber": null,
                "SupplyProjectId": null,
                "SupplyTaskNumber": null,
                "SupplyTaskId": null,
                "ToOrganizationName": null,
                "ToOrganizationId": null,
                "ToDemandSourceTypeName": null,
                "ToDemandSourceTypeId": null,
                "ToDemandSourceName": null,
                "ToDemandSourceHeaderNumber": null,
                "ToDemandSourceHeaderId": null,
                "ToDemandSourceLineNumber": null,
                "ToDemandSourceLineId": null,
                "ToSupplySourceTypeName": null,
                "ToSupplySourceTypeId": null,
                "ToSupplySourceHeaderNumber": null,
                "ToSupplySourceHeaderId": null,
                "ToSupplySourceLineNumber": null,
                "ToSupplySourceLineId": null,
                "ToRevision": null,
                "ToSubinventoryCode": null,
                "ToLocator": null,
                "ToLocatorId": null,
                "ToLotNumber": null,
                "ToSupplyProjectNumber": null,
                "ToSupplyProjectId": null,
                "ToSupplyTaskNumber": null,
                "ToSupplyTaskId": null,
                "LockCode": "2",
                "RowStatusCode": "1",
                "ErrorCode": null,
                "ErrorExplanationCode": null,
                "ErrorExplanation": null,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052150000000EACED000577080000000000002B6A",
                        "name": "inventoryStagedReservations",
                        "kind": "item",
                        "properties": {
                            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                        }
                    },
                    {
                        "rel": "canonical",
                        "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052150000000EACED000577080000000000002B6A",
                        "name": "inventoryStagedReservations",
                        "kind": "item"
                    }
                ]
            }
        },
        {
            "id": "part3",
            "path": "https://server/fscmRestApi/resources/version/inventoryStagedReservations",
            "operation": "create",
            "payload": {
                "ReservationInterfaceId": 21014,
                "ReservationBatchId": 11114,
                "ReservationActionCode": "1",
                "ProcessMode": null,
                "ProcessModeCode": null,
                "RequirementDate": "2022-04-20",
                "ItemNumber": "AS54888",
                "InventoryItemId": null,
                "OrganizationName": "Seattle Manufacturing",
                "OrganizationCode": null,
                "OrganizationId": 207,
                "DemandSourceTypeName": "Sales order",
                "DemandSourceTypeId": null,
                "DemandSourceName": null,
                "DemandSourceHeaderNumber": "SO-3",
                "DemandSourceHeaderId": null,
                "DemandSourceLineNumber": "1",
                "DemandSourceLineId": null,
                "SourceFulfillmentLineId": null,
                "ReservationQuantity": 1,
                "ReservationUnitOfMeasure": "Each",
                "ReservationUOMCode": null,
                "PrimaryReservationQuantity": null,
                "PrimaryUnitOfMeasure": null,
                "PrimaryUOMCode": null,
                "SecondaryReservationQuantity": null,
                "SecondaryUnitOfMeasure": null,
                "SecondaryUOMCode": null,
                "SupplySourceTypeName": "On hand",
                "SupplySourceTypeId": null,
                "SupplySourceHeaderNumber": null,
                "SupplySourceHeaderId": null,
                "SupplySourceLineNumber": null,
                "SupplySourceLineId": null,
                "Revision": null,
                "SubinventoryCode": null,
                "Locator": null,
                "LocatorId": null,
                "LotNumber": null,
                "SupplyProjectNumber": null,
                "SupplyProjectId": null,
                "SupplyTaskNumber": null,
                "SupplyTaskId": null,
                "ToOrganizationName": null,
                "ToOrganizationId": null,
                "ToDemandSourceTypeName": null,
                "ToDemandSourceTypeId": null,
                "ToDemandSourceName": null,
                "ToDemandSourceHeaderNumber": null,
                "ToDemandSourceHeaderId": null,
                "ToDemandSourceLineNumber": null,
                "ToDemandSourceLineId": null,
                "ToSupplySourceTypeName": null,
                "ToSupplySourceTypeId": null,
                "ToSupplySourceHeaderNumber": null,
                "ToSupplySourceHeaderId": null,
                "ToSupplySourceLineNumber": null,
                "ToSupplySourceLineId": null,
                "ToRevision": null,
                "ToSubinventoryCode": null,
                "ToLocator": null,
                "ToLocatorId": null,
                "ToLotNumber": null,
                "ToSupplyProjectNumber": null,
                "ToSupplyProjectId": null,
                "ToSupplyTaskNumber": null,
                "ToSupplyTaskId": null,
                "LockCode": "2",
                "RowStatusCode": "1",
                "ErrorCode": null,
                "ErrorExplanationCode": null,
                "ErrorExplanation": null,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052160000000EACED000577080000000000002B6A",
                        "name": "inventoryStagedReservations",
                        "kind": "item",
                        "properties": {
                            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                        }
                    },
                    {
                        "rel": "canonical",
                        "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations/00020000000EACED0005770800000000000052160000000EACED000577080000000000002B6A",
                        "name": "inventoryStagedReservations",
                        "kind": "item"
                    }
                ]
            }
        }
    ]
}

After the POST operation is successful, the Manage Reservations Interface job is completed and you can verify that the record is created by using the reservation batch ID in a GET operation. If the processing is completed successfully, then all the reservation interface records are deleted and corresponding reservations are created. If the processing is completed with errors, the error information is stamped on the reservation interface records.

Example URL

Use this resource URL format:

GET

 http://server/fscmRestApi/resources/version/inventoryStagedReservations?q=ReservationBatchId=11114

Example Response

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

{
    "items": [],
    "count": 0,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations",
            "name": "inventoryStagedReservations",
            "kind": "collection"
        }
    ]
}