快工助手跨境电商知识与商机助手

v2.product.get_item_base_info

Shopee 官方资料 · Shopee Open Platform 接口参考 · 适合开发者

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存,可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
Shopee / profile.shopee.api_reference
语言
en-US
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.product.get_item_base_info

Use this api to get basic info of item by item_id list.

#

§2 Overview

Overview

FieldValue
ModuleProduct
API typeShop
HTTP methodGET
Path/api/v2/product/get_item_base_info
Production URLhttps://partner.shopeemobile.com/api/v2/product/get_item_base_info
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/product/get_item_base_info
Rate limit[0, 0, 0]
PermissionERP System; Seller In House System; Product Management; Order Management; Accounting And Finance; Marketing; Customer Service; Brand Membership; Customized APP; Ads Service; Custom APP; Swam ERP; Livestream Management; Ads Facil; Affiliate Marketing Solution Management; Shopee Video Management
#

§3 Request parameters

Request parameters

NameTypeRequiredSampleDescription
item_id_listint64[]Yes[34001,34002]item_id list; limit [0,50]
need_tax_infobooleanNotrueif true will response tax_info
need_complaint_policybooleanNotrueif true will response complaint_policy
#

§4 Response parameters

Response parameters

NameTypeRequiredSampleDescription
errorstringIndicate error type if hit error. Empty if no error happened.
messagestringIndicate error details if hit error. Empty if no error happened.
warningstringIndicate waring details if hit waring. Empty if no waring happened.
request_idstring7b9da0c6926642199c33ee9dd3a266f5The identifier for an API request for error tracking.
responseobject
response.item_listobject[]
response.item_list.item_idint6434002Shopee's unique identifier for an item.
response.item_list.category_idint3214646Shopee's unique identifier for a category.
response.item_list.item_namestringseller discountName of the item in local language.
response.item_list.descriptionstringfirst product 001first productif description_type is normal , Description information will be returned through this field,else description will be empty
response.item_list.item_skustringAn item SKU (stock keeping unit) is an identifier defined by a seller, sometimes called parent SKU. Item SKU can be assigned to an item in Shopee Listings.
response.item_list.create_timetimestamp1600572637Timestamp that indicates the date and time that the item was created.
response.item_list.update_timetimestamp1600572640Timestamp that indicates the last time that there was a change in value of the item, such as price/stock change.
response.item_list.attribute_listobject[]
response.item_list.attribute_list.attribute_idint324811The Identify of each category.
response.item_list.attribute_list.original_attribute_namestringBrand: L2 Default [14644]The name of each attribute.
response.item_list.attribute_list.is_mandatorybooleantrueThis is to indicate whether this attribute is mandantory.
response.item_list.attribute_list.attribute_value_listobject[]
response.item_list.attribute_list.attribute_value_list.value_idint320Unique identifier for value of this item attribute.
response.item_list.attribute_list.attribute_value_list.original_value_namestringDefaultValue name of this item attribute.
response.item_list.attribute_list.attribute_value_list.value_unitstringgValue unit of this item attribute.
response.item_list.price_infoobject[]If the item has models, price_info will not be returned. Please get the price of each model through the get_model_list api
response.item_list.price_info.currencystringSGDThe three-digit code representing the currency unit used for the item in Shopee Listings.
response.item_list.price_info.original_pricefloat122.02The original price of the item in the listing currency.
response.item_list.price_info.current_pricefloat122.02The current price of the item in the listing currency. If product under a onging promotion, current_price will be the promotion price
response.item_list.price_info.inflated_price_of_original_pricefloat222.02The After-tax original price of the item in the listing currency.
response.item_list.price_info.inflated_price_of_current_pricefloat111.02The After-tax current price of the item in the listing currency.
response.item_list.price_info.sip_item_pricefloat100.02The price of the item in sip.If item is for CNSC primary shop, this field will not be returned
response.item_list.price_info.sip_item_price_sourcestringautosource of sip' price. ( auto or manual).If item is for CNSC SIP primary shop, this field will not be returned
response.item_list.price_info.local_pricefloat122.02The original price multiplied by the local adjustment rate equals the local price. The local price is denominated in the local currency and is rounded to two decimal places.
response.item_list.price_info.local_promotion_pricefloat122.02During the promotion period, the CB price is multiplied by the local adjustment rate. Once the promotion starts, the price remains unchanged. During the promotion, the local_promotion_price= current_price, which is denominated in the local currency and retained to two decimal places.
response.item_list.imageobject
response.item_list.image.image_url_liststring[]List of image url.
response.item_list.image.image_id_liststring[]List of image id.
response.item_list.image.image_ratiostringImage ratio
response.item_list.weightstring"10.02"The weight of this item, the unit is KG.; If set the weight of models under this item, will return the max weight of all models during the switching period to ensure system compatibility, please switch to call v2.product.get_model_list to get the weight of models.
response.item_list.dimensionobjectThe dimension of this item.; If set the dimension of models under this item, will return the dimension with largest volume calculated by heightlengthwidth during the switching period to ensure system compatibility, please switch to call v2.product.get_model_list to get the dimension of models.
response.item_list.dimension.package_lengthint3211The length of package for this item, the unit is CM.
response.item_list.dimension.package_widthint3212The width of package for this item, the unit is CM.
response.item_list.dimension.package_heightint3213The height of package for this item, the unit is CM.
response.item_list.logistic_infoobject[]The logistics list.
response.item_list.logistic_info.logistic_idint3280012The identity of logistic channel.
response.item_list.logistic_info.logistic_namestringThe name of logistic.
response.item_list.logistic_info.enabledbooleantrueRelated to shopee.logistics.GetLogistics result.logistics.enabled only affect current item.
response.item_list.logistic_info.shipping_feefloat5.02Only needed when logistics fee_type = CUSTOM_PRICE.
response.item_list.logistic_info.size_idint32If specify logistic fee_type is SIZE_SELECTION size_id is required.
response.item_list.logistic_info.is_freebooleanfalsewhen seller chooses this option, the shipping fee of this channel on item will be set to 0. Default value is False.
response.item_list.logistic_info.estimated_shipping_feefloat4.02Estimated shipping fee calculated by weight. Don't exist if channel is no-integrated.
response.item_list.pre_orderobject
response.item_list.pre_order.is_pre_orderbooleanfalsePre-order will be set true.
response.item_list.pre_order.days_to_shipint323The days to ship. Only work for pre-orde.
response.item_list.wholesalesobject[]The wholesales tier list.
response.item_list.wholesales.min_countint321The min count of this tier wholesale.
response.item_list.wholesales.max_countint322The max count of this tier wholesale.
response.item_list.wholesales.unit_pricefloat4.02The current price of the wholesale in the listing currency.If item is in promotion, this price is useless.
response.item_list.wholesales.inflated_price_of_unit_pricefloat5.02The After-tax Price of the wholesale show to buyer.
response.item_list.conditionstringNEW/USEDIs it second-hand.
response.item_list.size_chartstringUrl of size chart image.
response.item_list.item_statusstringNORMALEnumerated type that defines the current status of the item. Applicable values: NORMAL, BANNED, UNLIST, SELLER_DELETE, SHOPEE_DELETE, REVIEWING.
response.item_list.deboostbooleanfalseIf deboost is true, means that the item's search ranking is lowered.
response.item_list.has_modelbooleanfalseDoes it contain model.
response.item_list.has_promotionbooleantrueIndicates whether the item is currently under any ongoing promotion.
response.item_list.video_infoobject[]Info of video list.
response.item_list.video_info.video_urlstringUrl of video.
response.item_list.video_info.thumbnail_urlstringThumbnail of video.
response.item_list.video_info.durationint32Duration of video.
response.item_list.brandobject
response.item_list.brand.brand_idint32123Id of brand.
response.item_list.brand.original_brand_namestringnikeOriginal name of brand.
response.item_list.item_dangerousint320This field is only applicable for local sellers in Indonesia and Malaysia. Use this field to identify whether a product is a dangerous product. 0 for non-dangerous product and 1 for dangerous product. For more information, please visit the market's respective Seller Education Hub.
response.item_list.gtin_codestringgtin code for br region, will return this code only item has default model; Note: gtin_code = "00" means that this item is “Item without GTIN”
response.item_list.size_chart_idint64id of new size chart.
response.item_list.promotion_imageobject
response.item_list.promotion_image.image_id_liststring[]Promotion image
response.item_list.promotion_image.image_url_liststring[]Promiton image urls
response.item_list.promotion_image.image_ratiostringPromotion image ratio
response.item_list.compatibility_infoobject
response.item_list.compatibility_info.vehicle_info_listobject[]
response.item_list.compatibility_info.vehicle_info_list.brand_idint641234ID of the brand.
response.item_list.compatibility_info.vehicle_info_list.model_idint642345ID of the model.
response.item_list.compatibility_info.vehicle_info_list.year_idint643456ID of the year.
response.item_list.compatibility_info.vehicle_info_list.version_idint644567ID of the version.
response.item_list.scheduled_publish_timetimestamp1733590920Scheduled publish time of this item.
response.item_list.authorised_brand_idint64ID of authorised reseller brand.
response.item_list.ssp_idint64Shopee's unique identifier for Shopee Standard Product.
response.item_list.is_fulfillment_by_shopeebooleanreturn true if the item only has a default model and it is FBS model
response.item_list.tagobject
response.item_list.tag.kitbooleanIndicate if the item is kit item.
response.item_list.purchase_limit_infoobjectpurchase limit info
response.item_list.purchase_limit_info.min_purchase_limitint32minimum purchase count for each order
response.item_list.purchase_limit_info.max_purchase_limitobject
response.item_list.purchase_limit_info.max_purchase_limit.purchase_limitint32maximum purchase limit for each order
response.item_list.medicine_idint64[Only for ID local sellers] as a unique identifier for each standardized medicine.
response.item_list.certification_infoobjectFor PH product certification input Required for some category and attribute option
response.item_list.certification_info.certification_listobject[]Array of certification records for the product, each containing type, certificate number, permit ID, and proof documents.
response.item_list.certification_info.certification_list.permit_idint32Permit ID, get from v2.product.get_product_certification_rule
response.item_list.certification_info.certification_list.certification_nostringCertification No.
response.item_list.certification_info.certification_list.expiry_dateint32expiry timestamp
response.item_list.certification_info.certification_list.certification_proofsobject[]An array of proof documents for the certification; each element represents one proof file.
response.item_list.certification_info.certification_list.certification_proofs.image_idstringThe unique image ID of the certification proof, returned by the image upload API.
response.item_list.certification_info.certification_list.certification_proofs.ratiofloatimage weight/ image height.
response.item_list.certification_info.certification_list.certification_proofs.file_namestringThe name of the uploaded certification proof file.
response.item_list.certification_info.certification_list.certification_proofs.image_urlstringThe image url of the proof
response.complaint_policyobjectComplaint policy.Only returned for local PL sellers, and need_complaint_policy in request is true.
response.complaint_policy.warranty_timestringONE_YEARTime for a warranty claim.Value should be in one of ONE_YEAR TWO_YEARS OVER_TWO_YEARS.
response.complaint_policy.exclude_entrepreneur_warrantybooleanIf True means "I exclude warranty complaints for entrepreneur"
response.complaint_policy.complaint_address_idint64The identity of complaint address.
response.complaint_policy.additional_informationstringAdditional information for complaint policy
response.tax_infoobjectTax information
response.tax_info.ncmstringMercosur Common Nomenclature, it is a convention between Mercosur member countries to easily recognize goods, services and productive factors negotiated among themselves.(BR region); Note: ncm = "00" means that this item doesn't have a NCM.
response.tax_info.diff_state_cfopstringTax Code of Operations and Installments for orders that seller and buyer are in different states. It identifies a specific operation by category at the time of issuing the invoice. (BR region)
response.tax_info.csosnstringCode of Operation Status – Simples Nacional, code for company operations to identify the origin of the goods and the taxation regime of the operations. (BR region)
response.tax_info.originstringProduct source, domestic or foreig (BR region)
response.tax_info.ceststringTax Replacement Specifying Code (CEST), to separate within the same NCM products that do or do not have ICMS tax substitution. (BR region); Note: cest = "00" means that this item doesn't have a CEST.
response.tax_info.measure_unitstring(BR region)
response.tax_info.invoice_optionstringValue shuold be one of NO_INVOICES VAT_MARGIN_SCHEME_INVOICES VAT_INVOICES NON_VAT_INVOICES and if value is NON_VAT_INVOICE vat_rate should be null (PL region)
response.tax_info.vat_ratestringValue should be one of 0% 5% 8% 23% NO_VAT_RATE (PL region)
response.tax_info.hs_codestringHS Code (Only for IN region)
response.tax_info.tax_codestringTax Code (Only for IN region)
response.tax_info.tax_typeint32tax_type only for TW whitelist shop. Shopee will referred Tax type when substitute sellers for issuing e-receipts to buyers. All variations share the same tax type. The meaning of value: 0: no tax type; 1: tax-able; 2: tax-free
response.tax_info.pisstringOnly for BR shop.; PIS - Programa de Integração Social (Social Integration Program). It is a government tax to collect resources for the payment of unemployment insurance and other employee related rights.; PIS % - the tax applied to this product
response.tax_info.cofinsstringOnly for BR shop.; COFINS – Contribuição para Financiamento da Seguridade Social (Contribution for Social Security Funding). It is a government tax to collect resources for public health system and social security.; COFINS % - the tax applied to this product
response.tax_info.icms_cststringOnly for BR shop.; ICMS - Imposto sobre Circulação de Mercadorias e Serviços (Circulation of Goods and Services Tax).; CST - Código da Situação Tributária (Tax Situation Code) is represented by a combination of 3 numbers with the purpose of demonstrating the origin of a product and determining the form of taxation that will apply to it. Therefore, each digit in the CST Table has a specific meaning: the first digit indicates the origin of the operation, the second digit represents the ICMS taxation on the operation and the third digit provides additional information about the form of taxation.
response.tax_info.pis_cofins_cststringOnly for BR shop.; The CST PIS/Cofins is a code on the Electronic Invoice (NF-e) that identifies the tax situation of PIS (Programa de Integração Social) and Cofins (Contribuição para o Financiamento da Seguridade Social) in sales of goods.
response.tax_info.federal_state_taxesstringOnly for BR shop.; Enter the total percentage of the combination of federal, state, and municipal taxes, using up to two decimals.
response.tax_info.operation_typestringOnly for BR shop.; 1: Retailer; 2: Manufacturer
response.tax_info.ex_tipistringOnly for BR shop.; The EXTIPI field in the NF-e (Nota Fiscal Eletrônica) is used to indicate if there's an exception to the IPI (Imposto sobre Produtos Industrializados) tax rate for a specific product.
response.tax_info.fci_numstringOnly for BR shop.; The FCI Control Number is a unique identifier assigned to each import FCI (Import Content Form). It's mandatory on the corresponding NF-e (electronic invoice) to ensure compliance with Brazilian import tax regulations.
response.tax_info.recopi_numstringOnly for BR shop.; RECOPI NACIONAL is a Brazilian government system that facilitates the registration and management of tax-exempt operations involving paper destined for printing books, newspapers, and periodicals (known as "papel imune" in Portuguese).
response.tax_info.additional_infostringOnly for BR shop.; Include relevant information to display on Invoice.
response.tax_info.group_item_infoobjectOnly for BR shop.; Required if the item is a group item.
response.tax_info.group_item_info.group_qtdstringExample: The package contains 6 soda cans. Whether you are selling a pack of 6 cans (fardo) or a single can (unit), enter 6.
response.tax_info.group_item_info.group_unitstringExample: The package contains 6 soda cans. Whether you are selling a pack of 6 cans (fardo) or a single can (unit), enter UNI for the individual can.
response.tax_info.group_item_info.group_unit_valuestringExample: The package contains 6 soda cans. Whether you are selling a pack of 6 cans (fardo) or a single can (unity), enter the value of the individual can.
response.tax_info.group_item_info.original_group_pricestringExample: The item is a package that contains 6 soda cans. Enter the price of the whole package.
response.tax_info.group_item_info.group_gtin_ssccstringExample: The item is a package that contains 6 soda cans. Please inform the GTIN SSCC code for the package.
response.tax_info.group_item_info.group_grai_gtin_ssccstringExample: The item is box, that contain 6 packages. Each package contains 6 soda cans. Please inform the GRAI GTIN SSCC code for the Box.
response.tax_info.export_cfopstring7101 - for sales of self-produced goods; 7102 - resale of third-party goods; a tax code used in Brazil to classify and identify the nature of goods or services transactions for tax purposes. This is used for goods export to other counties
response.description_infoobjectNew description field. Only whitelist sellers can use it.
response.description_info.extended_descriptionobjectIf description_type is extended , Description information will be returned through this field.
response.description_info.extended_description.field_listobject[]Field of extended description
response.description_info.extended_description.field_list.field_typestringType of extended description field :values: See Data Definition- description_field_type (text , image).
response.description_info.extended_description.field_list.textstringIf field_type is text, text information will be returned through this field.
response.description_info.extended_description.field_list.image_infoobjectIf field_type is image, image url will be returned through this field.
response.description_info.extended_description.field_list.image_info.image_idstringImage id
response.description_info.extended_description.field_list.image_info.image_urlstringImage url.
response.description_typestringType of description : values: See Data Definition- description_type (normal , extended).
response.stock_info_v2objectnew stock object
response.stock_info_v2.summary_infoobjectstock summary info
response.stock_info_v2.summary_info.total_reserved_stockint32Stock reserved for promotion.; Note: For SIP P Item, will return the total reserved stock for P Item and all A Items under the P Item;
response.stock_info_v2.summary_info.total_available_stockint32total available stock
response.stock_info_v2.seller_stockobject[]seller stock
response.stock_info_v2.seller_stock.location_idstringlocation id
response.stock_info_v2.seller_stock.stockint32stock in the current warehouse
response.stock_info_v2.seller_stock.if_saleablebooleanTo return if the stock of the location id is saleable
response.stock_info_v2.shopee_stockobject[]shopee stock
response.stock_info_v2.shopee_stock.location_idstringlocation id
response.stock_info_v2.shopee_stock.stockint32stock in the current warehouse
response.stock_info_v2.advance_stockobjectOnly for PH/VN/ID/MY local selected shops.
response.stock_info_v2.advance_stock.sellable_advance_stockint32Refers to Advance Fulfillment stock that Seller has shipped out and is available to be used to fulfill an order.
response.stock_info_v2.advance_stock.in_transit_advance_stockint32Refers to Advance Fulfillment stock that seller has shipped out and is still in transit and unavailable to be used to fulfill an order.
#

