Proces integracji z usługami InPost

Tworzenie przesyłki

Dostępne tryby tworzenia przesyłki:

Przesyłki utworzone w panelu manager.paczkomaty.pl, kurier.inpost.pl nie są widoczne w API.

Proces tworzenia przesyłki w trybie ofertowym:

Utworzenie przesyłki > Wybór oferty (ręczny lub za pomocą webhook) > Opłacenie przesyłki (dla konta prepaid oznacza automatyczne pobranie środków, dla konta postpaid oznacza potwierdzenie przesyłki)

W trybie uproszczonym wskazujemy serwis i następuje automatyczny wybór oferty oraz opłacenie przesyłki na wskazany serwis. W trybie ofertowym nie wskazuje się serwisu, należy wybrać jedną ze zwróconych ofert i opłacić ją.

Tworzenie i podgląd wielu przesyłek Tworzenie i podgląd wielu przesyłek

Nie ma możliwości anulowania przesyłki w statusie confirmed. Można utworzyć przesyłkę z użyciem parametru "only_choice_of_offer": true i zatrzymać ją na statusie "status": "offer_selected" następnie anulować Anulowanie przesyłki lub opłacić Opłacanie przesyłki

Dostępne serwisy dla konta prepaid

`inpost_locker_standard`	Przesyłka Paczkomat® - standardowa
`inpost_locker_allegro`	Przesyłka Paczkomat® - Allegro Paczkomat® InPost
`inpost_locker_pass_thru`	Przesyłka Paczkomat® - Podaj Dalej
`inpost_letter_allegro`	Przesyłka kurierska - Allegro MiniKurier24 InPost
`inpost_courier_allegro`	Przesyłka kurierska - Allegro Kurier24 InPost
`inpost_courier_c2c`	Przesyłka kurierska InPost Kurier C2C (usługa dla klienta detalicznego - prepaid)

Dostępne serwisy dla konta postpaid

`inpost_locker_standard`	Przesyłka Paczkomat® - standardowa
`inpost_locker_allegro`	Przesyłka Paczkomat® - Allegro Paczkomat® InPost
`inpost_locker_pass_thru`	Przesyłka Paczkomat® - Podaj Dalej
`inpost_letter_allegro`	Przesyłka kurierska - Allegro MiniKurier24 InPost
`inpost_courier_allegro`	Przesyłka kurierska - Allegro Kurier24 InPost
`inpost_courier_c2c`	Przesyłka kurierska InPost Kurier C2C (usługa dla klienta detalicznego - prepaid)
`inpost_courier_standard`	Przesyłka kurierska standardowa
`inpost_courier_express_1000`	Przesyłka kurierska z doręczeniem do 10:00
`inpost_courier_express_1200`	Przesyłka kurierska z doręczeniem do 12:00
`inpost_courier_express_1700`	Przesyłka kurierska z doręczeniem do 17:00
`inpost_courier_palette`	Przesyłka kurierska Paleta Standard

Na tej stronie

1 Tworzenie przesyłki
2 Sprawdzenie statusu przesyłki
3 Pobranie etykiety
4 Zamówienie kuriera
5 Wygenerowanie potwierdzenia nadania
6 Tracking przesyłki

Sprawdzenie statusu przesyłki

Ponieważ zakup przesyłki działa asynchronicznie, serwer w odpowiedzi zwróci informacje o przesyłce nieuwzględniające zmian wywołanych przez zakup (zmiana statusu, nadanie numeru trackingowego, gdyż informacje te będą dostępne dopiero po pewnym czasie).

Aby sprawdzić status przesyłki lub pobrać numer tracking należy odpytać przesyłkę za pomocą jej ID, lub skorzystać z powiadomień webhook.

Przykładowe zapytanie

GET /v1/shipments/ID_Shipments HTTP/1.1
Host: api-shipx-pl.easypack24.net
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9...

Odpowiedź

