Site Logo

🎉 ShipEngine is becoming ShipStation API 🎉

Over the next few months you'll notice the ShipEngine website, documentation portal, and dashboard being rebranded as ShipStation API. For our ShipEngine customers, you don't need to take any action or change any of your integrations in any way. All endpoints will remain the same and continue to function as they always have.

To learn more about what's coming, review our New ShipStation API page.

InPost

InPost offers domestic services for C2C and B2C shipments originating in the UK. Service also include paperless/QR code and drop-off capabilities.

This guide provides developers with the details needed to build InPost shipping capabilities into your ShipEngine workflows.

Requirements

PropertyTypeRequired?Description
nicknamestringrequiredUsed to identify your InPost account in ShipEngine
tokenstringOptionalLabelled (Non QR code) API Token
client_idstringOptionalLabelled (Non QR code) Client ID
token_labellessstringOptionalLabelless (QR code) API Token
client_id_labellessstringOptionalLabelless (QR code) Client ID

Connect Account

You can connect an InPost account using the POST method to the /v1/connections/carriers/ endpoint, or via the ShipEngine Dashboard.

For instructions on connecting InPost via the ShipEngine dashboard, go to our InPost help article.

Connect via Endpoint

carrier_name: inpost

POST /v1/connections/carriers/:carrier_name

Sample request:

1
2
3
4
5
6
7
8
9
10
11
12
POST /v1/connections/carriers/inpost HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
"nicknam": "My InPost account nickname",
"token": "YOUR_TOKEN"
"clientid": "123456789",
"tokenlabelless": "YOUR_TOKEN",
"clientidlabelless": "980980"
}

A successful connection will return a response with the carrier_id, which you'll use for any requests for this account going forward.

Rates

InPost does not send rates to ShipEngine. Contact your InPost account manager for details on your contracted rates.

Service Details

Available InPost services are provided below. Please note that carriers may update their available services at any time. To ensure you are always using valid services, you can use the list carrier services endpoint at any time.

Domestic Services

ServiceAPI Code
Next Day Delivery Servicenext_day_delivery_service
InPost Send48_hour_delivery_service
48 Hours Delivery Service - QR code48_hour_delivery_service_qr_code
Next Day Delivery Service - QR codenext_day_delivery_services_qr_code
Next Day - Address to Lockernext_day_address_to_locker
48 Hours - Address to Locker48_hour_address_to_locker
24/7 InPost collect Standardinpost_collect_standard
Locker to Locker (Labelled)inpost_locker_to_locker
Labelless L2L Service (InPost PDF QR code)inpost_locker_to_locker_qrcode

Return Services

InPost does not support creating return labels with their services.

Packages

The following carrier package types are available for InPost services:

NameMeasurementsAPI Code
Size A (Small)8 cm X 38 cm X 64 cminpost_small_size_a
Size B (Medium)19 cm X 38 cm X 64 cminpost_medium_size_b
Size C (Large)41 cm X 38 cm X 64 cminpost_large_size_c

Adding Shipment Insurance

InPost does not support adding carrier insurance to shipments.

Label Support

  • Label sizes: 4" x 6"
  • Label formats: PDF, PNG, ZPL

Label Reference Fields

InPost does not support adding custom label messages.

Multi-Package Labels

InPost does not support multi-package shipments.

Label Branding

InPost does not support label branding.

Voiding Labels

InPost supports voiding labels with ShipEngine.

Paperless Labels

InPost supports paperless/QR code labels with their "QR code"-specific services.

See our Paperless Labels page for details about creating paperless labels with ShipEngine.

Delivery Confirmation

Confirmation TypeAPI CodeDescription
No confirmation requirednoneNo delivery confirmation required for the shipment.

See our Delivery Confirmation page for more details about using the confirmation property.

Advanced Options

InPost does not currently support any advanced options.

To ensure you always have the most up-to-date information about a carrier's advanced options, use the list carrier options call.

Manifests

InPost does not require manifesting your shipments.

Scheduling Pickups

InPost does not support scheduling pickups.

Service Points (PUDO)

InPost does not support shipping to service points. The InPost Send and 48 Hours Delivery Service - QR code services are drop-off services.

Tracking

ShipEngine's integration with InPost supports receiving tracking updates. Review our ​Track a Package guides​​ for details on tracking with the ShipEngine API.

Disconnecting Your InPost Account

See the Disconnect section in our Delete a Carrier page for the process of deleting or disconnecting a carrier from ShipEngine.