v1

latestOpenAPI 3.0.0Proprietary2026-08-06130577659.7 KB

Orders|Order

Delete order.

This endpoint can be used to delete specific orders by providing an array of ids. If dryRun is enabled, the live system will not undergo any changes, as the request will only be simulated. Note that once an order has been deleted it cannot be restored. If you want to delete multiple orders at once, it will be beneficial to use an array of ids as this will improve performance and save resources.

get/order/delete

Query parameters

filter[byIds][]integer[]

Filters the order based on the internal IDs.

filter[byExternalReferences][]string[]

Filters the order based on the customer order numbers.

filter[byTourIds][]integer[]

Filters the order based on the tour IDs.

filter[byStatusText]string

Filters the order based on the status text.

Value
ARRIVAL
ASSIGNED
CREATED
DEPARTURE
FINISHED
NEAREST_POSITION
OPENED_BY_USER
READ
REJECTED
SIGNED
STARTED

filter[byOrderType]string

Filters the order based on the order type.

Value
REPEAT
ORDER
SAVED
MACHINE_TRANSPORT

filter[byBounds]string

Example:52.37652038909364 7.605081948346127, 52.375099096475545 7.6082684126850175

Filters the order based on the given rectangle.

filter[byUnassigned]boolean

Filters the order based on whether it's assigned to a tour.

filter[byProjectIds][]integer[]

Filters the order based on the project IDs.

filter[byTeamIds][]integer[]

Filters the order based on the team IDs.

dryRunboolean

Simulate the operation (default: false). (No data will be removed) This Parameter is optional.

Response

Success Response:

Example response

{
  "deletedItems": [
    {
      "orderDate": "2015-02-20T12:59:21+01:00",
      "targetDate": "2015-02-20T12:59:21+01:00",
      "latLng": [
        52.38127828631681,
        7.594243214018696
      ],
      "createdAt": "2015-02-20T12:59:21+01:00"
    }
  ]
}