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

v2.product.get_kit_item_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_kit_item_info

Get the kit basic information and kit components.

#

§2 Overview

Overview

FieldValue
ModuleProduct
API typeShop
HTTP methodGET
Path/api/v2/product/get_kit_item_info
Production URLhttps://partner.shopeemobile.com/api/v2/product/get_kit_item_info
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/product/get_kit_item_info
PermissionERP System; Seller In House System; Product Management; Swam ERP
#

§3 Request parameters

Request parameters

NameTypeRequiredSampleDescription
item_idint64Yes28001430ID of kit item.
#

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

§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_kit_item_info?access_token=access_token&item_id=28001430&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp")
.asString();
#

§8 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/product/get_kit_item_info?access_token=access_token&item_id=28001430&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_kit_item_info?access_token=access_token&item_id=28001430&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp' 
#

§10 Python

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/product/get_kit_item_info?access_token=access_token&item_id=28001430&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload={}
headers = {

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

print(response.text)
#

§11 Response sample

Response sample

#

§12 JSON

JSON

{
    "error": "",
    "message": "",
    "request_id": "04af1e367f32142ecc4cf9be502b6141",
    "response": {
        "product_info": {
            "attributes": [],
            "brand_info": {
                "brand_id": 0,
                "original_brand_name": "No brand"
            },
            "category_id": 107290,
            "create_time": 1725439928,
            "description_info": {
                "extended_description": {
                    "field_list": [
                        {
                            "field_type": "text",
                            "text": "item description sample"
                        }
                    ]
                }
            },
            "description_type": "extended",
            "dimension": {
                "package_height": 10,
                "package_length": 10,
                "package_width": 10
            },
            "image": {
                "image_id_list": [
                    "br-11134207-7r98o-lzri4neb5vcv18",
                    "br-11134207-7r98o-lzri4neb0933bc",
                    "br-11134207-7r98o-lzri4neba3275b"
                ],
                "image_ratio": "1:1",
                "image_url_list": [
                    "https://cf.shopee.com.br/file/br-11134207-7r98o-lzri4neb5vcv18",
                    "https://cf.shopee.com.br/file/br-11134207-7r98o-lzri4neb0933bc",
                    "https://cf.shopee.com.br/file/br-11134207-7r98o-lzri4neba3275b"
                ]
            },
            "item_id": 885138291,
            "item_name": "item name sample",
            "item_sku": "item sku sample",
            "item_status": "NORMAL",
            "logistic_info": [
                {
                    "enabled": true,
                    "is_free": false,
                    "logistic_id": 90003,
                    "logistic_name": "Correios",
                    "size_id": 0
                }
            ],
            "model_list": [
                {
                    "component_list": [
                        {
                            "component_item_id": 892571386,
                            "component_item_name": "test item 1",
                            "component_model_id": 18500720947,
                            "component_model_name": "test model 1",
                            "component_item_or_model_image": "br-11134207-7r98o-lzr1wsi9uadba5",
                            "component_item_or_model_sku": "test item 1",
                            "main_component": false,
                            "quantity": 3
                        },
                        {
                            "component_item_id": 892571385,
                            "component_item_name": "test item 2",
                            "component_model_id": 18500720944,
                            "component_model_name": "test model 2",
                            "component_item_or_model_image": "br-11134207-7r98o-lzr1lyf8hji786",
                            "component_item_or_model_sku": "test item 2",
                            "main_component": false,
                            "quantity": 2
                        }
                    ],
                    "model_id": 19250366170,
                    "model_sku": "",
                    "original_price": 14,
                    "tier_index": [
                        0
                    ]
                },
                {
                    "component_list": [
                        {
                            "component_item_id": 892571386,
                            "component_item_name": "test item 3",
                            "component_model_id": 18500720950,
                            "component_model_name": "test model 3",
                            "component_item_or_model_image": "br-11134207-7r98o-lzr1wsi9uadba5",
                            "component_item_or_model_sku": "test item 3",
                            "main_component": true,
                            "quantity": 1
                        },
                        {
                            "component_item_id": 892571385,
                            "component_item_name": "test item 4",
                            "component_model_id": 18500720943,
                            "component_model_name": "test model 4",
                            "component_item_or_model_image": "br-11134207-7r98o-lzr1lyf8hji786",
                            "component_item_or_model_sku": "test item 4",
                            "main_component": false,
                            "quantity": 2
                        }
                    ],
                    "model_id": 19250366171,
                    "model_sku": "",
                    "original_price": 12,
                    "tier_index": [
                        1
                    ]
                }
            ],
            "pre_order_info": {
                "days_to_ship": 2,
                "is_pre_order": false
            },
            "sync_setting": {
                "auto_sync_dts": false
            },
            "tier_variation_list": [
                {
                    "name": "variation name sample",
                    "option_list": [
                        {
                            "option": "Kit Variation 1"
                        },
                        {
                            "option": "Kit Variation 2"
                        }
                    ]
                }
            ],
            "update_time": 1725881434,
            "video_list": [],
            "weight": "1.5"
        }
    }
}
#

§13 Errors

Errors

ErrorDescriptionSolution
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
#

§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
2024-10-18New API
#