Reservations

More reservations API information can be found here: REST API documentation – Reservations.

Search reservations

Search reservations by executing the following POST call with the JSON body:

POST https://{YOUR-TENANT-NAME}.fulfillmenttools.com/api/reservations/search

{
    "query": {
        "tenantArticleId": {
            "eq": "11111"
        },
        "facilityRef": {
            "eq": "d083f631-9f4c-463b-85d4-9414fb19239f"
        }
        "relatedRefs": {
            "routingPlanRefs": {
                "contains": {
                    "eq": "85d25d89-f8a7-4600-9082-0d8b2d89a6af"
                }
            }
        }
    }
}

The example searches reservations for a specific tenantArticleId, facilityRef, and routingPlanRef.

More information on the search can be found under Basics – Search.

Remove reservations and stocks

Use the action REMOVE_RESERVATIONS_AND_REDUCE_STOCKS to remove reservations and the respective reserved stock by relatedRef.

Remove reservations and stocks by executing the following POST call with the JSON body:

POST https://{YOUR-TENANT-NAME}.fulfillmenttools.com/api/reservations/actions

{
    "name": "REMOVE_RESERVATIONS_AND_REDUCE_STOCKS",
    "relatedRefs": {
        "routingPlanRefs": [
            "routingPlanRef"
        ]
    }
}

If the request is successful, a 200 OK response is received with the below body.

{
    "results":[
        {
            "reservationId": "reservationId-1",
            "status": "DELETED",
            "stockOperations": [
                {
                    "status": "DELETED",
                    "stock": {
                        "id": "stockId-1",
                        "version": 1
                    }
                }
            ]
        },
        {
            "reservationId": "reservationId-2",
            "status": "DELETED",
            "stockOperations": [
                {
                    "status": "REDUCED",
                    "stock": {
                        "id": "stockId-1",
                        "version": 1
                    }
                }
            ]
        }
    ]
}

Remove reservations but keep stocks

Use the action REMOVE_RESERVATIONS_KEEP_STOCKS to remove reservations by relatedRef. No stock is reduced in this transaction.

Remove reservations by executing the following POST call with the JSON body:

POST https://{YOUR-TENANT-NAME}.fulfillmenttools.com/api/reservations/actions

{
    "name": "REMOVE_RESERVATIONS_KEEP_STOCKS",
    "relatedRefs": {
        "routingPlanRefs": [
            "routingPlanRef"
        ]
    }
}

If the request is successful, a 200 OK response is received with the below body.

{
    "results": [
        {
            "reservationId": "reservationId-1",
            "status": "DELETED"
        },
        {
            "reservationId": "reservationId-2",
            "status": "DELETED"
        }
    ]
}