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.

An Post

An Post offers domestic and international shipping solutions for shipments originating in Ireland and Great Britain. As the national postal service provider of Ireland, An Post is responsible for delivering mail and parcels across the country and operating post offices throughout its network.

This guide provides developers with the details needed to build An Post shipping capabilities into your ShipStation API workflows.

Requirements

PropertyTypeRequired?Description
nicknamestringrequired
customer_account_numberstringrequiredAccount number

An Post has many additional non-required properties you can set during the connection process. See details in the Connect Account section.

Connect Account

You can connect your An Post account using the POST method to the /v1/connections/carriers/ endpoint, or via the ShipStation API Dashboard.

Connect via Endpoint

carrier_name: an_post

POST /v1/connections/carriers/:carrier_name

Sample request:

1
2
3
4
5
6
7
8
9
POST /v1/connections/carriers/an_post HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
"nickname": "My An Post Account"
"customer_account_number": "123456789"
}
1
2
3
{
"carrier-id": "se-1234567"
}

Additional Connection Properties

PropertyTypeDescription
exp_prefixstringPackage tracking number prefix for Express With Signature Parcel service
exp_package_tracking_number_range_fromnumberPackage tracking number range first number for Express With Signature Parcel servic
exp_package_tracking_number_range_tonumberPackage tracking number range last number for Express With Signature Parcel service
swp_prefixstringPackage tracking number prefix for Express With Signature Packet service
swp_package_tracking_number_range_fromnumberPackage tracking number range first number for Express With Signature Packet service
swp_package_tracking_number_range_tonumberPackage tracking number range last number for Express With Signature Packet service
std_prefixstringPackage tracking number prefix for Standard Post Parcel service
std_package_tracking_number_range_fromnumberPackage tracking number range first number for Standard Post Parcel service
std_package_tracking_number_range_tonumberPackage tracking number range last number for Standard Post Parcel service
sts_prefixstringPackage tracking number prefix for Standard Post With Signature Parcel service
sts_package_tracking_number_range_fromnumberPackage tracking number range first number for Standard Post With Signature Parcel service
sts_package_tracking_number_range_tonumberPackage tracking number range last number for Standard Post With Signature Parcel service
pri_prefixstringPackage tracking number prefix for Priority Post Parcel service
pri_package_tracking_number_range_fromnumberPackage tracking number range first number for Priority Post Parcel service
pri_package_tracking_number_range_tonumberPackage tracking number range last number for Priority Post Parcel service
ret_prefixstringPackage tracking number prefix for Returns Service Parcel service
ret_package_tracking_number_range_fromnumberPackage tracking number range first number for Returns Service Parcel service
ret_package_tracking_number_range_tonumberPackage tracking number range last number for Returns Service Parcel service
ems_prefixstringPackage tracking number prefix for Courier Parcel service
ems_package_tracking_number_range_fromnumberPackage tracking number range first number for Courier Parcel service
ems_package_tracking_number_range_tonumberPackage tracking number range last number for Courier Parcel service
sto_prefixstringPackage tracking number prefix for Store Delivery Parcel service
sto_package_tracking_number_range_fromnumberPackage tracking number range first number for Store Delivery Parcel service
sto_package_tracking_number_range_tonumberPackage tracking number range last number for Store Delivery Parcel service
pkt_prefixstringPackage tracking number prefix for Express Packet service
pkt_package_tracking_number_range_fromnumberPackage tracking number range first number for Express Packet service
pkt_package_tracking_number_range_tonumberPackage tracking number range last number for Express Packet service
exe_prefixstringPackage tracking number prefix for Express International Packet service
exe_package_tracking_number_range_fromnumberPackage tracking number range first number for Express International Packet service
exe_package_tracking_number_range_tonumberPackage tracking number range last number for Express International Packet service
reg_prefixstringPackage tracking number prefix for Registered Post Packet service
reg_package_tracking_number_range_fromnumberPackage tracking number range first number for Registered Post Packet service
reg_package_tracking_number_range_tonumberPackage tracking number range last number for Registered Post Packet service
unt_prefixstringPackage tracking number prefix for IBMS/Untracked Packet service
unt_package_tracking_number_range_fromnumberPackage tracking number range first number for IBMS/Untracked Packet service
unt_package_tracking_number_range_tonumberPackage tracking number range last number for IBMS/Untracked Packet service

Rates

An Post does not send estimated rates to ShipStation API, as they not support querying a rate prior to label creation. Your An Post account contact can provide you with the details about your contracted rates.

Service Details

Available An Post 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

ServiceService API CodesShip From Countries
Express With Signature Parcelan_post_express_with_signature_parcelIE, GB
Express With Signature Packetan_post_express_with_signature_packetIE, GB
Express Packetan_post_express_packetIE
Standard Post With Signature Parcelan_post_standard_post_with_signature_parcelIE
Store Delivery Parcelan_post_store_delivery_parcelIE

International Services

ServiceService API CodesShip From Countries
Courier Parcelan_post_courier_parcelIE
Express International Packetaan_post_express_international_packetIE
IBMS/Untracked Packetan_post_ibms_untracked_packetIE
Priority Post Parcelan_post_priority_post_parcelIE
Registered Post Packetan_post_registered_post_packetIE
Standard Post Parcelan_post_standard_post_parcelIE

Shipping from Great Britain to Northern Ireland

At this time, An Post has not provided any details about required changes when creating labels for shipment from Great Britain to Northern Ireland as related to the Windsor Framework.

We will provide details about using An Post to ship to Northern Ireland as soon as they are available.

Return Services

An Post supports the following return services:

ServiceService API CodesShip From Countries
Returns Service Parcelan_post_returns_service_parcelIE

Review the Return Shipping Labels page for details on creating return labels with ShipStation API.

Packages

The following carrier package types are available for CarrierName services:

NameAPI CodePackage Attributes
Parcelan_post_parcelDomestic, International
Packetan_post_packetDomestic, International

Adding Shipment Insurance

Adding carrier shipment insurance is not supported for this carrier.

Label Support

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

Label Reference Fields

An Post supports adding custom label messages to label message 1.

Multi-Package Labels

An Post does not support multi-package shipping.

Label Branding

An Post does not support label branding.

Voiding Labels

You can void An Post labels with ShipStation API.

See our Void a Label page for details about voiding labels with ShipStation API.

Paperless Labels

An Post does not support creating paperless labels with ShipStation API.

Customs Declarations

More information coming soon!

Delivery Confirmation

Confirmation TypeAPI CodeDescription
No confirmation requirednoneUse when no confirmation is needed for the shipment.
Signature Confirmation requiredsignatureUse when signature confirmation is needed for the shipment.

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

Advanced Options

An Post does not support any advanced options.

Manifests

An Post requires you to manifest your shipments. Manifests are sent electronically to the SFTP location you set up during the connection process.

See our Manifests page for more details about creating manifests with ShipStation API.

Scheduling Pickups

An Post does not support Scheduling a pickup via ShipStation API.

Service Points (PUDO)

An Post does not support shipping to service points.

Tracking

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

Disconnecting Your An Post Account

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