stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.product.get_kit_item_info
Get the kit basic information and kit components.
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Product |
| API type | Shop |
| HTTP method | GET |
| Path | /api/v2/product/get_kit_item_info |
| Production URL | https://partner.shopeemobile.com/api/v2/product/get_kit_item_info |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/product/get_kit_item_info |
| Permission | ERP System; Seller In House System; Product Management; Swam ERP |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| item_id | int64 | Yes | 28001430 | ID of kit item. |
§4 Response parameters
Response parameters
| Name | Type | Required | 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 | |||
| response.product_info | object | |||
| response.product_info.item_id | int64 | 28001430 | ID of this kit item. | |
| response.product_info.item_name | string | item name sample | The name of this kit item. | |
| response.product_info.category_id | int64[] | 14646 | The category of this kit item, sync from the category of the main component of this kit item. | |
| response.product_info.item_status | string | NORMAL | Enumerated type that defines the current status of the item. Applicable values: NORMAL, BANNED, UNLIST, SELLER_DELETE, SHOPEE_DELETE, REVIEWING. | |
| response.product_info.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. | ||
| response.product_info.images | object | Item images with 1:1 ratio. | ||
| response.product_info.images.image_id_list | string[] | List of image id. | ||
| response.product_info.images.image_url_list | string[] | List of image url. | ||
| response.product_info.images.image_ratio | string | 1:1 | 1:1 | |
| response.product_info.long_images | object | Item images with 3:4 ratio. | ||
| response.product_info.long_images.image_id_list | string[] | List of image id. | ||
| response.product_info.long_images.image_url_list | string[] | List of image url. | ||
| response.product_info.long_images.image_ratio | string | 3:4 | 3:4 | |
| response.product_info.description_info | object | Rich text description field. Only whitelist sellers can use it. | ||
| response.product_info.description_info.extended_description | object | If description_type is extended , Description information will be returned through this field. | ||
| response.product_info.description_info.extended_description.field_list | object[] | Field of extended description. | ||
| response.product_info.description_info.extended_description.field_list.field_type | string | Type of extended description field. See Data Definition- description_field_type (text , image). | ||
| response.product_info.description_info.extended_description.field_list.text | string | If field_type is text, text information will be returned through this field. | ||
| response.product_info.description_info.extended_description.field_list.image_info | object | If field_type is image, image will be returned through this field. | ||
| response.product_info.description_info.extended_description.field_list.image_info.image_id | string | Image id. | ||
| response.product_info.description_info.extended_description.field_list.image_info.image_url | string | Image url. | ||
| response.product_info.description | string | If description_type is normal, description information will be returned through this field, else description will be empty. | ||
| response.product_info.description_type | string | Type of description : values: See Data Definition- description_type (normal , extended). | ||
| response.product_info.video_list | object | Info of video list. | ||
| response.product_info.video_list.video_url | string | Url of video. | ||
| response.product_info.video_list.thumbnail_url | string | Thumbnail of video. | ||
| response.product_info.video_list.duration | int32 | Duration of video. | ||
| response.product_info.attributes | object[] | The attributes of this kit item, sync from the attributes of the main component of this kit item. | ||
| response.product_info.attributes.attribute_id | int64 | 4811 | The Identify of each attribute. | |
| response.product_info.attributes.original_attribute_name | string | Brand: L2 Default [14644] | The name of each attribute. | |
| response.product_info.attributes.attribute_value_list | object[] | |||
| response.product_info.attributes.attribute_value_list.value_id | int64 | 0 | Unique identifier for value of this item attribute. | |
| response.product_info.attributes.attribute_value_list.original_value_name | string | Default | Value name of this item attribute. | |
| response.product_info.attributes.attribute_value_list.value_unit | string | g | Value unit of this item attribute. | |
| response.product_info.weight | string | "1.5" | The weight of this kit item, the unit is KG. | |
| response.product_info.dimension | object | The dimension of this kit item. | ||
| response.product_info.dimension.package_length | int32 | 11 | The length of package for this item, the unit is CM. | |
| response.product_info.dimension.package_width | int32 | 11 | The width of package for this item, the unit is CM. | |
| response.product_info.dimension.package_height | int32 | 11 | The height of package for this item, the unit is CM. | |
| response.product_info.brand_info | object | The brand of this kit item, sync from the brand of the main component of this kit item. | ||
| response.product_info.brand_info.brand_id | int64 | Id of brand. | ||
| response.product_info.brand_info.original_brand_name | string | Original name of brand. | ||
| response.product_info.model_list | object[] | Model info list, model number at most 9. | ||
| response.product_info.model_list.model_id | int64 | ID of this kit model. | ||
| response.product_info.model_list.model_sku | int64 | Seller SKU of this kit model. | ||
| response.product_info.model_list.original_price | float | Original price of this kit model. | ||
| response.product_info.model_list.tier_index | int32[] | Tier index of this kit model. | ||
| response.product_info.model_list.component_list | object[] | |||
| response.product_info.model_list.component_list.component_item_id | int64 | ID of the item that composes this kit model. | ||
| response.product_info.model_list.component_list.component_item_name | string | Name of the item that composes this kit model. | ||
| response.product_info.model_list.component_list.component_model_id | int64 | ID of the model that composes this kit model. | ||
| response.product_info.model_list.component_list.component_model_name | string | Name of the model that composes this kit model. | ||
| response.product_info.model_list.component_list.quantity | int32 | The amount of the item/model that composes this kit model. | ||
| response.product_info.model_list.component_list.main_component | boolean | Whether this item/model is the main component for this kit. | ||
| response.product_info.model_list.component_list.component_item_or_model_image | string | |||
| response.product_info.model_list.component_list.component_item_or_model_sku | string | |||
| response.product_info.pre_order_info | object | |||
| response.product_info.pre_order_info.is_pre_order | boolean | |||
| response.product_info.pre_order_info.days_to_ship | int32 | |||
| response.product_info.tier_variation_list | object[] | Variation config of item. | ||
| response.product_info.tier_variation_list.name | string | Variation name. | ||
| response.product_info.tier_variation_list.option_list | object[] | Option list. | ||
| response.product_info.tier_variation_list.option_list.option | string | Option name. | ||
| response.product_info.tier_variation_list.option_list.image | object[] | |||
| response.product_info.tier_variation_list.option_list.image.image_id | string | Id of image. | ||
| response.product_info.tier_variation_list.option_list.image.image_url | string | Url of image. |
§5 Common parameters
Common parameters
| Name | Type | Required | 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 |
§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×tamp=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×tamp=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×tamp=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×tamp=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
| Error | Description | Solution |
|---|---|---|
| error_data | parse data failed | |
| error_data | data not exist | |
| error_param | parameter invalid | |
| error_param | The information you queried is not found. | |
| error_param | Wrong parameters, detail: {msg}. | |
| error_server | Something wrong. Please try later. | |
| error_shop | shopid is invalid | |
| error_param | request not from gateway |
§14 Common errors
Common errors
| Error | Description | Solution |
|---|---|---|
| error_auth | partner_id is invalid | |
| error_auth | The App is deleted, and you'll be unable to make any API call. | |
| error_auth | App 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_param | There is no partner_id in query. | |
| error_param | Invalid partner_id. | |
| error_param | no timestamp | |
| error_param | Invalid timestamp | |
| error_param | There is no sign in query. | |
| error_sign | Wrong sign. | |
| invalid_partner_id | Invalid partner_id, please have a check. | |
| error_auth | No permission to current api. | |
| error_api_call_restricted | The 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_suspended | The API is offline. Please call v2 API instead. | |
| error_limit | The 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_limit | Too many requests. You have reached the rate limit. Please try again later. | |
| source_ip_undeclared | Request Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist | |
| error_param | Permission denied. This API is currently offline or the request path is incorrect. | |
| error_param | Partner_id is invalid, should be an integer between 0 and 4294967295. | |
| error_param | no timestamp. | |
| error_param | Timestamp is invalid, should be an integer between 0 and 4294967295. | |
| error_param | Timestamp is expired. | |
| error_partner_key_expired | Your 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_permission | This app type has no permission to this API. | |
| error_param | There is no access_token in query. | |
| error_auth | Invalid access_token. | |
| error_auth | Invalid partner_id or shopid. | |
| shop_no_linked | Partner and shop has no linked. | |
| shop_banned | The shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored. | |
| invalid_acceess_token | Invalid access_token, please have a check. | |
| partner_shop_no_link | Invalid partner_id or shop_id, please have a check. | |
| error_ashop_api_permission | The shop is Affiliate shop has no permission to call this API. | |
| error_kyc_auth | No permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API. | |
| error_auth | System error, please try again later. | |
| error_param | There is no shop_id in query. | |
| error_param | shop_id is invalid, should be an integer between 0 and 4294967295. |
§15 Update log
Update log
| Date | Change |
|---|---|
| 2024-10-18 | New API |
