The Amazon Shiptrack API provides a RESTful web service that allows Amazon to receive track-and-trace information for their mail items. It is based on Amazon's ShipTrack API Version 4.0 specification.

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.

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.

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.

The Parcel Force Image Retrieval V1 (REST) API is used to retrieve images and its metadata stored in the Enterprise image store (EIS).

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.

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.

API to register customer and create subscriptions for push api service.

Royal Mail API for Address matching. Eg. Finding addresses or retrieving address details.

This API specification details the requirements for integrating with Royal Mail API Shipping V2 (REST). It specifically covers how the Royal Mail API Shipping V2 (REST) 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 V2 (REST) 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 items with Royal Mail. Built on industry standards, Royal Mail API Shipping V2 (REST) 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 and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V2 (REST) 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 click here: www.royalmail.com/pro-shipping-help

This API specification details the requirements for integrating with Royal Mail API Shipping V2 (REST). It specifically covers how the Royal Mail API Shipping V2 (REST) 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 V2 (REST) 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 items with Royal Mail. Built on industry standards, Royal Mail API Shipping V2 (REST) 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 and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V2 (REST) 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 click here: www.royalmail.com/pro-shipping-help

This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

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 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 and offline barcoding 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.

Generic Catch All API deployed to allow external customers to utilise services built on Azure. This is a tactical API and will be removed once we have strategic solution in place.

The Royal Mail Authorisation API provides a RESTful web service that allows API consumers to obtain authorisation to access Royal Mail resources. There are no costs to customers for using the Authorisation V1 API, 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.

Generic Catch All API deployed to allow external customers to utilise services built on Azure. This is a tactical API and will be removed once we have strategic solution in place.

The Royal Mail Barcode Allocation V1 API provides a RESTful web service that allows API consumers to be allocated a range of barcodes. There are no costs to customers for using the Barcode Allocation V1 API, 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 provides Royal Mail mobile app users the ability to buy Royalmail postage digitally. The API provides the functionality to obtain shipping services,postage price for the item and obtain the QRcodes and labels for shipping. Using this 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.

This API provides Royal Mail mobile app users the ability to buy Royalmail postage digitally. The API provides the functionality to obtain shipping services,postage price for the item and obtain the QRcodes and labels for shipping. Using this 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

The CCI API is API interface used by Azure AD B2C for managing user identity in UAS during execution of user journeys (sign-in, sign-up, password reset, self-service password change). CCI stands for Consolidated Customer Identity.

The Royal Mail Customer Experience Opening Hours API allows customers to get customer experience regular working hours and working hours for upcoming holidays

Royal Mail Collection Order handler API exposes a REST service that allows Royal Mail customers to control on the delivery of their parcels by allowing them to book doorstep collections. It also delivers new capabilities for Royal Mail Operational teams in delivery offices to fulfill the collection requests in an efficient manner. The purpose of this API is to allow Royal Mail and Third Party retailers to check the available slots, book and manage doorstep collections.

Royal Mail Collections API exposes a REST service that allow RM App users to create, retrieve, cancel, update collection details, get timeslots for collections and validates barcode to return the item collection price. There are no costs to customers for using the Royal Mail Collections API V2 services, however customers’ 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.

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.

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.

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.

This API aims at providing RMG customers with a new service that allows them to attach digital content produced by RMG to a physical letter. This should allow them to e.g. post a Christmas card to someone and also send them a Christmas-themed animation video that they can watch once they have received the card. Customers willing to do so are expected to scan a barcoded stamp on their personal mobile devices via the Royal Mail app and select one of the available media options. They can then submit that preference (a Content Mapping) and post the physical letter. Upon receiving the letter, the recipient is expected to scan the barcoded stamp via RM App on their personal device, at which point they should be able to stream the media content on their screen. The API allows for customer interaction with the back-end via RM App but it does not allow for new content to be added or existing content to be removed as that's not something RM App users are expected to be allowed to do. The API also provides a reference endpoint URL to the media content to be streamed rather than returning the content itself as the content is expected to be served from a separate back-end service.

This API aims at providing RMG customers with a new service that allows them to attach digital content produced by RMG to a physical letter. This should allow them to e.g. post a Christmas card to someone and also send them a Christmas-themed animation video that they can watch once they have received the card. Customers willing to do so are expected to scan a barcoded stamp on their personal mobile devices via the Royal Mail app and select one of the available media options. They can then submit that preference (a Content Mapping) and post the physical letter. Upon receiving the letter, the recipient is expected to scan the barcoded stamp via RM App on their personal device, at which point they should be able to stream the media content on their screen. The API allows for customer interaction with the back-end via RM App but it does not allow for new content to be added or existing content to be removed as that's not something RM App users are expected to be allowed to do. The API also provides a reference endpoint URL to the media content to be streamed rather than returning the content itself as the content is expected to be served from a separate back-end service.

Royal Mail Enrichment Mail Piece API V1 (REST) is built to return pre-advice information to enable IPROL software to regenerate a barcode.

Royal Mail Events API exposes a REST service that allows to publish events information from source to multiple systems.

The Royal Mail Image Retrieval API V1 provides a RESTful web service that allows API consumers to retrieve image data from Royal Mail's Image Store. The API can return image data and its' associated metadata or the raw image as a binary stream. There are no costs to customers for using the Image Retrieval 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.

The Royal Mail Image Retrieval API V1 provides a RESTful web service that allows API consumers to retrieve image data from Royal Mail's Image Store. The API can return image data and its' associated metadata or the raw image as a binary stream. There are no costs to customers for using the Image Retrieval 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.

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).

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.

