Page Comparison

Table of Contents

excludeclass

maxLevel	6
minLevel	1	maxLevel	6
include
outline	false
indent
exclude
style	none
type	list
printable	true
class

The documentation provides a summary of the most important information regarding integration with InPost systems.

Contact	Description
Business topics	Your Account Manager
Integration topic	strategic-integracja@inpost.pl	Response time 1 working day
Carrier website	https://inpost.pl/
Carrier logo

Authorization

Description

Production

URL: https://api-shipx-pl.easypack24.net

Parcel Manager Production: https://manager.paczkomaty.pl/

Request collection: https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/18153477/Authorization+Query+Collections#Query-collection-and-environment-profiles

Sandbox

URL: https://sandbox-api-shipx-pl.easypack24.net

Parcel Manager Sandbox: https://sandbox-manager.paczkomaty.pl/

(You can access the sandbox by creating an account in the Sandbox Manager)

Request collection: https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/18153477/Authorization+Query+Collections#Query-collection-and-environment-profiles

Services	Description
`inpost_locker_standard`	Parcel locker shipment - standard	Delivery to Parcel Locker - the customer has 48h to collect the parcel. Can extend collection via the InPost app
`inpost_locker_allegro`	Parcel locker shipment - Allegro Paczkomat® InPost.	Delivery to Parcel Locker (Allegro service) - the customer has 48h to collect the parcel. Can extend collection via the InPost app
`inpost_locker_pass_thru`	Parcel locker shipment - Pass-Thru	Sending at Parcel Locker and collection of the parcel by the customer at the same Parcel Locker
`inpost_letter_allegro`	Courier shipment - Allegro MiniKurier24 InPost	Delivery by courier to the indicated address (Allegro service)
`inpost_courier_allegro`	Courier shipment - Allegro Kurier24 InPost.	Delivery by courier to the indicated address (Allegro service)
`inpost_courier_c2c`	Courier shipment - InPost Courier C2C (service for a retail customer - prepaid)	Delivery by courier to the indicated address
`inpost_courier_standard`	Courier shipment standard	Delivery by courier to the indicated address
`inpost_courier_express_1000`	Courier shipment with delivery until 10:00	Delivery by courier to the specified address by a specific time
`inpost_courier_express_1200`	Courier shipment with delivery until 12:00	Delivery by courier to the specified address by a specific time
`inpost_courier_express_1700`	Courier shipment with delivery until 17:00	Delivery by courier to the specified address by a specific time
`inpost_courier_palette`	Courier shipment Pallet Standard	Delivery to the pallet address by dedicated transport

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 dimensions Label field validation	143mm x 100mm (height x width)	Example Locker: Courier:
Other	We do not support unicode characters (i.e. kanji, Cyrillic, etc.) on label

Parcel Locker/Courier dimensions

Description

Courier dimensions

Maximum dimensions:

350 x 240 x 240 cm

Maximum weight:

50 kg

Quantity:

default 1,
maximum 99 ( only for domestic parcels )

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

Display Geowidget/API Points

Description

Documentation Geowidget V5

Geowidget v5

API Points

Authorization:

Production environment:

https://api.inpost.pl/v1/points

Sandbox environment:
https://sandbox-api-gateway-pl.easypack24.net/v1/points

Documentation: Points (Parcel Locker, ParcelPoint)

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)

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: 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. After enquiring about the status of the shipment the status "confirmed" is returned, which means that the shipment was created successfully and the tracking_number is returned Checking the status of a shipment: https://api-shipx-pl.easypack24.net/v1/shipments/ID_SHIPMENTSID S Download label: https://api-shipx-pl.easypack24.net/v1/shipments/ID_SHIPMENTS/label?format=pdf (pdf/zpl/epl) Tracking: (not authorized) 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 email → This parameter is required for Parcel Locker shipments This parameter is not required for Courier Standard shipments address → This parameter is not required for Parcel Locker shipments This parameter is required for Courier Standard shipments phone → Only 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 Only shipments for Parcel Lockers 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 The attribute is not required. The place where the costs were incurred must first be added to the organization so that it can be assigned to the shipment.
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

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

Tracking

Description

Tracking API/Report

Report: Report

API: Tracking

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]

Quick Returns

Description

Authorization

Email/Password

Endpoint

Production: https://api.paczkomaty.pl

Sandbox: https://sandbox-api.paczkomaty.pl

Documentation:

InPost Quick Returns

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: Generating active code

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: Report

You can check the current status of a shipment sent with a return code using the Report function.

Available parcel sizes

A/B/C

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 https://sandbox-manager.paczkomaty.pl/ in the My Account> API tab

Documentation:

Webhooks

Example when the shipment status has been changed:

Code Block

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

Code Block
{ "event_ts": "2020-03-20 15:08:06 +0100", "event": "shipment_confirmed", "organization_id": 1, "payload": { "shipment_id": 49, "tracking_number": "602677439331630337653846" } }

...

Versions Compared

Old Version 3

New Version 4

Key

Contact

Authorization

Services

Label

Parcel Locker/Courier dimensions

Display Geowidget/API Points

Shipments flow

Tracking

Quick Returns

Webhooks