§5 Common parameters

Common parameters

NameTypeRequiredSampleDescription
partner_idint1Partner ID is assigned upon registration is successful. Required for all requests.
timestamptimestamp1610000000This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_tokenstringc09222e3fc40ffb25fc947f738b1abf1The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_idint600000Shopee's unique identifier for a shop. Required param for most APIs.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2
#

§6 Request samples

Request samples

#

§7 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/product/get_item_base_info?timestamp=timestamp&sign=sign&shop_id=shop_id&need_tax_info=true&item_id_list=[34001 34002]&partner_id=partner_id&need_complaint_policy=true&access_token=access_token")
.asString();
#

§8 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/product/get_item_base_info?access_token=access_token&item_id_list=%5B34001+34002%5D&need_complaint_policy=true&need_tax_info=true&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
#

§9 cURL

cURL

curl --location --request GET 'https://partner.shopeemobile.com/api/v2/product/get_item_base_info?partner_id=partner_id&need_complaint_policy=true&access_token=access_token&timestamp=timestamp&sign=sign&shop_id=shop_id&need_tax_info=true&item_id_list=[34001,34002]' 
#

§10 Python

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/product/get_item_base_info?access_token=access_token&item_id_list=%5B34001+34002%5D&need_complaint_policy=true&need_tax_info=true&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload={}
headers = {

}
response = requests.request("GET",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)
#

