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 |
Use in Adverity |
|---|---|---|
actual_shipping_fee |
actual_shipping_fee |
dimension |
actual_shipping_fee_confirmed |
actual_shipping_fee_confirmed |
dimension |
add_on_deal_id |
add_on_deal_id |
dimension |
attribute_list |
attribute_list |
dimension |
attribute_list.attribute_id |
attribute_list.attribute_id |
dimension |
attribute_list.attribute_value_list.original_value_name |
attribute_list.attribute_value_list.original_value_name |
dimension |
attribute_list.attribute_value_list.value_id |
attribute_list.attribute_value_list.value_id |
dimension |
attribute_list.attribute_value_list.value_unit |
attribute_list.attribute_value_list.value_unit |
dimension |
attribute_list.is_mandatory |
attribute_list.is_mandatory |
dimension |
attribute_list.original_attribute_name |
attribute_list.original_attribute_name |
dimension |
attributes |
attributes |
dimension |
authorised_brand_id |
authorised_brand_id |
dimension |
booking_sn |
booking_sn |
dimension |
brand |
brand |
dimension |
brand.brand_id |
brand.brand_id |
dimension |
brand.original_brand_name |
brand.original_brand_name |
dimension |
buyer_cancel_reason |
buyer_cancel_reason |
dimension |
buyer_cpf_id |
buyer_cpf_id |
dimension |
buyer_user_id |
buyer_user_id |
dimension |
buyer_username |
buyer_username |
dimension |
cancel_by |
cancel_by |
dimension |
cancel_reason |
cancel_reason |
dimension |
category_id |
category_id |
dimension |
category_name |
category_name |
dimension |
cmt_count |
cmt_count |
metric |
cod |
cod |
dimension |
compatibility_info |
compatibility_info |
dimension |
country |
country |
dimension |
create_time |
create_time |
dimension |
currency |
currency |
dimension |
date |
date |
dimension |
days_to_ship |
days_to_ship |
metric |
description |
description |
dimension |
description_info |
description_info |
dimension |
description_info.extended_description.field_list.field_type |
description_info.extended_description.field_list.field_type |
dimension |
description_info.extended_description.field_list.image_info.image_id |
description_info.extended_description.field_list.image_info.image_id |
dimension |
description_info.extended_description.field_list.image_info.image_url |
description_info.extended_description.field_list.image_info.image_url |
dimension |
description_info.extended_description.field_list.text |
description_info.extended_description.field_list.text |
dimension |
dimension |
dimension |
dimension |
dimension.package_height |
dimension.package_height |
metric |
dimension.package_length |
dimension.package_length |
metric |
dimension.package_width |
dimension.package_width |
metric |
discount_id |
discount_id |
dimension |
discount_name |
discount_name |
dimension |
dropshipper |
dropshipper |
dimension |
dropshipper_phone |
dropshipper_phone |
dimension |
end_time |
end_time |
dimension |
escrow_amount |
escrow_amount |
metric |
escrow_tax |
escrow_tax |
metric |
estimated_shipping_fee |
estimated_shipping_fee |
metric |
fulfillment_flag |
fulfillment_flag |
dimension |
goods_to_declare |
goods_to_declare |
dimension |
gtin_code |
gtin_code |
metric |
has_model |
has_model |
dimension |
has_promotion |
has_promotion |
dimension |
has_uploaded_shipping_proof |
has_uploaded_shipping_proof |
dimension |
has_variation |
has_variation |
dimension |
image |
image |
dimension |
image.image_id_list |
image.image_id_list |
dimension |
image.image_url_list |
image.image_url_list |
dimension |
images |
images |
dimension |
invoice_data |
invoice_data |
dimension |
is_actual_shipping_fee_confirmed |
is_actual_shipping_fee_confirmed |
dimension |
is_add_on_deal |
is_add_on_deal |
dimension |
is_arrived_at_warehouse |
is_arrived_at_warehouse |
metric |
is_main_item |
is_main_item |
dimension |
is_pre_order |
is_pre_order |
dimension |
is_prescription_item |
is_prescription_item |
dimension |
is_reverse_logistics_channel_integrated |
is_reverse_logistics_channel_integrated |
dimension |
is_seller_arrange |
is_seller_arrange |
dimension |
is_shipping_proof_mandatory |
is_shipping_proof_mandatory |
dimension |
is_split_up |
is_split_up |
dimension |
is_wholesale |
is_wholesale |
dimension |
item |
item |
dimension |
item_id |
item_id |
dimension |
item_list |
item_list |
dimension |
item_list.add_on_deal |
item_list.add_on_deal |
dimension |
item_list.add_on_deal_id |
item_list.add_on_deal_id |
dimension |
item_list.image_info.image_url |
item_list.image_info.image_url |
dimension |
item_list.is_prescription_item |
item_list.is_prescription_item |
dimension |
item_list.item_id |
item_list.item_id |
dimension |
item_list.item_name |
item_list.item_name |
dimension |
item_list.item_sku |
item_list.item_sku |
dimension |
item_list.main_item |
item_list.main_item |
dimension |
item_list.model_discounted_price |
item_list.model_discounted_price |
metric |
item_list.model_id |
item_list.model_id |
dimension |
item_list.model_name |
item_list.model_name |
dimension |
item_list.model_original_price |
item_list.model_original_price |
metric |
item_list.model_quantity_purchased |
item_list.model_quantity_purchased |
metric |
item_list.model_sku |
item_list.model_sku |
dimension |
item_list.order_item_id |
item_list.order_item_id |
dimension |
item_list.product_location_id |
item_list.product_location_id |
dimension |
item_list.promotion_group_id |
item_list.promotion_group_id |
dimension |
item_list.promotion_id |
item_list.promotion_id |
dimension |
item_list.promotion_type |
item_list.promotion_type |
dimension |
item_list.weight |
item_list.weight |
metric |
item_list.wholesale |
item_list.wholesale |
dimension |
item_name |
item_name |
dimension |
item_original_price |
item_original_price |
metric |
item_promotion_price |
item_promotion_price |
metric |
item_promotion_stock |
item_promotion_stock |
metric |
item_sku |
item_sku |
metric |
item_status |
item_status |
dimension |
likes |
likes |
metric |
logistic_info |
logistic_info |
dimension |
logistic_info.enabled |
logistic_info.enabled |
dimension |
logistic_info.estimated_shipping_fee |
logistic_info.estimated_shipping_fee |
metric |
logistic_info.is_free |
logistic_info.is_free |
dimension |
logistic_info.logistic_id |
logistic_info.logistic_id |
dimension |
logistic_info.logistic_name |
logistic_info.logistic_name |
dimension |
logistics |
logistics |
dimension |
logistics_status |
logistics_status |
dimension |
message_to_seller |
message_to_seller |
dimension |
model_list |
model_list |
dimension |
model_list.model_id |
model_list.model_id |
dimension |
model_list.model_name |
model_list.model_name |
dimension |
model_list.model_normal_stock |
model_list.model_normal_stock |
dimension |
model_list.model_original_price |
model_list.model_original_price |
dimension |
model_list.model_promotion_price |
model_list.model_promotion_price |
dimension |
model_list.model_promotion_stock |
model_list.model_promotion_stock |
dimension |
name |
name |
dimension |
negotiation |
negotiation |
dimension |
normal_stock |
normal_stock |
metric |
note |
note |
dimension |
note_update_time |
note_update_time |
dimension |
order_chargeable_weight_gram |
order_chargeable_weight_gram |
metric |
order_item_id |
order_item_id |
dimension |
order_sn |
order_sn |
dimension |
order_status |
order_status |
dimension |
ordersn |
ordersn |
dimension |
original_price |
original_price |
metric |
package_height |
package_height |
metric |
package_length |
package_length |
metric |
package_list |
package_list |
dimension |
package_list.item_list.item_id |
package_list.item_list.item_id |
dimension |
package_list.item_list.model_id |
package_list.item_list.model_id |
dimension |
package_list.logistics_status |
package_list.logistics_status |
dimension |
package_list.package_number |
package_list.package_number |
dimension |
package_list.parcel_chargeable_weight_gram |
package_list.parcel_chargeable_weight_gram |
metric |
package_list.shipping_carrier |
package_list.shipping_carrier |
dimension |
package_query_number |
package_query_number |
dimension |
package_width |
package_width |
metric |
pay_time |
pay_time |
dimension |
payment_method |
payment_method |
dimension |
pickup_done_time |
pickup_done_time |
dimension |
pre_order |
pre_order |
dimension |
pre_order.days_to_ship |
pre_order.days_to_ship |
metric |
pre_order.is_pre_order |
pre_order.is_pre_order |
dimension |
price |
price |
metric |
price_info |
price_info |
dimension |
price_info.currency |
price_info.currency |
dimension |
price_info.current_price |
price_info.current_price |
metric |
price_info.original_price |
price_info.original_price |
metric |
product_location_id |
product_location_id |
dimension |
promotion_id |
promotion_id |
dimension |
promotion_image |
promotion_image |
dimension |
promotion_type |
promotion_type |
dimension |
purchase_limit |
purchase_limit |
metric |
purchase_limit_info |
purchase_limit_info |
dimension |
rating_star |
rating_star |
metric |
recipient_address |
recipient_address |
dimension |
recipient_address.city |
recipient_address.city |
dimension |
recipient_address.district |
recipient_address.district |
dimension |
recipient_address.full_address |
recipient_address.full_address |
dimension |
recipient_address.name |
recipient_address.name |
dimension |
recipient_address.phone |
recipient_address.phone |
dimension |
recipient_address.region |
recipient_address.region |
dimension |
recipient_address.state |
recipient_address.state |
dimension |
recipient_address.town |
recipient_address.town |
dimension |
recipient_address.zipcode |
recipient_address.zipcode |
metric |
refund_amount |
refund_amount |
metric |
region |
region |
dimension |
request_id |
request_id |
dimension |
reserved_stock |
reserved_stock |
metric |
return_address |
return_address |
dimension |
return_pickup_address |
return_pickup_address |
dimension |
return_refund_request_type |
return_refund_request_type |
metric |
return_refund_type |
return_refund_type |
dimension |
return_seller_due_date |
return_seller_due_date |
dimension |
return_ship_due_date |
return_ship_due_date |
dimension |
return_sn |
return_sn |
dimension |
return_solution |
return_solution |
metric |
returnsn |
returnsn |
metric |
reverse_logistics_channel_name |
reverse_logistics_channel_name |
dimension |
reverse_logistics_status |
reverse_logistics_status |
dimension |
reverse_shipping_fee |
reverse_shipping_fee |
metric |
sales |
sales |
metric |
seller_compensation |
seller_compensation |
dimension |
seller_proof |
seller_proof |
dimension |
service_code |
service_code |
dimension |
ship_by_date |
ship_by_date |
dimension |
shipping_carrier |
shipping_carrier |
dimension |
shopid |
shopid |
metric |
size_chart |
size_chart |
dimension |
size_chart_id |
size_chart_id |
dimension |
split_up |
split_up |
dimension |
start_time |
start_time |
dimension |
status |
status |
dimension |
stock |
stock |
metric |
stock_info |
stock_info |
dimension |
stock_info.current_stock |
stock_info.current_stock |
metric |
stock_info.normal_stock |
stock_info.normal_stock |
metric |
stock_info.reserved_stock |
stock_info.reserved_stock |
metric |
stock_info.stock_type |
stock_info.stock_type |
metric |
stock_info_v2 |
stock_info_v2 |
dimension |
stock_info_v2.seller_stock.stock |
stock_info_v2.seller_stock.stock |
metric |
stock_info_v2.summary_info.total_available_stock |
stock_info_v2.summary_info.total_available_stock |
metric |
stock_info_v2.summary_info.total_reserved_stock |
stock_info_v2.summary_info.total_reserved_stock |
metric |
total_amount |
total_amount |
metric |
tracking_no |
tracking_no |
dimension |
tracking_number |
tracking_number |
dimension |
update_time |
update_time |
dimension |
variation_discounted_price |
variation_discounted_price |
metric |
variation_id |
variation_id |
dimension |
variation_name |
variation_name |
dimension |
variation_original_price |
variation_original_price |
metric |
variation_quantity_purchased |
variation_quantity_purchased |
metric |
variation_sku |
variation_sku |
dimension |
variations |
variations |
dimension |
video_info |
video_info |
dimension |
video_info.duration |
video_info.duration |
metric |
video_info.thumbnail_url |
video_info.thumbnail_url |
dimension |
video_info.video_url |
video_info.video_url |
dimension |
views |
views |
metric |
weight |
weight |
metric |