For developers
Public API
Connect your store in a few minutes
To connect an online store and automate shipments: every feature of the merchant workspace is available programmatically, with key-and-token authentication.
43 features · 8 sections
Getting started and authenticating
REST API in JSON
A standard REST API where every request and response is JSON (UTF-8, ISO 8601 dates), simple to connect to any online store or application.
Key + token authentication
Every call is secured by two credentials — a fixed key and a regenerable token — sent in the X-API-Key and X-API-Token headers.
Credential check
A test call instantly confirms your credentials are valid and returns the identity of your merchant account.
Token regeneration
Regenerate your token at any time to immediately revoke a compromised access, without having to change your key.
Transparent rate limits
Clear and generous limits (50 requests per minute, 2,000 per hour, 20,000 per day) protect the service while comfortably covering e-commerce usage.
Live usage tracking
Each response reports, through dedicated headers, the quota already consumed and the API version, so you can steer your integrations precisely.
Ready-to-use Postman collection
Download a pre-configured Postman collection (all endpoints, authentication headers and body examples) to test the API in minutes.
Version history
A changelog queryable through the API keeps you informed of changes and of the current version of the public API.
Delivery reference data
Served wilayas
Retrieve the list of wilayas with, for each one, the available delivery modes (home, pickup point).
Deliverable communes
Get the communes of each wilaya and spot those that are not served, so you never record an undeliverable order.
Offices / pickup points (stopdesk)
List the stopdesk offices of each wilaya with their address, Google Maps position and contact number, to offer pickup-point collection.
Parcel statuses
Access the official status labels (In transit, Delivered, Cancelled, Collected…) to interpret and display the state of each parcel.
Logistics states
Follow the physical state of the parcel in the chain (in preparation, at the office, out for delivery, delivered…) alongside its commercial status.
Price list
Review your delivery prices per wilaya (home and stopdesk) as well as your service and packaging fees, to show the right price to your customers.
Creating and preparing your parcels
Batch creation
Create 1 to 100 parcels in a single call, each line succeeding or failing independently with a precise error message.
Home or pickup point
Choose for each parcel a home delivery (by commune) or collection at a stopdesk office (by office code).
Exchange parcels
Mark a parcel as an exchange to handle product swaps, with no constraint on the amount.
Order reference
Attach your own internal reference to each parcel, to reconcile it easily with your store’s orders.
Create already confirmed
Create a parcel directly in the “ready to ship” state when you do not need a preparation step.
Editing before shipping
Correct a parcel’s details (recipient, address, amount, delivery mode) for as long as it is still in preparation.
Batch confirmation
Move a batch of parcels from “in preparation” to “ready to ship” in a single call — the equivalent of the panel’s confirm button.
Deleting before shipping
Delete a parcel created by mistake, as long as it has not left the preparation stage.
Tracking and syncing
Paginated and filtered list
Browse all your parcels with pagination and filters (wilaya, dates, date type, tracking numbers) to find exactly what you are looking for.
Incremental sync
Fetch only the parcels that moved over a given period (by action date or since a date), ideal for syncing your store without re-downloading everything.
Parcel detail and journey
Get all the information about a parcel along with its full history, step by step.
Batch statuses
Query the status of up to 100 parcels in one request, by tracking number and/or by your own order reference.
Batch history
Retrieve in a single request the detailed journey of several parcels (up to 40) to trace their path.
Statistical summary
Display an instant overview: total number of parcels, delivery rate, and breakdown by status and by logistics state.
Printing labels
Print-ready label
Generate a parcel’s label at the exact dimensions (100×100 or 100×130 mm), with logo, barcode and all shipping information.
Grouped printing
Gather up to 100 labels in a single document (one page per parcel) to print a whole round at once.
Product catalogue (stock accounts)
Product catalogue
List your products (reference and label) on stock-managed accounts, where each parcel points to a product reference.
Adding a product
Create a new product with a unique reference, straight from your system, without going through the panel.
Updating a product
Change the reference or the label of an existing product in your catalogue at any time.
Packs and bundles
Group several items under a single “pack” reference to sell them together in one parcel, at the price of a single item.
Pickups and payouts
Pickup request
Schedule the collection of your parcels, specifying the number of parcels, the vehicle type, the commune and the preferred time.
Payout list
Review the paginated history of your payouts with, for each one, the net amount to collect and the number of parcels delivered and cancelled.
Payout detail
Open a payout’s detail to see every parcel it contains and the precise breakdown of the fees applied.
Webhooks — real-time notifications
Event subscription
Receive a notification on your own URL automatically at every status change of a parcel, without polling the API in a loop.
Choice of events
Subscribe to every event or only to those that interest you (for example only “Delivered”), through the catalogue of available events.
Test event
Send a test event to your URL to validate your integration before going live.
Secure signature
Each notification is signed with HMAC-SHA256 using your secret, so you can verify it really comes from us and has not been altered.
Reliable delivery
On failure, notifications are retried automatically with a progressive delay, with a unique identifier per event to avoid duplicates.
Notification log
Review the history of your latest sent notifications (status, attempt, error) to troubleshoot your integration easily.