Delete multiple orders

A DELETE request to the /orders endpoint permanently removes orders from Routific. Use this when orders are cancelled in your own system and you need them to disappear from Routific without a dispatcher deleting them manually.

Note that the orderUuid is required to delete an order that is generated by Routific and is originally returned in the response body of creating orders.

Request URL

🚧

Deletion is permanent

Deleting an order is not reversible. The order disappears from every list and count, GET /v1/orders/{orderUuid} will return 404, and the order can never be scheduled again.

If you only want to remove an order from a route while keeping it in Routific, do not use this endpoint.

Request Payload

[
    "6a8e071a-4ee0-470b-982e-b24ed1d1b90c",
    "9b3f2c44-1d7e-4a90-b3c1-8f2e6a91d445",
    "d72e1098-5b3a-4c62-9e17-3d8b4f0c7a21"
]

The payload accepts an array of orderUuids to delete. The payload is limited to a maximum of 500 uuids per request.

📘

Partial success is expected

A bulk request always returns 200, even when some orders could not be deleted. Deletable orders are deleted; the rest are returned with a reason.

Always inspect the response body rather than relying on the status code alone.

The response payload is dependent on whether the order being deleted is an unscheduled order or a scheduled order.

Sample Response Payload for multiple unscheduled orders

{
        "deleted": [
            {
                "uuid": "485a2130-b34c-4f48-a1f5-c7ee4d383734"
            },
            {
                "uuid": "acc8b019-a427-477f-9ad8-9629d25c31f8"
            }
        ],
        "failed":
        [
            {
                "uuid": "9b3f2c44-1d7e-4a90-b3c1-8f2e6a91d445",
                "reason": "order_completed"
            }
        ]
}

Here's a description of payload attributes returned in the response:

Sample Response Payload with atleast 1 scheduled order

{
    "actionUuid": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
    "actionName": "delete",
    "status": "finished"
}

Here's a description of payload attributes returned in the response: