# Vyzvednutí a doručení

Vyzvednutí a poslední míle vlastní flotilou používají stejná API. Vytvoření objednávky vyzvednutí nebo doručení → tisk místního štítku → sledování → odběr oznámení o událostech → zrušení testovací objednávky.

`type` volí zastávku: `D` doručení, `P` vyzvednutí. Proveďte kroky v pořadí. Cenová nabídka je volitelná a před vytvořením objednávky není nutná.

Nahraďte `YOUR_HOST` a `ACCESS_TOKEN` hodnotami z vašeho prostředí.

## 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"}'
```

Vrácený `access_token` vložte do hlavičky požadavku:

```
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`. Následující požadavky bez tohoto tokenu vrátí `401`.

## 2. Cenová nabídka (volitelně)

Tento krok je volitelný. Vrací pouze cenovou nabídku; objednávka se nevytváří. Vytvoření nevyžaduje předchozí nabídku. Nastavte `type` na `D` (doručení) nebo `P` (vyzvednutí).

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

```bash
curl -X POST https://YOUR_HOST/api/v1/orders/rate \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "D",
    "from_postcode": "H9S2H9",
    "from_country": "CA",
    "to_postcode": "H4B2T5",
    "to_country": "CA",
    "packages": [{
      "weight": 1,
      "weight_unit": 2,
      "length": 30,
      "width": 20,
      "height": 10,
      "dimension_unit": 2
    }]
  }'
```

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

```json
{
  "result": true,
  "shipping_price": "6.99",
  "currency": "CAD",
  "price_details": {
    "shipping_fee": "6.99",
    "tax_details": [{ "tax_name": "HST", "tax_rate": "13.00", "tax": "0.91" }]
  }
}
```

**GraphQL** (JSON skalár — bez selection set) (`ordersRate` ([Příručka GraphQL](/api/graphql/documentation#/orders/ordersRate))):

```graphql
mutation {
  ordersRate(
    type: "D"
    from_postcode: "H9S2H9"
    from_country: "CA"
    to_postcode: "H4B2T5"
    to_country: "CA"
    packages: [{ weight: 1, weight_unit: 2, length: 30, width: 20, height: 10, dimension_unit: 2 }]
  )
}
```

**Ověření:** pokud toto volání spustíte, `result` je true a `shipping_price` je číslo. Opakujte s `type` `P` pro nabídku vyzvednutí. Prázdná cena znamená, že PSČ není v aktivní oblasti. Vytvoření na tomto kroku nezávisí.

## 3. Vytvoření objednávky

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

Požadavek musí obsahovat `Idempotency-Key`, aby opakování nemohlo vytvořit druhou objednávku.

### Doručení (`type` `D`)

```bash
curl -X POST https://YOUR_HOST/api/v1/client/orderCreate \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: dev-local-001" \
  -d '{
    "type": "D",
    "need_pick_up": 0,
    "ref": "DEV-LOCAL-001",
    "name": "Jane Recipient",
    "telephone": "5555555555",
    "email": "jane@example.com",
    "address_1": "2667 boul des sources",
    "city": "Pointe-Claire",
    "province": "QC",
    "postcode": "H9S2H9",
    "country": "Canada",
    "packages": 1,
    "packagesDetail": [{
      "ref": "PKG-001",
      "weight": 1,
      "weight_unit": 2,
      "length": 30,
      "width": 20,
      "height": 10,
      "dimension_unit": 2
    }],
    "delivery_instruction": "Leave at the side door"
  }'
```

### Vyzvednutí (`type` `P`)

Stejný endpoint. Adresa je zastávka vyzvednutí.

```bash
curl -X POST https://YOUR_HOST/api/v1/client/orderCreate \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: dev-pickup-001" \
  -d '{
    "type": "P",
    "need_pick_up": 1,
    "ref": "DEV-PICKUP-001",
    "name": "Jane Sender",
    "telephone": "5555555555",
    "email": "jane@example.com",
    "address_1": "2667 boul des sources",
    "city": "Pointe-Claire",
    "province": "QC",
    "postcode": "H9S2H9",
    "country": "Canada",
    "packages": 1,
    "packagesDetail": [{
      "ref": "PKG-P-001",
      "weight": 1,
      "weight_unit": 2,
      "length": 30,
      "width": 20,
      "height": 10,
      "dimension_unit": 2
    }],
    "pickup_instruction": "Ring the side bell"
  }'
