Royal Mail Perfomance Testing - API Developer Portal

Description

This Product consists of all API's considered for PVT Testing before every release.

APIs

Royal Mail Mailpiece Event Submission V1 (SOAP)

1.0.4

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.

SOAP

Online
Royal Mail Local Collect V2 (SOAP)

1.0.19

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

SOAP

Online
Royal Mail Local Collect V2 (REST)

1.0.13

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

REST

Online
Royal Mail Electronic Customs Declaration V1 (SOAP)

1.0.1

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.

SOAP

Online
Royal Mail Delivery Office Finder V1 (REST)

1.0.4

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.

REST

Online
Royal Mail Online Postage V1 (SOAP)

1.0.3

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

SOAP

Online
Royal Mail Local Collect V1 (SOAP)

1.0.8

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

SOAP

Online
Royal Mail Local Collect V1 (REST)

1.0.6

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

REST

Online
Royal Mail International Tracked Direct V2 (REST)

1.0.5

International Tracked Direct API V2 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 V2 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

REST

Online

Plans

In order to subscribe, you must create an account or sign in.

PVT Bronze Plan

10 calls per 10 seconds

Select

9 APIs including

Royal Mail Mailpiece Event Submission V1 (SOAP) 1.0.4
Royal Mail Online Postage V1 (SOAP) 1.0.3
Royal Mail Electronic Customs Declaration V1 (SOAP) 1.0.1
Royal Mail International Tracked Direct V2 (REST) 1.0.5
Royal Mail Local Collect V1 (REST) 1.0.6

View details

APIs

Title	Version	Type	Rate limits
Royal Mail Mailpiece Event Submission V1 (SOAP)	1.0.4	SOAP	10 calls per 10 seconds
POST /PostMPETracks			10 calls per 10 seconds
Royal Mail Online Postage V1 (SOAP)	1.0.3	SOAP	10 calls per 10 seconds
POST /createPostage			10 calls per 10 seconds
POST /getPostageServiceDetails			10 calls per 10 seconds
POST /getCountries			10 calls per 10 seconds
POST /getServicesByCountry			10 calls per 10 seconds
POST /getStatus			10 calls per 10 seconds
POST /spoilPostage			10 calls per 10 seconds
Royal Mail Electronic Customs Declaration V1 (SOAP)	1.0.1	SOAP	10 calls per 10 seconds
POST /CreateOrUpdateDeclarations			10 calls per 10 seconds
POST /GetHSCodes			10 calls per 10 seconds
POST /GetRestrictionProhibitionByDescription			10 calls per 10 seconds
POST /GetRestrictionProhibitionByHS			10 calls per 10 seconds
POST /ConvertAnonymousToCDSDeclaration			10 calls per 10 seconds
POST /ConvertCurrency			10 calls per 10 seconds
POST /CreateNewDeclaration			10 calls per 10 seconds
POST /CreateNewResponse			10 calls per 10 seconds
POST /CreateOrUpdateResponses			10 calls per 10 seconds
POST /GetCustomsStatus			10 calls per 10 seconds
POST /GetDecisionNameAndCategoryFromCode			10 calls per 10 seconds
POST /GetWatchdogItemInfo			10 calls per 10 seconds
POST /Load			10 calls per 10 seconds
POST /SetWatchdogItemInfo			10 calls per 10 seconds
POST /StoreDeclaration			10 calls per 10 seconds
POST /StoreResponse			10 calls per 10 seconds
POST /UpdateMailState			10 calls per 10 seconds
Royal Mail International Tracked Direct V2 (REST)	1.0.5	REST	10 calls per 10 seconds
DELETE /{trackingNumber}			10 calls per 10 seconds
POST /			10 calls per 10 seconds
POST /bagcontent			10 calls per 10 seconds
GET /{trackingNumber}/history			10 calls per 10 seconds
Royal Mail Local Collect V1 (REST)	1.0.6	REST	10 calls per 10 seconds
PUT /{bookingReference}			10 calls per 10 seconds
GET /			10 calls per 10 seconds
GET /geosearch			10 calls per 10 seconds
Royal Mail Local Collect V1 (SOAP)	1.0.8	SOAP	10 calls per 10 seconds
POST /SetLCDeliveryLocation			10 calls per 10 seconds
POST /GetLCDeliveryLocations			10 calls per 10 seconds
Royal Mail Local Collect V2 (REST)	1.0.13	REST	10 calls per 10 seconds
GET /{postcode}			10 calls per 10 seconds
GET /geo/spatial			10 calls per 10 seconds
Royal Mail Delivery Office Finder V1 (REST)	1.0.4	REST	10 calls per 10 seconds
GET /			10 calls per 10 seconds
Royal Mail Local Collect V2 (SOAP)	1.0.19	SOAP	10 calls per 10 seconds
POST /getLocations			10 calls per 10 seconds

PVT Gold Plan

unlimited

Select

9 APIs including

Royal Mail Mailpiece Event Submission V1 (SOAP) 1.0.4
Royal Mail Online Postage V1 (SOAP) 1.0.3
Royal Mail Electronic Customs Declaration V1 (SOAP) 1.0.1
Royal Mail International Tracked Direct V2 (REST) 1.0.5
Royal Mail Local Collect V1 (REST) 1.0.6

View details

APIs

