Courier and sales-channel templates — Help

Decide what stores can add: edit built-in couriers and shops, add couriers of your own, and see what stores ask for.

Console › Integrations. A template describes a courier or sales channel; stores add connections from it (Settings › Couriers / Sales channels › Add).

Built-in templates

PostEx, TCS, Leopards, Custom courier, Shopify, WooCommerce, Custom store (API) and CSV import ship with the code. You can change their name, description, icon, colour, defaults (tracking link, tracking format, tag), status words, tests and which plans may use them, or retire them. Reset to built-in undoes your changes.

Your own couriers

+ New courier template: name, code (e.g. mnp), icon, description.
Type: Tracked (no API - logging, labels, tracking link, claims) or API recipe.
Setup fields stores fill in (API token...), defaults (tracking link with {tn}, format), status words.
Save as Draft: it appears only in store #1 (the original store), so you can add it there and run its test page. Then set it to Published.

API recipes

A recipe describes a simple REST API in JSON: base_url (and test_base_url + sandbox_field), format (json or form), auth (params, header, basic), ok_path/ok_value/error_path, and the steps cities, book, track, cancel. Values use placeholders like {{order.city_id}} or {{cred.api_key}}. The Leopards recipe is a complete example ("Insert the Leopards recipe").

NoteA recipe cannot do everything: couriers with unusual sign-in, PDF labels or signed webhooks need code in a release. Start them as Tracked couriers - stores can use them at once - and ask for a built-in version.

Versions

Editing a published template makes a new version. Stores using it see "Update available" on the courier's card; nothing changes in a store until its admin presses Update (new settings get their defaults, nothing is overwritten).

Requests and the update report

Requests from stores counts the couriers and shop systems stores asked for. The update report shows what the one-time move to couriers/channels created in every store, and how many old batches still have no courier.