Royal Mail API Shipping V3 (Operational) - API Developer Portal

Description

This is for Royal Mail Customers to subscribe to the Royal mail Pro Shipping V3 Operational Plan.

APIs

3.0.20-test-7714

API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection.

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

REST

Online

Plans

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

Iron

10 calls per day

Select

Royal Mail API Shipping V3 (REST) 3.0.20-test-7714

View details

APIs

Title	Version	Type	Rate limits
Royal Mail API Shipping V3 (REST)	3.0.20-test-7714	REST	10 calls per day
POST /shipments			10 calls per day
PARAMETERS /shipments			10 calls per day
PUT /shipments/{shipmentId}/printDocument			10 calls per day
PARAMETERS /shipments/{shipmentId}/printDocument			10 calls per day
PUT /shipments/{shipmentId}/printLabel			10 calls per day
PARAMETERS /shipments/{shipmentId}/printLabel			10 calls per day
PUT /shipments/cancel			10 calls per day
PARAMETERS /shipments/cancel			10 calls per day
PUT /shipments/defer			10 calls per day
PARAMETERS /shipments/defer			10 calls per day
PUT /shipments/hold			10 calls per day
PARAMETERS /shipments/hold			10 calls per day
PUT /shipments/release			10 calls per day
PARAMETERS /shipments/release			10 calls per day
POST /shipments/serviceAvailability			10 calls per day
PARAMETERS /shipments/serviceAvailability			10 calls per day
POST /manifests			10 calls per day
PARAMETERS /manifests			10 calls per day
POST /manifests/bycarrier			10 calls per day
PARAMETERS /manifests/bycarrier			10 calls per day
POST /manifests/byservice			10 calls per day
PARAMETERS /manifests/byservice			10 calls per day
GET /addresses			10 calls per day
POST /addresses			10 calls per day
PARAMETERS /addresses			10 calls per day
GET /addresses/{addressId}			10 calls per day
PUT /addresses/{addressId}			10 calls per day
DELETE /addresses/{addressId}			10 calls per day
PARAMETERS /addresses/{addressId}			10 calls per day
POST /token			10 calls per day
GET /items			10 calls per day
POST /items			10 calls per day
PARAMETERS /items			10 calls per day
GET /items/{itemId}			10 calls per day
PUT /items/{itemId}			10 calls per day
DELETE /items/{itemId}			10 calls per day
PARAMETERS /items/{itemId}			10 calls per day
GET /packaging			10 calls per day
POST /packaging			10 calls per day
PARAMETERS /packaging			10 calls per day
GET /packaging/{packagingId}			10 calls per day
PUT /packaging/{packagingId}			10 calls per day
DELETE /packaging/{packagingId}			10 calls per day
PARAMETERS /packaging/{packagingId}			10 calls per day

Blue

2 rate limits *

Select

Royal Mail API Shipping V3 (REST) 3.0.20-test-7714

View details

APIs

