Skip to main content
Shopee is one of Southeast Asia and Latin America’s leading e-commerce platforms, providing a marketplace for sellers to list products and manage orders. The Shopee Open Platform API enables access to your seller data including products, orders, advertising campaigns, and shop performance metrics.

Configuring Shopee as a Source

In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Shopee option from the list of connectors. Click Next and you’ll be prompted to add your access.

1. Add account access

You’ll need to authorize Nekt to access your Shopee seller data. Click on the Shopee Authorization button and log in with your Shopee seller account. Grant the necessary permissions for the shop you want to extract data from. The following configurations are available:
  • API URL: Select the appropriate API endpoint for your region:
    • https://partner.shopeemobile.com - Global (Southeast Asia)
    • https://openplatform.shopee.com.br - Brazil
    • https://openplatform.shopee.cn - China
  • Start Date: The earliest date from which records will be synced. If not provided, all available historical data will be extracted.
Make sure you have the correct API permissions enabled in your Shopee Partner account. The connector requires access to Product, Order, Payment, and Ads APIs depending on which streams you select.
Once you’re done, click Next.

2. Select streams

Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.
Tip: The stream can be found more easily by typing its name.
Select the streams and click Next.

3. Configure data streams

Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.
  • Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
  • Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
  • Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
  • Sync Type: you can choose between INCREMENTAL and FULL_TABLE.
    • Incremental: every time the extraction happens, we’ll get only the new data - which is good if, for example, you want to keep every record ever fetched.
    • Full table: every time the extraction happens, we’ll get the current state of the data - which is good if, for example, you don’t want to have deleted data in your catalog.
Once you are done configuring, click Next.

4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Optionally, you can define some additional settings:
  • Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
  • Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.
Once you are ready, click Next to finalize the setup.

5. Check your new source

You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.
For you to be able to see it on your Catalog, you need at least one successful source run.

Streams and Fields

Below you’ll find all available data streams from Shopee and their corresponding fields:
Complete product catalog with detailed information including pricing, inventory, media, and attributes.
FBS (Fulfillment by Shopee) warehouse stock per product and warehouse location.
Complete order details including buyer information, items, payments, and shipping.
Financial breakdown per order, including marketplace commission data.
Product engagement and sales metrics.

Use Cases for Data Analysis

This guide outlines valuable business intelligence use cases when consolidating Shopee data, along with ready-to-use SQL queries that you can run on Explorer.

1. Product Performance Overview

Analyze product performance combining catalog data with engagement metrics. Business Value:
  • Identify best-selling and most-viewed products
  • Understand conversion from views to sales
  • Optimize product listings based on engagement

2. Order Status Analysis

Track order distribution by status to monitor fulfillment health. Business Value:
  • Monitor order processing efficiency
  • Identify bottlenecks in fulfillment
  • Track cancellation rates and reasons

Implementation Notes

Shopee uses Unix timestamps (seconds since epoch) for date/time fields. To convert in queries:
The connector supports multiple regional API endpoints:
  • Global (SEA): Singapore, Malaysia, Thailand, Vietnam, Philippines, Indonesia, Taiwan
  • Brazil: Specific endpoint for Brazilian marketplace
  • China: Mainland China operations
Make sure to select the correct API URL for your shop’s region.
The connector supports incremental sync for:
  • Products: Uses update_time as the replication key
  • Orders: Uses update_time as the replication key
For products and orders, only records modified since the last sync will be extracted.
The connector automatically manages access token refresh to prevent authentication failures:
  • Access tokens are refreshed proactively 30 minutes before expiration
  • The signing key is dynamically updated when generating new tokens
  • Refresh tokens are stored securely in the Meltano database
  • Token expiration defaults to 4 hours if not specified by the API
Shopee data contains nested structures. When querying:
  • Use UNNEST to flatten arrays (e.g., item_list in orders)
Example for order items:

Skills for agents

Download Shopee skills file

Shopee connector documentation as plain markdown, for use in AI agent contexts.