InPost Integration FAQ
- Michał Machowski
- Paweł Milewski
The documentation provides a summary of the most important information regarding integration with InPost systems.
Contact | Description |
|---|---|
Business topics | Your Account Manager |
Carrier website | |
Carrier privacy policy | |
Carrier logo |  |
ShipX document | |
Fast Return document | |
Plugins document | |
Common Errors |
On this page
- 1 Contact
- 2 API ShipX
- 2.1 Authorization
- 2.1.1 Production
- 2.1.2 Sandbox
- 2.1.3 Create token
- 2.2 Standard Services
- 2.3 Allegro dedicated services
- 2.4 Label
- 2.4.1 Label format
- 2.4.2 Label type
- 2.4.3 Label dimensions
- 2.4.4 Label field validation
- 2.4.5 Other
- 2.5 Parcel Locker/Courier dimensions
- 2.5.1 Courier dimensions
- 2.5.2 Locker dimensions
- 2.6 Shipments flow
- 2.6.1 Flow (endpoint)
- 2.6.2 Parameters
- 2.6.3 Statuses
- 2.6.4 Status confirming delivery of parcel (final) generating payment (customer charged)
- 2.6.5 Push technologies to delivery notifications
- 2.6.6 Picking up parcels with Parcel Locker
- 2.6.7 Multi-packs in inpost_courier_standard
- 2.6.8 Shipment cancellation
- 2.6.9 API Response time
- 2.6.10 Common Errors
- 2.7 Tracking
- 2.7.1 Tracking API/Report
- 2.7.2 URL tracking link
- 2.7.3 Other
- 2.8 Webhooks
- 2.8.1 Configuration
- 2.8.2 Addres IP webhook
- 2.1 Authorization
- 3 Display Geowidget/API Points
- 4 Quick Returns
API ShipX
Authorization | Description |
|
|---|---|---|
Production | URL: https://api-shipx-pl.easypack24.net Parcel Manager Production: InPost - Manager paczek | Request collection: Authorization / Query Collections | Query collection and environment profiles |
Sandbox | URL: https://sandbox-api-shipx-pl.easypack24.net Parcel Manager Sandbox: InPost - Manager paczek (You can access the sandbox by creating an account in the Sandbox Manager) | Request collection: Authorization / Query Collections | Query collection and environment profiles |
Create token | Documentation: (google translate required) https://inpost.pl/sites/default/files/2022-03/instrukcja-konfiguracji-api-shipx.pdf
| Organization ID:  Token:
|
Standard Services | Description |
|
|---|---|---|
| Parcel locker shipment - standard | Delivery to Parcel Locker - the customer has 48h to collect the parcel. Can extend collection via the InPost app |
| Courier shipment standard | Delivery by courier to the indicated address |
| Courier shipment - InPost Courier C2C (service for a retail customer - prepaid) | Delivery by courier to the indicated address |
| Parcel locker shipment - Pass-Thru | Sending at Parcel Locker and collection of the parcel by the customer at the same Parcel Locker |
| Courier shipment with delivery until 10:00 | Delivery by courier to the specified address by a specific time |
| Courier shipment with delivery until 12:00 | Delivery by courier to the specified address by a specific time |
| Courier shipment with delivery until 17:00 | Delivery by courier to the specified address by a specific time |
| Courier shipment Pallet Standard | Delivery to the pallet address by dedicated transport |
Allegro dedicated services | Description |
|
| Allegro dedicated service | Delivery to Parcel Locker (Allegro service) - the customer has 48h to collect the parcel. Can extend collection via the InPost app |
| Allegro dedicated service | Delivery by courier to the indicated address (Allegro service) |
| Allegro dedicated service | Delivery by courier to the indicated address (Allegro service) |
Label | Description |
|
|---|---|---|
Label format | ZPL/PDF/EPL | PDF: https://api-shipx-pl.easypack24.net/v1/shipments/1592329333/label?format=pdf ZPL: https://api-shipx-pl.easypack24.net/v1/shipments/1592329333/label?format=zpl EPL: https://api-shipx-pl.easypack24.net/v1/shipments/1592329333/label?format=eplepepl |
Label type | A6/normal PDF - 200 DPI ZPL - 200DPI and 300DPI (courier/parcel locker)
| 300DPI: https://api-shipx-pl.easypack24.net/v1/shipments/1592329333/label?format=zpl&type=dpi300 200DPI: https://api-shipx-pl.easypack24.net/v1/shipments/1592329333/label?format=zpl&type=dpi300 |
Label dimensionsLabel field validation | 143mm x 100mm (height x width) | Example
|
Other |
"company_name": 26 characters "street" and "building number" together on label: 56 characters "city": 23 characters "first_name" and "last_name" together on label: 21 characters
|
|
Parcel Locker/Courier dimensions | Description |
|
|---|---|---|
Courier dimensions | Maximum dimensions:
Maximum weight:
Quantity:
|
|
Locker dimensions | height x width x depth cm Size A (S) - 8 x 38 x 64 cm Size B (M) - 19 x 38 x 64 cm Size C (L) - 41 x38 x 64 cm Max weight: 25 kg | The corresponding parcel size is mapped from the box into which the parcel was placed by the courier, depending on the machine.
|
Shipments flow | Description |
|
|---|---|---|
Flow (endpoint) | Integration process: Integration process with InPost services We recommend creating shipments in simplified mode DOC: Creating a shipment in the simplified mode
Create shippments: POST https://api-shipx-pl.easypack24.net/v1/organizations/YOUR_ID_ORGANIZATIONS/shipments
The ShipX API is asynchronous, so when a shipment is created, the status returned is "created" without tracking_number.
Checking the status of a shipment: GET https://api-shipx-pl.easypack24.net/v1/shipments/ID_SHIPMENTSID S Download label: GET https://api-shipx-pl.easypack24.net/v1/shipments/ID_SHIPMENTS/label?format=pdf (pdf/zpl/epl) Tracking: (not authorized) GET https://api-shipx-pl.easypack24.net/v1/tracking/TRACKING_NUMBER
| Create shipment: Checking the status of a shipment:
|
Parameters | sender → The attribute is not required. If no data is provided ,by default the data of the organization in which the shipment is created will be used By default, if you do not add the SENDER parameter in the requisition for the creation of a parcel - the sender data are assigned from our system, the ones you specified when creating an account in Parcel Manager. If you want to overwrite the SENDER parameter data, you should add this part in the request for shipment creation: This way you will overwrite the data, phone number or email with your own data: ‘sender": {
email → This parameter is required for Parcel Locker shipments We use the Apache commons library version 1.6 to validate email addresses. http://commons.apache.org/proper/commons-validator/index.html address → This parameter is not required for Parcel Locker shipments phone → Regex PL: \A(\(?((\+)|00)48\)?) → 9 digits target_point → The name of the destination point to which the shipment is to be delivered, from which it will be collected by the receiver, e.g. name of the a parcel locker dropoff_point → Name of the sending point to which the sender delivers the shipment to be sent, e.g. name of the parcel locker. Required when stating the sending method pok, courier_pok, parcel_locker reference → Additional description of the shippment e.g the order number. Will transfer information to labels for Parcel Locker service
The attribute is not required. At least 3 characters, up to 100 characters, the attribute mrefay be transferred empty comments → The attribute is not required. At least 3 characters, up to 100 characters, the attribute mrefay be transferred empty. Will transfer information to labels for Parcel Locker service and Courier Standard mpk → Name of the place where the costs were incurred MPK - a value that the user can freely modify. It must be created - this value is unique and can not create another one like it. Usage: This allows you to split shipments (giving 2 different MPKs in shippment) and filter them later without creating a subaccount in InPost systems.
|
|
Statuses | DOC: Statuses Statuses list for Parcel Locker: https://api-shipx-pl.easypack24.net/v1/statuses?shipment_type=inpost_locker_standard&lang=en_GB Statuses list for Courier Standard: https://api-shipx-pl.easypack24.net/v1/statuses?shipment_type=inpost_courier&lang=en_GB
| Standard process:
adopted_at_source_branch
adopted_at_target_branch
out_for_delivery
ready_to_pickup
delivered
return to shipper
undelivered_wrong_address
avizo
readdressed
rejected_by_receiver
delay_in_delivery
undelivered
|
Status confirming delivery of parcel (final) generating payment (customer charged) | “Delivered” |
|
Push technologies to delivery notifications | InPost parcels delivered in Poland receive notifications in the InPost mobile app and email notifications. If someone does not have the mobile app, they receive an SMS |
|
Picking up parcels with Parcel Locker | Parcels can be picked up by scanning the QR code or opening the box remotely via the app |
|
Multi-packs in | The maximum number of multipacks is: 99 |
|
Shipment cancellation | In order to cancel a shipment within an organization, the user has to be its member. Additionally, the shipment has to be in DOC: https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/18153504 | An unused label will be cancelled after 45 days |
API Response time | On Sandbox:: extended time above 2 seconds On Production: up to 2 seconds maximum The time for querying the shipment should be extended to the indicated values
|
|
Common Errors |
When creating a collection parcel, please note that the parcel must be insured for a minimum of the collection value or more
The API returns an error when the wrong organisation id is entered. You will need to log in to https://manager.paczkomaty.pl and retrieve the organisation id located on the API tab at https://manager.paczkomaty.pl/auth/login.
If the API returns a 500 error, contact the integracja@inpost.pl integration team or your account manager with the error ID that will appear in the response from the API.,
If you are a postpaid customer (you have a contract) please check that the payment for the last invoice has been made and then contact your account manager to check that the contract is connected to your account
Please contact your account manager. This means that the courier service has not been connected
The specified receiving point “target_point” is incorrect (name) or the point has been taken off the network due to failure, relocation, etc.
It means that the selected pick-up point does not have the function of collecting a shipment from this point. You can only send a shipment at this point. |
|
Tracking | Description |
|
|---|---|---|
Tracking API/Report | Report: https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/101384332 API: https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/101384347
Tracking is not available on the sandbox environment. No statuses are returned | Example request (No need to authorise): GET https://api-shipx-pl.easypack24.net/v1/tracking/520000015802677026992693 |
URL tracking link | https://inpost.pl/sledzenie-przesylek?number=[parcel_number] |
|
Other |
|
|
Webhooks |
|
|
|---|---|---|
Configuration | Webhook is used to send the user information about changes in the status of the shipment. For a production environment, the webhook address can be added on the page https://manager.paczkomaty.pl/zaloguj in the My Account> API tab For a sandbox environment, the webhook address can be added on the page InPost - Manager paczek in the My Account> API tab
DOC: https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/18153494 | Example when the shipment status has been changed: {
"event_ts": "2020-03-20 15:08:42 +0100",
"event": "shipment_status_changed",
"organization_id": 1,
"payload": {
"shipment_id": 49,
"status": "delivered",
"tracking_number": "602677439331630337653846"
}
}
Example when the shipment has been created: {
"event_ts": "2020-03-20 15:08:06 +0100",
"event": "shipment_confirmed",
"organization_id": 1,
"payload": {
"shipment_id": 49,
"tracking_number": "602677439331630337653846"
}
}
|
Addres IP webhook | Webhook address database: 91.216.25.0/24 |
|
Display Geowidget/API Points | Description |
|
|---|---|---|
Documentation Geowidget V5 | DOC: https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/50069505 | Example: Production: https://geowidget.inpost.pl/examples/index.html Sandbox: https://sandbox-easy-geowidget-sdk.easypack24.net/examples/index.html
|
API Points | Authorization Production environment https://api.inpost.pl/v1/points Sandbox environment https://sandbox-api-gateway-pl.easypack24.net/v1/points
DOC (PROD/SAND): https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/18153493 Token Geowidget Access to the Points API is authorised. Obtaining a token is possible through the Parcel Manager. | The Points resource represents locations where the services of logistics operators are available. Points can be self-service machines (Parcel Machine®) or branches, customer service points
The parcel_locker type displays all points from which the customer can collect the parcel and only the currently active (enabled) points. Excludes points that are only used for sending parcels (no parcel pick-up) Search point by location:
Pagination:
|
Quick Returns | Description |
|
|---|---|---|
Authorization | Email/Password from Parcel Manager https://manager.paczkomaty.pl/auth/login |
|
Endpoint | Production: https://api.paczkomaty.pl Sandbox: https://sandbox-api.paczkomaty.pl DOC:
| The function https://api.paczkomaty.pl/?do=revloggenerateactivecode is used to generate one active return code, with which you can send a parcel at the Parcel Locker DOC: https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/101384295 The https://api.paczkomaty.pl/?do=revloggetreport function allows you to generate a report that will return active codes and used codes along with the shipment status. DOC: https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/101384332 You can check the current status of a shipment sent with a return code using the Report function.
|
Available parcel sizes | height x width x depth cm Size A (S) - 8 x 38 x 64 cm Size B (M) - 19 x 38 x 64 cm Size C (L) - 41 x38 x 64 cm
|
|
Shipment return tracking
| Example tracking flow:
"tracking_details": [
{
"origin_status": "DOR",
"status": "delivered",
"agency": null,
"location": null,
"datetime": "2024-07-03T12:56:26.000+02:00"
},
{
"origin_status": "PDD_3",
"status": "out_for_delivery_to_address",
"agency": null,
"location": null,
"datetime": "2024-07-03T08:14:43.000+02:00"
},
{
"origin_status": "PWO",
"status": "adopted_at_source_branch",
"agency": null,
"location": null,
"datetime": "2024-07-03T04:25:07.000+02:00"
},
{
"origin_status": "WZO",
"status": "sent_from_source_branch",
"agency": null,
"location": null,
"datetime": "2024-07-02T17:30:52.000+02:00"
},
{
"origin_status": "PWO",
"status": "adopted_at_source_branch",
"agency": null,
"location": null,
"datetime": "2024-07-02T17:00:31.000+02:00"
},
{
"origin_status": "OZPA",
"status": "taken_by_courier",
"agency": null,
"location": null,
"datetime": "2024-07-02T08:52:07.000+02:00"
},
{
"origin_status": "NWP",
"status": "dispatched_by_sender",
"agency": null,
"location": null,
"datetime": "2024-07-01T21:24:14.000+02:00"
},
{
"origin_status": "PPN",
"status": "confirmed",
"agency": null,
"location": null,
"datetime": "2024-07-01T21:24:01.000+02:00"
} |
|