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
0
No votes yet

Royal Mail Local Collect V1 (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. The Local Collect API allows customers to retrieve an up-to-date list of Post Offices and confirm selection in a given location, where the item will 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.

0
No votes yet

Royal Mail Local Collect V1 (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. The Local Collect API allows customers to retrieve an up-to-date list of Post Offices and confirm selection in a given location, where the item will 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.

0
No votes yet

Royal Mail Online Postage V2 (SOAP)

The Online Postage API provides any Royal Mail approved third party Marketplace website the ability to print their own postage labels. The API provides the functionality to obtain a country list for a given carrier, obtain terms and conditions for the mail services, obtain the postage price for an individual item, obtain the postage for an individual mail item and spoil (cancel) that unused postage.

This service is only available to Royal Mail approved third party Marketplace websites. Using the Online Postage API will require development costs that will be covered by the third party developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs.

Customers who are interested should contact their Royal Mail account handler to check eligibility.

0
No votes yet

Royal Mail Mailpiece Event Submission V1 (SOAP)

The Mail Piece Event Submission API provides an external interface for partner postal operators to submit tracking event messages for Royal Mail products that are processed externally.

There are no costs using the Mail Piece Event Submission API, however development costs must be covered by the partner postal operator. Royal Mail will not accept any responsibility for these development, implementation and testing costs.

0
No votes yet

Royal Mail Electronic Customs Declaration V1 (SOAP)

The Customs Declaration System API provides operations to support the creation and submission of customs declarations. These operations are to lookup HS codes, check that items are not prohibited in the destination country and submit the declaration electronically.

0
No votes yet

Parcel Force World Wide Tracking V1 (SOAP)

The Parcelforce Tracking API exposes a web service that allows customers enquire on the tracking status of mail items which are being handled through the Parcelforce network. There are two API operations available which provide both single and multi-item tracking services.

The first API operation provides single item parcel tracking functionality based on Parcelforce consignment number, parcel label, foreign parcel label or senders reference for one account. The second API operation provides registration, parcel searching and multiple parcel searching functionality based on customer number (or sender reference) and account information.

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

0
No votes yet

Royal Mail International Tracked Direct V2 (REST)

International Tracked Direct API V1 provides the integration method to Royal Mail business customers for using Royal Mail's international tracked direct service. This API offers the capability of creation and cancellation of an international shipment, getting bag label(s) and manifest and tracking international tracked direct shipments. Built on industry standards, International Tracked Direct API V1 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get international shipping quickly. There are no costs to customers for using the International Tracked Direct API V1, 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.

0
No votes yet

Royal Mail Delivery Office Finder V1 (REST)

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.

0
No votes yet

Royal Mail Incidents Management V1 (REST)

The Royal Mail Incidents Management V1 (REST) API exposes a web service that allows Royal Mail customers to create customer complaint tickets, to create an instance of contacts in Oracle Service Cloud (OSC) and also allow to retrieve/lookup existing customer contact details from Oracle Service Cloud (OSC).

0
No votes yet

Royal Mail PSP Employee Verification (SOAP)

Royal Mail PSP Employee Verification (SOAP) API exposes a web service that allows MyRoyalMail.com hosted in eBusiness to verify with PSP if employee still working for Royal Mail Group.

Pages