```

| Pole | Význam |
|---|---|
| `type` | `D` doručení, nebo `P` vyzvednutí |
| `need_pick_up` | `0` — zásilka už je ve skladu. `1` — řidič musí zásilku vyzvednout |
| `ref` | Externí reference pro vyhledání a odsouhlasení |
| `name` / adresa | Doručení: příjemce. Vyzvednutí: zastávka vyzvednutí |
| `auto_deduplication` | `1` odmítne druhou zásilku se stejnou `ref` zásilky |

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

```json
{ "result": true, "id": 12345, "tracking_number": "SR123456789012", "orders_status_id": 2 }
```

`orders_status_id` `2` je Nová. Uložte `id`, `tracking_number` a `ref`.

**Ověření:** pošlete **stejné** tělo se stejným `Idempotency-Key` znovu. Musíte dostat stejné `id` a nesmíte vytvořit druhou objednávku.

Objednávka se **nevytvoří**, když:

| `code` | Postup |
|---|---|
| `INSUFFICIENT_BALANCE` | `insufficient_balance` obsahuje required / available / shortfall. Dobijte, pak zkuste znovu. |
| `OUT_OF_DELIVERY_AREA` | Adresa je mimo obsluhovanou oblast a firma takové objednávky maže. Odešlete adresu v obsluhované oblasti. |
| `IDEMPOTENCY_CONFLICT` | Stejný idempotenční klíč byl znovu použit s jiným tělem požadavku. Použijte nový klíč. |

Zachovaná objednávka mimo oblast může přesto vrátit `result: true` s `shipping_price: null` a `warning`. Přečtěte to pole.

## 4. Načtení objednávky

```bash
curl "https://YOUR_HOST/api/v1/orders/list?page=1&per_page=50" \
  -H "Authorization: Bearer ACCESS_TOKEN"

curl https://YOUR_HOST/api/v1/orders/12345 \
  -H "Authorization: Bearer ACCESS_TOKEN"
```

**REST:** `GET /api/v1/orders/list` — všechny objednávky účtu, nejnovější jako první, každá se svými zásilkami a jejich položkami. Odesláním `page` a `per_page` společně stránkujete (`per_page` nejvýše 1000); bez nich dostanete nejnovějších 1000 objednávek a příznak `truncated`. [Příručka REST](/api/documentation#/paths/v1-orders-list/get)

**GraphQL:** `ordersList` ([Příručka GraphQL](/api/graphql/documentation#/orders/ordersList))

**REST:** `GET /api/v1/orders/{orderId}` — [Příručka REST](/api/documentation#/paths/v1-orders-orderId/get)

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

**Ověření:** objednávka patří k přihlášenému účtu. `ref` odpovídá hodnotě, kterou jste vytvořili. `tracking_number` odpovídá kroku 3.

## 5. Tisk místního štítku

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

```bash
curl -X POST https://YOUR_HOST/api/v1/shipping/getShippingLabel \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "SR123456789012",
    "type": "TRACKING_NUMBER",
    "base64": 1,
    "hide_sender_address": 0,
    "hide_receiver_address": 0
  }'
