Shopee: Most-used fields

The table below gives information about most-used fields that you can import from Shopee. Other fields might also be available in Adverity.

The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.

API name	Adverity UI name	Description	Use in Adverity
actual_shipping_fee	actual_shipping_fee	The final shipping cost for an order, which is a positive value. For non-integrated logistics channels, this value is 0. This field is only displayed for non-CB SIP affiliate shops.	dimension
actual_shipping_fee_confirmed	actual_shipping_fee_confirmed	Indicates if the actual shipping fee for an order has been confirmed.	dimension
add_on_deal_id	add_on_deal_id	A unique identifier for an add-on deal or promotion.	dimension
attribute_list	attribute_list	A list of attributes defining specific characteristics of a product.	dimension
attribute_list.attribute_id	attribute_list.attribute_id	The unique identifier for a product attribute.	dimension
attribute_list.attribute_value_list.original_value_name	attribute_list.attribute_value_list.original_value_name	The original name of the attribute value, as retrieved from the product attributes API.	dimension
attribute_list.attribute_value_list.value_id	attribute_list.attribute_value_list.value_id	The unique identifier for a specific attribute value.	dimension
attribute_list.attribute_value_list.value_unit	attribute_list.attribute_value_list.value_unit	The unit of measurement for a quantitative product attribute value.	dimension
attribute_list.is_mandatory	attribute_list.is_mandatory	Indicates if the product attribute is mandatory for listing.	dimension
attribute_list.original_attribute_name	attribute_list.original_attribute_name	The original name of the product attribute.	dimension
attributes	attributes	A collection of product attributes defining its characteristics.	dimension
authorised_brand_id	authorised_brand_id	The identifier for a brand that is authorized or registered on the Shopee platform.	dimension
booking_sn	booking_sn	Shopee’s unique identifier for a booking, returned only for advance fulfillment matched orders.	dimension
brand	brand	Contains information about the brand of the product.	dimension
brand.brand_id	brand.brand_id	The unique identifier for the brand.	dimension
brand.original_brand_name	brand.original_brand_name	The original name of the brand.	dimension
buyer_cancel_reason	buyer_cancel_reason	The reason provided by the buyer for cancelling an order.	dimension
buyer_cpf_id	buyer_cpf_id	The CPF ID of the buyer (specific to certain regions like Brazil). This field is available when requesting optional fields in order details.	dimension
buyer_user_id	buyer_user_id	The unique identifier for the buyer of an order.	dimension
buyer_username	buyer_username	The name of the buyer for an order. This information may be masked as ‘****’ for non-integrated orders in the Taiwan region.	dimension
cancel_by	cancel_by	Indicates who canceled the order. This field is available when requesting optional fields in order details.	dimension
cancel_reason	cancel_reason	The reason provided for the cancellation of an order.	dimension
category_id	category_id	The unique identifier for the product category.	dimension
category_name	category_name	The name of the product category.	dimension
cmt_count	cmt_count	The total number of comments or reviews received for a product.	metric
cod	cod	Indicates if the order is a Cash on Delivery (COD) order.	dimension
compatibility_info	compatibility_info	Information related to product compatibility, especially relevant for items like auto parts, specifying which models or types it works with.	dimension
country	country	The two-letter ISO ALPHA-2 code representing the country.	dimension
create_time	create_time	The timestamp when the order or item was created.	dimension
currency	currency	The three-digit ISO currency code for the order’s total amount.	dimension
date	date	A standardized date field derived from API timestamps, representing the date of an event.	dimension
days_to_ship	days_to_ship	The number of days required to ship a pre-order item.	metric
description	description	The detailed description of the product.	dimension
description_info	description_info	Contains detailed description information about the product.	dimension
description_info.extended_description.field_list.field_type	description_info.extended_description.field_list.field_type	This field defines the type of content within an extended product description. It indicates whether a specific part of the description contains text or an image. Possible values include “text” and “image”.	dimension
description_info.extended_description.field_list.image_info.image_id	description_info.extended_description.field_list.image_info.image_id	The unique identifier for an image included in a product’s extended description.	dimension
description_info.extended_description.field_list.image_info.image_url	description_info.extended_description.field_list.image_info.image_url	The URL where an image, part of a product’s extended description, can be accessed.	dimension
description_info.extended_description.field_list.text	description_info.extended_description.field_list.text	The textual content of a specific field within a product’s extended description.	dimension
dimension	dimension	The physical dimensions of the item or package.	dimension
dimension.package_height	dimension.package_height	The height of the product package in centimeters.	metric
dimension.package_length	dimension.package_length	The length of the product package in centimeters.	metric
dimension.package_width	dimension.package_width	The width of the product package in centimeters.	metric
discount_id	discount_id	The unique identifier for a discount promotion.	dimension
discount_name	discount_name	The name of the discount promotion.	dimension
dropshipper	dropshipper	Indicates whether the order is handled by a dropshipper. This field is available when requesting optional fields in order details.	dimension
dropshipper_phone	dropshipper_phone	The phone number of the dropshipper. This field is available when requesting optional fields in order details.	dimension
end_time	end_time	The timestamp indicating when a discount activity or promotion ends.	dimension
escrow_amount	escrow_amount	The amount held in escrow for an order, which is released to the seller upon successful completion of the transaction.	metric
escrow_tax	escrow_tax	Cross-border tax imposed by the Indonesian government on sellers. This field is only displayed for non-CB SIP affiliate shops.	metric
estimated_shipping_fee	estimated_shipping_fee	The estimated shipping fee for the order.	metric
fulfillment_flag	fulfillment_flag	A flag indicating how the order is fulfilled (e.g., by Shopee, cross-border seller, local seller).	dimension
goods_to_declare	goods_to_declare	Information related to goods that need to be declared. This field is available when requesting optional fields in order details.	dimension
has_model	has_model	Indicates whether a product has specific models, which are often used to define variations or distinct versions of a product.	dimension
has_variation	has_variation	Indicates whether a product has different variations, such as size, color, or other attributes.	dimension
image	image	Contains image-related information for the product.	dimension
image.image_id_list	image.image_id_list	A list of unique identifiers for product images.	dimension
image.image_url_list	image.image_url_list	A list of URLs for product images.	dimension
images	images	A list of image URLs for the product.	dimension
invoice_data	invoice_data	Invoice-related data for an order. This field is available when requesting optional fields in order details.	dimension
is_actual_shipping_fee_confirmed	is_actual_shipping_fee_confirmed	Indicates whether the actual shipping fee has been confirmed. This field is available when requesting optional fields in order details.	dimension
is_add_on_deal	is_add_on_deal	Indicates if the item is part of an add-on deal.	dimension
is_main_item	is_main_item	Indicates if the item is the main item in a bundle or a sub-item.	dimension
is_pre_order	is_pre_order	Indicates if the item is a pre-order item.	dimension
is_prescription_item	is_prescription_item	Indicates if the item is a prescription-required product.	dimension
is_split_up	is_split_up	Indicates if an order has been split into multiple packages. This field is available when requesting optional fields in order details.	dimension
is_wholesale	is_wholesale	Indicates if the item is available for wholesale purchase.	dimension
item_id	item_id	Shopee’s unique identifier for a product item.	dimension
item_list	item_list	A list of items included in an order or package.	dimension
item_list.add_on_deal	item_list.add_on_deal	Indicates if the item in the list is part of an add-on deal.	dimension
item_list.add_on_deal_id	item_list.add_on_deal_id	The unique identifier for an add-on deal that this item belongs to.	dimension
item_list.image_info.image_url	item_list.image_info.image_url	The URL of the image for the product item in the list.	dimension
item_list.is_prescription_item	item_list.is_prescription_item	Indicates if the item in the list is a prescription-required product.	dimension
item_list.item_id	item_list.item_id	Shopee’s unique identifier for the product item in the list.	dimension
item_list.item_name	item_list.item_name	The name of the product item in the list.	dimension
item_list.item_sku	item_list.item_sku	The Stock Keeping Unit (SKU) for the product item in the list.	dimension
item_list.main_item	item_list.main_item	Indicates if the item is the main item in a bundle or a sub-item.	dimension
item_list.model_discounted_price	item_list.model_discounted_price	The discounted price of the specific product model within the item list.	metric
item_list.model_id	item_list.model_id	The unique identifier for the product model within the item list.	dimension
item_list.model_name	item_list.model_name	The name of the product model within the item list.	dimension
item_list.model_original_price	item_list.model_original_price	The original price of the product model within the item list.	metric
item_list.model_quantity_purchased	item_list.model_quantity_purchased	The quantity of a specific model within a product that has been purchased as part of an order.	metric
item_list.model_sku	item_list.model_sku	The Stock Keeping Unit (SKU) for the product model within the item list.	dimension
item_list.order_item_id	item_list.order_item_id	The unique identifier for the order item within the item list.	dimension
item_list.product_location_id	item_list.product_location_id	The unique identifier for the warehouse or location where the product item in the list is stored.	dimension
item_list.promotion_group_id	item_list.promotion_group_id	The unique identifier for a product promotion group within an item list.	dimension
item_list.promotion_id	item_list.promotion_id	The unique identifier for the promotion applied to this item in the list.	dimension
item_list.promotion_type	item_list.promotion_type	The type of promotion applied to this item in the list.	dimension
item_list.weight	item_list.weight	The weight of the item, measured in kilograms (KG). For product models, if not specified, it defaults to the item’s weight.	metric
item_list.wholesale	item_list.wholesale	Indicates if the item in the list is available for wholesale purchase.	dimension
item_name	item_name	The name of the product item.	dimension
item_original_price	item_original_price	The original price of the product item before any discounts or promotions.	metric
item_promotion_price	item_promotion_price	The discounted price of the item during a promotion. If the item has variations, this value will be 0, and the promotion price for variations should be checked separately.	metric
item_promotion_stock	item_promotion_stock	The reserved stock quantity of the item for a promotion. This parameter is necessary if the item has no variation.	metric
item_sku	item_sku	The Stock Keeping Unit (SKU) for the product item, defined by the seller.	dimension
item_status	item_status	The current status of the product item on Shopee (e.g., normal, banned, unlisted).	dimension
likes	likes	The number of likes a product has received. This metric is available through the v2.product.get_item_extra_info API and represents the cumulative value of likes for a product.	metric
logistic_info	logistic_info	Contains detailed information about the logistics arrangements for an order.	dimension
logistic_info.enabled	logistic_info.enabled	Indicates if a specific logistics option is enabled.	dimension
logistic_info.estimated_shipping_fee	logistic_info.estimated_shipping_fee	The estimated shipping fee for the specific logistics option.	metric
logistic_info.is_free	logistic_info.is_free	Indicates whether free shipping is offered for the logistics option or product.	dimension
logistic_info.logistic_id	logistic_info.logistic_id	The unique identifier for the logistics channel.	dimension
logistic_info.logistic_name	logistic_info.logistic_name	The name of the logistics channel or service.	dimension
logistics	logistics	Contains general logistics information for the product or order.	dimension
message_to_seller	message_to_seller	A message from the buyer to the seller for the order.	dimension
model_list	model_list	A list of product models or variations for an item.	dimension
model_list.model_id	model_list.model_id	The unique identifier for a specific product model.	dimension
model_list.model_name	model_list.model_name	The name of the product model.	dimension
model_list.model_normal_stock	model_list.model_normal_stock	The regular stock quantity available for the product model.	dimension
model_list.model_original_price	model_list.model_original_price	The original price of the product model before any discounts.	dimension
model_list.model_promotion_price	model_list.model_promotion_price	The discounted price of a specific model (variation) during a promotion.	dimension
model_list.model_promotion_stock	model_list.model_promotion_stock	The reserved stock quantity of a specific model (variation) for a promotion.	dimension
name	name	The name of the item in the local language.	dimension
normal_stock	normal_stock	The regular stock quantity available for an item, not including promotional or reserved stock.	metric
note	note	A note made by the seller for internal reference regarding the order.	dimension
note_update_time	note_update_time	The timestamp when the seller’s note for the order was last updated.	metric
order_chargeable_weight_gram	order_chargeable_weight_gram	The chargeable weight of the order in grams, used for calculating shipping fees.	metric
order_item_id	order_item_id	The unique identifier for an item within a specific order.	dimension
order_sn	order_sn	Shopee’s unique identifier for an order.	dimension
order_status	order_status	The current status of the order (e.g., unpaid, ready to ship, completed).	dimension
ordersn	ordersn	Shopee’s unique identifier for an order.	dimension
original_price	original_price	The original price of the product or its variation before any discounts.	metric
package_height	package_height	The height of the product package in centimeters.	metric
package_length	package_length	The length of the product package in centimeters.	metric
package_list	package_list	A list of packages associated with an order.	dimension
package_list.item_list.item_id	package_list.item_list.item_id	Shopee’s unique identifier for an item within a package list.	dimension
package_list.item_list.model_id	package_list.item_list.model_id	The unique identifier for a product model within an item in the package list.	dimension
package_list.logistics_status	package_list.logistics_status	The logistics status of a specific package within an order.	dimension
package_list.package_number	package_list.package_number	Shopee’s unique identifier for a package within an order.	dimension
package_list.parcel_chargeable_weight_gram	package_list.parcel_chargeable_weight_gram	The chargeable weight of the parcel in grams, used for calculating shipping fees.	metric
package_list.shipping_carrier	package_list.shipping_carrier	The name of the shipping carrier for the package.	dimension
package_width	package_width	The width of the product package in centimeters.	metric
pay_time	pay_time	The timestamp indicating when the buyer completed payment for the order. This field is available when requesting optional fields in order details.	dimension
payment_method	payment_method	The method used by the buyer to pay for the order.	dimension
pickup_done_time	pickup_done_time	The timestamp when the package pickup for the order was completed by the logistics provider.	dimension
pre_order	pre_order	Contains information indicating if the item is a pre-order.	dimension
pre_order.days_to_ship	pre_order.days_to_ship	The number of days required to ship a pre-order item.	metric
pre_order.is_pre_order	pre_order.is_pre_order	Indicates if the item is designated as a pre-order.	dimension
price	price	The original price of the item before any promotions or discounts in the listing currency.	metric
price_info	price_info	Contains detailed pricing information for the product, including current and original prices.	dimension
price_info.currency	price_info.currency	The three-digit ISO currency code for the product’s price.	dimension
price_info.current_price	price_info.current_price	The current price of the item in the listing currency. If the product is under an ongoing promotion, this will be the promotion price.	metric
price_info.original_price	price_info.original_price	The original price of the product before any discounts.	metric
product_location_id	product_location_id	The unique identifier for the warehouse or location where the product is stored.	dimension
promotion_id	promotion_id	The unique identifier for a promotion.	dimension
promotion_image	promotion_image	The image used for a product’s promotional campaigns or discount offers.	dimension
promotion_type	promotion_type	The type of promotion applied to the item (e.g., Flash Sale, Bundle Deal).	dimension
purchase_limit	purchase_limit	The maximum number of this product that can be purchased at the promotion price in a discount activity.	metric
purchase_limit_info	purchase_limit_info	Details about the purchase limits applied to a product, particularly during promotions.	dimension
rating_star	rating_star	The average star rating given to a product by buyers.	metric
reason	reason	Indicates the original return reason submitted by the buyer when initiating a return request, or the reassessed return reason by the platform.	dimension
recipient_address	recipient_address	The complete address details of the recipient for the order.	dimension
recipient_address.city	recipient_address.city	The city component of the recipient’s address.	dimension
recipient_address.district	recipient_address.district	The district component of the recipient’s address.	dimension
recipient_address.full_address	recipient_address.full_address	The complete, detailed address of the recipient.	dimension
recipient_address.name	recipient_address.name	The name of the recipient.	dimension
recipient_address.phone	recipient_address.phone	The phone number of the recipient.	dimension
recipient_address.region	recipient_address.region	The region component of the recipient’s address.	dimension
recipient_address.state	recipient_address.state	The state or province component of the recipient’s address.	dimension
recipient_address.town	recipient_address.town	The town of the recipient’s address. The presence of this field depends on the region and/or country.	dimension
recipient_address.zipcode	recipient_address.zipcode	The postal code of the recipient’s address for an order or a shop address.	metric
refund_amount	refund_amount	The amount of money refunded for a return request.	metric
region	region	The two-digit code representing the region where the order originated.	dimension
request_id	request_id	A unique identifier for an API request, used for tracking and troubleshooting.	dimension
reserved_stock	reserved_stock	The total quantity of stock reserved for ongoing promotions or sales events.	metric
return_seller_due_date	return_seller_due_date	The deadline for the seller to deal with a return request.	metric
return_ship_due_date	return_ship_due_date	The deadline for a buyer to ship a returned item back to the seller or for a return request to be processed.	dimension
returnsn	returnsn	Shopee’s unique identifier for a return request.	metric
reverse_shipping_fee	reverse_shipping_fee	The shipping fee for returning an item.	metric
sales	sales	The total number of units sold for a product or the total sales revenue generated.	metric
service_code	service_code	A code required at some sorting hubs for cross-border orders, which must be included on the shipping label.	dimension
ship_by_date	ship_by_date	The deadline for the seller to ship out the package.	dimension
shipping_carrier	shipping_carrier	The name of the logistics service provider or shipping carrier.	dimension
shopid	shopid	Shopee’s unique identifier for a shop.	metric
size_chart	size_chart	Information about the size chart applicable to the product.	dimension
size_chart_id	size_chart_id	The identifier for a size chart associated with a product, providing buyers with guidance on product sizing.	dimension
split_up	split_up	Indicates if the order has been split into multiple shipments. This field is available when requesting optional fields in order details.	dimension
start_time	start_time	The timestamp indicating when a discount activity or promotion starts.	dimension
status	status	The current status of an order or return, such as ‘CANCELLED’ or ‘ACCEPTED’.	dimension
stock	stock	The current available stock quantity for the item.	metric
stock_info	stock_info	Comprehensive information regarding the stock levels and availability of a product.	dimension
stock_info.current_stock	stock_info.current_stock	The current available stock quantity of an item.	metric
stock_info.normal_stock	stock_info.normal_stock	The regular stock quantity of a product. This field is deprecated and users should transition to the seller_stock field in stock_info_v2.	metric
stock_info.reserved_stock	stock_info.reserved_stock	The quantity of stock reserved, often due to ongoing or upcoming promotions or pending orders. This field is part of an older stock information structure.	metric
stock_info.stock_type	stock_info.stock_type	The classification or category of stock for a product, such as regular stock, pre-order stock, or promotional stock.	metric
stock_info_v2	stock_info_v2	Detailed stock information including total reserved stock, total available stock, seller stock, and Shopee stock. This field provides a more accurate representation of stock when both seller and Shopee stock are present.	dimension
stock_info_v2.seller_stock.stock	stock_info_v2.seller_stock.stock	The stock quantity managed by the seller for a specific product or model. This field can be associated with different warehouse locations.	metric
stock_info_v2.summary_info.total_available_stock	stock_info_v2.summary_info.total_available_stock	The total quantity of a product’s stock that is currently available for sale across all locations.	metric
stock_info_v2.summary_info.total_reserved_stock	stock_info_v2.summary_info.total_reserved_stock	The total quantity of stock that is reserved for promotions or other purposes, as part of the detailed stock information.	metric
total_amount	total_amount	The total amount paid by the buyer for the order.	metric
tracking_no	tracking_no	The tracking number for the shipment or return parcel.	dimension
tracking_number	tracking_number	The tracking number for the shipment or return parcel.	dimension
update_time	update_time	The timestamp when the item or record was last updated.	dimension
variation_discounted_price	variation_discounted_price	The discounted price of a specific variation within an item.	metric
variation_id	variation_id	Shopee’s unique identifier for a specific variation (model) of an item.	dimension
variation_name	variation_name	The name of the variation that belongs to the same item.	dimension
variation_original_price	variation_original_price	The original price of a specific product variation.	metric
variation_quantity_purchased	variation_quantity_purchased	The quantity of a specific product variation that has been purchased.	metric
variation_sku	variation_sku	The SKU (stock keeping unit) for a specific variation of an item.	dimension
variations	variations	A collection of all variations (models) available for an item, including their details.	dimension
video_info	video_info	Information about product videos, including upload IDs.	dimension
video_info.duration	video_info.duration	The length of the video in seconds.	metric
video_info.thumbnail_url	video_info.thumbnail_url	The URL of the thumbnail image associated with the video.	dimension
video_info.video_url	video_info.video_url	The URL where the video can be accessed for playback.	dimension
views	views	The total number of times a product listing or shop page has been viewed.	metric
weight	weight	The weight of the item in kilograms (KG).	metric