Title	Version	Type	Rate limits
Royal Mail API Shipping V3 (REST)	3.0.20-test-7714	REST	2 rate limits *
POST /shipments			2 rate limits *
PARAMETERS /shipments			2 rate limits *
PUT /shipments/{shipmentId}/printDocument			2 rate limits *
PARAMETERS /shipments/{shipmentId}/printDocument			2 rate limits *
PUT /shipments/{shipmentId}/printLabel			2 rate limits *
PARAMETERS /shipments/{shipmentId}/printLabel			2 rate limits *
PUT /shipments/cancel			2 rate limits *
PARAMETERS /shipments/cancel			2 rate limits *
PUT /shipments/defer			2 rate limits *
PARAMETERS /shipments/defer			2 rate limits *
PUT /shipments/hold			2 rate limits *
PARAMETERS /shipments/hold			2 rate limits *
PUT /shipments/release			2 rate limits *
PARAMETERS /shipments/release			2 rate limits *
POST /shipments/serviceAvailability			2 rate limits *
PARAMETERS /shipments/serviceAvailability			2 rate limits *
POST /manifests			2 rate limits *
PARAMETERS /manifests			2 rate limits *
POST /manifests/bycarrier			2 rate limits *
PARAMETERS /manifests/bycarrier			2 rate limits *
POST /manifests/byservice			2 rate limits *
PARAMETERS /manifests/byservice			2 rate limits *
GET /addresses			2 rate limits *
POST /addresses			2 rate limits *
PARAMETERS /addresses			2 rate limits *
GET /addresses/{addressId}			2 rate limits *
PUT /addresses/{addressId}			2 rate limits *
DELETE /addresses/{addressId}			2 rate limits *
PARAMETERS /addresses/{addressId}			2 rate limits *
POST /token			2 rate limits *
GET /items			2 rate limits *
POST /items			2 rate limits *
PARAMETERS /items			2 rate limits *
GET /items/{itemId}			2 rate limits *
PUT /items/{itemId}			2 rate limits *
DELETE /items/{itemId}			2 rate limits *
PARAMETERS /items/{itemId}			2 rate limits *
GET /packaging			2 rate limits *
POST /packaging			2 rate limits *
PARAMETERS /packaging			2 rate limits *
GET /packaging/{packagingId}			2 rate limits *
PUT /packaging/{packagingId}			2 rate limits *
DELETE /packaging/{packagingId}			2 rate limits *
PARAMETERS /packaging/{packagingId}			2 rate limits *

Bronze

25000 calls per day

Select

Royal Mail API Shipping V3 (REST) 3.0.20-test-7714

View details

APIs

Title	Version	Type	Rate limits
Royal Mail API Shipping V3 (REST)	3.0.20-test-7714	REST	25000 calls per day
POST /shipments			25000 calls per day
PARAMETERS /shipments			25000 calls per day
PUT /shipments/{shipmentId}/printDocument			25000 calls per day
PARAMETERS /shipments/{shipmentId}/printDocument			25000 calls per day
PUT /shipments/{shipmentId}/printLabel			25000 calls per day
PARAMETERS /shipments/{shipmentId}/printLabel			25000 calls per day
PUT /shipments/cancel			25000 calls per day
PARAMETERS /shipments/cancel			25000 calls per day
PUT /shipments/defer			25000 calls per day
PARAMETERS /shipments/defer			25000 calls per day
PUT /shipments/hold			25000 calls per day
PARAMETERS /shipments/hold			25000 calls per day
PUT /shipments/release			25000 calls per day
PARAMETERS /shipments/release			25000 calls per day
POST /shipments/serviceAvailability			25000 calls per day
PARAMETERS /shipments/serviceAvailability			25000 calls per day
POST /manifests			25000 calls per day
PARAMETERS /manifests			25000 calls per day
POST /manifests/bycarrier			25000 calls per day
PARAMETERS /manifests/bycarrier			25000 calls per day
POST /manifests/byservice			25000 calls per day
PARAMETERS /manifests/byservice			25000 calls per day
GET /addresses			25000 calls per day
POST /addresses			25000 calls per day
PARAMETERS /addresses			25000 calls per day
GET /addresses/{addressId}			25000 calls per day
PUT /addresses/{addressId}			25000 calls per day
DELETE /addresses/{addressId}			25000 calls per day
PARAMETERS /addresses/{addressId}			25000 calls per day
POST /token			25000 calls per day
GET /items			25000 calls per day
POST /items			25000 calls per day
PARAMETERS /items			25000 calls per day
GET /items/{itemId}			25000 calls per day
PUT /items/{itemId}			25000 calls per day
DELETE /items/{itemId}			25000 calls per day
PARAMETERS /items/{itemId}			25000 calls per day
GET /packaging			25000 calls per day
POST /packaging			25000 calls per day
PARAMETERS /packaging			25000 calls per day
GET /packaging/{packagingId}			25000 calls per day
PUT /packaging/{packagingId}			25000 calls per day
DELETE /packaging/{packagingId}			25000 calls per day
PARAMETERS /packaging/{packagingId}			25000 calls per day

