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

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:

Copy

HTTPcURLJavaScriptNodeJSPHPPythonRubyC#JavaGoSwiftObjective-CPowerShell

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

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

International Services

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:

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:

Adding Shipment Insurance

Adding carrier shipment insurance is not supported for this carrier.

Label Support

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

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.