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 ShipStation V2 API workflows.
| Property | Type | Required? | Description |
|---|---|---|---|
nickname | string | required | Used to identify your InPost account in ShipStation V2 API |
token | string | Optional | Labelled (Non QR code) API Token |
client_id | string | Optional | Labelled (Non QR code) Client ID |
token_labelless | string | Optional | Labelless (QR code) API Token |
client_id_labelless | string | Optional | Labelless (QR code) Client ID |
You can connect an InPost account using the POST method to the /v2/connections/carriers/ endpoint, or via the ShipStation dashboard.
For instructions on connecting InPost via the ShipStation dashboard, go to our InPost help article.
carrier_code: inpost
POST /v2/connections/carriers/:carrier_code
- Productionhttps://api.shipstation.com/v2/connections/carriers/{carrier_name}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
- connect_access_worldwide_request_body
- connect_amazon_buy_shipping_request_body
- connect_amazon_shipping_uk
- connect_apc_request_body
- connect_asendia_request_body
- connect_australia_post_request_body
- connect_canada_post_request_body
- connect_dhl_ecommerce_request_body
- connect_dhl_express_request_body
- connect_dhl_express_au_request_body
- connect_dhl_express_ca_request_body
- connect_dhl_express_uk_request_body
- connect_dpd_request_body
- connect_endicia_request_body
- connect_fedex_request_body
- connect_fedex_uk_request_body
- connect_firstmile_request_body
- connect_imex_request_body
- connect_lasership_request_body
- connect_newgistics_request_body
- connect_ontrac_request_body
- connect_purolator_request_body
- connect_royal_mail_request_body
- connect_rr_donnelley_request_body
- connect_seko_request_body
- connect_sendle_request_body
- connect_stamps_request_body
- connect_ups_request_body
curl -i -X POST \
https://api.shipstation.com/v2/connections/carriers/dhl_express \
-H 'Content-Type: application/json' \
-H 'api-key: YOUR_API_KEY_HERE' \
-d '{
"nickname": "Stamps.com",
"username": "your_username",
"password": "your_password"
}'A successful connection will return a response with the carrier_id, which you'll use for any requests for this account going forward.
InPost does not send rates to ShipStation V2 API. Contact your InPost account manager for details on your contracted rates.
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 (ShipEngine guide) endpoint at any time.
| Service | API Code |
|---|---|
| Next Day Delivery Service | next_day_delivery_service |
| InPost Send | 48_hour_delivery_service |
| 48 Hours Delivery Service - QR code | 48_hour_delivery_service_qr_code |
| Next Day Delivery Service - QR code | next_day_delivery_services_qr_code |
| Next Day - Address to Locker | next_day_address_to_locker |
| 48 Hours - Address to Locker | 48_hour_address_to_locker |
| 24/7 InPost collect Standard | inpost_collect_standard |
| Locker to Locker (Labelled) | inpost_locker_to_locker |
| Labelless L2L Service (InPost PDF QR code) | inpost_locker_to_locker_qrcode |
InPost does not support creating return labels (ShipEngine guide) with their services.
The following carrier package types (ShipEngine guide) are available for InPost services:
| Name | Measurements | API Code |
|---|---|---|
| Size A (Small) | 8 cm X 38 cm X 64 cm | inpost_small_size_a |
| Size B (Medium) | 19 cm X 38 cm X 64 cm | inpost_medium_size_b |
| Size C (Large) | 41 cm X 38 cm X 64 cm | inpost_large_size_c |
InPost does not support adding carrier insurance to shipments.
- Label sizes: 4" x 6"
- Label formats: PDF, PNG, ZPL
InPost does not support adding custom label messages (ShipEngine guide).
InPost does not support multi-package shipments (ShipEngine guide).
InPost does not support label branding (ShipEngine guide).
InPost supports voiding labels (ShipEngine guide) with ShipStation V2 API.
InPost supports paperless/QR code labels with their "QR code"-specific services.
See our Paperless Labels page (ShipEngine guide) for details about creating paperless labels with ShipStation V2 API.
| Confirmation Type | API Code | Description |
|---|---|---|
| No confirmation required | none | No delivery confirmation required for the shipment. |
See our Delivery Confirmation page (ShipEngine guide) for more details about using the confirmation property.
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 (ShipEngine guide).
InPost does not require manifesting (ShipEngine guide) your shipments.
InPost does not support scheduling pickups (ShipEngine guide).
InPost does not support shipping to service points (ShipEngine guide). The InPost Send and 48 Hours Delivery Service - QR code services are drop-off services.
ShipStation V2 API's integration with InPost supports receiving tracking updates. Review our Track a Package guides (ShipEngine guide) for details on tracking with the ShipStation V2 API.
See the Disconnect section in our Delete a Carrier page (ShipEngine guide) for the process of deleting or disconnecting a carrier from ShipStation V2 API.
NOTE:
If you disconnect a carrier account and reconnect it, the account will have a new
carrier_idin ShipStation V2 API.