Title	Version	Type	Rate limits
Royal Mail Mailpiece Event Submission V1 (SOAP)	1.0.4	SOAP	unlimited
POST /PostMPETracks			unlimited
Royal Mail Online Postage V1 (SOAP)	1.0.3	SOAP	unlimited
POST /createPostage			unlimited
POST /getPostageServiceDetails			unlimited
POST /getCountries			unlimited
POST /getServicesByCountry			unlimited
POST /getStatus			unlimited
POST /spoilPostage			unlimited
Royal Mail Electronic Customs Declaration V1 (SOAP)	1.0.1	SOAP	unlimited
POST /CreateOrUpdateDeclarations			unlimited
POST /GetHSCodes			unlimited
POST /GetRestrictionProhibitionByDescription			unlimited
POST /GetRestrictionProhibitionByHS			unlimited
POST /ConvertAnonymousToCDSDeclaration			unlimited
POST /ConvertCurrency			unlimited
POST /CreateNewDeclaration			unlimited
POST /CreateNewResponse			unlimited
POST /CreateOrUpdateResponses			unlimited
POST /GetCustomsStatus			unlimited
POST /GetDecisionNameAndCategoryFromCode			unlimited
POST /GetWatchdogItemInfo			unlimited
POST /Load			unlimited
POST /SetWatchdogItemInfo			unlimited
POST /StoreDeclaration			unlimited
POST /StoreResponse			unlimited
POST /UpdateMailState			unlimited
Royal Mail International Tracked Direct V2 (REST)	1.0.5	REST	unlimited
DELETE /{trackingNumber}			unlimited
POST /			unlimited
POST /bagcontent			unlimited
GET /{trackingNumber}/history			unlimited
Royal Mail Local Collect V1 (REST)	1.0.6	REST	unlimited
PUT /{bookingReference}			unlimited
GET /			unlimited
GET /geosearch			unlimited
Royal Mail Local Collect V1 (SOAP)	1.0.8	SOAP	unlimited
POST /SetLCDeliveryLocation			unlimited
POST /GetLCDeliveryLocations			unlimited
Royal Mail Local Collect V2 (REST)	1.0.13	REST	unlimited
GET /{postcode}			unlimited
GET /geo/spatial			unlimited
Royal Mail Delivery Office Finder V1 (REST)	1.0.4	REST	unlimited
GET /			unlimited
Royal Mail Local Collect V2 (SOAP)	1.0.19	SOAP	unlimited
POST /getLocations			unlimited

PVT Silver Plan

unlimited

Select

9 APIs including

Royal Mail Mailpiece Event Submission V1 (SOAP) 1.0.4
Royal Mail Online Postage V1 (SOAP) 1.0.3
Royal Mail Electronic Customs Declaration V1 (SOAP) 1.0.1
Royal Mail International Tracked Direct V2 (REST) 1.0.5
Royal Mail Local Collect V1 (REST) 1.0.6

View details

APIs

Title	Version	Type	Rate limits
Royal Mail Mailpiece Event Submission V1 (SOAP)	1.0.4	SOAP	unlimited
POST /PostMPETracks			unlimited
Royal Mail Online Postage V1 (SOAP)	1.0.3	SOAP	unlimited
POST /createPostage			unlimited
POST /getPostageServiceDetails			unlimited
POST /getCountries			unlimited
POST /getServicesByCountry			unlimited
POST /getStatus			unlimited
POST /spoilPostage			unlimited
Royal Mail Electronic Customs Declaration V1 (SOAP)	1.0.1	SOAP	unlimited
POST /CreateOrUpdateDeclarations			unlimited
POST /GetHSCodes			unlimited
POST /GetRestrictionProhibitionByDescription			unlimited
POST /GetRestrictionProhibitionByHS			unlimited
POST /ConvertAnonymousToCDSDeclaration			unlimited
POST /ConvertCurrency			unlimited
POST /CreateNewDeclaration			unlimited
POST /CreateNewResponse			unlimited
POST /CreateOrUpdateResponses			unlimited
POST /GetCustomsStatus			unlimited
POST /GetDecisionNameAndCategoryFromCode			unlimited
POST /GetWatchdogItemInfo			unlimited
POST /Load			unlimited
POST /SetWatchdogItemInfo			unlimited
POST /StoreDeclaration			unlimited
POST /StoreResponse			unlimited
POST /UpdateMailState			unlimited
Royal Mail International Tracked Direct V2 (REST)	1.0.5	REST	unlimited
DELETE /{trackingNumber}			unlimited
POST /			unlimited
POST /bagcontent			unlimited
GET /{trackingNumber}/history			unlimited
Royal Mail Local Collect V1 (REST)	1.0.6	REST	unlimited
PUT /{bookingReference}			unlimited
GET /			unlimited
GET /geosearch			unlimited
Royal Mail Local Collect V1 (SOAP)	1.0.8	SOAP	unlimited
POST /SetLCDeliveryLocation			unlimited
POST /GetLCDeliveryLocations			unlimited
Royal Mail Local Collect V2 (REST)	1.0.13	REST	unlimited
GET /{postcode}			unlimited
GET /geo/spatial			unlimited
Royal Mail Delivery Office Finder V1 (REST)	1.0.4	REST	unlimited
GET /			unlimited
Royal Mail Local Collect V2 (SOAP)	1.0.19	SOAP	unlimited
POST /getLocations			unlimited