Royal Mail Tracking for Server-side App (Operational) V3 - API Developer Portal

Description

royal-mail-tracking-for-server-side-app-operational-v3 allows Royal Mail account customers to subscribe to a plan and use Royal Mail Tracking (for Server-side app) v3 REST API to retrieve track-and-trace information for their mail items.

APIs

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

3.0.1

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)

REST

Online

Plans

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

Assessment

50 calls per day

Select

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

View details

APIs

Title	Version	Type	Rate limits
Royal Mail Tracking (for Server-side app) v3 REST API	3.0.1	REST	50 calls per day
GET /{mailPieceId}/events			50 calls per day
PARAMETERS /{mailPieceId}/events			50 calls per day
GET /summary			50 calls per day
PARAMETERS /summary			50 calls per day
GET /{mailPieceId}/signature			50 calls per day
PARAMETERS /{mailPieceId}/signature			50 calls per day
GET /{mailPieceId}/photo			50 calls per day
PARAMETERS /{mailPieceId}/photo			50 calls per day

Bronze

2 rate limits *

Select

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

View details

APIs

Title	Version	Type	Rate limits
Royal Mail Tracking (for Server-side app) v3 REST API	3.0.1	REST	2 rate limits *
GET /{mailPieceId}/events			2 rate limits *
PARAMETERS /{mailPieceId}/events			2 rate limits *
GET /summary			2 rate limits *
PARAMETERS /summary			2 rate limits *
GET /{mailPieceId}/signature			2 rate limits *
PARAMETERS /{mailPieceId}/signature			2 rate limits *
GET /{mailPieceId}/photo			2 rate limits *
PARAMETERS /{mailPieceId}/photo			2 rate limits *

Bronze (T & C)

2 rate limits *

Select

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

View details

APIs

Title	Version	Type	Rate limits
Royal Mail Tracking (for Server-side app) v3 REST API	3.0.1	REST	2 rate limits *
GET /{mailPieceId}/events			2 rate limits *
PARAMETERS /{mailPieceId}/events			2 rate limits *
GET /summary			2 rate limits *
PARAMETERS /summary			2 rate limits *
GET /{mailPieceId}/signature			2 rate limits *
PARAMETERS /{mailPieceId}/signature			2 rate limits *
GET /{mailPieceId}/photo			2 rate limits *
PARAMETERS /{mailPieceId}/photo			2 rate limits *

Diamond

2 rate limits *

Select

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

View details

APIs

Title	Version	Type	Rate limits
Royal Mail Tracking (for Server-side app) v3 REST API	3.0.1	REST	2 rate limits *
GET /{mailPieceId}/events			2 rate limits *
PARAMETERS /{mailPieceId}/events			2 rate limits *
GET /summary			2 rate limits *
PARAMETERS /summary			2 rate limits *
GET /{mailPieceId}/signature			2 rate limits *
PARAMETERS /{mailPieceId}/signature			2 rate limits *
GET /{mailPieceId}/photo			2 rate limits *
PARAMETERS /{mailPieceId}/photo			2 rate limits *

Diamond Plus

2 rate limits *

Select

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

View details

APIs

Title	Version	Type	Rate limits
Royal Mail Tracking (for Server-side app) v3 REST API	3.0.1	REST	2 rate limits *
GET /{mailPieceId}/events			2 rate limits *
PARAMETERS /{mailPieceId}/events			2 rate limits *
GET /summary			2 rate limits *
PARAMETERS /summary			2 rate limits *
GET /{mailPieceId}/signature			2 rate limits *
PARAMETERS /{mailPieceId}/signature			2 rate limits *
GET /{mailPieceId}/photo			2 rate limits *
PARAMETERS /{mailPieceId}/photo			2 rate limits *

Diamond Plus (T & C)

2 rate limits *

Select

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

View details

APIs