{
    "href": "https://api-shipx-pl.easypack24.net/v1/shipments/123",
    "id": 123,
    "status": "confirmed",
    "tracking_number": "602677217131630339938736",
    "service": "inpost_locker_standard",
    "reference": "0123456789",
    "is_return": false,
    "application_id": 25,
    "created_by_id": null,
    "external_customer_id": null,
    "sending_method": "dispatch_order",
    "end_of_week_collection": false,
    "comments": null,
    "mpk": null,
    "additional_services": [],
    "custom_attributes": {
        "target_point": "KRA012",
        "sending_method": "dispatch_order"
    },
    "cod": {
        "amount": 12.5,
        "currency": "PLN"
    },
    "insurance": {
        "amount": 25.0,
        "currency": "PLN"
    },
    "sender": {
        "id": 123,
        "name": null,
        "company_name": "ShpiX",
        "first_name": "Jan",
        "last_name": "Kowalski",
        "email": "test@grupainteger.pl",
        "phone": "333222111",
        "address": {
            "id": 123,
            "street": null,
            "building_number": null,
            "line1": "test",
            "line2": null,
            "city": "test",
            "post_code": "02-677",
            "country_code": "PL"
        }
    },
    "receiver": {
        "id": 123,
        "name": null,
        "company_name": null,
        "first_name": null,
        "last_name": null,
        "email": "test@inpost.pl",
        "phone": "111222333",
        "address": null
    },
    "selected_offer": {
        "id": 123,
        "status": "bought",
        "expires_at": null,
        "rate": null,
        "currency": "PLN",
        "additional_services": [],
        "carrier": {
            "id": "inpost_locker",
            "name": "InPost Paczkomaty",
            "description": "InPost Paczkomaty - Przesyłki paczkomatowe"
        },
        "service": {
            "id": "inpost_locker_standard",
            "name": "Paczkomatowa standardowa",
            "description": "Przesyłka paczkomatowa standardowa"
        },
        "unavailability_reasons": null
    },
    "offers": [
        {
            "id": 123,
            "status": "bought",
            "expires_at": null,
            "rate": null,
            "currency": "PLN",
            "additional_services": [],
            "carrier": {
                "id": "inpost_locker",
                "name": "InPost Paczkomaty",
                "description": "InPost Paczkomaty - Przesyłki paczkomatowe"
            },
            "service": {
                "id": "inpost_locker_standard",
                "name": "Paczkomatowa standardowa",
                "description": "Przesyłka paczkomatowa standardowa"
            },
            "unavailability_reasons": null
        }
    ],
    "transactions": [
        {
            "id": 123,
            "status": "success",
            "offer_id": 123,
            "details": {},
            "created_at": "2021-10-15T09:52:15.708+02:00",
            "updated_at": "2021-10-15T09:52:15.874+02:00"
        }
    ],
    "parcels": [
        {
            "id": 123,
            "tracking_number": "602677217131630339938736",
            "is_non_standard": false,
            "template": "large",
            "dimensions": {
                "length": 380.0,
                "width": 640.0,
                "height": 410.0,
                "unit": "mm"
            },
            "weight": {
                "amount": 25.0,
                "unit": "kg"
            }
        }
    ],
    "created_at": "2021-10-15T09:52:15.576+02:00",
    "updated_at": "2021-10-15T09:52:19.811+02:00"
}

Przykładowe powiadomienie webhook:

{
"event_ts": "2018-07-17 12:57:29 +0200",
"event": "shipment_confirmed",
"organization_id": 35,
"created_by_id": null,
"payload": {
"shipment_id": 87235,
"tracking_number": "633300208831612315289193"
}

Pobranie etykiety

Dostępne są 2 metody:

Pobranie jednej etykiety Pobieranie etykiet
Pobranie wielu etykiet Pobieranie etykiet | Pobieranie wielu etykiet

Zamówienie kuriera

Kuriera należy zamawiać na adres wtedy gdy nie posiada się stałego zlecenia odbioru lub gdy odbiór ma nastąpić z innego miejsca.

Szczegółowe informacje na stronie: Zlecenie odbioru (Zamawianie kuriera) | Tworzenie zlecenia odbioru

Wygenerowanie potwierdzenia nadania

Funkcjonalność umożliwia generowanie potwierdzenia nadania dla przesyłek posiadających zlecenie odbioru, oraz przesyłek nieposiadających zleceń odbioru.

Szczegółowe informacje na stronie: Drukowanie potwierdzenia nadania

Dostępne są 2 metody:

Metoda generująca manifest dla zlecenia odbioru (printout)
Metoda generująca manifest dla wskazanych numerów paczek (printouts)

Tracking przesyłki

Poniżej prezentujemy dostępne sposoby pobierania informacji o aktualnym stanie przesyłki w procesie logistycznym. Za ich pomocą można uzyskać informacje o utworzeniu przesyłki, ostatniej zmianie statusu czy też historii statusów.

Zasób Tracking Tracking przesyłki
Powiadomienia webhook Webhooki

Developer Documentations