curl -X POST "https://api.dcycle.io/v2/transports/delete" \
-H "x-api-key: ${DCYCLE_API_KEY}" \
-H "x-organization-id: ${DCYCLE_ORG_ID}" \
-H "Idempotency-Key: 6c5b4a39-2817-4f06-a5f4-e3d2c1b0a9f8" \
-H "Content-Type: application/json" \
-d '{"ids": ["3f2e1d0c-9b8a-4796-8584-a3b2c1d0e9f8"]}'
import os
import uuid
import requests
response = requests.post(
"https://api.dcycle.io/v2/transports/delete",
headers={
"x-api-key": os.environ["DCYCLE_API_KEY"],
"x-organization-id": os.environ["DCYCLE_ORG_ID"],
"Idempotency-Key": str(uuid.uuid4()), # keep it to retry this same batch
},
json={"ids": ["3f2e1d0c-9b8a-4796-8584-a3b2c1d0e9f8"]},
timeout=60,
)
response.raise_for_status()
print(response.json()["id"])
{
"id": "5d4c3b2a-1908-4f7e-b6d5-c4b3a2918070",
"status": "processing",
"entity_type": "transport_routes",
"operation": "delete",
"source": "api_bulk",
"counts": { "submitted": 1, "succeeded": 0, "failed": 0 },
"chunks_total": 1,
"chunks_done": 0,
"created_at": "2026-10-20T09:20:31.877Z",
"finished_at": null,
"links": {
"self": "/v2/ingest-jobs/5d4c3b2a-1908-4f7e-b6d5-c4b3a2918070",
"items": "/v2/ingest-jobs/5d4c3b2a-1908-4f7e-b6d5-c4b3a2918070/items"
}
}
{
"type": "https://code.dcycle.io/api-reference/errors#BULK_RECORDS_REJECTED",
"title": "Unprocessable Entity",
"status": 422,
"code": "BULK_RECORDS_REJECTED",
"detail": "1 of the submitted records are invalid; nothing was written.",
"errors": [
{
"source_row_index": 0,
"client_row_id": null,
"error_code": "NOT_FOUND",
"error_params": { "field": "ids", "value": "3f2e1d0c-9b8a-4796-8584-a3b2c1d0e9f8" }
}
],
"rejected": 1,
"request_id": "b2248a31-0f1b-4a7d-83ce-b29bd5977b4c"
}
{ "dry_run": true, "submitted": 1, "valid": 1 }
Delete Freight Transports (v2)
Delete up to 5,000 freight shipments by id, asynchronously, as an ingest job
POST
/
v2
/
transports
/
delete
curl -X POST "https://api.dcycle.io/v2/transports/delete" \
-H "x-api-key: ${DCYCLE_API_KEY}" \
-H "x-organization-id: ${DCYCLE_ORG_ID}" \
-H "Idempotency-Key: 6c5b4a39-2817-4f06-a5f4-e3d2c1b0a9f8" \
-H "Content-Type: application/json" \
-d '{"ids": ["3f2e1d0c-9b8a-4796-8584-a3b2c1d0e9f8"]}'
import os
import uuid
import requests
response = requests.post(
"https://api.dcycle.io/v2/transports/delete",
headers={
"x-api-key": os.environ["DCYCLE_API_KEY"],
"x-organization-id": os.environ["DCYCLE_ORG_ID"],
"Idempotency-Key": str(uuid.uuid4()), # keep it to retry this same batch
},
json={"ids": ["3f2e1d0c-9b8a-4796-8584-a3b2c1d0e9f8"]},
timeout=60,
)
response.raise_for_status()
print(response.json()["id"])
{
"id": "5d4c3b2a-1908-4f7e-b6d5-c4b3a2918070",
"status": "processing",
"entity_type": "transport_routes",
"operation": "delete",
"source": "api_bulk",
"counts": { "submitted": 1, "succeeded": 0, "failed": 0 },
"chunks_total": 1,
"chunks_done": 0,
"created_at": "2026-10-20T09:20:31.877Z",
"finished_at": null,
"links": {
"self": "/v2/ingest-jobs/5d4c3b2a-1908-4f7e-b6d5-c4b3a2918070",
"items": "/v2/ingest-jobs/5d4c3b2a-1908-4f7e-b6d5-c4b3a2918070/items"
}
}
{
"type": "https://code.dcycle.io/api-reference/errors#BULK_RECORDS_REJECTED",
"title": "Unprocessable Entity",
"status": 422,
"code": "BULK_RECORDS_REJECTED",
"detail": "1 of the submitted records are invalid; nothing was written.",
"errors": [
{
"source_row_index": 0,
"client_row_id": null,
"error_code": "NOT_FOUND",
"error_params": { "field": "ids", "value": "3f2e1d0c-9b8a-4796-8584-a3b2c1d0e9f8" }
}
],
"rejected": 1,
"request_id": "b2248a31-0f1b-4a7d-83ce-b29bd5977b4c"
}
{ "dry_run": true, "submitted": 1, "valid": 1 }
← Transport API
Delete freight shipments by id, together with their sections and emissions. The request checks every id and answers
Request-level errors:
202 Accepted with an ingest job that deletes them in the background (see
how bulk ingestion works). Follow it with
GET /v2/ingest-jobs/{id} or, for a job submitted with an API key, the
ingest_job.finished webhook.
The ids are the ones a create job gives you (each item’s entity_id in
GET /v2/ingest-jobs/{id}/items) or the ids of
List Transport Routes.
Permanent. Deleted shipments and their emissions cannot be recovered. Use
dry_run=true first if you are not
sure.Beta. Part of the bulk ingest API, in beta. The contract may still change before general availability.
curl -X POST "https://api.dcycle.io/v2/transports/delete" \
-H "x-api-key: ${DCYCLE_API_KEY}" \
-H "x-organization-id: ${DCYCLE_ORG_ID}" \
-H "Idempotency-Key: 6c5b4a39-2817-4f06-a5f4-e3d2c1b0a9f8" \
-H "Content-Type: application/json" \
-d '{"ids": ["3f2e1d0c-9b8a-4796-8584-a3b2c1d0e9f8"]}'
import os
import uuid
import requests
response = requests.post(
"https://api.dcycle.io/v2/transports/delete",
headers={
"x-api-key": os.environ["DCYCLE_API_KEY"],
"x-organization-id": os.environ["DCYCLE_ORG_ID"],
"Idempotency-Key": str(uuid.uuid4()), # keep it to retry this same batch
},
json={"ids": ["3f2e1d0c-9b8a-4796-8584-a3b2c1d0e9f8"]},
timeout=60,
)
response.raise_for_status()
print(response.json()["id"])
{
"id": "5d4c3b2a-1908-4f7e-b6d5-c4b3a2918070",
"status": "processing",
"entity_type": "transport_routes",
"operation": "delete",
"source": "api_bulk",
"counts": { "submitted": 1, "succeeded": 0, "failed": 0 },
"chunks_total": 1,
"chunks_done": 0,
"created_at": "2026-10-20T09:20:31.877Z",
"finished_at": null,
"links": {
"self": "/v2/ingest-jobs/5d4c3b2a-1908-4f7e-b6d5-c4b3a2918070",
"items": "/v2/ingest-jobs/5d4c3b2a-1908-4f7e-b6d5-c4b3a2918070/items"
}
}
{
"type": "https://code.dcycle.io/api-reference/errors#BULK_RECORDS_REJECTED",
"title": "Unprocessable Entity",
"status": 422,
"code": "BULK_RECORDS_REJECTED",
"detail": "1 of the submitted records are invalid; nothing was written.",
"errors": [
{
"source_row_index": 0,
"client_row_id": null,
"error_code": "NOT_FOUND",
"error_params": { "field": "ids", "value": "3f2e1d0c-9b8a-4796-8584-a3b2c1d0e9f8" }
}
],
"rejected": 1,
"request_id": "b2248a31-0f1b-4a7d-83ce-b29bd5977b4c"
}
{ "dry_run": true, "submitted": 1, "valid": 1 }
How it works
- The request checks every id. One that does not exist, is outside your organization’s perimeter or is repeated
rejects the whole request with
422, and nothing is deleted. - The job deletes them in the background with their sections, emissions, calculation data and custom column values. A shipment read from a file leaves that file settled once it has no shipment left.
- When every chunk is done the job is
completed(orcompleted_with_errors). For a job submitted with an API key,ingest_job.finishedis sent with"operation": "delete"to the webhook endpoints of thex-organization-idorganization.
Request
Headers
string
required
Your API key (see Authentication).
string
required
Your organization. Its shipments, and those of the organizations under it that you can write to, can be deleted.
string
required
1 to 255 characters, unique per batch. A retry with the same key and body returns the original job
(with
Idempotent-Replayed: true); the same key with another body is
422 IDEMPOTENCY_KEY_REUSED, and while the first request is still being processed 409 IDEMPOTENCY_KEY_IN_PROGRESS.Query Parameters
boolean
default:"false"
Check only: the same
422 for bad ids, nothing deleted, no job; 200 with {"dry_run": true, "submitted": n, "valid": n} when every id is valid.Body Parameters
array[uuid]
required
Shipment (transport route) ids, 1 to 5,000, each once.
Response
202 Accepted with the job (entity_type: transport_routes, operation: delete) and a Location header to it.
GET /v2/ingest-jobs/{id}/items has one item per shipment, in the order sent;
an item is failed with DELETE_FAILED when its shipment was already gone by the time the job reached it.
Errors
Problem details. Per-id codes inerrors[].error_code of a 422 BULK_RECORDS_REJECTED
(source_row_index is the position in ids):
error_code | Cause |
|---|---|
NOT_FOUND | The shipment does not exist, is deleted or is outside your organization’s perimeter (all answer the same). |
DUPLICATE_ID | The shipment is already in the request. |
401 for a missing or invalid API key, 403 LOGGED_USER_NOT_MEMBER when the key’s user is not a
member of the organization, 422 REQUEST_VALIDATION_FAILED for a malformed body (no ids, more than 5,000, no
Idempotency-Key), 422 IDEMPOTENCY_KEY_REUSED, 409 IDEMPOTENCY_KEY_IN_PROGRESS, and 429 beyond the
rate limits.
Limits
| Limit | Value |
|---|---|
| Ids per request | 1 to 5,000 |
| Shipments per deletion chunk | 200 |
Related Endpoints
Create Freight Transports (v2)
Create shipments in bulk
List Transport Routes
Find the ids to delete
Get Ingest Job
Follow the deletion
List Job Items
The outcome of each id
Was this page helpful?