§11 Response sample

Response sample

#

§12 JSON

JSON

{
    "error": "-",
    "message": "-",
    "warning": "-",
    "request_id": "7b9da0c6926642199c33ee9dd3a266f5",
    "response": {
        "item_list": [
            {
                "item_id": 34002,
                "category_id": 14646,
                "item_name": "seller discount",
                "description": "first product 001first product",
                "item_sku": "-",
                "create_time": 1600572637,
                "update_time": 1600572640,
                "attribute_list": [
                    {
                        "attribute_id": 4811,
                        "original_attribute_name": "Brand: L2 Default [14644]",
                        "is_mandatory": true,
                        "attribute_value_list": [
                            {
                                "value_id": 0,
                                "original_value_name": "Default",
                                "value_unit": "g"
                            }
                        ]
                    }
                ],
                "price_info": [
                    {
                        "currency": "SGD",
                        "original_price": 122.02,
                        "current_price": 122.02,
                        "inflated_price_of_original_price": 222.02,
                        "inflated_price_of_current_price": 111.02,
                        "sip_item_price": 100.02,
                        "sip_item_price_source": "auto"
                    }
                ],
                "image": {
                    "image_url_list": [
                        "-"
                    ],
                    "image_id_list": [
                        "-"
                    ]
                },
                "weight": "10.02",
                "dimension": {
                    "package_length": 11,
                    "package_width": 12,
                    "package_height": 13
                },
                "logistic_info": [
                    {
                        "logistic_id": 80012,
                        "logistic_name": "-",
                        "enabled": true,
                        "shipping_fee": 5.02,
                        "size_id": 0,
                        "is_free": true,
                        "estimated_shipping_fee": 4.02
                    }
                ],
                "pre_order": {
                    "is_pre_order": true,
                    "days_to_ship": 3
                },
                "wholesales": [
                    {
                        "min_count": 1,
                        "max_count": 2,
                        "unit_price": 4.02,
                        "inflated_price_of_unit_price": 5.02
                    }
                ],
                "condition": "NEW/USED",
                "size_chart": "-",
                "item_status": "NORMAL",
                "deboost": "false",
                "has_model": true,
                "promotion_id": 13123,
                "video_info": [
                    {
                        "video_url": "-",
                        "thumbnail_url": "-",
                        "duration": 0
                    }
                ],
                "brand": {
                    "brand_id": 123,
                    "original_brand_name": "nike"
                },
                "item_dangerous": 0,
                "complaint_policy": {
                    "warranty_time": " ONE_YEAR",
                    "exclude_entrepreneur_warranty": true,
                    "complaint_address_id": 0,
                    "additional_information": "-"
                },
                "tax_info": {
                    "ncm": "-",
                    "diff_state_cfop": "-",
                    "csosn": "-",
                    "origin": "-",
                    "cest": "-",
                    "measure_unit": "-",
                    "invoice_option": "-",
                    "vat_rate": "-",
                    "hs_code": "-",
                    "tax_code": "-"
                },
                "description_info": {
                    "extended_description": {
                        "field_list": [
                            {
                                "field_type": "-",
                                "text": "-",
                                "image_info": {
                                    "image_id": "-",
                                    "image_url": "-"
                                }
                            }
                        ]
                    }
                },
                "description_type": "-",
                "stock_info_v2": {
                    "summary_info": {
                        "total_reserved_stock": 100,
                        "total_available_stock": 100
                    },
                    "seller_stock": [
                        {
                            "location_id": "-",
                            "stock": 10
                        }
                    ],
                    "shopee_stock": [
                        {
                            "location_id": "-",
                            "stock": 0
                        }
                    ]
                }
            }
        ]
    }
}
#

