# Cancela um pedido, e o que já saiu da prateleira volta à posição

**POST** `/v1/objects/sales-order/{id}/cancel`

Aberto, o pedido só deixa de reservar. Já separado, a reserva é solta e nasce a OS de devolver à posição (`return`). Embarcado ou cancelado antes, recusa.

> **Ação da chave: `sales_order.cancel`** Quem cria a chave escolhe as ações que ela abre; sem esta, a rota recusa com `api_key_action_not_granted`.

> **Toda escrita pede `Idempotency-Key`** Um UUID por escrita. Repetida com o mesmo corpo, devolve a mesma resposta sem escrever de novo. Os SDKs mandam sozinhos.

## Parâmetros do caminho

- `id` (string, obrigatório)

## Corpo

- `reason` (string): O motivo, gravado no fato.
- `source` ("qr-camera" | "code128-gun" | "typed" | "import", obrigatório): De onde veio o pedido de escrita: câmera, leitor, digitado ou sistema (`import`).

## Devolve

O `data` do envelope `{ ok, data, error, error_code, field, trace_id }`:

- `sales_order` (objeto, obrigatório)
  - `closed_orders` (lista de any): Só no pedido já separado: as OS que fecharam por ficar sem parada.
  - `customer` (string, ou nulo)
  - `depot_id` (uuid)
  - `dropped_stops` (integer): Só no pedido já separado: as paradas de separação que saíram.
  - `freed_units` (integer): Só no pedido já separado: as unidades cuja reserva foi solta.
  - `id` (uuid)
  - `lines` (integer)
  - `order_ref` (string)
  - `return` (objeto): Só no pedido já separado: a OS de devolver à posição.
  - `status` ("canceled")
  - `touched_orders` (lista de uuid): Só no pedido já separado: as OS mexidas.
  - `units` (integer)

## Recusas

### HTTP 400 · Pedido mal formado

- [`invalid_idempotency_key`](/erros/invalid_idempotency_key.md) (HTTP 400): Toda escrita pede o cabeçalho `Idempotency-Key` com um UUID.
- [`version_unknown`](/erros/version_unknown.md) (HTTP 400): A `Kernos-Version` pedida não existe. Use uma das versões declaradas no cabeçalho, ou não o mande.

### HTTP 401 · Sem credencial válida

- [`api_key_expired`](/erros/api_key_expired.md) (HTTP 401): A chave venceu. Gire a chave no painel e use a nova.
- [`api_key_wrong_environment`](/erros/api_key_wrong_environment.md) (HTTP 401): A chave é do outro ambiente: `ksk_test_` vai em https://stag.kernos.com.br, `ksk_live_` em https://api.kernos.com.br.
- [`unauthenticated`](/erros/unauthenticated.md) (HTTP 401): Credencial ausente, inválida ou expirada.

### HTTP 403 · Sem permissão

- [`agent_token_out_of_scope`](/erros/agent_token_out_of_scope.md) (HTTP 403): O token de agente (`kat_`) só vale na porta MCP. Para a API, use o token de sessão ou uma chave de integração.
- [`api_key_action_not_granted`](/erros/api_key_action_not_granted.md) (HTTP 403): A chave não tem esta ação. Edite as ações da chave no painel.
- [`api_key_out_of_scope`](/erros/api_key_out_of_scope.md) (HTTP 403): A chave só vale nas rotas do contrato público.
- [`depot_out_of_reach`](/erros/depot_out_of_reach.md) (HTTP 403): Quem chama não alcança o CD deste objeto. Peça alcance ao CD ou use outra credencial.
- [`forbidden_role`](/erros/forbidden_role.md) (HTTP 403): O papel de quem chama nesta empresa não permite esta ação.
- [`module_not_subscribed`](/erros/module_not_subscribed.md) (HTTP 403): A empresa não assina o módulo desta rota.
- [`tenant_mismatch`](/erros/tenant_mismatch.md) (HTTP 403): A credencial não pertence à empresa do endereço chamado.
- [`tenant_unavailable`](/erros/tenant_unavailable.md) (HTTP 403): A empresa está indisponível no momento.

### HTTP 404 · Não encontrado

- [`not_found`](/erros/not_found.md) (HTTP 404): Não existe objeto com esse identificador nesta empresa.

### HTTP 409 · Conflito

