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.
| Property | Type | Required? | Description |
|---|---|---|---|
nickname | string | required | |
customer_account_number | string | required | Account number |
An Post has many additional non-required properties you can set during the connection process. See details in the Connect Account section.
You can connect your An Post account using the POST method to the /v1/connections/carriers/ endpoint, or via the ShipStation API Dashboard.
carrier_name: an_post
POST /v1/connections/carriers/:carrier_name
Sample request:
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"
} {
"carrier-id": "se-1234567"
}| Property | Type | Description |
|---|---|---|
exp_prefix | string | Package tracking number prefix for Express With Signature Parcel service |
exp_package_tracking_number_range_from | number | Package tracking number range first number for Express With Signature Parcel servic |
exp_package_tracking_number_range_to | number | Package tracking number range last number for Express With Signature Parcel service |
swp_prefix | string | Package tracking number prefix for Express With Signature Packet service |
swp_package_tracking_number_range_from | number | Package tracking number range first number for Express With Signature Packet service |
swp_package_tracking_number_range_to | number | Package tracking number range last number for Express With Signature Packet service |
std_prefix | string | Package tracking number prefix for Standard Post Parcel service |
std_package_tracking_number_range_from | number | Package tracking number range first number for Standard Post Parcel service |
std_package_tracking_number_range_to | number | Package tracking number range last number for Standard Post Parcel service |
sts_prefix | string | Package tracking number prefix for Standard Post With Signature Parcel service |
sts_package_tracking_number_range_from | number | Package tracking number range first number for Standard Post With Signature Parcel service |
sts_package_tracking_number_range_to | number | Package tracking number range last number for Standard Post With Signature Parcel service |
pri_prefix | string | Package tracking number prefix for Priority Post Parcel service |
pri_package_tracking_number_range_from | number | Package tracking number range first number for Priority Post Parcel service |
pri_package_tracking_number_range_to | number | Package tracking number range last number for Priority Post Parcel service |
ret_prefix | string | Package tracking number prefix for Returns Service Parcel service |
ret_package_tracking_number_range_from | number | Package tracking number range first number for Returns Service Parcel service |
ret_package_tracking_number_range_to | number | Package tracking number range last number for Returns Service Parcel service |
ems_prefix | string | Package tracking number prefix for Courier Parcel service |
ems_package_tracking_number_range_from | number | Package tracking number range first number for Courier Parcel service |
ems_package_tracking_number_range_to | number | Package tracking number range last number for Courier Parcel service |
sto_prefix | string | Package tracking number prefix for Store Delivery Parcel service |
sto_package_tracking_number_range_from | number | Package tracking number range first number for Store Delivery Parcel service |
sto_package_tracking_number_range_to | number | Package tracking number range last number for Store Delivery Parcel service |
pkt_prefix | string | Package tracking number prefix for Express Packet service |
pkt_package_tracking_number_range_from | number | Package tracking number range first number for Express Packet service |
pkt_package_tracking_number_range_to | number | Package tracking number range last number for Express Packet service |
exe_prefix | string | Package tracking number prefix for Express International Packet service |
exe_package_tracking_number_range_from | number | Package tracking number range first number for Express International Packet service |
exe_package_tracking_number_range_to | number | Package tracking number range last number for Express International Packet service |
reg_prefix | string | Package tracking number prefix for Registered Post Packet service |
reg_package_tracking_number_range_from | number | Package tracking number range first number for Registered Post Packet service |
reg_package_tracking_number_range_to | number | Package tracking number range last number for Registered Post Packet service |
unt_prefix | string | Package tracking number prefix for IBMS/Untracked Packet service |
unt_package_tracking_number_range_from | number | Package tracking number range first number for IBMS/Untracked Packet service |
unt_package_tracking_number_range_to | number | Package tracking number range last number for IBMS/Untracked Packet service |
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.
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.
| Service | Service API Codes | Ship From Countries |
|---|---|---|
| Express With Signature Parcel | an_post_express_with_signature_parcel | IE, GB |
| Express With Signature Packet | an_post_express_with_signature_packet | IE, GB |
| Express Packet | an_post_express_packet | IE |
| Standard Post With Signature Parcel | an_post_standard_post_with_signature_parcel | IE |
| Store Delivery Parcel | an_post_store_delivery_parcel | IE |
| Service | Service API Codes | Ship From Countries |
|---|---|---|
| Courier Parcel | an_post_courier_parcel | IE |
| Express International Packet | aan_post_express_international_packet | IE |
| IBMS/Untracked Packet | an_post_ibms_untracked_packet | IE |
| Priority Post Parcel | an_post_priority_post_parcel | IE |
| Registered Post Packet | an_post_registered_post_packet | IE |
| Standard Post Parcel | an_post_standard_post_parcel | IE |
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.
An Post supports the following return services:
| Service | Service API Codes | Ship From Countries |
|---|---|---|
| Returns Service Parcel | an_post_returns_service_parcel | IE |
Review the Return Shipping Labels page for details on creating return labels with ShipStation API.
The following carrier package types are available for CarrierName services:
| Name | API Code | Package Attributes |
|---|---|---|
| Parcel | an_post_parcel | Domestic, International |
| Packet | an_post_packet | Domestic, International |
Adding carrier shipment insurance is not supported for this carrier.
- Label sizes: 4" x 6"
- Label formats: PDF, PNG, ZPL
An Post supports adding custom label messages to label message 1.
An Post does not support multi-package shipping.
An Post does not support label branding.
You can void An Post labels with ShipStation API.
See our Void a Label page for details about voiding labels with ShipStation API.
An Post does not support creating paperless labels with ShipStation API.
More information coming soon!
| Confirmation Type | API Code | Description |
|---|---|---|
| No confirmation required | none | Use when no confirmation is needed for the shipment. |
| Signature Confirmation required | signature | Use when signature confirmation is needed for the shipment. |
See our Delivery Confirmation page for more details about using the confirmation property.
An Post does not support any advanced options.
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.
An Post does not support Scheduling a pickup via ShipStation API.
An Post does not support shipping to service points.
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.
See the Disconnect section in our Delete a Carrier page for the process of deleting or disconnecting a carrier from ShipStation API.
NOTE:
If you disconnect a carrier account and reconnect it, the account will have a new
carrier_idin ShipStation API.