Shopee Connector Reference

40 metrics67 dimensions

Fields

The Shopee connector exposes 107 fields (40 metrics, 67 dimensions). Every field ID below can be passed to the Windsor.ai API in the fields parameter.

Shopee Fields

Shopee orders fields

The orders report of the Shopee connector includes 15 fields.

ID	Type	Name	Description
order_buyer_username	TEXT	Order Buyer Username	The username of the buyer.
order_cod	BOOLEAN	Order COD	Whether the order is cash on delivery.
order_create_time	TIMESTAMP	Order Create Time	The time the order was created. ISO 8601 datetime (UTC).
order_currency	TEXT	Order Currency	The currency of the order total.
order_days_to_ship	NUMERIC	Order Days To Ship	The number of days the seller has to ship the order.
order_id	TEXT	Order ID	The Shopee order serial number (order_sn).
order_message_to_seller	TEXT	Order Message To Seller	The message the buyer left for the seller.
order_pay_time	TIMESTAMP	Order Pay Time	The time the order was paid. ISO 8601 datetime (UTC).
order_payment_method	TEXT	Order Payment Method	The payment method used for the order.
order_region	REGION	Order Region	The two-letter region code of the order, for example ID.
order_ship_by_date	TIMESTAMP	Order Ship By Date	The date by which the order must be shipped. ISO 8601 (UTC).
order_shipping_carrier	TEXT	Order Shipping Carrier	The shipping carrier of the order.
order_status	TEXT	Order Status	The order status, for example READY_TO_SHIP or COMPLETED.
order_total_amount	NUMERIC	Order Total Amount	The total amount the buyer paid for the order.
order_update_time	TIMESTAMP	Order Update Time	The time the order was last updated. ISO 8601 datetime (UTC).

Shopee products fields

The products report of the Shopee connector includes 16 fields.

ID	Type	Name	Description
product_available_stock	NUMERIC	Product Available Stock	The total available stock of the item.
product_brand	TEXT	Product Brand	The brand name of the item.
product_category_id	TEXT	Product Category ID	The Shopee category ID of the item.
product_condition	TEXT	Product Condition	The item condition, for example NEW or USED.
product_create_time	TIMESTAMP	Product Create Time	The time the item was created. ISO 8601 datetime (UTC).
product_currency	TEXT	Product Currency	The currency of the item price.
product_current_price	NUMERIC	Product Current Price	The current selling price of the item.
product_description	TEXT	Product Description	The item description.
product_id	TEXT	Product ID	The Shopee item ID.
product_image_src	IMAGE_URL	Product Image URL	The URL of the first item image.
product_name	TEXT	Product Name	The item name.
product_original_price	NUMERIC	Product Original Price	The original price of the item before discounts.
product_sku	TEXT	Product SKU	The seller SKU of the item.
product_status	TEXT	Product Status	The item status, for example NORMAL.
product_update_time	TIMESTAMP	Product Update Time	The time the item was last updated. ISO 8601 datetime (UTC).
product_weight	NUMERIC	Product Item Weight	The item weight in kilograms.

Shopee returns fields

The returns report of the Shopee connector includes 12 fields.

ID	Type	Name	Description
return_amount_before_discount	NUMERIC	Return Amount Before Discount	The item amount before discounts.
return_create_time	TIMESTAMP	Return Create Time	The time the return was created. ISO 8601 datetime (UTC).
return_currency	TEXT	Return Currency	The currency of the refund amount.
return_due_date	TIMESTAMP	Return Due Date	The seller response due date. ISO 8601 datetime (UTC).
return_id	TEXT	Return ID	The Shopee return serial number (return_sn).
return_order_id	TEXT	Return Order ID	The order serial number (order_sn) of the return.
return_reason	TEXT	Return Reason	The return reason code, for example ITEM_DAMAGED.
return_refund_amount	NUMERIC	Return Refund Amount	The amount refunded to the buyer.
return_refund_type	TEXT	Return Refund Type	The type of refund for the return.
return_status	TEXT	Return Status	The return status, for example REFUND_PAID.
return_text_reason	TEXT	Return Text Reason	The free-text reason the buyer gave for the return.
return_update_time	TIMESTAMP	Return Update Time	The time the return was last updated. ISO 8601 datetime (UTC).

Shopee settlement fields

The settlement report of the Shopee connector includes 32 fields.

