royalmail.com

Import your orders, retrieve your orders and generate labels.

🔑 apikey 12 endpoints ecommerce
📄 Docs 📋 OpenAPI spec 🔬 Try in Swagger UI

SDKs by language (3 total)

composer require royalmail-shipping-v3-sdk
composer require royalmail-tracking-v2-sdk
composer require royalmail-php
curl examples
Retrieve pageable list of orders
curl \
  -H "Authorization: $API_KEY" \
  /orders
Get API version details.
curl \
  -H "Authorization: $API_KEY" \
  /version
Retrieve pageable list of orders with details
curl \
  -H "Authorization: $API_KEY" \
  /orders/full
Endpoints (12 total)
GET
/orders
Retrieve pageable list of orders
GET
/version
Get API version details.
GET
/orders/full
Retrieve pageable list of orders with details
GET
/manifests/{manifestGuid}
Retrieve manifest status and documentation
GET
/orders/{orderIdentifiers}
Retrieve specific orders
GET
/orders/{orderIdentifiers}/full
Retrieve details of the specific orders
GET
/orders/{orderIdentifiers}/label
Return a single PDF file with generated label and/or associated document(s)
POST
/orders
Create orders
POST
/manifests
Manifest orders
POST
/manifests/{manifestGuid}/retry
Retry failed manifest
PUT
/orders/status
Set order status
DELETE
/orders/{orderIdentifiers}
Delete orders
Language coverage
PHP
3
At a glance
Total SDKs3
Languages1
Endpoints12
Authapikey
Categories1