Product base info management
Last Updated: 2022-11-01
Language Supported:
English /
简体中文 /
繁體中文 /
Português (Brasil) /
ไทย
1. Getting product list
1.1 Getting all shop products
This API allows you to get a list of all the products in the shop or filter by update_time range and item status
1.2 Searching for item_id
This API allows you to search for a list of item_id based on some specific conditions, including
- A list of item_id containing the product name keyword
- A list of item_id containing the sku keyword
- A list of item_id lacking required attributes
- A list of item_id lacking optional attributes
2. Getting product information
API: v2.product.get_item_base_info + v2.product.get_model_list
If the product has no variants, you only need to call v2.product.get_item_base_info to get the product base information, otherwise you also need to call v2.product.get_model_list API to get the variants price and stock.
The field “has_model” in v2.product.get_item_base_info API indicates whether the product has variants or not.
3. Getting the data of product
API: v2.product.get_item_extra_info
This API can get the data of views, likes, sales, ratings, and star rating from a product.
The data of views is from the last 30 days' statistics, the sales data is the cumulative value.
4. Getting product promotion information
API: v2.product.get_item_promotion
This API allows you to get information about all ongoing or upcoming promotions that the product is added in. If the product is added into multiple promotions, the promotion_id field of v2.product.get_item_base_info will return one of the promotion_id, and we suggest you continue to call API v2.product.get_item_promotion to get all the promotions information.
5. Updating product information
-
This API supports updating product information except for the size_chart/price/stock/model information. Fields that are uploaded will be updated, and fields that are not uploaded will not be updated.
-
For item_sku/wholesale/video_upload_id, we support the delete operation, you can upload the null string then we will delete it.
Example of deleting item_sku:
{
"item_id": 800182459,
"item_sku": ""
}
-
Please refer to the FAQ about updating extended descriptions.
-
If you did not update some fields but encountered a prompt that these fields are filled in incorrectly, this situation is normal because every time you update, we will verify the legitimacy of all the product information, so if it does not meet the requirements, please modify it.
6. Unlisting or deleting product
“unlist” : true means the product will be unlist,“unlist” : false, means the product will be re-listed.
This API can change item_status to be “deleted”, please note that after the deletion, you will not be able to update the product, and the seller can not view this item through the Seller Center.
For Shopee deleted and Seller deleted products, within 90 days, you can still get the product information through API, after 90 days, the product data will be permanently deleted in Shopee database, you can not query any information about this product, if you need, please save the product information in time.
7. Updating size chart image
API: v2.product.update_size_chart
This API can be used to add or update the image size chart of the product, if you encounter the error "Your shop can not edit image size chart", please check the announcement.
8. Registering Brand
API: v2.product.register_brand
Sellers can register their own brands through this API. If Shopee audits this brand successfully, you will get a valid brand_id for adding or updating products.
For the specific audit process, please check the FAQ
*The following content is only applicable to CNSC/KRSC sellers.
9. Getting global product list
API: v2.global_product.get_global_item_list
This API allows you to get a list of all global_item_id or filter by update_time range under the merchant. This API will not return a list of deleted global_item_id.
10. Getting a global product ID
API: v2.global_product.get_global_item_id
By calling this API, you can quickly find the global_item_id of a shop product.
11. Getting global product information
API: v2.global_product.get_global_item_info + v2.global_product.get_global_model_list
-
If the global product does not contain variants, you only need to call v2.global_product.get_global_item_info to get the global product information, otherwise you also need to call v2.global_product.get_global_model_list to get the variants stock and price information.
-
Product data and promotion information are not saved on global products.
You can call v2.product.get_item_extra_info to get the shop product data and v2.product.get_item_promotion to get the promotion data of shop products.
12. Updating global products
API: v2.global_product.update_global_item
- Since some fields can be managed by global products and shop products together, you can check the article "Creating global product" for details. You can set the fields synchronization through v2.global_product.set_sync_field API, then Shopee will automatically synchronize to shop products after you update the global product.
13. Deleting global product
API: v2.global_product.delete_global_item
Global products do not support unlist, but can only be deleted. After the global products are deleted, all published shop products will also be deleted.
14. Updating the size chart image
API: v2.global_product.update_size_chart
This API allows you to add or update the size chart of global products. If you want to update the size chart of a shop product individually, you can call v2.product.update_size_chart API.
You can check this FAQ to learn more about which product module interface permissions CNSC/KRSC sellers have.