Title	Version	Type	Rate limits
Royal Mail Tracking (for Server-side app) v3 REST API	3.0.1	REST	2 rate limits *
GET /{mailPieceId}/events			2 rate limits *
PARAMETERS /{mailPieceId}/events			2 rate limits *
GET /summary			2 rate limits *
PARAMETERS /summary			2 rate limits *
GET /{mailPieceId}/signature			2 rate limits *
PARAMETERS /{mailPieceId}/signature			2 rate limits *
GET /{mailPieceId}/photo			2 rate limits *
PARAMETERS /{mailPieceId}/photo			2 rate limits *

Diamond (T & C)

2 rate limits *

Select

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

View details

APIs

Title	Version	Type	Rate limits
Royal Mail Tracking (for Server-side app) v3 REST API	3.0.1	REST	2 rate limits *
GET /{mailPieceId}/events			2 rate limits *
PARAMETERS /{mailPieceId}/events			2 rate limits *
GET /summary			2 rate limits *
PARAMETERS /summary			2 rate limits *
GET /{mailPieceId}/signature			2 rate limits *
PARAMETERS /{mailPieceId}/signature			2 rate limits *
GET /{mailPieceId}/photo			2 rate limits *
PARAMETERS /{mailPieceId}/photo			2 rate limits *

Gold

2 rate limits *

Select

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

View details

APIs

Title	Version	Type	Rate limits
Royal Mail Tracking (for Server-side app) v3 REST API	3.0.1	REST	2 rate limits *
GET /{mailPieceId}/events			2 rate limits *
PARAMETERS /{mailPieceId}/events			2 rate limits *
GET /summary			2 rate limits *
PARAMETERS /summary			2 rate limits *
GET /{mailPieceId}/signature			2 rate limits *
PARAMETERS /{mailPieceId}/signature			2 rate limits *
GET /{mailPieceId}/photo			2 rate limits *
PARAMETERS /{mailPieceId}/photo			2 rate limits *

Gold (T & C)

2 rate limits *

Select

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

View details

APIs

Title	Version	Type	Rate limits
Royal Mail Tracking (for Server-side app) v3 REST API	3.0.1	REST	2 rate limits *
GET /{mailPieceId}/events			2 rate limits *
PARAMETERS /{mailPieceId}/events			2 rate limits *
GET /summary			2 rate limits *
PARAMETERS /summary			2 rate limits *
GET /{mailPieceId}/signature			2 rate limits *
PARAMETERS /{mailPieceId}/signature			2 rate limits *
GET /{mailPieceId}/photo			2 rate limits *
PARAMETERS /{mailPieceId}/photo			2 rate limits *

Platinum

2 rate limits *

Select

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

View details

APIs

Title	Version	Type	Rate limits
Royal Mail Tracking (for Server-side app) v3 REST API	3.0.1	REST	2 rate limits *
GET /{mailPieceId}/events			2 rate limits *
PARAMETERS /{mailPieceId}/events			2 rate limits *
GET /summary			2 rate limits *
PARAMETERS /summary			2 rate limits *
GET /{mailPieceId}/signature			2 rate limits *
PARAMETERS /{mailPieceId}/signature			2 rate limits *
GET /{mailPieceId}/photo			2 rate limits *
PARAMETERS /{mailPieceId}/photo			2 rate limits *

Platinum Plus

2 rate limits *

Select

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

View details

APIs

Title	Version	Type	Rate limits
Royal Mail Tracking (for Server-side app) v3 REST API	3.0.1	REST	2 rate limits *
GET /{mailPieceId}/events			2 rate limits *
PARAMETERS /{mailPieceId}/events			2 rate limits *
GET /summary			2 rate limits *
PARAMETERS /summary			2 rate limits *
GET /{mailPieceId}/signature			2 rate limits *
PARAMETERS /{mailPieceId}/signature			2 rate limits *
GET /{mailPieceId}/photo			2 rate limits *
PARAMETERS /{mailPieceId}/photo			2 rate limits *

Platinum Plus (T & C)

2 rate limits *

Select

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

View details

APIs

