---
search:
  tags:
    - Inventory
    - POST
seo:
  description: >-
    Cancels only before shipping and restores units to… Reference for the POST
    /inventory/shipments/{id}/cancel endpoint in the Toreca Cloud Partner API.
sidebar:
  label: Cancel an unshipped shipment
  badge: POST
title: Cancel an unshipped shipment
type: openapi-operation
---
Cancels only before shipping and restores units to allocated. Shipped shipments fail with shipment_shipped. In addition to inventory:read, this needs its operation scope and the approving member’s inventory.write permission.

`POST /inventory/shipments/{id}/cancel`

**Request body** (`application/json`, required)

- `reason` (string, required)

Request body example:

```json
{
  "reason": "string"
}
```

**Responses**

- `200` — Success
- `400` — \`invalid\_request\`: a parameter is invalid.
- `401` — \`invalid\_token\`: the token is missing, expired, or for another resource.
- `403` — One of \`insufficient\_scope\`, \`connection\_revoked\`, \`client\_disabled\` or \`forbidden\`.
- `404` — \`not\_found\`
- `409` — Conflict, reused requestId or receipt not confirmed
- `422` — The state, target or value refuses the operation. Inspect error and affected IDs.

Response example, 200:

```json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "orderNumber": "string",
  "status": "reserved",
  "version": 0,
  "destinationLabel": "string",
  "externalRef": "string",
  "trackingNumber": "string",
  "shippedAt": "2019-08-24T14:15:22Z",
  "items": [
    {
      "commitmentId": "4e1ecf7c-8127-4207-92b0-010ff43ff54d",
      "inventoryItemId": "ef1bc09e-447a-46aa-a9d9-d86e3d490831",
      "assetNumber": "string",
      "status": "string",
      "sale": {
        "amountMinor": 0,
        "currency": "string",
        "source": "string"
      }
    }
  ]
}
```