Diamond

200000 calls per day

Select

Royal Mail API Shipping V3 (REST) 3.0.20-test-7714

View details

APIs

Title	Version	Type	Rate limits
Royal Mail API Shipping V3 (REST)	3.0.20-test-7714	REST	200000 calls per day
POST /shipments			200000 calls per day
PARAMETERS /shipments			200000 calls per day
PUT /shipments/{shipmentId}/printDocument			200000 calls per day
PARAMETERS /shipments/{shipmentId}/printDocument			200000 calls per day
PUT /shipments/{shipmentId}/printLabel			200000 calls per day
PARAMETERS /shipments/{shipmentId}/printLabel			200000 calls per day
PUT /shipments/cancel			200000 calls per day
PARAMETERS /shipments/cancel			200000 calls per day
PUT /shipments/defer			200000 calls per day
PARAMETERS /shipments/defer			200000 calls per day
PUT /shipments/hold			200000 calls per day
PARAMETERS /shipments/hold			200000 calls per day
PUT /shipments/release			200000 calls per day
PARAMETERS /shipments/release			200000 calls per day
POST /shipments/serviceAvailability			200000 calls per day
PARAMETERS /shipments/serviceAvailability			200000 calls per day
POST /manifests			200000 calls per day
PARAMETERS /manifests			200000 calls per day
POST /manifests/bycarrier			200000 calls per day
PARAMETERS /manifests/bycarrier			200000 calls per day
POST /manifests/byservice			200000 calls per day
PARAMETERS /manifests/byservice			200000 calls per day
GET /addresses			200000 calls per day
POST /addresses			200000 calls per day
PARAMETERS /addresses			200000 calls per day
GET /addresses/{addressId}			200000 calls per day
PUT /addresses/{addressId}			200000 calls per day
DELETE /addresses/{addressId}			200000 calls per day
PARAMETERS /addresses/{addressId}			200000 calls per day
POST /token			200000 calls per day
GET /items			200000 calls per day
POST /items			200000 calls per day
PARAMETERS /items			200000 calls per day
GET /items/{itemId}			200000 calls per day
PUT /items/{itemId}			200000 calls per day
DELETE /items/{itemId}			200000 calls per day
PARAMETERS /items/{itemId}			200000 calls per day
GET /packaging			200000 calls per day
POST /packaging			200000 calls per day
PARAMETERS /packaging			200000 calls per day
GET /packaging/{packagingId}			200000 calls per day
PUT /packaging/{packagingId}			200000 calls per day
DELETE /packaging/{packagingId}			200000 calls per day
PARAMETERS /packaging/{packagingId}			200000 calls per day

Gold

100000 calls per day

Select

Royal Mail API Shipping V3 (REST) 3.0.20-test-7714

View details

APIs

