Proces integracji z usługami InPost

 

Tworzenie przesyłki

 

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ą. 


 

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

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

Odpowiedź

 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 { "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:

1 2 3 4 5 6 7 8 9 { "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:

Ważne informacje

  • Etykiety można pobrać dla przesyłek opłaconych - w statusie confirmed lub późniejszym

  • Maksymalnie można pobrać etykiety dla 100 przesyłek

  • W przypadku jednej przesyłki zwracany jest pojedynczy plik .pdf, .epl/.epl2, .zpl

  • W przypadku wielu przesyłek:
    - jeżeli przesyłki są tego samego serwisu, zwracany jest pojedynczy plik z wszystkimi przesyłkami
    - jeżeli przesyłki są dla różnych serwisów, zwracany jest plik .zip z plikami .epl/.epl2, .zpl, .pdf oddzielnie dla każdego serwisu


 

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: https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/11731045/1.6.0+Zlecenia+odbioru#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: https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/11731059

Dostępne są 2 metody:

  • Metoda generująca manifest dla zlecenia odbioru (printout)

  • Metoda generująca manifest dla wskazanych numerów paczek (printouts)

Ważne informacje

  • W przypadku jednej przesyłki zwracany jest pojedynczy plik *.pdf

  • W przypadku wielu przesyłek:
    - jeżeli przesyłki są tego samego serwisu, zwracany jest pojedynczy plik *.pdf z wszystkimi przesyłkami
    - jeżeli przesyłki są dla różnych serwisów, zwracany jest plik *.zip z plikami *.pdf (oddzielnie dla każdego serwisu).

  • Maksymalnie można pobrać manifest dla 100 przesyłek


 

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.