# Bulk delete shipment carriers

Operation ID: `bulkDeleteShipmentCarriers`

Group: Inventory › Shipment Carriers

[Open in the interactive reference](https://docs.api.lensing.ai/lensing/v1/endpoints/bulkDeleteShipmentCarriers)

`POST /inventory/shipment-carriers/bulk-delete`

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Deletes multiple shipment carriers in one request. If any id is unknown, or names a carrier that outbound shipments still reference, none are deleted. The error gives that id's position in the request.

The response lists the deleted carriers in the order you sent them, each with its id and the name it had. To retire a carrier that is still in use, set active to false with PATCH inventory/shipment-carriers/:id.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Api-Version` | header | string · v1 | yes | The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`. |
| `Idempotency-Key` | header | string | no | An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with `400 IDEMPOTENCY_NOT_SUPPORTED` rather than silently ignored. |

## Request body

Required, `application/json`: bulkDeleteShipmentCarriersInput.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `ids` | array<string> | yes | The unique identifiers for the shipment carriers to delete. If any id is unknown or its carrier is still named on a shipment, the whole call is rejected and nothing is deleted. Example: `["3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45","e57a0d34-9f62-4b18-bc25-71a6e8039d4b"]`. |

```json
{
  "ids": [
    "3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45",
    "e57a0d34-9f62-4b18-bc25-71a6e8039d4b"
  ]
}
```

## Response

`200` Success

Under `data` (bulkDeleteShipmentCarriersOutput):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `deleted` | array<object> | yes | The deleted shipment carriers, in the same order as the input. |
| `deleted[].id` | string | yes | The unique identifier for the deleted shipment carrier. |
| `deleted[].name` | string | yes | The name the deleted carrier held. |

```json
{
  "data": {
    "deleted": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "<name>"
      }
    ]
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}
```

## Response headers

- `Idempotency-Replayed` — Present and `true` only when this response replays a previously stored one for the same Idempotency-Key, rather than reflecting a live execution. Absent on a live response - never sent as `false`.

## Errors

| Code | Status |
| --- | --- |
| `NOT_FOUND` | 400 |
| `SHIPMENT_CARRIER_IN_USE` | 400 |
| `IDEMPOTENCY_KEY_CONFLICT` | 409 |
| `IDEMPOTENCY_PAYLOAD_MISMATCH` | 422 |

## Statuses

- `400` — Invalid request or business failure. Codes: NOT_FOUND, SHIPMENT_CARRIER_IN_USE
- `401` — The request carries no valid access token.
- `403` — Not authorized
- `404` — Not found
- `409` — The Idempotency-Key is still being processed by another request.
- `422` — The Idempotency-Key was already used with a different request payload.
- `429` — Too many requests from this client address. The response has no body and no `Retry-After` header.
- `500` — Internal server error