Title	Version	Type	Rate limits
Royal Mail API Shipping V3 (REST)	3.0.20-test-7714	REST	100000 calls per day
POST /shipments			100000 calls per day
PARAMETERS /shipments			100000 calls per day
PUT /shipments/{shipmentId}/printDocument			100000 calls per day
PARAMETERS /shipments/{shipmentId}/printDocument			100000 calls per day
PUT /shipments/{shipmentId}/printLabel			100000 calls per day
PARAMETERS /shipments/{shipmentId}/printLabel			100000 calls per day
PUT /shipments/cancel			100000 calls per day
PARAMETERS /shipments/cancel			100000 calls per day
PUT /shipments/defer			100000 calls per day
PARAMETERS /shipments/defer			100000 calls per day
PUT /shipments/hold			100000 calls per day
PARAMETERS /shipments/hold			100000 calls per day
PUT /shipments/release			100000 calls per day
PARAMETERS /shipments/release			100000 calls per day
POST /shipments/serviceAvailability			100000 calls per day
PARAMETERS /shipments/serviceAvailability			100000 calls per day
POST /manifests			100000 calls per day
PARAMETERS /manifests			100000 calls per day
POST /manifests/bycarrier			100000 calls per day
PARAMETERS /manifests/bycarrier			100000 calls per day
POST /manifests/byservice			100000 calls per day
PARAMETERS /manifests/byservice			100000 calls per day
GET /addresses			100000 calls per day
POST /addresses			100000 calls per day
PARAMETERS /addresses			100000 calls per day
GET /addresses/{addressId}			100000 calls per day
PUT /addresses/{addressId}			100000 calls per day
DELETE /addresses/{addressId}			100000 calls per day
PARAMETERS /addresses/{addressId}			100000 calls per day
POST /token			100000 calls per day
GET /items			100000 calls per day
POST /items			100000 calls per day
PARAMETERS /items			100000 calls per day
GET /items/{itemId}			100000 calls per day
PUT /items/{itemId}			100000 calls per day
DELETE /items/{itemId}			100000 calls per day
PARAMETERS /items/{itemId}			100000 calls per day
GET /packaging			100000 calls per day
POST /packaging			100000 calls per day
PARAMETERS /packaging			100000 calls per day
GET /packaging/{packagingId}			100000 calls per day
PUT /packaging/{packagingId}			100000 calls per day
DELETE /packaging/{packagingId}			100000 calls per day
PARAMETERS /packaging/{packagingId}			100000 calls per day

Green

2 rate limits *

Select

Royal Mail API Shipping V3 (REST) 3.0.20-test-7714

View details

APIs

Title	Version	Type	Rate limits
Royal Mail API Shipping V3 (REST)	3.0.20-test-7714	REST	2 rate limits *
POST /shipments			2 rate limits *
PARAMETERS /shipments			2 rate limits *
PUT /shipments/{shipmentId}/printDocument			2 rate limits *
PARAMETERS /shipments/{shipmentId}/printDocument			2 rate limits *
PUT /shipments/{shipmentId}/printLabel			2 rate limits *
PARAMETERS /shipments/{shipmentId}/printLabel			2 rate limits *
PUT /shipments/cancel			2 rate limits *
PARAMETERS /shipments/cancel			2 rate limits *
PUT /shipments/defer			2 rate limits *
PARAMETERS /shipments/defer			2 rate limits *
PUT /shipments/hold			2 rate limits *
PARAMETERS /shipments/hold			2 rate limits *
PUT /shipments/release			2 rate limits *
PARAMETERS /shipments/release			2 rate limits *
POST /shipments/serviceAvailability			2 rate limits *
PARAMETERS /shipments/serviceAvailability			2 rate limits *
POST /manifests			2 rate limits *
PARAMETERS /manifests			2 rate limits *
POST /manifests/bycarrier			2 rate limits *
PARAMETERS /manifests/bycarrier			2 rate limits *
POST /manifests/byservice			2 rate limits *
PARAMETERS /manifests/byservice			2 rate limits *
GET /addresses			2 rate limits *
POST /addresses			2 rate limits *
PARAMETERS /addresses			2 rate limits *
GET /addresses/{addressId}			2 rate limits *
PUT /addresses/{addressId}			2 rate limits *
DELETE /addresses/{addressId}			2 rate limits *
PARAMETERS /addresses/{addressId}			2 rate limits *
POST /token			2 rate limits *
GET /items			2 rate limits *
POST /items			2 rate limits *
PARAMETERS /items			2 rate limits *
GET /items/{itemId}			2 rate limits *
PUT /items/{itemId}			2 rate limits *
DELETE /items/{itemId}			2 rate limits *
PARAMETERS /items/{itemId}			2 rate limits *
GET /packaging			2 rate limits *
POST /packaging			2 rate limits *
PARAMETERS /packaging			2 rate limits *
GET /packaging/{packagingId}			2 rate limits *
PUT /packaging/{packagingId}			2 rate limits *
DELETE /packaging/{packagingId}			2 rate limits *
PARAMETERS /packaging/{packagingId}			2 rate limits *

