Skip to content

Settings

Open Add-ons > Manage add-ons > Royal Mail Click & Drop Shipping > Settings.

Setting Default Description
Enable On When off, no new work is started. Jobs of work that is already under way are still processed.
Marketplace owner mode On On: every order uses the marketplace owner’s account and rate table; vendors have no connection page. Off: each vendor connects their own account.
Debug log Off Also stores every HTTP call with masked request and response. The API key is never stored.
Log retention (days) 90 Older log entries are removed by the cron run.
Create the label when the order status becomes empty Empty = send orders to Click & Drop by hand from the order page.
Also create a CS-Cart shipment On Records the tracking number as a regular shipment once Click & Drop has it.
Default parcel weight (g) 500 Used for the rate and the order when the products have no weight.
Package format Parcel Packaging format sent with every order (letter, large letter, small parcel, medium parcel, parcel).
Customs declaration category Commercial sale of goods Declared for the items of international orders.
Country of origin of the goods GB ISO code declared for the items of international orders.
Fallback shipping rate empty Offered when no band of the rate table covers the parcel. Empty = the method is hidden.

The API key is not an ordinary setting: it is entered on the Connection page and stored encrypted (AES-256-GCM, key derived from your store’s own secret). It is never shown again; leave the field empty to keep the saved value.

Field Description
API key Created in Click & Drop under Settings > Integrations (Royal Mail Public API). Sent as a Bearer token.
Account type Pay as you go: the order is created in Click & Drop and you print the label there. OBA: the API also returns the label.
Service codes The Click & Drop service used for each checkout service.

There is no sandbox: Click & Drop has one environment, so a connection test reads the carriers of your account and creates nothing.

Each service has rows of zone, up to (grams) and price in the store’s primary currency. A parcel uses the smallest band that holds its weight; if no band fits the method is not offered (or the fallback rate is used). Zones: United Kingdom (GB), European Union member states, rest of the world. Weights above 30000 g cannot be sent by Click & Drop. Rows without weight or price are ignored when you save.

The queue runs from cron. Use either the command line or the secret web address shown in the Cron section of the settings:

  • php /path/to/store/admin.php --dispatch=kv_royal_mail.cron
  • https://your-store.example/index.php?dispatch=kv_royal_mail.cron&key=<secret>

Click & Drop has no webhooks, so open orders are checked for their tracking number and despatch state by this cron run, every 30 minutes until Click & Drop reports the despatch.

  • Log lists every call and job with filters (level, action, text, dates) and a CSV export.
  • Jobs lists the queue. A job that fails is retried after 5 minutes, 15 minutes, 1 hour, 3 hours and 12 hours, then marked “Gave up”; use Retry to queue it again. Royal Mail allows 5 calls per second; answers with HTTP 429 are retried.

In the vendor panel a vendor sees only their own records. With the marketplace owner mode off the vendor also gets the Connection and Rates tabs for their own account.