Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Create the kit item by selecting multiple items and setting main component and quantity per kit.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Add model. More detail please check: https://open.shopee.com/developer-guide/219
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Create asynchronous task to batch add item
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Create asynchronous task to batch publish outlet item
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Create asynchronous task to batch update outlet item's price
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Create asynchronous task to batch update outlet stock
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Boost item.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Recommend category by item name.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Use this call to delete a product item.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Delete item model.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
This API generates a single consolidated image by combining the cover images of all selected items. It is typically used to create a unified product display image for kits or bundles.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Get the list of A Items under SIP Affiliate Shop corresponding to P Items under SIP Primary Shop.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Use this Open API to get all vehicle list.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Get the attribute tree for categories
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Query batch task result
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Get boosted item list.
Optionalparams: GetBoostedListRequest
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Get the brand data of a leaf category. More detail please check: https://open.shopee.com/developer-guide/209
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Get category tree data. More detail please check https://open.shopee.com/developer-guide/209
Optionalparams: GetCategoryRequest
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Use this api to get comment by shop_id, item_id, or comment_id, get up to 1000 comments.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
get direct item by main item.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
get recommend price for direct shop.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Use this api to get basic info of item by item_id list.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Get the content quality details (including content quality level, content issues, and system suggestions) for specific product list.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Use this api to get extra info of item by item_id list.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Get item upload control.
Optionalparams: GetItemLimitRequest
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Use this call to get a list of items.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Query the list of products and their content quality details by content quality level or content issues.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Get item promotion info.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
get item violation info
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Get the kit basic information and kit components.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Get the limit of Kit item.
Optionalparams: GetKitItemLimitRequest
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
get main item by direct item.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Get the mapping information between a Mart item and its corresponding outlet item by outlet item ID.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Get the mapping information between a Mart item and its corresponding outlet item by item ID.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Get model list of an item.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Get product certification rule
Optionalparams: GetProductCertificationRuleRequest
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Get recommend attributes.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Get new size chart detail. Now only local shop support to use this api to get new size chart detail.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Get new size chart list. Now only support local shop to use new size chart.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Get the details of an SSP or CSSP. At least one of ssp_id and cssp_id is required, and cssp_id takes priority when both are provided.The response covers the product content such as the category path, attributes, brand and variations. Each entry in cssps is a country-specific SSP under the SSP, and its tier_indices point to the selected options of the parent tier_variation.
Optionalparams: GetSspDetailRequest
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Get the SSP enrollment recommendations of the authorized shop, separating items that can be enrolled automatically from items that may be enrolled after further action.auto_enroll_time is the automatic enrollment time in seconds as a future timestamp, returned for automatic enrollment only.
Optionalparams: GetSspRecommendationRequest
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Get the standardized tier variation defined by Shopee, which is currently a three-layer tree structure. The top layer is variations, the second layer is groups, groups are used to divide options, and the third layer is options.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Use this Open API to get vehicle list by brand, model, year, and version.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Get recommended weight. Now only BR shop support to use this api to get recommended weight.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
This API allows you to update the tier structure of a product. Defining only color creates one tier, while color + size creates two tiers (maximum supported). Supported changes include: no tier ↔ one/two tiers, one tier ↔ two/no tier, and two tiers ↔ one/no tier. For details, see Developer Guide. Please wait at least 5 seconds after creating an item before creating variants, as processing may be delayed.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Link one or more models of an item to their country-specific SSPs. item_id and model_cssp_pairs are required, and each pair must contain model_id and cssp_id; ssp_id is optional.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
This API supports publishing an existing item from the mart shop to an outlet shop.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Use this call to register a brand.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Use this api to reply comments from buyers in batch.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
this api is for searching attribute value list for attribute with support_search_value flag
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Use this call to search item.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Search SSPs by title or by image. At most 50 results are returned.When image_id_list is provided, the search is based on image similarity and title is ignored; otherwise title must contain at least three characters.
Optionalparams: SearchSspListRequest
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Use this API to retrieve Unpackaged SKU ID information for items that toggle on logistics channel 30029.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Remove the SSP links of one or more models of an item. item_id and model_cssp_pairs are required, and each pair must contain model_id and cssp_id; ssp_id is optional.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Unlist item.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Update item.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Update the kit basic information and kit components, only support adding kit variations and updating existing kit variation’s image, price, and model_sku, don’t support deleting existing kit variations and updating the items, main component and quantity per kit of existing kit variations.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Update seller sku/ pre order/ model status for model.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Update price.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Update sip item price.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Use this API to update one item_id for each call, but still can support updating multiple model_ids stock of the same item_id (If you need batch modification, please call multiple times)This API will update only "seller_stock".Whenever there is a promotion ongoing or upcoming, the total stock must be larger than or equal to real-time “reserved_stock” promotion stock (Please check v2.get_item_promotion API for more details). Items that are deleted will not be allowed to modify stock.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
This api can only be used without changing the tier structure, you can add options, delete options, and update the option image by this api. More detail please check: https://open.shopee.com/developer-guide/219
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Add a new item.