Orange

2 rate limits *

Select

Royal Mail API Shipping V3 (REST) 3.0.20-test-7714

View details

APIs

Title	Version	Type	Rate limits
Royal Mail API Shipping V3 (REST)	3.0.20-test-7714	REST	2 rate limits *
POST /shipments			2 rate limits *
PARAMETERS /shipments			2 rate limits *
PUT /shipments/{shipmentId}/printDocument			2 rate limits *
PARAMETERS /shipments/{shipmentId}/printDocument			2 rate limits *
PUT /shipments/{shipmentId}/printLabel			2 rate limits *
PARAMETERS /shipments/{shipmentId}/printLabel			2 rate limits *
PUT /shipments/cancel			2 rate limits *
PARAMETERS /shipments/cancel			2 rate limits *
PUT /shipments/defer			2 rate limits *
PARAMETERS /shipments/defer			2 rate limits *
PUT /shipments/hold			2 rate limits *
PARAMETERS /shipments/hold			2 rate limits *
PUT /shipments/release			2 rate limits *
PARAMETERS /shipments/release			2 rate limits *
POST /shipments/serviceAvailability			2 rate limits *
PARAMETERS /shipments/serviceAvailability			2 rate limits *
POST /manifests			2 rate limits *
PARAMETERS /manifests			2 rate limits *
POST /manifests/bycarrier			2 rate limits *
PARAMETERS /manifests/bycarrier			2 rate limits *
POST /manifests/byservice			2 rate limits *
PARAMETERS /manifests/byservice			2 rate limits *
GET /addresses			2 rate limits *
POST /addresses			2 rate limits *
PARAMETERS /addresses			2 rate limits *
GET /addresses/{addressId}			2 rate limits *
PUT /addresses/{addressId}			2 rate limits *
DELETE /addresses/{addressId}			2 rate limits *
PARAMETERS /addresses/{addressId}			2 rate limits *
POST /token			2 rate limits *
GET /items			2 rate limits *
POST /items			2 rate limits *
PARAMETERS /items			2 rate limits *
GET /items/{itemId}			2 rate limits *
PUT /items/{itemId}			2 rate limits *
DELETE /items/{itemId}			2 rate limits *
PARAMETERS /items/{itemId}			2 rate limits *
GET /packaging			2 rate limits *
POST /packaging			2 rate limits *
PARAMETERS /packaging			2 rate limits *
GET /packaging/{packagingId}			2 rate limits *
PUT /packaging/{packagingId}			2 rate limits *
DELETE /packaging/{packagingId}			2 rate limits *
PARAMETERS /packaging/{packagingId}			2 rate limits *

Red

2 rate limits *

Select

Royal Mail API Shipping V3 (REST) 3.0.20-test-7714

View details

APIs

