# Štítky dopravce

Nákup zásilky dopravce: seznam způsobů → cenová nabídka → vytvoření štítku → stažení PDF → sledování → příjem událostí → zrušení (nebo uzavření dne).

Tato příručka dokumentuje pouze následující operace. Proveďte je v pořadí.

Nahraďte `YOUR_HOST`, `ACCESS_TOKEN` a `shipping_method` svými hodnotami. Id způsobů se liší podle účtu — nikdy je nehardcodujte.

## 1. Přihlášení

```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
```

GraphQL používá stejnou hlavičku na `POST /api/graphql`.

[Příručka REST](/api/documentation#/paths/v1-user-login/post) · [Příručka GraphQL](/api/graphql/documentation#/user/userLogin)

**Ověření:** přihlášení vrátí `access_token`. Pozdější volání bez něj vrátí `401`.

## 2. Seznam způsobů odeslání

**REST:** `POST /api/v1/labelservice/getShippingMethodList` — [Příručka 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}'
```

Každý řádek má:

| Pole | Použití |
|---|---|
| `id` | `shipping_method` v každém pozdějším volání |
| `name` | Zobrazovaný název |
| `unique_identifier` | Stabilní kód |
| `options.signature_option` | Podpis dostupný |
| `options.insurance_option` | Pojištění dostupné |
| `options.multi_package` | Více než jeden kus |

**GraphQL:** `labelserviceGetShippingMethodList` ([Příručka GraphQL](/api/graphql/documentation#/labelservice/labelserviceGetShippingMethodList)) (JSON skalár).

**Ověření:** seznam není prázdný. Vybrali jste jedno `id` a víte, zda ten způsob povoluje podpis, pojištění a více zásilek. Prázdný seznam znamená, že na účtu není zapnutý žádný způsob.

## 3. Cenová nabídka

Zkušební běh. Dopravce je tázán na cenu; nic se nerezervuje. Tělo má stejný tvar jako při vytváření. `shipping_method` je povinné.

**REST:** `POST /api/v1/labelservice/rate` — [Příručka 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.

Pro více než jeden kus pošlete `packages: [{ ref, weight, length, width, height, weight_unit, dimension_unit }]`. `shipping_from` (id adresáře) nebo `shipping_from_code` může nahradit blok `sender_*`.

**GraphQL:** `labelserviceRate` ([Příručka GraphQL](/api/graphql/documentation#/labelservice/labelserviceRate)).

**Ověření:** `result` je true a máte cenu (a dny přepravy, když je dopravce pošle). Pokud není sazba, opravte cíl / zásilku / způsob **před** vytvořením.

## 4. Vytvoření štítku

Tím se zásilka rezervuje u dopravce.

**REST:** `POST /api/v1/labelservice/submitOrder` — [Příručka REST](/api/documentation#/paths/v1-labelservice-submitOrder/post)

Stejné tělo jako krok 3. Pošlete `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` ([Příručka GraphQL](/api/graphql/documentation#/labelservice/labelserviceSubmitOrder)).

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

| Pole | Použití |
|---|---|
| `id` | Id objednávky Superroute — stažení a zrušení |
| `tracking_numbers` | Dejte je kupujícímu; sledování je přijímá |
| `external_id` | Id zásilky dopravce |
| `shipping_price` | Účtovaná částka |

**Ověření:** `tracking_numbers` není prázdné. Uložte `id` a čísla. Stejný `Idempotency-Key` nesmí koupit druhý štítek.

## 5. Stažení PDF

**REST:** `POST /api/v1/labelservice/getShippingLabel` — [Příručka 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` může být `ORDER_ID`, `TRACKING_NUMBER` nebo `REF`. `base64: 0` streamuje PDF. Toto je **oficiální štítek dopravce**. Počet kusů je dán rezervací.

**GraphQL:** `labelserviceGetShippingLabel` ([Příručka GraphQL](/api/graphql/documentation#/labelservice/labelserviceGetShippingLabel)).

**Ověření:** PDF se otevře a ukáže čárový kód / sledovací číslo dopravce z kroku 4. Vytiskněte jednu testovací kopii a zahoďte ji — nedávejte testovací štítek dopravci.

## 6. Sledování

Bez tokenu. Použijte číslo z `tracking_numbers`:

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

[Příručka REST](/api/documentation#/operations/getPublicTracking) · [Příručka 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` je true, když události přicházejí od dopravce. Větvení podle `tracking_event_status_id` / `tracking_event_key`, ne podle `description`. Nejnovější událost je první v `data`. Rané události mohou stále být «informace odeslány», dokud dopravce nenačte zásilku. `500` je doručeno; `proofs[]` pak může obsahovat podpis (`type` `1`) nebo fotku (`type` `2`).

**Ověření:** vyhledání vrátí zásilku, kterou jste právě vytvořili. Neznámé číslo je `result: false` / 404.

## 7. Konfigurace oznámení o událostech

| Nastavení | Událost | Kdy |
|---|---|---|
| `order_create_webhook_url` | `order.created` | Uložit `id` a sledovací čísla dopravce |
| `tracking_event_webhook_url` | `tracking.event` | Skeny dopravce, na cestě, doručeno |
| `order_status_change_webhook_url` | `order.status_change` | Stav ve vašem systému |
| `order_cancel_failed_webhook_url` | `order.cancel_failed` | Zrušení odmítnuto, protože dopravce už má zásilku |

**REST:** `PUT /api/v1/webhook-settings` — [Příručka REST](/api/documentation#/paths/v1-webhook-settings/put)

**GraphQL:** `webhookSettingsUpdate` ([Příručka 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
  }'
```

Ověřujte **v2** nad surovým tělem: `HMAC_SHA256(timestamp + "." + raw_body, secret)` proti `X-Webhook-Signature-V2`. Deduplikujte podle `X-Webhook-Event-Id`. Odpovězte **2xx do 3 sekund**.

```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;
}
```

**Ověření:** jeden testovací `submitOrder` vyprodukuje `order.created` s těmito `tracking_numbers`. Špatné tajemství je `401` od vašeho přijímače.

## 8. Zrušení

Jen dokud to dopravce ještě povoluje (obvykle před vyzvednutím).

**REST:** `POST /api/v1/labelservice/cancelShippingLabel` — [Příručka 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` ([Příručka GraphQL](/api/graphql/documentation#/labelservice/labelserviceCancelShippingLabel)).

Dopravce, který už zásilku má, odmítne — to je `order.cancel_failed`.

**Ověření:** druhé zrušení je bezpečné. Sledování už zásilku nebere jako živou.

## 9. Konec dne (jen pokud to tento způsob vyžaduje)

Někteří dopravci potřebují denní manifest.

**REST:** `POST /api/v1/labelservice/endofday` — [Příručka 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` ([Příručka GraphQL](/api/graphql/documentation#/labelservice/labelserviceEndofday)).

Zavolejte jednou po posledním štítku odesílacího dne. Tento krok přeskočte, když způsob z kroku 2 takové požadavky nemá.

**Ověření:** tělo úspěchu (nebo potvrzení dopravce) vypíše dnešní štítky. Spusťte nejdřív na testovacím způsobu.

## Seznam testů

Použijte cíl, který ovládáte, a způsob, který lze zrušit:

- [ ] Seznam způsobů není prázdný; zachytili jste jedno `id`.
- [ ] Sazba vrátí cenu pro ten způsob a cíl.
- [ ] Submit vrátí `tracking_numbers`; stejný `Idempotency-Key` nekoupí druhý štítek.
- [ ] PDF štítku se otevře a ukáže sledovací číslo dopravce.
- [ ] Veřejné sledování najde zásilku podle toho čísla.
- [ ] Přijde `order.created`; podpis v2 ověří.
- [ ] Zrušení uspěje, **nebo** jste potvrdili, že tento způsob po rezervaci nelze zrušit.
- [ ] Pokud způsob potřebuje konec dne, testovací běh skončí bez chyby.