first

2026-07-16 11:56:15 +02:00
parent b650357194
commit 0e05fef335
23 changed files with 1900 additions and 15 deletions
@@ -0,0 +1,67 @@
+# Číselníky, výdejní místa a pomocné metody
+
+## Číselníky
+
+`GET /codelists/{name}?limit=1000&offset=0` → `GET codelist/{name}` v PPL.
+Podporované názvy:
+
+| Název | Obsah |
+|---|---|
+| `product` | produkty/služby (BUSS, PRIV, COPL, ...) |
+| `country` | země + povolení dobírky (COD) |
+| `currency` | povolené měny |
+| `service` | doplňkové služby k zásilkám |
+| `servicePriceLimit` | min/max hodnoty služeb (dobírka, připojištění) |
+| `ageCheck` | varianty kontroly věku příjemce (15/18+) |
+| `externalNumber` | typy externích čísel (např. CUST) |
+| `shipmentPhase` | fáze zásilky |
+| `status` | statusy zásilky (tracking) |
+| `validationMessage` | chybové kódy a hlášení |
+| `proofOfIdentityType` | typy osobních dokladů |
+| `documentFileType` | typy dokumentů (celní dokumenty) |
+
+Stránkování se předává v hlavičkách `X-Paging-Total-Items-Count`,
+`X-Paging-Offset`, `X-Paging-Limit`.
+
+## Výdejní místa
+
+`GET /access-points?countryCode=CZ&limit=100&offset=0` → `GET accessPoint`.
+Filtry: `zipCode`, `city`, `accessPointCode`, `accessPointTypes`
+(ParcelShop/ParcelBox/AlzaBox), GPS `latitude`+`longitude`+`radius` (km),
+`pickupEnabled`, `activeCardPayment`, `activeCashPayment`, `sizes` (S/M/L/XL).
+Odpověď: adresa, otevírací doba, GPS, kapacity dle velikostí.
+
+## Našeptávač adres
+
+`GET /address-whisper?street=...&city=...&zipCode=...&calledFrom=Street`
+→ `GET addressWhisper`. Vrací kandidáty adres vč. pole `valid` —
+vhodné pro validaci adresy před vytvořením zásilky.
+
+## Routing
+
+`GET /routing?country=CZ&zipCode=60200&...` → `GET routing`.
+Vrací `routeCode`, `depotCode`, `depotPosition`, `region`, `secondWave`.
+
+## Zákazník
+
+- `GET /customer` → `GET customer` — bankovní účty (měny pro dobírku, SWIFT)
+- `GET /customer/addresses` → `GET customer/address` — registrované adresy
+- `POST /customer/number-range` → `POST customer/numberRange` — přidělení
+  číselné řady zásilek `{productType, quantity}` → `packNumberFrom/To`
+
+## Ostatní
+
+- `GET /cpl-info` → `GET info` — stav/verze CPL API
+- `GET /version-information` → `GET versionInformation` — novinky API
+- `GET /data/{dataGuid}` → `GET data/{dataGuid}` — binární tisková data etikety
+
+## Generická proxy
+
+`/proxy/{cesta}` (GET/POST/PUT/PATCH/DELETE) předá request 1:1 na CPL API
+s doplněným Bearer tokenem — pokrývá vše, co nemá typovaný endpoint,
+i budoucí metody. Příklad:
+
+```
+GET /proxy/codelist/product?Limit=10&Offset=0
+POST /proxy/shipment/batch   (tělo 1:1 dle PPL dokumentace, bez transliterace)
+```