ID	Type	Name	Description
settlement_actual_shipping_fee	NUMERIC	Settlement Actual Shipping Fee	The actual shipping fee for the order.
settlement_ads_fee	NUMERIC	Settlement Ads Fee	The ads escrow top-up or technical support fee.
settlement_buyer_paid_shipping_fee	NUMERIC	Settlement Buyer Paid Shipping Fee	The shipping fee paid by the buyer.
settlement_buyer_payment_method	TEXT	Settlement Buyer Payment Method	The payment method the buyer used.
settlement_buyer_total_amount	NUMERIC	Settlement Buyer Total Amount	The total amount the buyer paid.
settlement_buyer_transaction_fee	NUMERIC	Settlement Buyer Transaction Fee	The transaction fee charged to the buyer.
settlement_campaign_fee	NUMERIC	Settlement Campaign Fee	The fee charged for participating in a campaign.
settlement_coins	NUMERIC	Settlement Coins	The Shopee coins value applied to the order.
settlement_commission_fee	NUMERIC	Settlement Commission Fee	The Shopee commission fee charged on the order.
settlement_cost_of_goods_sold	NUMERIC	Settlement Cost Of Goods Sold	The cost of goods sold for the order.
settlement_credit_card_transaction_fee	NUMERIC	Settlement Credit Card Transaction Fee	The credit card transaction fee on the order.
settlement_currency	TEXT	Settlement Currency	The currency of the settlement amounts.
settlement_drc_adjustable_refund	NUMERIC	Settlement DRC Adjustable Refund	The dispute-resolution adjustable refund amount.
settlement_escrow_amount	NUMERIC	Settlement Escrow Amount	The net amount released to the seller after Shopee fees.
settlement_escrow_amount_after_adjustment	NUMERIC	Settlement Escrow Amount After Adjustment	The escrow amount after post-release adjustments.
settlement_estimated_shipping_fee	NUMERIC	Settlement Estimated Shipping Fee	The estimated shipping fee for the order.
settlement_final_shipping_fee	NUMERIC	Settlement Final Shipping Fee	The final shipping fee borne by the seller.
settlement_order_discounted_price	NUMERIC	Settlement Order Discounted Price	The order price after discounts.
settlement_order_id	TEXT	Settlement Order ID	The Shopee order serial number (order_sn) of the settlement.
settlement_order_original_price	NUMERIC	Settlement Order Original Price	The order price before discounts.
settlement_order_selling_price	NUMERIC	Settlement Order Selling Price	The order selling price.
settlement_original_cost_of_goods_sold	NUMERIC	Settlement Original Cost Of Goods Sold	The original cost of goods sold before adjustments.
settlement_reverse_shipping_fee	NUMERIC	Settlement Reverse Shipping Fee	The return (reverse) shipping fee.
settlement_seller_discount	NUMERIC	Settlement Seller Discount	The discount funded by the seller.
settlement_seller_return_refund	NUMERIC	Settlement Seller Return Refund	The amount refunded to the buyer by the seller.
settlement_seller_transaction_fee	NUMERIC	Settlement Seller Transaction Fee	The transaction fee charged to the seller.
settlement_service_fee	NUMERIC	Settlement Service Fee	The Shopee service fee charged on the order.
settlement_shopee_discount	NUMERIC	Settlement Shopee Discount	The discount funded by Shopee.
settlement_shopee_shipping_rebate	NUMERIC	Settlement Shopee Shipping Rebate	The shipping rebate funded by Shopee.
settlement_total_adjustment_amount	NUMERIC	Settlement Total Adjustment Amount	The total adjustment amount applied to the order.
settlement_voucher_from_seller	NUMERIC	Settlement Voucher From Seller	The voucher amount funded by the seller.
settlement_voucher_from_shopee	NUMERIC	Settlement Voucher From Shopee	The voucher amount funded by Shopee.

Shopee wallet fields

The wallet report of the Shopee connector includes 11 fields.

ID	Type	Name	Description
wallet_amount	NUMERIC	Wallet Amount	The transaction amount.
wallet_create_time	TIMESTAMP	Wallet Create Time	The time the transaction was created. ISO 8601 datetime (UTC).
wallet_current_balance	NUMERIC	Wallet Current Balance	The wallet balance after the transaction.
wallet_description	TEXT	Wallet Description	The description of the transaction.
wallet_money_flow	TEXT	Wallet Money Flow	The direction of the money flow for the transaction.
wallet_order_id	TEXT	Wallet Order ID	The order serial number (order_sn) linked to the transaction.
wallet_transaction_fee	NUMERIC	Wallet Transaction Fee	The fee charged on the transaction.
wallet_transaction_id	TEXT	Wallet Transaction ID	The Shopee wallet transaction ID.
wallet_transaction_status	TEXT	Wallet Transaction Status	The transaction status, for example COMPLETED.
wallet_transaction_type	TEXT	Wallet Transaction Type	The transaction type, for example ESCROW_VERIFIED_ADD.
wallet_type	TEXT	Wallet Type	The wallet type, for example shopee_pay.

Shopee other fields

The Shopee connector has 21 fields that do not belong to a named report, or belong to a report with only one or two fields.

ID	Type	Name	Description
account_id	TEXT	Account ID	The Shopee shop ID.
account_name	TEXT	Account Name	The Shopee shop name.
data_fetched_at	TIMESTAMP	Data fetched at	UTC timestamp (second precision) of when the connector request that pulled the row started. Freshly pulled rows show this request's start time; cache hits keep the start time of the request that filled the cache. Selecting this field disables aggregation, so rows are returned individually (each keeping its own fetch time) instead of being summed.
datasource	TEXT	Data Source	The name of the Windsor connector returning the row
date	DATE	Date	The date of the record.
day_of_month	TEXT	Day of month	Day of the month
month	TEXT	Month	Number of the month
now	TIMESTAMP	Now	Current timestamp
source	TEXT	Source	The name of the Windsor connector returning the row
today	DATE	Today	Today's date
week	TEXT	Week	Week (Sun-Sat).
week_day	TEXT	Day of week and day number	Weekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday.
week_day_iso	TEXT	Day of week and day number, ISO	Weekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7
week_iso	TEXT	Week ISO	Week, ISO format (Mon-Sun).
year	TEXT	Year	Year
year_month	TEXT	Yearmonth	Year and month, e.g. 2024\|3
year_month_name	TEXT	Year month name	Year and month with the month name written out, e.g. "Jan 2025".
year_of_week	TEXT	Year of week	The year that contains first day of the week (Sun-Sat).
year_of_week_iso	TEXT	Year of week, ISO	The year that contains first day of the ISO week (Mon-Sun).
year_week	TEXT	Year week	Year and week for US weeks (Sun-Sat), e.g. 2024\|15
year_week_iso	TEXT	Year week ISO	Year and week for ISO weeks (Mon-Sun), e.g. 2024\|20

API Connectors