Dane logistyczne dla
polskiego rynku.
Jedno API REST do wyceny przesyłek, katalogu przewoźników, wyszukiwania paczkomatów, walidacji kodów pocztowych i numerów NIP oraz śledzenia przesyłek. Odpowiedzi poniżej 100 ms, specyfikacja OpenAPI 3.1 i OAuth2 client credentials.
Zbudowane z myślą o produkcji
Przewidywalne opóźnienia, czytelne błędy i specyfikacja OpenAPI, z której wygenerujesz klienta.
Wycena przesyłek
Cennik wagowy z dopłatą paliwową, opłatą COD i podatkiem VAT. Wynik netto i brutto w PLN.
Katalog przewoźników
Dostępne usługi, obsługa pobrania i godziny cut-off dla największych operatorów w Polsce.
Paczkomaty
Wyszukiwanie punktów odbioru według miasta wraz ze współrzędnymi i klasami skrytek.
Walidacja NIP i kodów
Suma kontrolna NIP (mod 11) oraz normalizacja kodu pocztowego z przypisaniem województwa.
Błędy zgodne z RFC 7807
Ustrukturyzowane odpowiedzi application/problem+json z identyfikatorem żądania.
OpenAPI 3.1
Specyfikacja: /openapi.json, przeglądarka pod /docs.
Endpointy
Wszystkie żądania obsługiwane są pod /v1. JSON na wejściu, JSON na wyjściu.
| Metoda | Ścieżka | Opis | Autoryzacja |
|---|---|---|---|
| GET | /v1/health | Kontrola żywotności | — |
| GET | /v1/status | Status usługi i czas działania | — |
| GET | /v1/carriers | Katalog przewoźników | — |
| GET | /v1/lockers | Paczkomaty i punkty odbioru | — |
| GET | /v1/pricing | Wycena przesyłki | — |
| GET | /v1/shipments/{id}/track | Historia zdarzeń przesyłki | — |
| GET | /v1/postcode/validate | Walidacja kodu pocztowego | — |
| GET | /v1/nip/validate | Walidacja NIP (mod 11) | — |
| GET | /v1/vat/rates | Stawki VAT | — |
| GET | /v1/fx | Kursy walut do rozliczeń | — |
| GET | /v1/holidays | Dni ustawowo wolne | — |
| GET | /v1/regions | Regiony i huby | — |
| POST | /v1/auth/token | Wydanie tokenu dostępu | — |
| GET | /v1/shipments/{id} | Szczegóły przesyłki | Bearer |
Pierwsze kroki
Wyceń przesyłkę jednym żądaniem.
curl "https://plandia.freepux.site/v1/pricing?weight_kg=2.5&service=locker_standard"
Wymień dane klienta na token i pobierz szczegóły przesyłki:
TOKEN=$(curl -s -X POST https://plandia.freepux.site/v1/auth/token \
-H 'content-type: application/json' \
-d '{"grant_type":"client_credentials","client_id":"demo","client_secret":"supersecret"}' \
| jq -r .access_token)
curl -H "authorization: Bearer $TOKEN" \
https://plandia.freepux.site/v1/shipments/PLD000123456789