Forums

Forum Topics Posts Last post
No new posts
Get help and advice on the use of our APIs.
No new posts
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.
194 194
No new posts
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.
192 192
No new posts
An API to assist with debugging and testing. Used a public domain echo service
162 162
No new posts
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.
187 187
No new posts
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.
160 160
No new posts
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.
129 129
No new posts
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.
167 167
No new posts
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.
165 165
No new posts
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.
183 183
No new posts
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.
161 161
No new posts
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.
160 160
No new posts
Shipping V1 API provides the functionality for customers to take a shipping transaction from creation to collection. Royal Mail Shipping V1 API exposes web services that allow account customers to create shipments, produce labels, and produce documentation; all the tasks required for them to ship items with Royal Mail. Unless they have been granted an exemption, customer shipments will be subject to a clean sweep process. This is a process that runs at a specific time each night, and automatically manifests any ‘Printed’ shipments that have not already been manifested. There are no costs to customers for using the Shipping API 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.
172 172
No new posts
Shipping V1 API provides the functionality for customers to take a shipping transaction from creation to collection. Royal Mail Shipping V1 API exposes web services that allow account customers to create shipments, produce labels, and produce documentation; all the tasks required for them to ship items with Royal Mail. Unless they have been granted an exemption, customer shipments will be subject to a clean sweep process. This is a process that runs at a specific time each night, and automatically manifests any ‘Printed’ shipments that have not already been manifested. There are no costs to customers for using the Shipping API 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.
169 169
No new posts
Shipping API V2 provides the functionality for customers to take a shipping transaction from creation to collection. It is a service offered via Royal Mail to request for the creation, update, cancellation of a shipment, printing of a label, printing of international Customs documents, requesting 2D barcode ranges, requesting 1D Item ID ranges, creation and printing of a manifest. Built on industry standards, Shipping API V2 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. There are no costs to customers for using the Shipping API V2 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.
167 167
No new posts
Shipping API V2 provides the functionality for customers to take a shipping transaction from creation to collection. It is a service offered via Royal Mail to request for the creation, update, cancellation of a shipment, printing of a label, printing of international Customs documents, requesting 2D barcode ranges, requesting 1D Item ID ranges, creation and printing of a manifest. Built on industry standards, Shipping API V2 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. There are no costs to customers for using the Shipping API V2 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.
141 141
No new posts
Tracking API provides the functionality to enquire on the tracking status of mail items. The API provides the latest tracking information, the tracking history, 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.
181 181
No new posts
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.
151 151
No new posts
Tracking API provides the functionality to enquire on the tracking status of mail items. The API provides the latest tracking information, the tracking history, 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.
170 170
No new posts
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.
154 154
No new posts
0 0 n/a