v2.product.get_item_base_info

GET /api/v2/product/get_item_base_info

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

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/product/get_item_base_info

Common Request Parameters

Name	Type	Sample	Description
partner_id	int	1	Partner ID is assigned upon registration is successful. Required for all requests.
timestamp	timestamp	1610000000	This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_token	string	c09222e3fc40ffb25fc947f738b1abf1	The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_id	int	600000	Shopee's unique identifier for a shop. Required param for most APIs.
sign	string	e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2	Signature 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

Request Parameters

Name	Type	Required	Sample	Description
item_id_list	int64[]	True	[34001,34002]	item_id list; limit [0,50]
need_tax_info	boolean	False	true	if true will response tax_info
need_complaint_policy	boolean	False	true	if true will response complaint_policy

Response Parameters

Name	Type	Sample	Description
error	string		Indicate error type if hit error. Empty if no error happened.
message	string		Indicate error details if hit error. Empty if no error happened.
warning	string		Indicate waring details if hit waring. Empty if no waring happened.
request_id	string	7b9da0c6926642199c33ee9dd3a266f5	The identifier for an API request for error tracking.
response	object
item_list	object[]
item_id	int64	34002	Shopee's unique identifier for an item.
category_id	int32	14646	Shopee's unique identifier for a category.
item_name	string	seller discount	Name of the item in local language.
description	string	first product 001first product	if description_type is normal , Description information will be returned through this field，else description will be empty
item_sku	string		An 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.
create_time	timestamp	1600572637	Timestamp that indicates the date and time that the item was created.
update_time	timestamp	1600572640	Timestamp that indicates the last time that there was a change in value of the item, such as price/stock change.
attribute_list	object[]
attribute_id	int32	4811	The Identify of each category.
original_attribute_name	string	Brand: L2 Default [14644]	The name of each attribute.
is_mandatory	boolean	true	This is to indicate whether this attribute is mandantory.
attribute_value_list	object[]
value_id	int32	0	Unique identifier for value of this item attribute.
original_value_name	string	Default	Value name of this item attribute.
value_unit	string	g	Value unit of this item attribute.
price_info	object[]		If the item has models, price_info will not be returned. Please get the price of each model through the get_model_list api
currency	string	SGD	The three-digit code representing the currency unit used for the item in Shopee Listings.
original_price	float	122.02	The original price of the item in the listing currency.
current_price	float	122.02	The current price of the item in the listing currency. If product under a onging promotion, current_price will be the promotion price
inflated_price_of_original_price	float	222.02	The After-tax original price of the item in the listing currency.
inflated_price_of_current_price	float	111.02	The After-tax current price of the item in the listing currency.
sip_item_price	float	100.02	The price of the item in sip.If item is for CNSC primary shop, this field will not be returned
sip_item_price_source	string	auto	source of sip' price. ( auto or manual).If item is for CNSC SIP primary shop, this field will not be returned
local_price	float	122.02	The 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.
local_promotion_price	float	122.02	During 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.
image	object
image_url_list	string[]		List of image url.
image_id_list	string[]		List of image id.
image_ratio	string		Image ratio
weight	string	"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.
dimension	object		The dimension of this item. If set the dimension of models under this item, will return the dimension with largest volume calculated by height*length*width during the switching period to ensure system compatibility, please switch to call v2.product.get_model_list to get the dimension of models.
package_length	int32	11	The length of package for this item, the unit is CM.
package_width	int32	12	The width of package for this item, the unit is CM.
package_height	int32	13	The height of package for this item, the unit is CM.
logistic_info	object[]		The logistics list.
logistic_id	int32	80012	The identity of logistic channel.
logistic_name	string		The name of logistic.
enabled	boolean	true	Related to shopee.logistics.GetLogistics result.logistics.enabled only affect current item.
shipping_fee	float	5.02	Only needed when logistics fee_type = CUSTOM_PRICE.
size_id	int32		If specify logistic fee_type is SIZE_SELECTION size_id is required.
is_free	boolean	false	when seller chooses this option, the shipping fee of this channel on item will be set to 0. Default value is False.
estimated_shipping_fee	float	4.02	Estimated shipping fee calculated by weight. Don't exist if channel is no-integrated.
pre_order	object
is_pre_order	boolean	false	Pre-order will be set true.
days_to_ship	int32	3	The days to ship. Only work for pre-orde.
wholesales	object[]		The wholesales tier list.
min_count	int32	1	The min count of this tier wholesale.
max_count	int32	2	The max count of this tier wholesale.
unit_price	float	4.02	The current price of the wholesale in the listing currency.If item is in promotion, this price is useless.
inflated_price_of_unit_price	float	5.02	The After-tax Price of the wholesale show to buyer.
condition	string	NEW/USED	Is it second-hand.
size_chart	string		Url of size chart image.
item_status	string	NORMAL	Enumerated type that defines the current status of the item. Applicable values: NORMAL, BANNED, UNLIST, SELLER_DELETE, SHOPEE_DELETE, REVIEWING.
deboost	boolean	false	If deboost is true, means that the item's search ranking is lowered.
has_model	boolean	false	Does it contain model.
promotion_id	int64	13123	The unique identifier of the promotion applied to the item.
has_promotion	boolean	true	Indicates whether the item is currently under any ongoing promotion.
video_info	object[]		Info of video list.
video_url	string		Url of video.
thumbnail_url	string		Thumbnail of video.
duration	int32		Duration of video.
brand	object
brand_id	int32	123	Id of brand.
original_brand_name	string	nike	Original name of brand.
item_dangerous	int32	0	This 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.
gtin_code	string		gtin 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”
size_chart_id	int64		id of new size chart.
promotion_image	object
image_id_list	string[]		Promotion image
image_url_list	string[]		Promiton image urls
image_ratio	string		Promotion image ratio
compatibility_info	object
vehicle_info_list	object[]
brand_id	int64	1234	ID of the brand.
model_id	int64	2345	ID of the model.
year_id	int64	3456	ID of the year.
version_id	int64	4567	ID of the version.
scheduled_publish_time	timestamp	1733590920	Scheduled publish time of this item.
authorised_brand_id	int64		ID of authorised reseller brand.
ssp_id	int64		Shopee's unique identifier for Shopee Standard Product.
is_fulfillment_by_shopee	boolean		return true if the item only has a default model and it is FBS model
tag	object
kit	boolean		Indicate if the item is kit item.
purchase_limit_info	object		purchase limit info
min_purchase_limit	int32		minimum purchase count for each order
max_purchase_limit	object
purchase_limit	int32		maximum purchase limit for each order
medicine_id	int64		[Only for ID local sellers] as a unique identifier for each standardized medicine.
complaint_policy	object		Complaint policy.Only returned for local PL sellers, and need_complaint_policy in request is true.
warranty_time	string	ONE_YEAR	Time for a warranty claim.Value should be in one of ONE_YEAR TWO_YEARS OVER_TWO_YEARS.
exclude_entrepreneur_warranty	boolean		If True means "I exclude warranty complaints for entrepreneur"
complaint_address_id	int64		The identity of complaint address.
additional_information	string		Additional information for complaint policy
tax_info	object		Tax information
ncm	string		Mercosur 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.
diff_state_cfop	string		Tax 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)
csosn	string		Code 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)
origin	string		Product source, domestic or foreig (BR region)
cest	string		Tax 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.
measure_unit	string		(BR region)
invoice_option	string		Value 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)
vat_rate	string		Value should be one of 0% 5% 8% 23% NO_VAT_RATE (PL region)
hs_code	string		HS Code (Only for IN region)
tax_code	string		Tax Code (Only for IN region)
tax_type	int32		tax_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
pis	string		Only 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
cofins	string		Only 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
icms_cst	string		Only 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.
pis_cofins_cst	string		Only 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.
federal_state_taxes	string		Only for BR shop. Enter the total percentage of the combination of federal, state, and municipal taxes, using up to two decimals.
operation_type	string		Only for BR shop. 1: Retailer 2: Manufacturer
ex_tipi	string		Only 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.
fci_num	string		Only 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.
recopi_num	string		Only 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).
additional_info	string		Only for BR shop. Include relevant information to display on Invoice.
group_item_info	object		Only for BR shop. Required if the item is a group item.
group_qtd	string		Example: The package contains 6 soda cans. Whether you are selling a pack of 6 cans (fardo) or a single can (unit), enter 6.
group_unit	string		Example: 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.
group_unit_value	string		Example: 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.
original_group_price	string		Example: The item is a package that contains 6 soda cans. Enter the price of the whole package.
group_gtin_sscc	string		Example: The item is a package that contains 6 soda cans. Please inform the GTIN SSCC code for the package.
group_grai_gtin_sscc	string		Example: The item is box, that contain 6 packages. Each package contains 6 soda cans. Please inform the GRAI GTIN SSCC code for the Box.
export_cfop	string		7101 - 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
description_info	object		New description field. Only whitelist sellers can use it.
extended_description	object		If description_type is extended , Description information will be returned through this field.
field_list	object[]		Field of extended description
field_type	string		Type of extended description field ：values: See Data Definition- description_field_type (text , image).
text	string		If field_type is text, text information will be returned through this field.
image_info	object		If field_type is image, image url will be returned through this field.
image_id	string		Image id
image_url	string		Image url.
description_type	string		Type of description : values: See Data Definition- description_type (normal , extended).
stock_info_v2	object		new stock object
summary_info	object		stock summary info
total_reserved_stock	int32		Stock 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;
total_available_stock	int32		total available stock
seller_stock	object[]		seller stock
location_id	string		location id
stock	int32		stock in the current warehouse
if_saleable	boolean		To return if the stock of the location id is saleable
shopee_stock	object[]		shopee stock
location_id	string		location id
stock	int32		stock in the current warehouse
advance_stock	object		Only for PH/VN/ID/MY local selected shops.
sellable_advance_stock	int32		Refers to Advance Fulfillment stock that Seller has shipped out and is available to be used to fulfill an order.
in_transit_advance_stock	int32		Refers to Advance Fulfillment stock that seller has shipped out and is still in transit and unavailable to be used to fulfill an order.
certification_info	object		For PH product certification input Required for some category and attribute option
certification_list	object[]		Array of certification records for the product, each containing type, certificate number, permit ID, and proof documents.
permit_id	int32		Permit ID, get from v2.product.get_product_certification_rule
certification_no	string		Certification No.
expiry_date	int32		expiry timestamp
certification_proofs	object[]		An array of proof documents for the certification; each element represents one proof file.
image_id	string		The unique image ID of the certification proof, returned by the image upload API.
ratio	float		image weight/ image height.
file_name	string		The name of the uploaded certification proof file.
image_url	string		The image url of the proof