Royal Mail
Overview
Royal Mail, a British postal and courier service, is known for providing reliable and efficient shipping solutions across the UK and internationally. It offers a variety of domestic and international services including 1st Class and 2nd Class mail, as well as premium options like Special Delivery Guaranteed by 1PM and 9AM.
Onboarding of a Royal Mail Carrier Account
We do not support Royal Mail carrier onboarding from API as of now. Royal Mail carrier account is automatically provisioned during onboarding.
API Operations for Shipping with Royal Mail
The APIs integrate with royal mail through the following operations:
| Operations | Method | Resource Path |
|---|---|---|
| Retrieve Country List | GET | /api/v1/countries |
| Get Carrier Account | GET | /api/v1/carrierAccounts |
| Create a Shipping Label | POST | /api/v1/shipments |
| Reprint a Label | GET | /api/v1/shipments/{{shipmentId}}/reprint |
| Void a Label | PUT | /api/v1/shipments/{{shipmentId}}/cancel |
Metadata
Metadata provides information about royal mail carrier services, including origin and destination countries, supported carrier services, supported package types, and supported special services. Users can select specific origin and destination countries from the provided dropdown menu to dynamically view relevant metadata specific to those countries.