# Shopee module

Shopee is one of the largest e-commerce platforms in **Southeast Asia, Taiwan, and Brazil**. It offers a wide variety of products including electronics, fashion, beauty, home goods, and groceries. Shopee is known for its mobile-first approach, user-friendly app, and frequent promotional campaigns such as flash sales and discount vouchers.

The platform also supports **local sellers and international brands**, making it a popular online marketplace for both buyers and merchants. Additionally, Shopee runs an **affiliate program**, allowing publishers and partners to earn commissions by promoting Shopee products through tracked affiliate links.

<figure><img src="https://4254262503-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M3fnB7iKYwDc1Xhr3H3%2Fuploads%2FQOrxWGl5QV8H49t8LVc7%2Fimage.png?alt=media&#x26;token=6aa9848e-b5d9-423f-9492-9864b3b853cf" alt="" width="563"><figcaption></figcaption></figure>

### How to Get App ID and API Key

1. **Sign up for Shopee Affiliate**\
   Register with the Shopee Affiliate platform for your region:
   * Brazil: <https://affiliate.shopee.com.br>
   * Indonesia: <https://affiliate.shopee.co.id>
   * Malaysia: <https://affiliate.shopee.com.my>
   * Mexico: <https://affiliate.shopee.com.mx>
   * Philippines: <https://affiliate.shopee.ph>
   * Polska: <https://affiliate.shopee.pl>
   * Singapore: <https://affiliate.shopee.sg>
   * Taiwan: <https://affiliate.shopee.tw>
   * Thailand: <https://affiliate.shopee.co.th>
   * Vietnam: <https://affiliate.shopee.vn>
2. **Log in to your Shopee Affiliate dashboard**\
   Use the account you created to access your dashboard.
3. **Go to the Open API section**\
   From your Shopee Affiliate homepage, open the **“Open API”** section.
4. **Generate credentials**\
   In this section, you can create or view your **App ID** and **API Key**.
5. **Add to Content Egg**\
   Copy both values into WordPress → **Content Egg → Modules → Shopee module**, then save changes.

<figure><img src="https://4254262503-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M3fnB7iKYwDc1Xhr3H3%2Fuploads%2FslPq6jjDIoIcujaYcbyq%2F%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%BD%D1%8F.png?alt=media&#x26;token=b3b0ddb2-0adb-41df-8ce1-f3a187cada01" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
**Affiliate links will be generated automatically** through the Shopee API, but you can also use **Deeplinks** from affiliate networks that support Shopee, such as Accesstrade. To do this, [set your Deeplink](https://ce-docs.keywordrush.com/modules/deeplink-settings) in the Shopee module settings of Content Egg, and the plugin will use it to create affiliate links with proper tracking and commission credit.
{% endhint %}

### Shopee Module Details

The **Shopee module** lets you add affiliate products to your WordPress site in two ways:

* **Keyword search** – find products by entering relevant search terms.
* **Direct product URL** – import specific items by pasting their Shopee links.

<figure><img src="https://4254262503-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M3fnB7iKYwDc1Xhr3H3%2Fuploads%2FbVU9UCHGtuEVLU3aukAW%2Fimage.png?alt=media&#x26;token=1ea81139-1ce5-4031-806c-ae8db0cf20f8" alt=""><figcaption></figcaption></figure>

You can also control how many results are displayed per query. The maximum limit is **50 products**.

#### Price Updates

The module supports **automatic price synchronization**.\
For best performance, we recommend running updates via a Cron job instead of triggering them on Page views. Review your preferences in the module settings.

#### Data Available from the Shopee API

Shopee’s API provides only **basic product details**, including the product title, main image, and current price. Extended content such as full descriptions, attributes, or detailed specifications is not included in the API feed.

Despite these limitations, the Shopee module is a **reliable solution for affiliate integration**. You can build product blocks that encourage clicks and conversions, while enhancing your listings with the plugin’s [AI-powered content generation](https://ce-docs.keywordrush.com/ai/content-generation-with-product-import).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://ce-docs.keywordrush.com/modules/affiliate/shopee.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.