
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- Brazilhttps://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.
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.
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.
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.Streams and Fields
Below you’ll find all available data streams from Shopee and their corresponding fields:Products
Products
Complete product catalog with detailed information including pricing, inventory, media, and attributes.Basic Info:
item_id- Unique identifier for the productitem_name- Product name/titleitem_sku- SKU codedescription- Product descriptiondescription_type- Type of descriptioncategory_id- Category identifiercondition- Product condition (new, used)item_status- Current status (NORMAL, BANNED, UNLIST, REVIEWING, SELLER_DELETE, SHOPEE_DELETE)
create_time- When the product was created (Unix timestamp)update_time- When the product was last updated (Unix timestamp)
price_info- Array of price information per currency:currency- Currency codeoriginal_price- Original list pricecurrent_price- Current selling priceinflated_price_of_original_price- Inflated original priceinflated_price_of_current_price- Inflated current pricesip_item_price- SIP item pricesip_item_price_source- SIP item price sourcelocal_price- Local pricelocal_promotion_price- Local promotional price
image- Product images:image_id_list- Array of image IDsimage_url_list- Array of image URLsimage_ratio- Image aspect ratio
video_info- Array of product videos:video_url- Video URLthumbnail_url- Video thumbnail URLduration- Video duration in seconds
promotion_image- Promotional images
attribute_list- Array of product attributes:attribute_id- Attribute identifieroriginal_attribute_name- Attribute nameis_mandatory- Whether attribute is requiredattribute_value_list- Array of values withvalue_id,original_value_name,value_unit
weight- Product weightdimension- Package dimensions:package_length- Lengthpackage_width- Widthpackage_height- Height
logistic_info- Array of logistics options:logistic_id- Logistics channel IDlogistic_name- Logistics channel nameenabled- Whether enabledshipping_fee- Shipping feesize_id- Size tier IDis_free- Free shipping flagestimated_shipping_fee- Estimated shipping cost
stock_info_v2- Detailed stock information:summary_info- Total reserved and available stock (total_reserved_stock,total_available_stock)seller_stock- Stock by seller location (location_id,stock,if_saleable)shopee_stock- Stock at Shopee warehouses (location_id,stock)advance_stock- Advance stock details (sellable_advance_stock,in_transit_advance_stock)
brand- Brand information (brand_id,original_brand_name)gtin_code- GTIN/EAN barcodeauthorised_brand_id- Authorized brand IDssp_id- SSP identifier
pre_order- Pre-order settings (is_pre_order,days_to_ship)wholesales- Wholesale pricing tiers (min_count,max_count,unit_price,inflated_price_of_unit_price)
purchase_limit_info- Purchase limits:min_purchase_limit- Minimum purchase quantitymax_purchase_limit- Maximum purchase limit (purchase_limit)
condition- Product condition (new, used)item_status- Current status (NORMAL, BANNED, UNLIST, REVIEWING, SELLER_DELETE, SHOPEE_DELETE)deboost- Whether product is deboost (visibility reduced)has_model- Whether product has variations/modelshas_promotion- Whether currently on promotionpromotion_id- Active promotion IDis_fulfillment_by_shopee- Whether fulfilled by Shopee (FBS)item_dangerous- Dangerous goods indicatorscheduled_publish_time- Scheduled publish time (Unix timestamp)
size_chart- Size chart contentsize_chart_id- Size chart identifier
tag- Product tags:kit- Whether product is a kit/bundle
description_info- Extended description:extended_description- Rich description withfield_listcontainingfield_type,text,image_info
description_type- Type of description
compatibility_info- Vehicle compatibility:vehicle_info_list- Array of compatible vehicles (brand_id,model_id,year_id,version_id)
tax_info- Tax details by region:- Brazil:
ncm,diff_state_cfop,same_state_cfop,export_cfop,csosn,origin,cest,measure_unit,pis,cofins,icms_cst,pis_cofins_cst,federal_state_taxes,operation_type,ex_tipi,fci_num,recopi_num,additional_info,group_item_info - Poland:
invoice_option,vat_rate - India:
hs_code,tax_code - Taiwan:
tax_type
- Brazil:
complaint_policy- Warranty and complaint settings:warranty_time- Warranty durationexclude_entrepreneur_warranty- Exclude entrepreneur warrantycomplaint_address_id- Complaint address IDadditional_information- Additional info
certification_info- Product certifications:certification_list- Array of certifications (permit_id,certification_no,expiry_date,certification_proofs)
Orders
Orders
Complete order details including buyer information, items, payments, and shipping.Basic Order Info:
order_sn- Unique order serial numberorder_status- Order statusregion- Order region/countrycurrency- Order currencycod- Cash on delivery flagtotal_amount- Total order amountmessage_to_seller- Buyer’s messagepending_terms- Array of pending termspending_description- Array of pending descriptions
create_time- Order creation time (Unix timestamp)update_time- Last update time (Unix timestamp, replication key)pay_time- Payment timeship_by_date- Ship by deadlinedays_to_ship- Days allowed to shipnote_update_time- When seller note was last updated
buyer_user_id- Buyer’s user IDbuyer_username- Buyer’s usernamebuyer_cpf_id- Buyer’s CPF (Brazil)recipient_address- Delivery address:name- Recipient namephone- Phone numberfull_address- Complete addresstown,district,city,state,region,zipcodegeolocation- Coordinates (latitude,longitude)
item_list- Array of ordered items:item_id,item_name,item_skumodel_id,model_name,model_skumodel_quantity_purchased- Quantitymodel_original_price,model_discounted_priceweight- Item weightwholesale- Wholesale order flagadd_on_deal,main_item,add_on_deal_id- Add-on deal infopromotion_type,promotion_id,promotion_group_id- Promotion detailspromotion_list- Array of promotions (promotion_type,promotion_id)order_item_id- Order item identifierimage_info- Item image (image_url)product_location_id- Product location IDsis_prescription_item- Prescription item flagis_b2c_owned_item- B2C owned item flagconsultation_id- Consultation ID (prescription items)hot_listing_item- Hot listing flag
shipping_carrier- Carrier namecheckout_shipping_carrier- Selected carrier at checkoutestimated_shipping_fee- Estimated shipping costactual_shipping_fee- Actual shipping costactual_shipping_fee_confirmed- Fee confirmation statusreverse_shipping_fee- Return shipping feeorder_chargeable_weight_gram- Chargeable weightfulfillment_flag- Fulfillment typepickup_done_time- Pickup completion timegoods_to_declare- Customs declaration required
package_list- Array of packages:package_number- Package tracking numberlogistics_status- Package statuslogistics_channel_id- Logistics channel IDshipping_carrier- Carrierallow_self_design_awb- Allow custom AWB designitem_list- Items in package (item_id,model_id,model_quantity,order_item_id,promotion_group_id,product_location_id)parcel_chargeable_weight- Package weightparcel_chargeable_weight_gram- Package weight in gramsgroup_shipment_id- Group shipment IDvirtual_contact_number- Virtual contact numberpackage_query_number- Query numbersorting_group- Sorting group
payment_method- Payment methodpayment_info- Array of payment details:payment_method- Method usedpayment_processor_register- Payment processorcard_brand- Card brand (if applicable)transaction_id- Transaction IDpayment_amount- Amount paid
cancel_by- Who cancelledcancel_reason- Cancellation reasonbuyer_cancel_reason- Buyer’s cancellation reason
invoice_data- Invoice details:number- Invoice numberseries_number- Series numberaccess_key- Access keyissue_date- Issue date (Unix timestamp)total_value- Total invoice valueproducts_total_value- Products total valuetax_code- Tax code
prescription_images- Array of prescription image URLsprescription_check_status- Check statuspharmacist_name- Pharmacist nameprescription_approval_time- Approval timeprescription_rejection_time- Rejection time
edt_from- Estimated delivery time fromedt_to- Estimated delivery time to
booking_sn- Booking serial numberadvance_package- Advance package flag
dropshipper- Dropshipper namedropshipper_phone- Dropshipper phone
note- Seller notessplit_up- Order split flagreturn_request_due_date- Return request deadlineis_buyer_shop_collection- Shop collection flagbuyer_proof_of_collection- Array of collection proof imageshot_listing_order- Hot listing order flag
Ads Product Campaigns
Ads Product Campaigns
Advertising campaign settings and configuration for product-level campaigns.Campaign Info:
campaign_id- Unique campaign identifiercommon_info- Common campaign settings:ad_type- Campaign type (auto, manual)ad_name- Campaign namecampaign_status- Status (ongoing, scheduled, ended, paused, deleted, closed)bidding_method- Bidding method (auto, manual)campaign_placement- Where ads appear (search, discovery, all)campaign_budget- Budget (0 = unlimited)campaign_duration- Start and end timesitem_id_list- Products in campaign
manual_bidding_info- Manual bidding settings:enhanced_cpc- Enhanced CPC enabledselected_keywords- Array of keywords:keyword- Keyword textstatus- Keyword statusmatch_type- Match type (exact, broad)bid_price_per_click- Bid amount
discovery_ads_locations- Discovery placement settings
auto_bidding_info- Auto bidding settings:roas_target- Target ROAS
auto_product_ads_info- Array of products:product_name- Product namestatus- Ad status (learning, ongoing, paused, ended, unavailable)item_id- Product ID
Ads Daily Product Campaign Performance
Ads Daily Product Campaign Performance
Daily performance metrics for product advertising campaigns.Identifiers:
campaign_id- Campaign identifierad_type- Campaign type (auto, manual)campaign_placement- Placement (search, discovery, all)ad_name- Campaign namedate- Report date (YYYY-MM-DD, replication key)
impression- Number of ad impressionsclicks- Number of clicksctr- Click-through rate (clicks ÷ impressions × 100%)expense- Amount spent on ads
broad_gmv- Revenue from any shop product within 7 days of ad clickbroad_order- Orders for any shop product within 7 daysbroad_order_amount- Quantity of products purchasedbroad_roi- ROAS (GMV ÷ expense)broad_cir- ACOS (expense ÷ GMV × 100%)cr- Conversion rate (conversions ÷ clicks × 100%)cpc- Cost per conversion (expense ÷ conversions)
direct_gmv- Revenue from advertised product within 7 daysdirect_order- Orders for advertised product within 7 daysdirect_order_amount- Quantity of advertised product purchaseddirect_roi- Direct ROASdirect_cir- Direct ACOSdirect_cr- Direct conversion ratecpdc- Cost per direct conversion
Product Analytics
Product Analytics
Product engagement and sales metrics.Key Fields:
item_id- Product identifiersale- Total sales countviews- Number of product viewslikes- Number of likes/favoritesrating_star- Average ratingcomment_count- Number of reviews/comments
Daily Shop Performance
Daily Shop Performance
Daily shop-level performance metrics for affiliate marketing.Key Fields:
report_date- Report date (YYYY-MM-DD, replication key)fetched_date_range- Actual data range
sales- Total affiliate sales revenuegross_item_sold- Total items sold through affiliatesorders- Number of affiliate orders
clicks- Clicks on affiliate links
est_commission- Estimated commission payoutroi- Return on investment (sales ÷ commission)
total_buyers- Total affiliate buyersnew_buyers- New buyers through affiliates
Data Model
The following diagram illustrates the relationships between the core data streams in Shopee. The arrows indicate the join keys that link the different entities.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
SQL query
SQL query
- AWS
- GCP
Sample Result
Sample Result
| item_id | item_name | total_sales | total_views | total_likes | rating_star | comment_count | conversion_rate |
|---|---|---|---|---|---|---|---|
| 123456789 | Wireless Bluetooth Earbuds | 2,450 | 45,230 | 1,890 | 4.8 | 856 | 5.42 |
| 234567890 | Phone Case Premium | 1,890 | 32,450 | 1,234 | 4.6 | 423 | 5.82 |
| 345678901 | USB-C Fast Charger | 1,567 | 28,900 | 987 | 4.7 | 312 | 5.42 |
| 456789012 | Screen Protector Pack | 1,234 | 18,450 | 567 | 4.5 | 234 | 6.69 |
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
SQL query
SQL query
- AWS
- GCP
Sample Result
Sample Result
| order_status | order_count | percentage | total_revenue | avg_order_value |
|---|---|---|---|---|
| COMPLETED | 1,245 | 62.25 | 89,234.50 | 71.67 |
| SHIPPED | 456 | 22.80 | 31,245.00 | 68.52 |
| READY_TO_SHIP | 189 | 9.45 | 14,523.00 | 76.84 |
| CANCELLED | 110 | 5.50 | 7,856.00 | 71.42 |
3. Advertising Campaign Performance
Analyze advertising ROI and identify top-performing campaigns. Business Value:- Track advertising spend efficiency
- Compare direct vs broad attribution
- Optimize campaign budgets based on performance
SQL query
SQL query
- AWS
- GCP
Sample Result
Sample Result
| campaign_name | ad_type | campaign_status | campaign_placement | total_impressions | total_clicks | total_spend | broad_gmv | broad_orders | direct_gmv | direct_orders | broad_roas | direct_roas |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Best Sellers Q4 | auto | ongoing | all | 245,670 | 8,920 | 1,784.00 | 12,450.00 | 156 | 8,920.00 | 98 | 6.98 | 5.00 |
| Flash Sale Promo | manual | ongoing | search | 189,450 | 6,234 | 1,246.80 | 9,870.00 | 124 | 7,650.00 | 89 | 7.92 | 6.14 |
| New Arrivals | auto | scheduled | discovery | 98,340 | 3,456 | 691.20 | 4,560.00 | 67 | 3,210.00 | 45 | 6.60 | 4.64 |
Implementation Notes
Timestamps
Timestamps
Shopee uses Unix timestamps (seconds since epoch) for date/time fields. To convert in queries:
Regional API Endpoints
Regional API Endpoints
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
Advertising Attribution
Advertising Attribution
Shopee Ads provides two types of conversion attribution:
- Broad Attribution: Tracks purchases of ANY product from your shop within 7 days of an ad click
- Direct Attribution: Tracks purchases of the ADVERTISED product only within 7 days
Incremental Sync
Incremental Sync
The connector supports incremental sync for:
- Products: Uses
update_timeas the replication key - Orders: Uses
update_timeas the replication key - Ads Daily Performance: Uses
dateas the replication key - Daily Shop Performance: Uses
report_dateas the replication key
Nested Data Structures
Nested Data Structures
Shopee data contains nested structures. When querying:
- Use
UNNESTto flatten arrays (e.g.,item_listin orders) - Access nested objects using dot notation (e.g.,
common_info.ad_name)