Installation and setup

Requirements

• CS-Cart and Multi-Vendor 4.17.2 or later.
• Administrator access to the store’s admin panel.
• A Shopee Open Platform developer account (free) with an app, see below. The account is yours: register at https://open.shopee.com, create an app of the type that fits you (for a seller who connects their own shop: a seller in-house system / ERP type app), and note its partner ID and partner key (Console > App list). Test and live have separate partner IDs and keys.
• A seller account with a shop on Shopee. The shop owner (or a main account that owns the shop) must approve the app once.
• The IP address of your server declared in the Console (App list > IP Address Whitelist): otherwise Shopee answers source_ip_undeclared.
• A cron job on your server (see step 8).

Install the add-on

1. Download the kv_shopee-<version>.zip package from your Kavio Labs or CS-Cart Marketplace account.
2. In the admin panel, open Add-ons > Manage add-ons.
3. Click the gear button and choose Manual installation, then upload the archive.
4. Find Shopee Marketplace Connector in the list and make sure its status is Active.
5. Enter your license key under Settings > License (Kavio Labs downloads) and click Check now.

Connect Shopee

1. Open the add-on page (Marketplaces > Shopee) and the Connection tab.
2. In the Shopee Open Platform Console, open your app and set the Redirect URL Domain (test and live) to the domain of this store. The Connection page shows the exact redirect URL.
3. Choose Test mode and enter the test partner ID and partner key. Pick the API host (Global unless your server is near mainland China or Brazil). Save: the page now shows an authorization link.
4. Open the authorization link, log in as the shop owner and confirm. Shopee sends you back to the store, which stores the tokens (valid 4 hours, renewed automatically). If the redirect does not reach the store (for example on a development host), paste the code and shop_id from the address bar into the fallback form within 10 minutes.
5. Click Test connection: a green message names your shop and its region.
6. Switch to Live mode and repeat steps 3 to 5 with the live partner ID and key, only after the test works.
7. Map categories and attributes, set the price and stock rules (see Usage).
8. Add the cron job from the settings page (Cron section), every minute is fine. Overlapping runs are prevented.
9. Optional: on the Push Mechanism page of your app in the Console, enter the Webhook URL shown on the Connection page, press Verify and tick Order Status Push and Order TrackingNo Push. Without it the add-on polls on the cron schedule.

Multi-Vendor

By default the marketplace owner connects one shop for all vendors (Marketplace owner mode on). Switch it off to let each vendor connect their own Shopee shop in the vendor panel (Connection tab).

Update

1. Upload the new package the same way. Your settings, credentials, authorizations and data are kept.
2. The add-on adds missing tables and settings by itself on the first request after the update.

See CHANGELOG for what changed in each version.

Uninstall

Open Add-ons > Manage add-ons, click the add-on’s gear button and choose Uninstall. This removes the add-on’s settings, language variables and database tables, including the stored credentials and tokens.