Takealot Store Management
This is the installation and configuration guide for Takealot Store Management, the module you downloaded from your ECOSIRE dashboard. Everything on this page describes the takealot_store_management module exactly as it ships today — the facts below were read out of the released build, not from a roadmap.
| Technical name | takealot_store_management |
| Odoo versions | 17.0, 18.0, 19.0 (Community or Enterprise) |
| Current shipped version | 17.0 → 17.0.2.1.2, 18.0 → 18.0.2.1.2, 19.0 → 19.0.2.1.2 |
| Price | $499 USD — one-time, per Odoo version |
| Odoo module licence | LGPL-3 |
| Category | Connector |
A licence issued for Odoo 17 unlocks only the 17.0 download and only validates on an Odoo 17 database. It will not activate on 18 or 19, and those ZIPs will not appear in your dashboard. Buy the version you actually run — and if you later upgrade Odoo, you need the licence for the new version. This is enforced on both the download and the activation paths, so there is no way round it.
Requirements
| Requirement | Detail |
|---|---|
| Odoo | 17.0, 18.0 or 19.0, Community or Enterprise. Self-hosted or Odoo.sh — Odoo Online (SaaS) cannot install third-party modules |
| Odoo apps | base, sale_management, stock, account, delivery, mail, web, portal, product, contacts, digest, knowledge — Odoo installs any that are missing |
| ECOSIRE dependency | ecosire_license_client — a separate free download, not bundled in this ZIP. See step 3 |
| Python packages | requests |
| Platform account | A Takealot account with API access |
| Licence | An active ECOSIRE licence for this module and your Odoo version |
Install the Python packages into the same interpreter that runs Odoo:
sudo -u odoo pip install requests
Installation
1. Download the ZIP for your Odoo version
Sign in at ecosire.com and open your dashboard downloads. You will only be offered the file matching your licence's Odoo version — that is expected, see the warning above.
2. Extract into your addons path
unzip takealot_store_management_v19_*.zip -d /opt/odoo/addons/
ls /opt/odoo/addons/takealot_store_management/__manifest__.py # sanity check
The module must end up as a single top-level takealot_store_management/ directory with __manifest__.py directly inside it. If your ls check fails, the folder landed one level too deep or too shallow — move it so the path above resolves.
3. Install the ECOSIRE licence client
takealot_store_management declares ecosire_license_client as a hard dependency, so Odoo will refuse to install this module until the licence client is present in your addons path. The licence client is a separate, free module and is not bundled in this ZIP. Download it from your ECOSIRE dashboard alongside the connector and extract it the same way:
unzip ecosire_license_client_v*_*.zip -d /opt/odoo/addons/
The licence client is distributed separately from the connector archives. If you cannot see it in your downloads, email [email protected] with your licence key and we will send it to you — do not try to install the connector without it, because Odoo will simply refuse.
4. Restart Odoo and install
sudo systemctl restart odoo
- Go to Apps and click Update Apps List (developer mode must be on).
- Search for Takealot Store Management and click Install.
- Odoo pulls in
ecosire_license_clientand the Odoo apps listed above automatically.
When the install finishes, a Takealot menu appears in the main Odoo app switcher.
Activate your licence
How to obtain a licence key
You activate a key you already hold — this section is how you get one in the first place.
- Create an ECOSIRE account at ecosire.com using the email address you want the licence issued to. Your keys and downloads live in that account's dashboard.
- Buy the module, either direct from ecosire.com or from the Odoo App Store.
- If you bought on the Odoo App Store, send us proof of purchase. Email
[email protected]from your account's email address with the Odoo sales-order slip or order reference from your Odoo purchase. The App Store does not tell us who bought what, so this is how we match the purchase to your account. - We issue the key to your dashboard. It appears under your downloads alongside the ZIP for your Odoo version, in the form
ECO-XXXX-XXXX-XXXX. - Activate it with the steps below.
The key is issued against the Odoo major version you bought — see the warning at the top of this page. Tell us which version you run when you send proof of purchase, so we issue the right one.
Before you activate
Set your instance's public URL first. The licence is bound to the domain derived from web.base.url, so activating with a placeholder value binds the licence to the wrong host:
- Turn on developer mode.
- Settings → Technical → System Parameters, find
web.base.url. - Set it to the real HTTPS URL your users browse to, e.g.
https://erp.example.com.
Activate
- Go to Settings → ECOSIRE.COM → Activate License.
- Paste your licence key.
- Choose Takealot Store Management in the module dropdown (it lists the installed ECOSIRE modules).
- Click Activate.
Settings → ECOSIRE.COM → License Status then shows, per module, the licence state, last-verified time, Odoo version, module version, support expiry, and whether an offline token is cached.
What the client sends
Activation and validation are HTTPS JSON calls to https://api.ecosire.com/api. Every request carries the same five fields:
{
"key": "ECO-XXXX-XXXX-XXXX-XXXX",
"module_name": "takealot_store_management",
"domain": "erp.example.com",
"hw_fingerprint": "<sha256 of this installation's hardware/db identity>",
"odoo_version": "19.0"
}
| Endpoint | Used for |
|---|---|
POST /api/licenses/activate | First-time activation — binds the licence to this domain |
POST /api/licenses/validate | Ongoing verification |
POST /api/licenses/issue-token | Fetches the signed offline token used for the grace period |
POST /api/licenses/deactivate-self | Releases this domain so the key can move to another database |
The base URL is overridable through the ecosire.license.api_url system parameter. You do not need to change it.
Activation slots, and moving between databases
Each licence carries its own activation limit, and new licences default to a single domain. Some licences are issued with more. Do not assume a number — check Settings → ECOSIRE.COM → License Status, or the licence detail page in your ECOSIRE portal, for the limit on yours. Re-activating on a domain that is already bound is a no-op success, not a second slot.
- To move a live licence to a different database, use Deactivate on the activation screen first; that releases the domain server-side so you can activate elsewhere.
- Ten failed activation attempts within one hour trips a client-side rate limiter. Wait up to 60 minutes, or contact support — do not keep retrying a key you are unsure about.
Staying licensed after activation
A daily scheduled action, ECOSIRE License: Background Re-verification, re-checks the licence out of the request path, refreshes the cached offline token, and keeps the last-known-good timestamp fresh. Because of that, a transient network problem or a worker restart does not lock you out. Verification results are cached for five minutes, so a licence change can take a few minutes to show up.
If you see a hard rejection instead — LICENSE_NOT_FOUND, LICENSE_INACTIVE, LICENSE_EXPIRED, MODULE_MISMATCH, VERSION_MISMATCH or NOT_ACTIVATED_ON_DOMAIN — the grace period is deliberately not granted; fix the underlying problem. See Troubleshooting.
Configuration
Connect to Takealot
Create a connection record on the takealot.instance model. The fields the module defines for the connection are:
| Field | Technical name | Type | Required |
|---|---|---|---|
| Instance Name | name | Char | Yes |
| Takealot Shop URL | shop_url | Char | Yes |
| Company | company_id | Many2one | Yes |
| API Key / Client ID | api_key | Char | No |
| API Password | password | Char | No |
| Client Secret | shared_secret | Char | No |
| Access Token | access_token | Char | No |
The fields marked Yes are enforced by the model — Odoo will not let you save the record without them. The technical name is the reliable identifier if your screen wording differs.
The same record carries 4 behaviour checkboxes — auto_validate_inventory, auto_confirm_order, auto_create_invoice, auto_validate_invoice. They gate what the module is allowed to do automatically once it is connected. Leave anything you are not ready for switched off, and turn them on one at a time.
The module's own source contacts this host: seller-api.takealot.com. Your firewall must allow outbound HTTPS to them.
Scheduled actions
The module installs 13 scheduled actions (Settings → Technical → Scheduled Actions):
| Scheduled action | Runs every | Enabled on install |
|---|---|---|
| Takealot: Sync Products | 30 minutes | Yes |
| Takealot: Sync Orders | 15 minutes | Yes |
| Takealot: Sync Customers | 60 minutes | Yes |
| Takealot: Sync Inventory | 10 minutes | Yes |
| Takealot: Process Queue Jobs | 5 minutes | Yes |
| Takealot: Import Payout Reports | 6 hours | Yes |
| Takealot: Import Refunds | 30 minutes | Yes |
| Takealot: Auto Risk Detection | 30 minutes | Yes |
| Takealot: Generate Analytics | 4 hours | Yes |
| Takealot: Webhook Health Check | 60 minutes | Yes |
| Takealot: Cleanup Old Logs | 24 hours | Yes |
| Takealot: Process Workflows | 10 minutes | Yes |
| Takealot: Daily Summary Report | 1 day | Yes |
Intervals above are the shipped defaults. Adjust them to your volume — but be aware that the platform, not Odoo, sets the API rate limits, and shortening a sync interval is the usual cause of throttling errors in the logs.
Using the module
The module's menu is laid out as:
- Takealot → Dashboard
- Takealot → Orders
- Takealot → Refunds
- Takealot → Products
- Takealot → Customers
- Takealot → Payouts
- Takealot → Analytics
- Takealot → Operations — Run Operations, Queue Jobs, Logs
- Takealot → Premium & Compliance — VAT201 Schedules, DC Inbound Shipments, Pickup Points, Mr D Food Orders, Superbalist Listings, Settlements
- Takealot → Configuration — Instances, Locations, Payment Gateways, Scheduled Actions, Webhooks
A normal first run is:
- Save the connection record and confirm the module reports a successful connection before importing anything.
- Review the mapping records so imported data lands on the right Odoo records.
- Run a small import first — restrict it by date or by a handful of products — and check the results before letting the scheduled actions take over.
- Watch the log records during the first full sync. Failures are recorded there rather than raised at the user.
Troubleshooting
Licensing
| Symptom / error code | Cause and fix |
|---|---|
VERSION_MISMATCH | The licence is for a different Odoo major version than the database you activated on. Licences are not transferable across Odoo versions. |
MODULE_MISMATCH | The licence belongs to a different ECOSIRE module. Check you selected Takealot Store Management (takealot_store_management) in the activation dropdown. |
NOT_ACTIVATED_ON_DOMAIN | The database's web.base.url domain is not among the licence's activated domains. Activate on this domain, or deactivate the old one first. |
LICENSE_EXPIRED / LICENSE_INACTIVE | The licence is past its expiry or has been suspended. Check the licence in your ECOSIRE portal. |
LICENSE_NOT_FOUND | The key does not exist. Keys are upper-cased before sending, so case is not the problem — re-copy it from your portal. |
| Activation limit reached | Every slot on the licence is bound to a domain. Deactivate one first. |
| Too many failed activation attempts | Ten failures in one hour. Wait up to 60 minutes. |
| Could not determine your Odoo instance domain | web.base.url is empty. Set it, then activate. |
The requests library is required | requests is missing from Odoo's Python environment. Install it into the interpreter that runs Odoo. |
| Odoo refuses to install the module | ecosire_license_client is not in your addons path. See step 3. |
Syncing
| Symptom | Cause and fix |
|---|---|
| The connection will not validate | Re-check every required field in the table above. Most failures are a mistyped secret, or credentials created for a sandbox while the module points at production (or vice-versa). |
| Nothing syncs even though the connection is fine | The scheduled actions are disabled at the Odoo level, or Odoo's cron worker is not running. Check Settings → Technical → Scheduled Actions and that --max-cron-threads is greater than zero. |
| Sync starts then stops part-way | Read the module's log records for that run. Rate limiting and rejected field values are the two common causes; both are logged with the platform's own error text. |
| Records import but map to the wrong Odoo values | Fix the mapping records under the module's configuration, then re-run the import. |
| Duplicated products or customers | Run the initial import once. If a first attempt half-finished, check the existing records before re-running rather than importing on top. |
Version history
| Odoo version | Version you download today |
|---|---|
| 17.0 | 17.0.2.1.2 |
| 18.0 | 18.0.2.1.2 |
| 19.0 | 19.0.2.1.2 |
ECOSIRE module versions are <odoo major>.<module major>.<minor>.<patch>, so 19.0.2.1.2 is the Odoo 19 build of module version 2.1.2. Your installed version is shown in Apps and in Settings → ECOSIRE.COM → License Status.
What changed in 2.1.2
Every API path in the module was re-verified against Takealot's live API specification and corrected where it did not match. Alongside that:
- Webhook subscriptions are now supported — register, list, test and delete them from Odoo. Earlier documentation stated this module was polling-only; that was wrong.
- Return disputes can be raised and updated. This is the seller-side action the Seller API actually supports; there is no approve/reject call.
- Settlement amounts are read from the statement file, which is attached to the settlement record. The JSON listing exposes document metadata and a download link only, so no amounts are inferred from it.
- Fulfilment status is read-only. The Seller API has no seller-side shipment or order-status endpoint, so "Update Order Status" is now Update Local Fulfilment Status — it marks the Odoo-side mapping fulfilled from your completed deliveries and never claims to have updated Takealot.
- Read coverage was extended to offer counts, stock counts and stock-health statistics, sales summary, per-order customer invoices, catalogue PLID lookup, category attributes, brand search and async report tasks.
What the Takealot Seller API cannot do
Takealot describes its Seller API as "the initial phase of the Seller API". These are not module limitations — the platform exposes no endpoint, and this module does not simulate one: pushing shipment or order status, approving or rejecting a return, writing stock quantities through a separate inventory API, reading payouts or adjustments, requesting brand approval, or submitting new products. New products go through Add-a-Product or loadsheets in the Seller Portal.