Proces integracji z usługami InPost

Tworzenie przesyłki

Dostępne tryby tworzenia przesyłki:
- Tryb uproszczony [1.9.0] Tworzenie przesyłki w trybie uproszczonym
- Tryb ofertowy [1.9.0] Tworzenie przesyłki w trybie ofertowym

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 [1.6.4] Tworzenie i podgląd wielu przesyłek

Przesyłki wielopaczkowe można tworzyć tylko dla serwisów kurierskich. Przesyłki paczkomatowe nie obsługują wielopaczkowości, zawsze można wygenerować więcej przesyłek dla jednego zamówienia na te same dane.

W przypadku podania paczkopunktu jako punktu odbioru (target_point": "POP-WAW364") zostanie podmieniony serwis z "service": "inpost_locker_standard" na "service": "inpost_locker_customer_service_point".

Dostępne serwisy dla konta prepaid

`inpost_locker_standard`	Przesyłka paczkomatowa - standardowa
`inpost_locker_allegro`	Przesyłka paczkomatowa - Allegro Paczkomaty InPost
`inpost_locker_pass_thru`	Przesyłka paczkomatowa - 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 postpeid

`inpost_locker_standard`	Przesyłka paczkomatowa - standardowa
`inpost_locker_allegro`	Przesyłka paczkomatowa - Allegro Paczkomaty InPost
`inpost_locker_pass_thru`	Przesyłka paczkomatowa - 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
`inpost_courier_local_standard`	Przesyłka kurierska Lokalna Standardowa
`inpost_courier_local_express`	Przesyłka kurierska Lokalna Expresowa
`inpost_courier_local_super_express`	Przesyłka kurierska Lokalna Super Expresowa

Na tej stronie

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ź

Click here to expand...

{
    "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 [1.6.0] Pobieranie etykiety przesyłki
Pobranie wielu etykiet [1.6.0] Pobieranie wielu etykiet

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

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: [1.6.0] Drukowanie zleceń odbioru