§13 Errors

Errors

ErrorDescriptionSolution
error_networkInner http call failed
error_dataparse data failed
error_datadata not exist
error_paramparameter invalid
error_paramThe information you queried is not found.
error_paramWrong parameters, detail: {msg}.
error_serverSomething wrong. Please try later.
error_shopshopid is invalid
error_paramrequest not from gateway
error_item_not_foundItem_id is not found.
error_param_shop_id_not_foundShop_id is not found.
error_invalid_languageInvalid language.
error_get_shop_failGet shop failed. please try later.
error_innerOur system is taking some time to respond, please try later.
error_innerSystem error, please try again later or contact the OpenAPI support team.
error_item_not_foundProduct not found
error_innerUpdate item failed {{.error_info}}
error_innerUpdate item failed {{.error_info}}
error_innerSystem error, please try again later or contact the OpenAPI support team.
error_innerSystem error, please try again later or contact the OpenAPI support team.
error_desc_image_no_pass{{.error_info}}
error_desc_image_no_pass{{.error_info}}
error_desc_image_no_pass{{.error_info}}
error_desc_image_no_pass{{.error_info}}
error_authThe location_id input is not matched the shop's location_id(more/wrong). Please double check.
error_authLack of location_id, please double check.
error_authPlease wait for the holiday mode set then to edit item. Please try later.
error_authTotal stock must be more than reserved stock.
error_param{{.error_info}}
error_authYour shop can not use model level dts
error_param{{.error_info}}
error_authYou do not have right to use seller location_id, please only fill seller_stock filed.
error_desc_image_no_pass{{.error_info}}
error_desc_image_no_pass{{.error_info}}
error_desc_image_no_pass{{.error_info}}
error_desc_image_no_pass{{.error_info}}
error_param{{.error_info}}
error.paramCan not update item with stock less than reserved stock
error_paramCan not update item with different stock structure. Can only update seller stock with location id when existing seller stock have location id. Can only update seller stock without location id when existing seller stock without location id.
error_paramCan not update item with stock less than reserve stock
error_authStock should be larger than reserved stock.
error_system_busyOur system is taking some time to respond, please try later.
error_paramCan not update item with different stock structure. Can only update seller stock with location id when existing seller stock have location id. Can only update seller stock without location id when existing seller stock without location id.
error_slash_price_loadFailed to load slash price.
error_query_over_itemid_sizeInteral error, please contact openapi team.
error_query_condition_list_limitInteral error, please contact openapi team.
error_query_query_limit_too_largeInteral error, please contact openapi team.
#

