Integration process with InPost services

Create shipment

Available modes of shipment creation:
- Simplified mode https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/18153501
- offer mode https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/18153503

The process of creating a shipment in the offer mode:

Create shipment > Select offer (manual or via webhook) > Paying for shipment (for prepaid account it means automatic collection of funds, for postpaid account it means confirmation of shipment)

In the simplified mode, you indicate the service and automatically select the offer and pay for the shipment to the indicated service. In the offer mode, you do not indicate the service, you select one of the returned offers and pay for it.

Creating and viewing shipment batches https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/18153502

Multi-packet shipments can only be created for courier services. Parcel locker do not support multipacking, you can always generate more shipments for one order with the same data.

If a ParcelPoint is given as a pickup point (target_point": "POP-WAW364") the service will be changed from "service": "inpost_locker_standard" to "service": "inpost_locker_customer_service_point".

Available services for prepaid account

`inpost_locker_standard`	Parcel locker shipment - standard
`inpost_locker_allegro`	Parcel locker shipment - Allegro Paczkomat® InPost.
`inpost_locker_pass_thru`	Parcel locker shipment - Pass-Thru
`inpost_letter_allegro`	Courier shipment - Allegro MiniKurier24 InPost
`inpost_courier_allegro`	Courier shipment - Allegro Kurier24 InPost.
`inpost_courier_c2c`	Courier shipment - InPost Courier C2C (service for a retail customer - prepaid)

Available services for your postpeid account

`inpost_locker_standard`	Parcel locker shipment - standard
`inpost_locker_allegro`	Parcel locker shipment - Allegro Paczkomat® InPost.
`inpost_locker_pass_thru`	Parcel locker shipment - Pass-Thru
`inpost_letter_allegro`	Courier shipment - Allegro MiniKurier24 InPost
`inpost_courier_allegro`	Courier shipment - Allegro Kurier24 InPost.
`inpost_courier_c2c`	Courier shipment - InPost Courier C2C (service for a retail customer - prepaid)
`inpost_courier_standard`	Courier shipment standard
`inpost_courier_express_1000`	Courier shipment with delivery until 10:00
`inpost_courier_express_1200`	Courier shipment with delivery until 12:00
`inpost_courier_express_1700`	Courier shipment with delivery until 17:00
`inpost_courier_palette`	Courier shipment Pallet Standard

On this page

1 Create shipment
2 Checking the status of a shipment
3 Shipment label download
4 Creating new DispatchOrder
5 Printing dispatch orders
6 Shipment Tracking

Checking the status of a shipment

Because shipment buying is asynchronous, the server will respond with information about the shipment that does not include changes caused by the purchase (status change, tracking number assignment, as this information will only be available after a certain period of time).

To check the status of a shipment or get a tracking number, please query the shipment with its ID or use webhook notifications.

Sample request

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

Response

{
    "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"
}

Sample webhook notification:

{
"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"
}

Shipment label download

There are 2 methods available:

One label download
Downloading multiple labels

Creating new DispatchOrder

Courier service should be ordered to your address if you do not have a standing collection order or if you want to collect from another location.

Detailed information at:

Printing dispatch orders

The functionality allows for generating manifests for shipments whether or not they have dispatch orders.

Detailed information at:

2 methods are available:

Method for generating a manifest for the dispatch order (printout)
Method for generating a manifest for the indicated shipment IDs (printouts)

Shipment Tracking

Below we present the available ways of downloading information about the current status of a shipment in the logistics process. You can use them to retrieve information about the creation of a shipment, the last status change, or the history of statuses.

Tracking resource
Webhook notifications