{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["carrierMetadata"]},"type":"markdown"},"seo":{"title":"Royal Mail","description":"itney Bowes Shipping API, developers can integrate features such as comparing shipping rates from multiple carriers, creating and purchasing shipping labels, tracking packages, scheduling pickups, managing returns, and accessing other shipping features. These APIs also offers a variety of shipping services, including international shipping and multi-carrier rate shopping, which allows developers to choose the best carrier and rate for each shipment.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"royal-mail","__idx":0},"children":["Royal Mail"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Royal Mail (RMG), 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."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"onboarding-of-a-royal-mail-carrier-account","__idx":2},"children":["Onboarding of a Royal Mail Carrier Account"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To onboard an RMG carrier account through an API, the user needs to possess the following pre-requisites:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["X-PB-Location header in add carrier account API to add the carrier accounts based out of countries other than the subscription's default."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"example-rmg-registration-request","__idx":3},"children":["Example RMG Registration Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"{\n   \"carrierID\": \"RMG\",\n   \"description\": \"RMG by API\",\n   \"carrierAccountType\": \"Shipping\",\n   \"provisioningType\": \"Web\",\n   \"parameters\": {\n       \"dieNumber\": \"PB1XXXX12\",\n       \"paymentKey\": \"808ae3dd-XXXX-XXXX-XXXX-95a34595f505\"\n   }\n}\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the request to onboard the RMG carrier account is successful, the resulting response will be similar to the provided Sample Response below."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"example-rmg-registration-response","__idx":4},"children":["Example RMG Registration Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"{\n    \"carrierAccountID\": \"4ZZA5adnL7dp\",\n    \"description\": \"RMG by API\",\n    \"carrierID\": \"RMG\",\n    \"parameters\": {\n        \"dieNumber\": \"PB1XXXX12\",\n        \"paymentKey\": \"808ae3dd-XXXX-XXXX-XXXX-95a34595f505\"\n    },\n    \"carrierAccountType\": \"Shipping\",\n    \"provisioningType\": \"Web\",\n    \"permission\": {\n        \"permissionByEntity\": \"\",\n        \"permissionByValue\": null\n    }\n}\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"windsor-agreement-compliance","__idx":5},"children":["Windsor Agreement Compliance"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Windsor Agreement applies to shipments with ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["BT postal codes"]}," (Northern Ireland) when shipping from ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Great Britain"]}," (England, Wales, or Scotland) using the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["RMG carrier"]},". To comply with customs regulations, additional data fields and validations have been introduced for shipments under this agreement, especially for ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["business-to-business (B2B)"]}," transactions."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," If shipping is done within the BT postal codes, then the Windsor agreement is not"," ","applicable."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"customs-and-regulatory-requirements","__idx":6},"children":["Customs and Regulatory Requirements"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["HS (Harmonized System) Code"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sender EORI"]},", and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Recipient EORI"]}," numbers are mandatory for B2B shipments. These ensure that goods can be correctly classified and reported for customs clearance."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["When the declared shipment value exceeds ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["£135"]},", users must additionally provide either the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sender UKIMS"]}," or ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Recipient UKIMS"]}," number. If this information is missing, the system will prevent label generation."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"export-type-options","__idx":7},"children":["Export Type Options"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Shipments under the Windsor Agreement must include an appropriate ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reasonForExport"]},". A new category, ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Mixed Content"]},", has been added to the existing options:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Commercial Sample"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Documents"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Gift"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Merchandise"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Other"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Returned Goods"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Mixed Content (new)"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"export-license-declaration","__idx":8},"children":["Export License Declaration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Export License Number Required"]}," flag is now available in the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Additional Custom Forms"]}," section. This option is visible for both ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["B2B"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["B2C"]}," shipments and must be selected if applicable."]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-operations-for-shipping-with-royal-mail","__idx":9},"children":["API Operations for Shipping with Royal Mail"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The APIs integrate with royal mail through the following operations:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operations"},"children":["Operations"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Resource Path"},"children":["Resource Path"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve Country List"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["/api/v1/countries"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get Carrier Account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["/api/v1/carrierAccounts"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rate a Parcel"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["/api/v2/rates"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a Shipping Label"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["/api/v1/shipments"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reprint a Label"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["/api/v1/shipments/{{shipmentId}}/reprint"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Void a Label"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PUT"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["/api/v1/shipments/{{shipmentId}}/cancel"]}]}]}]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"metadata","__idx":10},"children":["Metadata"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"CarrierMetadata","attributes":{"carrierID":"RMG"},"children":[]}]},"headings":[{"value":"Royal Mail","id":"royal-mail","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Onboarding of a Royal Mail Carrier Account","id":"onboarding-of-a-royal-mail-carrier-account","depth":2},{"value":"Example RMG Registration Request","id":"example-rmg-registration-request","depth":5},{"value":"Example RMG Registration Response","id":"example-rmg-registration-response","depth":5},{"value":"Windsor Agreement Compliance","id":"windsor-agreement-compliance","depth":2},{"value":"Customs and Regulatory Requirements","id":"customs-and-regulatory-requirements","depth":3},{"value":"Export Type Options","id":"export-type-options","depth":3},{"value":"Export License Declaration","id":"export-license-declaration","depth":3},{"value":"API Operations for Shipping with Royal Mail","id":"api-operations-for-shipping-with-royal-mail","depth":2},{"value":"Metadata","id":"metadata","depth":2}],"frontmatter":{"title":"Royal Mail (RMG)","description":"Royal Mail carrier description","tocMaxDepth":3,"seo":{"title":"Royal Mail"}},"lastModified":"2026-05-15T13:59:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/shipping/carriers/overview/royalmail","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}