```

`type`: `TRACKING_NUMBER`, `ORDER_ID` nebo `REF`. `base64: 0` (výchozí) streamuje PDF. Při `base64: 1` je celé tělo odpovědi řetězec JSON na nejvyšší úrovni obsahující PDF v base64, nikoli objekt s polem `pdf_data`. Pokud chcete štítek v běžném objektu JSON, zavolejte raději `POST /api/v2/shipping/getShippingLabel`.

**GraphQL:** `shippingGetShippingLabel` ([Příručka GraphQL](/api/graphql/documentation#/shipping/shippingGetShippingLabel)). `shippingGetShippingLabelV2` ([Příručka GraphQL](/api/graphql/documentation#/shipping/shippingGetShippingLabelV2)) vždy vrací JSON (`pdf_data`).

**Ověření:** PDF se otevře. Štítek doručení ukazuje příjemce; štítek vyzvednutí ukazuje adresu vyzvednutí. Skryté adresní pole je na štítku prázdné.

## 6. Sledování

Veřejný endpoint sledování; přístupový token není potřeba.

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

[Příručka REST](/api/documentation#/operations/getPublicTracking) · [Příručka GraphQL](/api/graphql/documentation#/tracking/trackingPublic)

Stejná URL přijímá vaše `ref`, když bylo uloženo jako externí číslo.

**GraphQL** (typované — potřebuje selection set):

```graphql
query {
  trackingPublic(trackingNumber: "SR123456789012") {
    result
    deliveried
    returntosender
    rejectedbyrecipient
    postcode
    data {
      tracking_event_status_id
      tracking_event_key
      description
      updated_at_localized
    }
    proofs { file_id type full_url signed_url }
  }
}
```

Větvení podle `tracking_event_status_id`, ne podle `description` (tento řetězec sleduje `Accept-Language`):

| `tracking_event_status_id` | Strana | Význam |
|---|---|---|
| `100` | obě | Objednávka přijata |
| `300` / `301` | doručení | V zařízení |
| `450` | doručení | Na cestě k doručení |
| `500` | doručení | Doručeno |
| `501` | doručení | Doručení selhalo, je potřeba nový plán |
| `460` | vyzvednutí | Na cestě k vyzvednutí |
| `510` | vyzvednutí | Vyzvednuto |
| `512` | vyzvednutí | Vyzvednutí selhalo, zkuste později |
| `513` | vyzvednutí | Problém při vyzvednutí |

`data` je od nejnovější. První řádek berte jako aktuální. `deliveried: true` po `500`.

Při `500` nebo `510` může `proofs[]` obsahovat `type` `1` (podpis) nebo `2` (fotka) plus `file_id` a `signed_url`. Fotka nahraná po této události v tomto payloadu není — v kroku 7 odebírejte `pod.files_updated`.

**Ověření:** hned po vytvoření je nejnovější událost `100` a `deliveried` je false. Neznámé číslo je `result: false` / 404 — zobrazte stav nenalezeno; nevymýšlejte sledovací události.

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

Nakonfigurujte URL zpětných volání, které tento tok vyžaduje:

| Nastavení | Událost | Kdy |
|---|---|---|
| `order_create_webhook_url` | `order.created` | Uložit `id` a `tracking_number` |
| `order_status_change_webhook_url` | `order.status_change` | Stav zobrazený zákazníkovi |
| `tracking_event_webhook_url` | `tracking.event` | Časová osa vyzvednutí nebo doručení |
| `pod_files_webhook_url` | `pod.files_updated` | Fotka/podpis po vyzvednutí nebo doručení |
| `order_cancel_failed_webhook_url` | `order.cancel_failed` | Zrušení, které jste odeslali, bylo odmítnuto |

**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",
    "order_status_change_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í:** vytvořte jednu testovací objednávku a uvidíte `order.created` se stejným `id` / `tracking_number`. Neplatný podpis musí přijímač odmítnout kódem `401`. Druhé doručení stejného `X-Webhook-Event-Id` se nesmí zpracovat dvakrát.

## 8. Zrušení testovací objednávky

**REST:** `POST /api/v1/orders/cancel` — [Příručka REST](/api/documentation#/paths/v1-orders-cancel/post) — právě jedno z `order_id`, `tracking_number`, `external_tracking_number`.

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

Už zrušeno: `200` s `already_cancelled: true`. **GraphQL:** `ordersCancel` ([Příručka GraphQL](/api/graphql/documentation#/orders/ordersCancel)).

**Ověření:** veřejné sledování zásilku už nebere jako aktivní. Pokud je zrušení odmítnuto (`409`, např. `ORDER_ALREADY_IN_DELIVERY`), spustí se `order.cancel_failed`.

## 9. Dávkové vytvoření (volitelně)

- `POST /api/v1/client/batchOrderCreate` — [Příručka REST](/api/documentation#/paths/v1-client-batchOrderCreate/post) — čeká, dokud není zpracován každý řádek.
- `POST /api/v1/client/batchOrderCreateAsync` — [Příručka REST](/api/documentation#/paths/v1-client-batchOrderCreateAsync/post) — ihned vrátí identifikátor úlohy; pollujte `GET /api/v1/client/async/{id}` — [Příručka REST](/api/documentation#/paths/v1-client-async-id/get) nebo berte `order.create_async`.

Stejná pole jako krok 3, jako pole objednávek. Každý řádek může být `type` `D` nebo `P`. **GraphQL:** `clientBatchOrderCreate` ([Příručka GraphQL](/api/graphql/documentation#/client/clientBatchOrderCreate)) / `clientBatchOrderCreateAsync` ([Příručka GraphQL](/api/graphql/documentation#/client/clientBatchOrderCreateAsync)).

**Ověření:** každý řádek má vlastní `result`. Asynchronní endpoint použijte, když odesíláte více než přibližně 100 řádků.

## Seznam testů

Použijte testovací `ref` jako `DEV-LOCAL-001` / `DEV-PICKUP-001`:

- [ ] (Volitelně) Cenová nabídka vrátí cenu pro PSČ v oblasti s `type` `D`.
- [ ] (Volitelně) Cenová nabídka vrátí cenu pro PSČ v oblasti s `type` `P`.
- [ ] Vytvoření doručení vrátí `id` + `tracking_number`; stejný `Idempotency-Key` nevytvoří druhou objednávku.
- [ ] Vytvoření vyzvednutí vrátí `id` + `tracking_number`; `need_pick_up` je `1`.
- [ ] Seznam / detail ukáže objednávku pod tímto účtem.
- [ ] PDF místního štítku se otevře a ukáže příjemce nebo adresu vyzvednutí.
- [ ] Veřejné sledování vrátí časovou osu bez tokenu; nejnovější událost je `100`.
- [ ] Přijde `order.created`; podpis v2 ověří.
- [ ] Zrušení vrátí `result: true` (nebo `already_cancelled: true` při opakování).