§14 Common errors

Common errors

ErrorDescriptionSolution
error_authpartner_id is invalid
error_authThe App is deleted, and you'll be unable to make any API call.
error_authApp developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
error_paramThere is no partner_id in query.
error_paramInvalid partner_id.
error_paramno timestamp
error_paramInvalid timestamp
error_paramThere is no sign in query.
error_signWrong sign.
invalid_partner_idInvalid partner_id, please have a check.
error_authNo permission to current api.
error_api_call_restrictedThe App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
api_suspendedThe API is offline. Please call v2 API instead.
error_limitThe total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00)
error_rate_limitToo many requests. You have reached the rate limit. Please try again later.
source_ip_undeclaredRequest Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_paramPermission denied. This API is currently offline or the request path is incorrect.
error_paramPartner_id is invalid, should be an integer between 0 and 4294967295.
error_paramno timestamp.
error_paramTimestamp is invalid, should be an integer between 0 and 4294967295.
error_paramTimestamp is expired.
error_partner_key_expiredYour API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api.
error_api_permissionThis app type has no permission to this API.
error_paramThere is no access_token in query.
error_authInvalid access_token.
error_authInvalid partner_id or shopid.
shop_no_linkedPartner and shop has no linked.
shop_bannedThe shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_tokenInvalid access_token, please have a check.
partner_shop_no_linkInvalid partner_id or shop_id, please have a check.
error_ashop_api_permissionThe shop is Affiliate shop has no permission to call this API.
error_kyc_authNo permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_authSystem error, please try again later.
error_paramThere is no shop_id in query.
error_paramshop_id is invalid, should be an integer between 0 and 4294967295.
#

§15 Update log

Update log

DateChange
2026-04-03remove promotion_id
2026-03-13add new response field "medicine_id"
2025-11-17add new response field "purchase_limit_info"
2025-11-07add new response field "has_promotion"
2025-08-22add new response field "image_url" under "certification_proofs"
#