API Library

Find an API for your business

Simplify your shipping, print your own postage or take advantage of online tracking - there's a range of APIs to help your business run more smoothly. You'll need to set up an API account before you get started.

API_block1_image1

Royal Mail Local Collect V2 (SOAP)

Local Collect is a delivery enhancement to Royal Mail Tracked & Special Delivery Guaranteed products that enables customers to benefit from ‘Click and Collect’ options by having their parcels delivered to participating Post Offices and Royal Mail Customer Service Points. The Local Collect API allows customers to retrieve an up-to-date list of Post Offices and Royal Mail Customer Service Points, where the item can be held awaiting collection. There are no costs to customers for using the Local Collect API services, however development costs must be covered by the customer. Royal Mail will not accept any responsibility for these development, implementation and testing costs.

Royal Mail Local Collect V2 (REST)

Local Collect is a delivery enhancement to Royal Mail Tracked & Special Delivery Guaranteed products that enables customers to benefit from ‘Click and Collect’ options by having their parcels delivered to participating Post Offices and Royal Mail Customer Service Points. The Local Collect API allows customers to retrieve an up-to-date list of Post Offices and Royal Mail Customer Service Points, where the item can be held awaiting collection. There are no costs to customers for using the Local Collect API services, however development costs must be covered by the customer. Royal Mail will not accept any responsibility for these development, implementation and testing costs.

Royal Mail API Shipping V3 (REST)

API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help.

Royal Mail Delivery Office Finder V1 (REST) API

The Delivery Office Finder API enables customers to obtain details of the Royal Mail Delivery Office dedicated to the provided postcode with the name, address, facilities and business hours of the Delivery Office being returned.

Royal Mail Tracking (for Server-side app) v2 REST API

The Royal Mail Tracking API V2 exposes a web service that allows account customers to receive track-and-trace information for their mail items. Built on industry standards, Tracking API V2 provides a simple and low cost method for customers to integrate with Royal Mail.

The API provides the latest tracking information, the tracking history, and the proof of delivery information for a single mail item and summary information for multiple mail pieces. The API provides an alternative mechanism to using the track and trace function on the Royal Mail website (http://www.royalmail.com/track-trace).

There are no costs to customers for using the Tracking API V2, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs.

Customers should address initial enquiries regarding development of systems for these purposes to their account handler.