This is Landed Cost Visibility API which consists of a series of APIs such as HS Code Classification Service, Landed Cost Service, Prohibited & Restricted Service, Denied Parties Service, Combined Service and Document Solution service API

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.

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 enquiry offices. The Local Collect API allows customers to retrieve an up-to-date list of Post Offices and Royal Mail Enquiry Offices, 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.

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 enquiry offices. The Local Collect API allows customers to retrieve an up-to-date list of Post Offices and Royal Mail Enquiry Offices, 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.

The Royal Mail Location Finder V1 API provides a RESTful web service that allows mobile app consumers to retrieve nearby customer service points and related details for a given postcode or longitude/latitude.

The Royal Mail Locations V1 (REST) API exposes a web service that allows Royal Mail internal consumers to get the local collect locations i.e. POLs and CSPs belongs to the same delivery office for a given postcode.

The Royal Mail Authorisation API provides a RESTful web service that allows API consumers to obtain authorisation to access Royal Mail resources. There are no costs to customers for using the Authorisation V1 API, 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.

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.

RM App Address API for address look-up and match

Royal Mail Mobile App Redelivery REST API allows mobile app users to retrieve available redelivery dates and submit a redelivery request

This API works as stub for aggregated response from PDA and EPS

The Royal Mail My User Account API allows customers to register and perform account management operations. This API will allow a customer to verify their email address by requesting a verification email to be sent to their email address. This API will also allow a customer to confirm their email address by responding with the token in the verification email.

The Royal Mail My User Account REST API allows customers to mange their account details. User can view and edit Title, First name, Last name, Email, Mobile phone number, Home phone number, Address

The Royal Mail My User Account V2 (REST) API allows customers to manage their account details.

Royal Mail Order API exposes a REST service that allows third party retailers to handle creation, amendment or cancellation of order. There are no costs to customers for using the Order 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.

The Royal Mail Delivery Change Options V1 (REST) API exposes a web service that allows Royal Mail customers to change delivery Options information for their mail items. The API is initially used for ebusiness webapps of the Royal Mail website to receive and update delivery change options available for a mailpiece.

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.

Stub API to register customer for push api service

API to register customer and create subscriptions for push api service.

Barcode Range API created as part of Push API subscription process to allow customers to specify range of barcodes which are in scope for mailPiece related event information to be generated against and sent to the customer specific endpoint.

Royal Mail Redelivery V1 (REST) API exposes a web service that allows Royal Mail internal consumers to allow redeliveries to be booked for action by CSP and OPG via CLEO (Customer Link In Every Office).

The Royal Mail Sender Logo Mappings API is used so that sender logos can be identified for sender accounts.

This API provides Royal Mail mobile app users the ability to buy Royalmail postage digitally. The API provides the functionality to obtain shipping services,postage price for the item and obtain the QRcodes and labels for shipping. Using this 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.

Royal Mail Tasks API exposes a REST service that allows Royal Mail internal consumer applications to manage tasks associated with a given entity.

The Royal Mail Tracking (for Client-side App) REST exposes a web service that allows account customers to receive track-and-trace information for their mail items. The API is backend for ebusiness and Post Office track and trace webapps of the Royal Mail website (https://www.royalmail.com/track-your-item) For B2B logged in users , this API providing summary for latest mailPieceIds , options to get details of a mailPiecesId and proof of image.

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.

The Royal Mail Tracking (for Client-side App) REST exposes a web service that allows account customers to receive track-and-trace information for their mail items. The API is backend for ebusiness and Post Office track and trace webapps of the Royal Mail website (https://www.royalmail.com/track-your-item) For B2B logged in users , this API providing summary for latest mailPieceIds , options to get details of a mailPiecesId and proof of image.

The Royal Mail Tracking (for Client-side App) REST exposes a web service that allows RM App to receive track-and-traceinformation for their mail items.

The Royal Mail Tracking (for RM App users) REST API exposes a web service that allows RM App users to receive track-and-trace information for their mail items.

The Royal Mail Tracking (for RM App users) REST API exposes a web service that allows RM App users to receive track-and-trace information for their mail items.

The Royal Mail Tracking API V3 exposes a web service that allows account customers to receive track-and-trace information for their mail items. Built on industry standards, Tracking API V3 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 V3, 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.

The Royal Mail Tracking Alias V1 (REST) API exposes a web service to associate an alias with the tracking datastore. This web service will enable various digital channels to identify a parcel or letter via an alias label as opposed to the traditional tracking number.

The Royal Mail Tracking details V1 API is a RESTful web service to validate and provide Preadvice data based on Tracking Id.

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.

User Account Service REST API for actions relating to user accounts

Royal Mail User Info eBiz Stub is working as a backend service for Royal Mail User Info V1 REST

The Royal Mail My Info API allows customers to get their designated postie and customer service point.

The Royal Mail Registration API allows customers to register and perform account management operations.

Royal Mail Webhook V1 (REST) allows external customers to send event driven messages to royalmail webhook external endpoint for further processing at downstream

Tracking API provides the functionality to enquire on the tracking status of mail items. The API provides the latest tracking information for single and multiple mail items, the tracking history for a single mail item, and the proof of delivery information (minus the signature image) for a single mail item. 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 services, however development costs must be covered by the customer. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial inquiries regarding development of systems for these purposes to their account handler.

User Account Service REST API for actions relating to user accounts

User Account Service REST API for actions relating to user accounts