# Armazenamento e saída

Dar entrada da mercadoria em armazenamento de armazém e depois expedir os artigos armazenados: configuração → cotar → criar o armazenamento → pagar → listar artigos ainda em armazém → estimar a saída → criar a saída → pagar → rastrear → cancelar.

Este guia documenta apenas as operações seguintes. Execute-as em sequência. A autenticação usa uma conta de **cliente**.

Substitua `YOUR_HOST` e `ACCESS_TOKEN` pelos valores do seu ambiente.

## 1. Autenticação (cliente)

```bash
curl -X POST https://YOUR_HOST/api/v1/user/customer/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`.

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

## 2. Configuração do armazenamento

**REST:** `GET /api/v1/customer/storage-orders/config` — [Manual REST](/api/documentation#/paths/v1-customer-storage-orders-config/get)

```bash
curl https://YOUR_HOST/api/v1/customer/storage-orders/config \
  -H "Authorization: Bearer ACCESS_TOKEN"
```

**GraphQL:** `customerStorageOrderConfig` ([Manual GraphQL](/api/graphql/documentation#/customer/customerStorageOrderConfig))

**Verificação:** registou um `id` de armazém e, se o catálogo não estiver vazio, um `id` de embalagem.

## 3. Cotar o armazenamento

**REST:** `POST /api/v1/customer/storage-orders/calculate-price`

```bash
curl -X POST https://YOUR_HOST/api/v1/customer/storage-orders/calculate-price \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "warehouse_id": 7,
    "start_date": "2026-09-10",
    "end_date": "2026-10-10",
    "items": [{
      "qty": 1,
      "length": 30,
      "width": 20,
      "height": 15,
      "dimension_unit": 2,
      "weight": 2,
      "weight_unit": 2
    }]
  }'
```

**Verificação:** `success` ou `result` é true e tem um preço. Falta de `warehouse_id` / datas é `400`.

## 4. Criar o pedido de armazenamento

**REST:** `POST /api/v1/customer/storage-orders`

```bash
curl -X POST https://YOUR_HOST/api/v1/customer/storage-orders \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: dev-store-001" \
  -d '{
    "warehouse_id": 7,
    "start_date": "2026-09-10",
    "end_date": "2026-10-10",
    "items": [{
      "description": "Box A",
      "qty": 1,
      "length": 30,
      "width": 20,
      "height": 15,
      "dimension_unit": 2,
      "weight": 2,
      "weight_unit": 2,
      "value": 100
    }]
  }'
```

**Verificação:** a resposta tem `data.id`. Guarde esse id do pedido de armazenamento.

## 5. Pagar o armazenamento

**REST:** `POST /api/v1/customer/storage-orders/{id}/pay`

```bash
curl -X POST https://YOUR_HOST/api/v1/customer/storage-orders/1024/pay \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
```

Opcional: primeiro `GET /api/v1/customer/storage-orders/{id}/payment-info`.

**REST:** `GET /api/v1/customer/storage-orders/{id}` — [Manual REST](/api/documentation#/paths/v1-customer-storage-orders-id/get)

**GraphQL:** `customerStorageOrderShow` ([Manual GraphQL](/api/graphql/documentation#/customer/customerStorageOrderShow))

**Verificação:** o pedido de armazenamento está pago / confirmado. `402` significa carregar a carteira e tentar de novo.

A saída abaixo só funciona depois de os volumes serem **recebidos** no armazém. Para um teste, espere até a equipa (ou uma receção de teste) os ter marcado como recebidos e continue.

## 6. Listar artigos ainda em armazém

**REST:** `GET /api/v1/customer/shipout-orders/available-items` — [Manual REST](/api/documentation#/paths/v1-customer-shipout-orders-available-items/get)

```bash
curl "https://YOUR_HOST/api/v1/customer/shipout-orders/available-items?warehouse_id=7" \
  -H "Authorization: Bearer ACCESS_TOKEN"
```

**GraphQL:** `customerShipoutAvailableItems` ([Manual GraphQL](/api/graphql/documentation#/customer/customerShipoutAvailableItems))

**Verificação:** registou um ou mais `storage_package_ids` (exemplo `5001`). Lista vazia significa que ainda nada foi recebido — não crie uma saída. `403` significa que a saída está desativada para este cliente.

## 7. Estimar e criar a saída

**REST:** `GET /api/v1/customer/shipout-orders/services?warehouse_id=7` — [Manual REST](/api/documentation#/paths/v1-customer-shipout-orders-services/get)

Registe um `service_code`.

**REST:** `POST /api/v1/customer/shipout-orders/services/{serviceCode}/estimate` — [Manual REST](/api/documentation#/paths/v1-customer-shipout-orders-services-serviceCode--estimate/post)

```bash
curl -X POST https://YOUR_HOST/api/v1/customer/shipout-orders/services/intl_express/estimate \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "warehouse_id": 7,
    "delivery_postcode": "M5V2H1",
    "delivery_country": "CA",
    "packages": [{
      "weight": 2.5,
      "length": 30,
      "width": 20,
      "height": 15,
      "weight_unit": 2,
      "dimension_unit": 2
    }]
  }'
```

**REST:** `POST /api/v1/customer/shipout-orders/services/{serviceCode}/orders` — [Manual REST](/api/documentation#/paths/v1-customer-shipout-orders-services-serviceCode--orders/post)

```bash
curl -X POST https://YOUR_HOST/api/v1/customer/shipout-orders/services/intl_express/orders \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: dev-shipout-001" \
  -d '{
    "warehouse_id": 7,
    "storage_package_ids": [5001],
    "delivery_name": "Jane Recipient",
    "delivery_telephone": "5555555555",
    "delivery_email": "jane@example.com",
    "delivery_address_1": "123 King St W",
    "delivery_city": "Toronto",
    "delivery_province": "ON",
    "delivery_country": "CA",
    "delivery_postcode": "M5V2H1"
  }'
```

**GraphQL:** `customerCreateShipoutOrder` ([Manual GraphQL](/api/graphql/documentation#/customer/customerCreateShipoutOrder))

**Verificação:** a resposta tem um `id` de saída. Os volumes de armazenamento selecionados ficam bloqueados neste pedido.

## 8. Pagar a saída, rastrear, eventos

**REST:** `POST /api/v1/customer/shipout-orders/{id}/pay` — [Manual REST](/api/documentation#/paths/v1-customer-shipout-orders-id--pay/post)

```bash
curl -X POST https://YOUR_HOST/api/v1/customer/shipout-orders/8001/pay \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
```

**GraphQL:** `customerPayShipout` ([Manual GraphQL](/api/graphql/documentation#/customer/customerPayShipout))

**REST:** `GET /api/v1/customer/shipout-orders/{id}` — [Manual REST](/api/documentation#/paths/v1-customer-shipout-orders-id/get)

Quando existe um número de rastreio:

```bash
curl https://YOUR_HOST/api/v1/tracking/SR123456789012
```

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

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

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

Verifique **v2**: `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:** o pagamento regista um montante (ou `402` / `422` com um motivo claro). O rastreio público encontra o envio assim que existir um número.

## 9. Cancelar uma saída de teste

**REST:** `POST /api/v1/customer/shipout-orders/{id}/cancel` — [Manual REST](/api/documentation#/paths/v1-customer-shipout-orders-id--cancel/post)

```bash
curl -X POST https://YOUR_HOST/api/v1/customer/shipout-orders/8001/cancel \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
```

**GraphQL:** `customerCancelShipout` ([Manual GraphQL](/api/graphql/documentation#/customer/customerCancelShipout))

Isto liberta o bloqueio dos volumes de armazenamento. O próprio armazenamento cancela-se com `POST /api/v1/customer/storage-orders/{id}/cancel` enquanto ainda for permitido.

**Verificação:** `422` significa que este estado não pode ser cancelado. Após um cancelamento bem-sucedido da saída, o passo 6 volta a listar os volumes.

## Lista de testes

- [ ] A configuração do armazenamento devolve um `id` de armazém.
- [ ] A cotação do armazenamento devolve um preço.
- [ ] A criação do armazenamento devolve `data.id`.
- [ ] O pagamento do armazenamento é bem-sucedido, **ou** confirmou que a carteira precisa de ser carregada.
- [ ] Os artigos disponíveis listam volumes recebidos (`storage_package_ids`).
- [ ] A estimativa da saída devolve um preço ou `has_items_needing_quote`.
- [ ] A criação da saída devolve um `id` e bloqueia esses volumes.
- [ ] O pagamento da saída é bem-sucedido (ou `402` / `422` é compreendido).
- [ ] O rastreio público encontra o envio assim que existir um número de rastreio.
- [ ] O cancelamento da saída liberta os volumes, **ou** este estado não pode ser cancelado.