Skip to main content

v2.product.get_kit_item_info

GET /api/v2/product/get_kit_item_info

Get the kit basic information and kit components.

Endpoint URL

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

Common Request Parameters

NameTypeSampleDescription
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

Request Parameters

NameTypeRequiredSampleDescription
item_idint64True28001430ID of kit item.

Response Parameters

NameTypeSampleDescription
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
product_infoobject
item_idint6428001430ID of this kit item.
item_namestringitem name sampleThe name of this kit item.
category_idint64[]14646The category of this kit item, sync from the category of the main component of this kit item.
item_statusstringNORMALEnumerated type that defines the current status of the item. Applicable values: NORMAL, BANNED, UNLIST, SELLER_DELETE, SHOPEE_DELETE, REVIEWING.
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.
imagesobjectItem images with 1:1 ratio.
image_id_liststring[]List of image id.
image_url_liststring[]List of image url.
image_ratiostring1:11:1
long_imagesobjectItem images with 3:4 ratio.
image_id_liststring[]List of image id.
image_url_liststring[]List of image url.
image_ratiostring3:43:4
description_infoobjectRich text description field. Only whitelist sellers can use it.
extended_descriptionobjectIf description_type is extended , Description information will be returned through this field.
field_listobject[]Field of extended description.
field_typestringType of extended description field. See Data Definition- description_field_type (text , image).
textstringIf field_type is text, text information will be returned through this field.
image_infoobjectIf field_type is image, image will be returned through this field.
image_idstringImage id.
image_urlstringImage url.
descriptionstringIf description_type is normal, description information will be returned through this field, else description will be empty.
description_typestringType of description : values: See Data Definition- description_type (normal , extended).
video_listobjectInfo of video list.
video_urlstringUrl of video.
thumbnail_urlstringThumbnail of video.
durationint32Duration of video.
attributesobject[]The attributes of this kit item, sync from the attributes of the main component of this kit item.
attribute_idint644811The Identify of each attribute.
original_attribute_namestringBrand: L2 Default [14644]The name of each attribute.
attribute_value_listobject[]
value_idint640Unique identifier for value of this item attribute.
original_value_namestringDefaultValue name of this item attribute.
value_unitstringgValue unit of this item attribute.
weightstring"1.5"The weight of this kit item, the unit is KG.
dimensionobjectThe dimension of this kit item.
package_lengthint3211The length of package for this item, the unit is CM.
package_widthint3211The width of package for this item, the unit is CM.
package_heightint3211The height of package for this item, the unit is CM.
brand_infoobjectThe brand of this kit item, sync from the brand of the main component of this kit item.
brand_idint64Id of brand.
original_brand_namestringOriginal name of brand.
model_listobject[]Model info list, model number at most 9.
model_idint64ID of this kit model.
model_skuint64Seller SKU of this kit model.
original_pricefloatOriginal price of this kit model.
tier_indexint32[]Tier index of this kit model.
component_listobject[]
component_item_idint64ID of the item that composes this kit model.
component_item_namestringName of the item that composes this kit model.
component_model_idint64ID of the model that composes this kit model.
component_model_namestringName of the model that composes this kit model.
quantityint32The amount of the item/model that composes this kit model.
main_componentbooleanWhether this item/model is the main component for this kit.
component_item_or_model_imagestring
component_item_or_model_skustring
pre_order_infoobject
is_pre_orderboolean
days_to_shipint32
tier_variation_listobject[]Variation config of item.
namestringVariation name.
option_listobject[]Option list.
optionstringOption name.
imageobject[]
image_idstringId of image.
image_urlstringUrl of image.