Integration process with InPost services

 

 

Create shipment

 

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.


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 Paczkomaty 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 Paczkomaty 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

inpost_courier_local_standard

Courier shipment Local Standardowa

inpost_courier_local_express

Courier shipment Local Express

inpost_courier_local_super_express

Courier shipment Local Super Express


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

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

Response

 

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" }
  • Sample webhook notification:

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

 

Shipment label download

 

There are 2 methods available:

Important information

  • Shipment label can be downloaded only for already bought shipments - confirmed or later status.

  • Only users that are the shipments sender can download the label.

  • For single parcel shipments a single file is returned in the following format .pdf, .epl/.epl2, .zpl,

  • For multiple parcel shipments a single file is returned in the following format .pdf, .epl, .zpl containing labels for all the parcels

  • Attention! Choosing EPL format for courier parcels will result in an EPL file, for locker and allegro parcels the format will be EPL2.


 

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: https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/18153482/1.6.0+Dispatch+Order#Creating-new-DispatchOrder


 

Printing dispatch orders

 

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

Detailed information at: https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/18153499

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)

Important information

  • In case of one shipment a single *.pdf  file is returned

  • In case of multiple shipments
    - In case shipments are of the same service, a single *.pdf file with all the shipments is included
    - In case shipments are from multiple services, a single *.zip file containing *.pdf files is returned (separate *.pdf file for each service)

  • A maximum of 100 manifests for shipments can be downloaded at once


 

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.