Skip to main content

Shopee Store Management

Integrate your Shopee seller account with Odoo to manage products, orders, customers and settlements. This module connects to Shopee's Open Platform API to synchronize your catalog, import orders, push listings and stock, and track operations through an OWL 2 dashboard built directly into Odoo.

Compatibility: Odoo 17 / 18 / 19 Price: $549 (one-time), per Odoo major version Licence: OPL-1 on Odoo 19 — no activation key. Odoo 17 and 18 still require an ECOSIRE licence key

Key Features​

  • Open Platform API integration, with region-specific hosts and HMAC-signed requests
  • 12 marketplace regions selectable per shop: SG, MY, TH, TW, ID, VN, PH, BR, MX, CO, CL, PL
  • Product import from Shopee, hydrated from item base info
  • Product, price, image, variant and stock export to Shopee, with per-option control
  • Barcode / GTIN preflight that blocks a malformed listing before Shopee rejects it
  • Order import, with buyers and products resolved or created from the order
  • Auto-workflow, including optional payment validation on the posted invoice
  • Settlements, refunds, returns and risk flags under a Finance menu
  • Analytics records and daily digests
  • Category, attribute, shipping-method and payment-method mapping
  • Signature-verified webhook receiver with a local pause switch
  • Multi-region enforcement: a single-region shop refuses rows for other markets
  • OWL 2 dashboard with KPIs, a Shopee-only sales trend, and an order-status chart
  • Multi-company record isolation and per-configuration access

Prerequisites​

  • Odoo 17, 18, or 19 (Community or Enterprise edition)
  • Your ECOSIRE purchase for this module and your Odoo version. On Odoo 19 no key is entered in Odoo; on Odoo 17 and 18 an active ECOSIRE licence is still required
  • A Shopee seller account with API access (registered at open.shopee.com)

Installation​

  1. Download the module ZIP from your ECOSIRE Dashboard
  2. Extract to your Odoo addons directory: 
    unzip ecosire-shopee-*.zip -d /opt/odoo/addons/
  3. Restart the Odoo service: 
    sudo systemctl restart odoo
  4. Navigate to Apps, click Update Apps List
  5. Search for Shopee Store Management and click Install
  6. On Odoo 17 and 18, install the free ecosire_license_client module first and activate your licence. On Odoo 19 there is no licence client and no activation step — see the installation guide

Configuration​

Step 1: Obtain Shopee API Credentials​

  1. Log in to the Shopee Open Platform
  2. Register as a developer and create a new application
  3. Select the required API scopes (shop, product, order, logistics, payment)
  4. Copy the Partner ID and Partner Key

Step 2: Connect in Odoo​

  1. Navigate to Shopee → Configuration → Settings and create a configuration record
  2. Enter your Partner ID, Partner Key and Shop ID, and assign the Odoo company
  3. Select the target Shopee region (e.g. MY, SG, TH)
  4. Complete Shopee's authorization for the shop and store the resulting access and refresh tokens on the record
  5. Click Test Connection to verify API access
  6. Create one configuration per shop if you run several. If a shop serves more than one region, switch on Multi-Region before adding rows for the second market — a single-region configuration refuses them

Step 3: Configure Sync Settings​

On the configuration record, switch on only the areas you are ready for — Sync Products, Sync Orders, Sync Customers, Sync Inventory — and turn them on one at a time. The Auto Sync flags decide which configurations the scheduled actions pick up; the module ships six scheduled actions (products hourly, orders every 30 minutes, inventory every 15 minutes, customers every 6 hours, plus a daily connection test and log cleanup).

Then set up the mappings under Shopee → Configuration → Master Data, so imported data lands on the right Odoo records:

  • Category mapping — Shopee categories to Odoo product categories
  • Product attributes and terms — Shopee attributes to Odoo variant attributes
  • Shipping methods — Shopee logistics channels to Odoo carriers
  • Payment methods and gateways — Shopee payment methods to Odoo journals
  • Order status mapping — Shopee order states to the module's order states

Initial Sync​

  1. Go to Shopee → Operations → Import Wizard
  2. Select the data types to import (Products, Customers, Orders)
  3. Set the date range for historical orders
  4. Start the import and monitor progress in the sync log
  5. Review the mapping records and re-run if anything landed on the wrong Odoo record

Run a small import first — restrict it by date or to a handful of products — and check the results before letting the scheduled actions take over.

To push the other way, use Shopee → Operations → Export Wizard. Run Barcode Preflight on your products first: the export refuses to push a product whose barcode is not a structurally valid GTIN, because Shopee rejects a malformed barcode at listing time and the failure is much harder to read from the far side.

Dashboard​

The OWL 2 dashboard provides:

  • KPI tiles — revenue, orders, customers, products, average order value and sync health, each with a period-over-period delta
  • Sales trend — a line chart counting Shopee orders only, formatted in the record's own currency
  • Order status breakdown — a doughnut chart across order states
  • Period filters — today, 7 / 30 / 90 days, year, or a custom range
  • Activity feed — recent sync log entries, with drill-downs
  • Status footer — queue jobs, errors, out-of-stock and sync rate

Troubleshooting​

IssueSolution
Connection failedVerify API credentials and check network connectivity
Sync not runningCheck Odoo scheduled actions (cron jobs) are enabled, and that the configuration's Auto Sync flag for that lane is on
'ShopeeAPI' object has no attribute 'get_products'An Odoo 19 build older than 19.0.2.1.1. Upgrade the module.
Duplicate productsReview product mapping settings and matching rules
Orders not importingVerify order status filters and date range settings
Export skips a productIts barcode has not passed Barcode Preflight, or is not a valid GTIN
Rows rejected for another regionThe configuration is single-region. Switch on Multi-Region first.
Webhook deliveries are refusedThe webhook record is paused, or its Delivery URL does not exactly match the Push URL registered in the Shopee console

Support​

Last updated on