# Etiquetas de transportadora

Comprar um envio de transportadora: listar métodos → cotar → criar a etiqueta → descarregar o PDF → rastrear → receber eventos → cancelar (ou fechar o dia).

Este guia documenta apenas as operações seguintes. Execute-as em sequência.

Substitua `YOUR_HOST`, `ACCESS_TOKEN` e `shipping_method` pelos seus. Os id de método diferem por conta — nunca os fixe no código.

## 1. Autenticação

```bash
curl -X POST https://YOUR_HOST/api/v1/user/login \
  -H "Content-Type: application/json" \
  -d '{"email":"you@example.com","password":"your_password"}'
```

```
Authorization: Bearer ACCESS_TOKEN
```

O GraphQL usa o mesmo cabeçalho em `POST /api/graphql`.

[Manual REST](/api/documentation#/paths/v1-user-login/post) · [Manual GraphQL](/api/graphql/documentation#/user/userLogin)

**Verificação:** o login devolve `access_token`. Uma chamada posterior sem ele devolve `401`.

## 2. Listar métodos de envio

**REST:** `POST /api/v1/labelservice/getShippingMethodList` — [Manual REST](/api/documentation#/paths/v1-labelservice-getShippingMethodList/post)

```bash
curl -X POST https://YOUR_HOST/api/v1/labelservice/getShippingMethodList \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"detail": true}'
```

Cada linha tem:

| Campo | Uso |
|---|---|
| `id` | `shipping_method` em cada chamada posterior |
| `name` | Nome de apresentação |
| `unique_identifier` | Código estável |
| `options.signature_option` | Assinatura disponível |
| `options.insurance_option` | Seguro disponível |
| `options.multi_package` | Mais de uma peça |

**GraphQL:** `labelserviceGetShippingMethodList` ([Manual GraphQL](/api/graphql/documentation#/labelservice/labelserviceGetShippingMethodList)) (escalar JSON).

**Verificação:** a lista não está vazia. Escolheu um `id` e sabe se esse método permite assinatura, seguro e vários volumes. Uma lista vazia significa que nenhum método está ativo na conta.

## 3. Cotar

Ensaio. Pede-se um preço à transportadora; nada é reservado. O corpo tem a mesma forma da criação. `shipping_method` é obrigatório.

**REST:** `POST /api/v1/labelservice/rate` — [Manual REST](/api/documentation#/paths/v1-labelservice-rate/post)

```bash
curl -X POST https://YOUR_HOST/api/v1/labelservice/rate \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "shipping_method": 59,
    "name": "Jane Recipient",
    "telephone": "5555555555",
    "email": "jane@example.com",
    "address_1": "6701 RUE HADLEY",
    "city": "Montreal",
    "province": "QC",
    "postcode": "H4E3R3",
    "country": "CA",
    "weight": 1,
    "length": 30,
    "width": 20,
    "height": 10,
    "dimension_unit": 2,
    "weight_unit": 2,
    "signature_option": 0,
    "insurance_option": 0,
    "package_type": "parcel",
    "ref": "DEV-LABEL-001",
    "sender_name": "Acme Warehouse",
    "sender_telephone": "5555555555",
    "sender_address_1": "2667 boul des sources",
    "sender_city": "Pointe-Claire",
    "sender_province": "QC",
    "sender_postcode": "H9S2H9",
    "sender_country": "CA"
  }'
```

`weight_unit`: `1` g, `2` kg, `3` oz, `4` lb. `dimension_unit`: `1` mm, `2` cm, `3` m, `4` in.

Para mais de uma peça, envie `packages: [{ ref, weight, length, width, height, weight_unit, dimension_unit }]`. `shipping_from` (id da agenda) ou `shipping_from_code` pode substituir o bloco `sender_*`.

**GraphQL:** `labelserviceRate` ([Manual GraphQL](/api/graphql/documentation#/labelservice/labelserviceRate)).

**Verificação:** `result` é true e tem um preço (e dias de trânsito, se a transportadora os enviar). Se não houver tarifa, corrija destino / volume / método **antes** de criar.

## 4. Criar a etiqueta

Isto reserva o envio com a transportadora.

**REST:** `POST /api/v1/labelservice/submitOrder` — [Manual REST](/api/documentation#/paths/v1-labelservice-submitOrder/post)

O mesmo corpo do passo 3. Envie `Idempotency-Key`.

```bash
curl -X POST https://YOUR_HOST/api/v1/labelservice/submitOrder \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: dev-label-001" \
  -d '{
    "shipping_method": 59,
    "name": "Jane Recipient",
    "telephone": "5555555555",
    "email": "jane@example.com",
    "address_1": "6701 RUE HADLEY",
    "city": "Montreal",
    "province": "QC",
    "postcode": "H4E3R3",
    "country": "CA",
    "weight": 1,
    "length": 30,
    "width": 20,
    "height": 10,
    "dimension_unit": 2,
    "weight_unit": 2,
    "signature_option": 0,
    "insurance_option": 0,
    "package_type": "parcel",
    "ref": "DEV-LABEL-001",
    "sender_name": "Acme Warehouse",
    "sender_telephone": "5555555555",
    "sender_address_1": "2667 boul des sources",
    "sender_city": "Pointe-Claire",
    "sender_province": "QC",
    "sender_postcode": "H9S2H9",
    "sender_country": "CA"
  }'
```

**GraphQL:** `labelserviceSubmitOrder` ([Manual GraphQL](/api/graphql/documentation#/labelservice/labelserviceSubmitOrder)).

```json
{
  "result": true,
  "id": 12345,
  "shipping_price": "12.50",
  "tracking_numbers": ["1Z999AA10123456784"],
  "external_id": "EXT_12345"
}
```

| Campo | Uso |
|---|---|
| `id` | Id de pedido Superroute — descarga e cancelamento |
| `tracking_numbers` | Dê-os ao comprador; o rastreio aceita-os |
| `external_id` | Id de envio da transportadora |
| `shipping_price` | Valor cobrado |

**Verificação:** `tracking_numbers` não está vazio. Guarde `id` e os números. A mesma `Idempotency-Key` não deve comprar uma segunda etiqueta.

## 5. Descarregar o PDF

**REST:** `POST /api/v1/labelservice/getShippingLabel` — [Manual REST](/api/documentation#/paths/v1-labelservice-getShippingLabel/post)

```bash
curl -X POST https://YOUR_HOST/api/v1/labelservice/getShippingLabel \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "12345",
    "type": "ORDER_ID",
    "base64": 1
  }'
```

`type` pode ser `ORDER_ID`, `TRACKING_NUMBER` ou `REF`. `base64: 0` envia um PDF. Esta é a **etiqueta oficial da transportadora**. O número de peças fica fixo pela reserva.

**GraphQL:** `labelserviceGetShippingLabel` ([Manual GraphQL](/api/graphql/documentation#/labelservice/labelserviceGetShippingLabel)).

**Verificação:** o PDF abre e mostra o código de barras / número de rastreio da transportadora do passo 4. Imprima uma cópia de teste e deite-a fora — não entregue uma etiqueta de teste a uma transportadora.

## 6. Rastrear

Sem token. Use um número de `tracking_numbers`:

```bash
curl https://YOUR_HOST/api/v1/tracking/1Z999AA10123456784
```

[Manual REST](/api/documentation#/operations/getPublicTracking) · [Manual GraphQL](/api/graphql/documentation#/tracking/trackingPublic)

**GraphQL:**

```graphql
query {
  trackingPublic(trackingNumber: "1Z999AA10123456784") {
    result
    deliveried
    is_third_party_tracking
    data {
      tracking_event_status_id
      tracking_event_key
      description
      updated_at_localized
    }
    proofs { file_id type full_url signed_url }
  }
}
```

`is_third_party_tracking` é true quando os eventos vêm da transportadora. Ramifique por `tracking_event_status_id` / `tracking_event_key`, não por `description`. O evento mais recente vai primeiro em `data`. Eventos iniciais podem ainda ser «informação submetida» até a transportadora digitalizar o volume. `500` é entregue; `proofs[]` pode então incluir assinatura (`type` `1`) ou foto (`type` `2`).

**Verificação:** a consulta devolve o envio que acabou de criar. Um número desconhecido é `result: false` / 404.

## 7. Configurar notificações de eventos

| Definição | Evento | Quando |
|---|---|---|
| `order_create_webhook_url` | `order.created` | Persistir `id` e números de rastreio da transportadora |
| `tracking_event_webhook_url` | `tracking.event` | Digitalizações da transportadora, em entrega, entregue |
| `order_status_change_webhook_url` | `order.status_change` | Estado no seu sistema |
| `order_cancel_failed_webhook_url` | `order.cancel_failed` | Cancelamento recusado porque a transportadora já tem o volume |

**REST:** `PUT /api/v1/webhook-settings` — [Manual REST](/api/documentation#/paths/v1-webhook-settings/put)

**GraphQL:** `webhookSettingsUpdate` ([Manual GraphQL](/api/graphql/documentation#/webhooks/webhookSettingsUpdate)).

```bash
curl -X PUT https://YOUR_HOST/api/v1/webhook-settings \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "order_create_webhook_url": "https://erp.example.com/hooks/superroute",
    "tracking_event_webhook_url": "https://erp.example.com/hooks/superroute",
    "webhook_sign_secret": "YOUR_LONG_RANDOM_SECRET",
    "webhook_verify_ssl": 1
  }'
```

Verifique **v2** sobre o corpo em bruto: `HMAC_SHA256(timestamp + "." + raw_body, secret)` contra `X-Webhook-Signature-V2`. Deduplique em `X-Webhook-Event-Id`. Responda **2xx em menos de 3 segundos**.

```php
$raw = file_get_contents('php://input');
$ts  = $_SERVER['HTTP_X_WEBHOOK_TIMESTAMP'] ?? '';
$sig = $_SERVER['HTTP_X_WEBHOOK_SIGNATURE_V2'] ?? '';
$expected = hash_hmac('sha256', $ts . '.' . $raw, $sharedSecret);
if (!hash_equals($expected, $sig)) {
    http_response_code(401);
    exit;
}
```

**Verificação:** um `submitOrder` de teste produz `order.created` com esses `tracking_numbers`. Um segredo errado é `401` do seu recetor.

## 8. Cancelar

Só enquanto a transportadora ainda o permitir (normalmente antes da recolha).

**REST:** `POST /api/v1/labelservice/cancelShippingLabel` — [Manual REST](/api/documentation#/paths/v1-labelservice-cancelShippingLabel/post)

```bash
curl -X POST https://YOUR_HOST/api/v1/labelservice/cancelShippingLabel \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id":"12345","type":"ORDER_ID"}'
```

**GraphQL:** `labelserviceCancelShippingLabel` ([Manual GraphQL](/api/graphql/documentation#/labelservice/labelserviceCancelShippingLabel)).

Uma transportadora que já tem o volume recusará — isso é `order.cancel_failed`.

**Verificação:** um segundo cancelamento é seguro. O rastreio já não trata o envio como ativo.

## 9. Fecho do dia (só se este método o exigir)

Algumas transportadoras precisam de um manifesto diário.

**REST:** `POST /api/v1/labelservice/endofday` — [Manual REST](/api/documentation#/paths/v1-labelservice-endofday/post)

```bash
curl -X POST https://YOUR_HOST/api/v1/labelservice/endofday \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"shipping_method": 59}'
```

**GraphQL:** `labelserviceEndofday` ([Manual GraphQL](/api/graphql/documentation#/labelservice/labelserviceEndofday)).

Chame-o uma vez depois da última etiqueta do dia de envio. Salte este passo quando o método do passo 2 não tiver essa exigência.

**Verificação:** o corpo de sucesso (ou a confirmação da transportadora) lista as etiquetas de hoje. Execute primeiro num método de teste.

## Lista de testes

Use um destino que controla e um método que possa ser cancelado:

- [ ] A lista de métodos não está vazia; capturou um `id`.
- [ ] A tarifa devolve um preço para esse método e destino.
- [ ] Submit devolve `tracking_numbers`; a mesma `Idempotency-Key` não compra uma segunda etiqueta.
- [ ] O PDF da etiqueta abre e mostra o número de rastreio da transportadora.
- [ ] O rastreio público encontra o envio por esse número.
- [ ] Chega `order.created`; a assinatura v2 verifica.
- [ ] Cancelar funciona, **ou** confirmou que este método não se pode cancelar depois de reservar.
- [ ] Se o método precisa de fecho do dia, uma execução de teste termina sem erro.