Title	Version	Type	Rate limits
Royal Mail Tracking (for Server-side app) v3 REST API	3.0.1	REST	2 rate limits *
GET /{mailPieceId}/events			2 rate limits *
PARAMETERS /{mailPieceId}/events			2 rate limits *
GET /summary			2 rate limits *
PARAMETERS /summary			2 rate limits *
GET /{mailPieceId}/signature			2 rate limits *
PARAMETERS /{mailPieceId}/signature			2 rate limits *
GET /{mailPieceId}/photo			2 rate limits *
PARAMETERS /{mailPieceId}/photo			2 rate limits *

Platinum (T & C)

2 rate limits *

Select

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

View details

APIs

Title	Version	Type	Rate limits
Royal Mail Tracking (for Server-side app) v3 REST API	3.0.1	REST	2 rate limits *
GET /{mailPieceId}/events			2 rate limits *
PARAMETERS /{mailPieceId}/events			2 rate limits *
GET /summary			2 rate limits *
PARAMETERS /summary			2 rate limits *
GET /{mailPieceId}/signature			2 rate limits *
PARAMETERS /{mailPieceId}/signature			2 rate limits *
GET /{mailPieceId}/photo			2 rate limits *
PARAMETERS /{mailPieceId}/photo			2 rate limits *

Ruby

2 rate limits *

Select

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

View details

APIs

Title	Version	Type	Rate limits
Royal Mail Tracking (for Server-side app) v3 REST API	3.0.1	REST	2 rate limits *
GET /{mailPieceId}/events			2 rate limits *
PARAMETERS /{mailPieceId}/events			2 rate limits *
GET /summary			2 rate limits *
PARAMETERS /summary			2 rate limits *
GET /{mailPieceId}/signature			2 rate limits *
PARAMETERS /{mailPieceId}/signature			2 rate limits *
GET /{mailPieceId}/photo			2 rate limits *
PARAMETERS /{mailPieceId}/photo			2 rate limits *

Ruby (T & C)

2 rate limits *

Select

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

View details

APIs

Title	Version	Type	Rate limits
Royal Mail Tracking (for Server-side app) v3 REST API	3.0.1	REST	2 rate limits *
GET /{mailPieceId}/events			2 rate limits *
PARAMETERS /{mailPieceId}/events			2 rate limits *
GET /summary			2 rate limits *
PARAMETERS /summary			2 rate limits *
GET /{mailPieceId}/signature			2 rate limits *
PARAMETERS /{mailPieceId}/signature			2 rate limits *
GET /{mailPieceId}/photo			2 rate limits *
PARAMETERS /{mailPieceId}/photo			2 rate limits *

Silver

2 rate limits *

Select

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

View details

APIs

Title	Version	Type	Rate limits
Royal Mail Tracking (for Server-side app) v3 REST API	3.0.1	REST	2 rate limits *
GET /{mailPieceId}/events			2 rate limits *
PARAMETERS /{mailPieceId}/events			2 rate limits *
GET /summary			2 rate limits *
PARAMETERS /summary			2 rate limits *
GET /{mailPieceId}/signature			2 rate limits *
PARAMETERS /{mailPieceId}/signature			2 rate limits *
GET /{mailPieceId}/photo			2 rate limits *
PARAMETERS /{mailPieceId}/photo			2 rate limits *

Silver (T & C)

2 rate limits *

Select

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

View details

APIs

Title	Version	Type	Rate limits
Royal Mail Tracking (for Server-side app) v3 REST API	3.0.1	REST	2 rate limits *
GET /{mailPieceId}/events			2 rate limits *
PARAMETERS /{mailPieceId}/events			2 rate limits *
GET /summary			2 rate limits *
PARAMETERS /summary			2 rate limits *
GET /{mailPieceId}/signature			2 rate limits *
PARAMETERS /{mailPieceId}/signature			2 rate limits *
GET /{mailPieceId}/photo			2 rate limits *
PARAMETERS /{mailPieceId}/photo			2 rate limits *

API Portal Experience	Get started	Help
Home	Log in	Support
Getting Started	Get started for free	Getting started guide
Royal Mail APIs		API docs
		Contact us