---
title: "Delete order."
method: GET
path: "/order/delete"
tags: ["Orders|Order"]
---

# Delete order.

`GET /order/delete`

This endpoint can be used to delete specific orders by providing an array of `id`s. 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.

## Query parameters

- `filter[byIds][]` integer[]
- `filter[byExternalReferences][]` string[]
- `filter[byTourIds][]` integer[]
- `filter[byStatusText]` string
- `filter[byOrderType]` string
- `filter[byBounds]` string
- `filter[byUnassigned]` boolean
- `filter[byProjectIds][]` integer[]
- `filter[byTeamIds][]` integer[]
- `dryRun` boolean

## Response `200`

Success Response:

- StandardOrderDeleteResponse
  - `deletedItems` object[] — The orders that were deleted.
    - `id` integer — The internal id of the order
    - `reference` string — The internal reference for the order (max. 64 characters)
    - `orderType` string — The order type. This parameter is optional. The allowed value and default is 'ORDER'
    - `externalReference` string — The customer order number (max. 64 characters)
    - `status` string — The order state | Value | | ------------------------ | | ARRIVAL | | ASSIGNED | | CREATED | | DEPARTURE | | FINISHED | | NEAREST_POSITION | | OPENED_BY_USER | | READ | | REJECTED | | SIGNED | | STARTED |
    - `subject` string — Order subject (max. 255 characters)
    - `text` string — Order description
    - `orderDate` string — Represents a date and a time. (ISO 8601) ICU-Format: yyyy-MM-dd'T'HH:mm:ssxxx
    - `duration` integer — The order duration
    - `priority` string — order priority | Value | | ------------------------ | | LOW | | NORMAL | | HIGH |
    - `targetDate` string — Represents a date and a time. (ISO 8601) ICU-Format: yyyy-MM-dd'T'HH:mm:ssxxx
    - `externalAddressId` string — The external customer id.
    - `name` string — The name1 address addition. (max. 255 characters)
    - `name2` string — The name2 address addition. (max. 255 characters)
    - `name3` string — The name3 address addition. (max. 255 characters)
    - `street` string — The street (max. 255 characters)
    - `zipCode` string — The zip code
    - `city` string — The city
    - `countryCode` string — The country code
    - `latLng` number[] — Represents a geo coordinate. An array of two double values, representing the latitude and longitude.
    - `contactPersonName` string — The contact person name (max. 255 characters)
    - `contactPersonEmail` string — The contact person email (max. 255 characters)
    - `contactPersonPhoneNumber` string — The contact person phone number (max. 64 characters)
    - `contactPersonMobileNumber` string — The contact person mobile phone number (max. 64 characters)
    - `customerOrderReference` string — The customer order reference (max. 64 characters)
    - `offerReference` string — The offer reference (max. 255 characters)
    - `category` integer — The id of the order category. You need to provide this Parameter or the categoryExternalId.
    - `categoryExternalId` string — The external id of the order category (Used if category not provided).
    - `type` string — | Values | | -------------- | | PROJECT | | CUSTOM_PROJECT |
    - `project` integer — The id of the project.
    - `projectReferenceSign` string — The reference sign of the project (Used if project not provided).
    - `createdAt` string — Represents a date and a time. (ISO 8601) ICU-Format: yyyy-MM-dd'T'HH:mm:ssxxx

---

[API](https://skmtc.net/geocapture/apis/geocapture-api.md) · [All operations](https://skmtc.net/geocapture/apis/geocapture-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/geocapture/geocapture-api/versions/869b05603541/schema)