Title	Version	Type	Rate limits
Royal Mail API Shipping V3 (REST)	3.0.20-test-7714	REST	2 rate limits *
POST /shipments			2 rate limits *
PARAMETERS /shipments			2 rate limits *
PUT /shipments/{shipmentId}/printDocument			2 rate limits *
PARAMETERS /shipments/{shipmentId}/printDocument			2 rate limits *
PUT /shipments/{shipmentId}/printLabel			2 rate limits *
PARAMETERS /shipments/{shipmentId}/printLabel			2 rate limits *
PUT /shipments/cancel			2 rate limits *
PARAMETERS /shipments/cancel			2 rate limits *
PUT /shipments/defer			2 rate limits *
PARAMETERS /shipments/defer			2 rate limits *
PUT /shipments/hold			2 rate limits *
PARAMETERS /shipments/hold			2 rate limits *
PUT /shipments/release			2 rate limits *
PARAMETERS /shipments/release			2 rate limits *
POST /shipments/serviceAvailability			2 rate limits *
PARAMETERS /shipments/serviceAvailability			2 rate limits *
POST /manifests			2 rate limits *
PARAMETERS /manifests			2 rate limits *
POST /manifests/bycarrier			2 rate limits *
PARAMETERS /manifests/bycarrier			2 rate limits *
POST /manifests/byservice			2 rate limits *
PARAMETERS /manifests/byservice			2 rate limits *
GET /addresses			2 rate limits *
POST /addresses			2 rate limits *
PARAMETERS /addresses			2 rate limits *
GET /addresses/{addressId}			2 rate limits *
PUT /addresses/{addressId}			2 rate limits *
DELETE /addresses/{addressId}			2 rate limits *
PARAMETERS /addresses/{addressId}			2 rate limits *
POST /token			2 rate limits *
GET /items			2 rate limits *
POST /items			2 rate limits *
PARAMETERS /items			2 rate limits *
GET /items/{itemId}			2 rate limits *
PUT /items/{itemId}			2 rate limits *
DELETE /items/{itemId}			2 rate limits *
PARAMETERS /items/{itemId}			2 rate limits *
GET /packaging			2 rate limits *
POST /packaging			2 rate limits *
PARAMETERS /packaging			2 rate limits *
GET /packaging/{packagingId}			2 rate limits *
PUT /packaging/{packagingId}			2 rate limits *
DELETE /packaging/{packagingId}			2 rate limits *
PARAMETERS /packaging/{packagingId}			2 rate limits *

Silver

50000 calls per day

Select

Royal Mail API Shipping V3 (REST) 3.0.20-test-7714

View details

APIs

Title	Version	Type	Rate limits
Royal Mail API Shipping V3 (REST)	3.0.20-test-7714	REST	50000 calls per day
POST /shipments			50000 calls per day
PARAMETERS /shipments			50000 calls per day
PUT /shipments/{shipmentId}/printDocument			50000 calls per day
PARAMETERS /shipments/{shipmentId}/printDocument			50000 calls per day
PUT /shipments/{shipmentId}/printLabel			50000 calls per day
PARAMETERS /shipments/{shipmentId}/printLabel			50000 calls per day
PUT /shipments/cancel			50000 calls per day
PARAMETERS /shipments/cancel			50000 calls per day
PUT /shipments/defer			50000 calls per day
PARAMETERS /shipments/defer			50000 calls per day
PUT /shipments/hold			50000 calls per day
PARAMETERS /shipments/hold			50000 calls per day
PUT /shipments/release			50000 calls per day
PARAMETERS /shipments/release			50000 calls per day
POST /shipments/serviceAvailability			50000 calls per day
PARAMETERS /shipments/serviceAvailability			50000 calls per day
POST /manifests			50000 calls per day
PARAMETERS /manifests			50000 calls per day
POST /manifests/bycarrier			50000 calls per day
PARAMETERS /manifests/bycarrier			50000 calls per day
POST /manifests/byservice			50000 calls per day
PARAMETERS /manifests/byservice			50000 calls per day
GET /addresses			50000 calls per day
POST /addresses			50000 calls per day
PARAMETERS /addresses			50000 calls per day
GET /addresses/{addressId}			50000 calls per day
PUT /addresses/{addressId}			50000 calls per day
DELETE /addresses/{addressId}			50000 calls per day
PARAMETERS /addresses/{addressId}			50000 calls per day
POST /token			50000 calls per day
GET /items			50000 calls per day
POST /items			50000 calls per day
PARAMETERS /items			50000 calls per day
GET /items/{itemId}			50000 calls per day
PUT /items/{itemId}			50000 calls per day
DELETE /items/{itemId}			50000 calls per day
PARAMETERS /items/{itemId}			50000 calls per day
GET /packaging			50000 calls per day
POST /packaging			50000 calls per day
PARAMETERS /packaging			50000 calls per day
GET /packaging/{packagingId}			50000 calls per day
PUT /packaging/{packagingId}			50000 calls per day
DELETE /packaging/{packagingId}			50000 calls per day
PARAMETERS /packaging/{packagingId}			50000 calls per day

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