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