Shopee Connector Reference

6 metrics46 dimensions

The Shopee connector exposes 52 fields (6 metrics, 46 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.

IDTypeNameDescription
order_buyer_usernameTEXTOrder Buyer UsernameThe username of the buyer.
order_codBOOLEANOrder CODWhether the order is cash on delivery.
order_create_timeTIMESTAMPOrder Create TimeThe time the order was created. ISO 8601 datetime (UTC).
order_currencyTEXTOrder CurrencyThe currency of the order total.
order_days_to_shipNUMERICOrder Days To ShipThe number of days the seller has to ship the order.
order_idTEXTOrder IDThe Shopee order serial number (order_sn).
order_message_to_sellerTEXTOrder Message To SellerThe message the buyer left for the seller.
order_pay_timeTIMESTAMPOrder Pay TimeThe time the order was paid. ISO 8601 datetime (UTC).
order_payment_methodTEXTOrder Payment MethodThe payment method used for the order.
order_regionREGIONOrder RegionThe two-letter region code of the order, for example ID.
order_ship_by_dateTIMESTAMPOrder Ship By DateThe date by which the order must be shipped. ISO 8601 (UTC).
order_shipping_carrierTEXTOrder Shipping CarrierThe shipping carrier of the order.
order_statusTEXTOrder StatusThe order status, for example READY_TO_SHIP or COMPLETED.
order_total_amountNUMERICOrder Total AmountThe total amount the buyer paid for the order.
order_update_timeTIMESTAMPOrder Update TimeThe time the order was last updated. ISO 8601 datetime (UTC).

Shopee products fields

The products report of the Shopee connector includes 16 fields.

IDTypeNameDescription
product_available_stockNUMERICProduct Available StockThe total available stock of the item.
product_brandTEXTProduct BrandThe brand name of the item.
product_category_idTEXTProduct Category IDThe Shopee category ID of the item.
product_conditionTEXTProduct ConditionThe item condition, for example NEW or USED.
product_create_timeTIMESTAMPProduct Create TimeThe time the item was created. ISO 8601 datetime (UTC).
product_currencyTEXTProduct CurrencyThe currency of the item price.
product_current_priceNUMERICProduct Current PriceThe current selling price of the item.
product_descriptionTEXTProduct DescriptionThe item description.
product_idTEXTProduct IDThe Shopee item ID.
product_image_srcIMAGE_URLProduct Image URLThe URL of the first item image.
product_nameTEXTProduct NameThe item name.
product_original_priceNUMERICProduct Original PriceThe original price of the item before discounts.
product_skuTEXTProduct SKUThe seller SKU of the item.
product_statusTEXTProduct StatusThe item status, for example NORMAL.
product_update_timeTIMESTAMPProduct Update TimeThe time the item was last updated. ISO 8601 datetime (UTC).
product_weightNUMERICProduct Item WeightThe item weight in kilograms.

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.

IDTypeNameDescriptionReport
account_idTEXTAccount IDThe Shopee shop ID.
account_nameTEXTAccount NameThe Shopee shop name.
data_fetched_atTIMESTAMPData fetched atUTC 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.
datasourceTEXTData SourceThe name of the Windsor connector returning the row
dateDATEDateThe date of the record.
day_of_monthTEXTDay of monthDay of the month
monthTEXTMonthNumber of the month
nowTIMESTAMPNowCurrent timestamp
sourceTEXTSourceThe name of the Windsor connector returning the row
todayDATETodayToday's date
weekTEXTWeekWeek (Sun-Sat).
week_dayTEXTDay of week and day numberWeekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday.
week_day_isoTEXTDay of week and day number, ISOWeekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7
week_isoTEXTWeek ISOWeek, ISO format (Mon-Sun).
yearTEXTYearYear
year_monthTEXTYearmonthYear and month, e.g. 2024|3
year_month_nameTEXTYear month nameYear and month with the month name written out, e.g. "Jan 2025".
year_of_weekTEXTYear of weekThe year that contains first day of the week (Sun-Sat).
year_of_week_isoTEXTYear of week, ISOThe year that contains first day of the ISO week (Mon-Sun).
year_weekTEXTYear weekYear and week for US weeks (Sun-Sat), e.g. 2024|15
year_week_isoTEXTYear week ISOYear and week for ISO weeks (Mon-Sun), e.g. 2024|20