Reference · built on requestConnectorShipping & logistics

Royal Mail

Click & Drop orders, labels, manifests, and customs consignments, plus tracking for Royal Mail account customers.

Request Royal MailAsk about this listing

About

Royal Mail is the UK's universal postal service. Two published interfaces matter here. The Click & Drop API at api.parcel.royalmail.com imports orders, retrieves them, sets order status, returns label PDFs for Online Business Account customers, manifests orders, and builds bulk customs consignments with a commercial invoice. The Royal Mail Developer Portal lists the Tracking (for Server-side app) v2 REST API for account customers, plus Local Collect and Delivery Office Finder.

An operator on Fibric pushes paid orders into Click & Drop as they arrive, proposes the end-of-day manifest, and reads tracking history to propose a customer notice when an item has not moved.

This is a reference listing. It documents what Fibric would read from Royal Mail and what it could propose, based on the vendor's published interfaces. Fibric builds it under a managed deployment when you request it; selecting it here installs nothing.

What it reads

  • Orders in your Click & Drop account, paged or by order identifier, via GET /orders
  • Manifest status and documentation via GET /manifests/{manifestGuid}
  • Bulk customs consignments and the shipments linked to them
  • The carriers configured on your Click & Drop account via GET /carriers
  • Latest tracking information, tracking history, and proof of delivery for mail items through the Tracking v2 REST API
  • Post Offices and Customer Service Points where an item can be held for collection, from Local Collect

Proposed actions

  • Target capability: propose importing orders into Click & Drop through POST /orders
  • Target capability: propose an order status change through PUT /orders/status
  • Target capability: propose manifesting orders through POST /manifests, with a retry after a failed attempt
  • Target capability: propose a bulk customs consignment and its commercial invoice upload for export orders
  • Target capability: propose retrieving the label PDF for an order (Online Business Account customers only)

Proposed actions are target capabilities. Every action runs propose-first and needs a validated deployment and the appropriate permissions.

What you can build

  • Prepare export paperwork

    Group international orders into a bulk customs consignment and propose the commercial invoice upload before the manifest closes.

    With Customs Declaration

  • Chase an item that stopped moving

    Read tracking history for each despatched order and propose a customer notice when no event has arrived within the service's expected window.

    With Missed Delivery, Tracking Sync

  • Catch orders shipped but never invoiced

    Match manifested orders back to the billing system and propose the invoice for any that were despatched without one.

    With Unbilled Shipment

What it needs

  • A Click & Drop account with an API key for order import, status, and manifests
  • An Online Business Account (OBA) for label generation through the Click & Drop API
  • For Tracking v2, a Royal Mail account and an integration initiated by your Royal Mail account manager
  • A registered application on the Developer Portal; some subscriptions need approval, usually within a week
Authentication
Click & Drop API: an API key sent as a Bearer token in the Authorization header. Developer Portal APIs: a client ID and client secret assigned to your registered application.

Limits

  • Label download through the Click & Drop API is reserved for OBA customers
  • Several order endpoints, including full order details and deletion, are reserved for ChannelShipper customers
  • A failed manifest can be retried only after 30 minutes; earlier calls return 400
  • Each customs document must be a base64-encoded PDF under 5MB

Access and pricing

Reference listing. Fibric builds the connector under a managed deployment when you request it. Your quote covers the build, capabilities, usage, and support.

Request Royal Mail

Questions and answers

What can the Click & Drop API do?
Import orders, retrieve orders, set order status, retrieve a label PDF for OBA customers, manifest orders, and manage bulk customs consignments with a commercial invoice. It is served at api.parcel.royalmail.com/api/v1 with a Bearer API key.
Is tracking available through an API?
Yes, for account customers. The Tracking (for Server-side app) v2 REST API on the Developer Portal returns the latest tracking information, the tracking history, and proof of delivery. Your Royal Mail account manager initiates access.
Do I need a business account?
For labels through the Click & Drop API, yes: label retrieval is reserved for Online Business Account customers. Order import, status changes, and manifesting work with a Click & Drop account and its API key.
Ask about Royal Mail

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.

This connector listing is developed, published, and supported by Fibric. It describes integration with Royal Mail through published interfaces. Third-party names and logos identify the systems an integration connects to; they are the property of their respective owners, who are not affiliated with Fibric and do not sponsor or endorse this listing. Trademark policy