- [`idempotency_key_reused`](/erros/idempotency_key_reused.md) (HTTP 409): Esta `Idempotency-Key` já foi usada com outro corpo. Gere uma chave nova para uma escrita nova.
- [`order_loaded`](/erros/order_loaded.md) (HTTP 409): O pedido tem volume carregado num envio: tire o volume do envio antes de cancelar.
- [`order_not_open`](/erros/order_not_open.md) (HTTP 409): Um dos pedidos já está em outra onda ou já saiu.

### HTTP 422 · Não processável

- [`invalid_source`](/erros/invalid_source.md) (HTTP 422): Origem da leitura inválida: use um dos valores declarados no campo.

### HTTP 429 · Muitos pedidos

- [`rate_limited`](/erros/rate_limited.md) (HTTP 429): Muitos pedidos por segundo com esta chave. Espere o `Retry-After`, em segundos, e tente de novo.

#### curl

**Cancela um pedido, e o que já saiu da prateleira volta à posição**

```sh
curl -X POST "https://stag.kernos.com.br/v1/objects/sales-order/<id>/cancel" \
  -H "Authorization: Bearer ksk_test_…" \
  -H "Kernos-Version: 2026-10-03" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{ "source": "import", "reason": "Cliente desistiu" }'
```

#### Node

**Cancela um pedido, e o que já saiu da prateleira volta à posição**

```js
import { Kernos } from '@kernosbr/kernos'

const kernos = new Kernos(process.env.KERNOS_API_KEY)
const result = await kernos.salesOrder.cancel('<id>', { source: 'import', reason: 'Cliente desistiu' })
```

#### Python

**Cancela um pedido, e o que já saiu da prateleira volta à posição**

```python
import os
from kernos import Kernos

kernos = Kernos(os.environ["KERNOS_API_KEY"])
result = kernos.sales_order.cancel("<id>", {"source": "import", "reason": "Cliente desistiu"})
```

#### PHP

**Cancela um pedido, e o que já saiu da prateleira volta à posição**

```php
<?php
$kernos = new Kernos\Kernos(getenv('KERNOS_API_KEY'));
$result = $kernos->salesOrder->cancel('<id>', ['source' => 'import', 'reason' => 'Cliente desistiu']);
```

#### Java

**Cancela um pedido, e o que já saiu da prateleira volta à posição**

```java
Kernos kernos = new Kernos(System.getenv("KERNOS_API_KEY"));
JsonNode result = kernos.salesOrder().cancel("<id>", Map.of("source", "import", "reason", "Cliente desistiu"));
```

#### C#

**Cancela um pedido, e o que já saiu da prateleira volta à posição**

```csharp
var kernos = new KernosClient(Environment.GetEnvironmentVariable("KERNOS_API_KEY"));
var result = await kernos.SalesOrder.CancelAsync("<id>", new { source = "import", reason = "Cliente desistiu" });
```

#### Go

**Cancela um pedido, e o que já saiu da prateleira volta à posição**

```go
client, err := kernos.New(os.Getenv("KERNOS_API_KEY"))
result, err := client.SalesOrder.Cancel(ctx, "<id>", map[string]any{"source": "import", "reason": "Cliente desistiu"})
```

#### Rust

**Cancela um pedido, e o que já saiu da prateleira volta à posição**

```rust
let kernos = Kernos::new(&std::env::var("KERNOS_API_KEY")?)?;
let result = kernos.sales_order().cancel("<id>", &json!({ "source": "import", "reason": "Cliente desistiu" }), None)?;
```

**Resposta · 200 (a forma, sem dado real)**

```json
{
  "ok": true,
  "data": {
    "sales_order": {
      "closed_orders": [
        null
      ],
      "customer": "…",
      "depot_id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50",
      "dropped_stops": 0,
      "freed_units": 0,
      "id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50",
      "lines": 0,
      "order_ref": "…",
      "return": {},
      "status": "canceled",
      "touched_orders": [
        "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50"
      ],
      "units": 0
    }
  },
  "error": null,
  "error_code": null,
  "field": null,
  "trace_id": null
}
```

> **Ambiente** `ksk_test_` fala com `https://stag.kernos.com.br`; `ksk_live_`, com `https://api.kernos.com.br`. O prefixo da chave escolhe o endereço.