stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.product.get_kit_item_limit
Get the limit of Kit item.
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Product |
| API type | Shop |
| HTTP method | GET |
| Path | /api/v2/product/get_kit_item_limit |
| Production URL | https://partner.shopeemobile.com/api/v2/product/get_kit_item_limit |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/product/get_kit_item_limit |
| Permission | ERP System; Seller In House System; Product Management; Swam ERP |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| category_id | int64 | No | 400055 | Shopee's unique identifier for a category. |
§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 | success | Indicate error details if hit error. Empty if no error happened. | |
| warning | string | Warning message. | ||
| request_id | string | 28ad0434c6954963a2a6d6ed7195554d | The identifier for an API request for error tracking. | |
| response | object | |||
| response.price_limit | object | |||
| response.price_limit.min_limit | float | 5.5 | Item price max limit. | |
| response.price_limit.max_limit | float | 10000000.0 | Item price min limit. | |
| response.item_name_length_limit | object | |||
| response.item_name_length_limit.min_limit | int64 | 5 | Item name length min limit. | |
| response.item_name_length_limit.max_limit | int64 | 99 | Item name length max limit. | |
| response.item_image_count_limit | object | |||
| response.item_image_count_limit.min_limit | int64 | 1 | Item image count min limit. | |
| response.item_image_count_limit.max_limit | int64 | 10 | Item image count max limit. | |
| response.description_limit | object | |||
| response.description_limit.description_length_min | int64 | 10 | Item description length min limit. | |
| response.description_limit.description_length_max | int64 | 499 | length max limit for item extended description text part. | |
| response.description_limit.description_text_length_min | int64 | 10 | length min limit for item extended description text part, when one of the minimum limits for image and text is reached, the item can be added or updated successfully. | |
| response.description_limit.description_text_length_max | int64 | 499 | length max limit for item extended description text part | |
| response.description_limit.description_image_num_min | int64 | 1 | length min limit for item extended description image num, when one of the minimum limits for image and text is reached, the item can be added or updated successfully. | |
| response.description_limit.description_image_num_max | int64 | 5 | length max limit for item extended description image num. | |
| response.description_limit.description_image_width_min | int64 | 1 | length min limit for item extended description image width. | |
| response.description_limit.description_image_height_min | int64 | 1 | length min limit for item extended description image hight. | |
| response.description_limit.description_image_aspect_ratio_min | float | 0.5 | length min limit for item extended description image aspect ( aspect_ratio= image width / image hight ). | |
| response.description_limit.description_image_aspect_ratio_max | float | 32.0 | length max limit for item extended description image aspect ( aspect_ratio= image width / image hight ). | |
| response.tier_variation_name_length_limit | object | |||
| response.tier_variation_name_length_limit.min_limit | int32 | 1 | Item tier variation name length min limit. | |
| response.tier_variation_name_length_limit.max_limit | int32 | 50 | Item tier variation name length max limit. | |
| response.tier_variation_option_length_limit | object | |||
| response.tier_variation_option_length_limit.min_limit | int32 | 1 | Item tier variation option length min limit. | |
| response.tier_variation_option_length_limit.max_limit | int32 | 50 | Item tier variation option length max limit. | |
| response.weight_limit | object | |||
| response.weight_limit.weight_mandatory | boolean | true | Whether weight is mandatory or not for the category. | |
| response.dimension_limit | object | |||
| response.dimension_limit.dimension_mandatory | boolean | true | Whether dimension is mandatory or not for the category. | |
| response.dts_limit | object | |||
| response.dts_limit.non_pre_order_days_to_ship | int32 | 2 | Days to ship for non pre-order products. | |
| response.dts_limit.support_pre_order | boolean | true | Whether support pre_order for the category. | |
| response.dts_limit.days_to_ship_limit | object | Days to ship for pre-order products. | ||
| response.dts_limit.days_to_ship_limit.min_limit | int32 | 3 | Min limit of days to ship for pre-order products. | |
| response.dts_limit.days_to_ship_limit.max_limit | int32 | 30 | Max limit of days to ship for pre-order products. | |
| response.component_count_limit_of_single_model | object | |||
| response.component_count_limit_of_single_model.min_limit | int32 | 2 | Item count min limit that each kit variations support. | |
| response.component_count_limit_of_single_model.max_limit | int32 | 10 | Item count max limit that each kit variations support. |
§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_limit?access_token=access_token&category_id=400055&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_limit?access_token=access_token&category_id=400055&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_limit?access_token=access_token&category_id=400055&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_limit?access_token=access_token&category_id=400055&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": "success",
"warning": "-",
"request_id": "28ad0434c6954963a2a6d6ed7195554d",
"response": {
"price_limit": {
"min_limit": 5.5,
"max_limit": 10000000
},
"item_name_length_limit": {
"min_limit": 5,
"max_limit": 99
},
"item_image_count_limit": {
"min_limit": 1,
"max_limit": 10
},
"description_limit": {
"description_length_min": 10,
"description_length_max": 499,
"description_text_length_min": 10,
"description_text_length_max": 499,
"description_image_num_min": 1,
"description_image_num_max": 5,
"description_image_width_min": 1,
"description_image_height_min": 1,
"description_image_aspect_ratio_min": 0.5,
"description_image_aspect_ratio_max": 32
},
"tier_variation_name_length_limit": {
"min_limit": 1,
"max_limit": 50
},
"tier_variation_option_length_limit": {
"min_limit": 1,
"max_limit": 50
},
"weight_limit": {
"weight_mandatory": true
},
"dimension_limit": {
"dimension_mandatory": true
},
"dts_limit": {
"non_pre_order_days_to_ship": 2,
"support_pre_order": true,
"days_to_ship_limit": {
"min_limit": 3,
"max_limit": 30
}
},
"component_count_limit_of_single_model": {
"min_limit": 2,
"max_limit": 10
}
}
}
§13 Error example
Error example
§14 JSON
JSON
{
"error": "product.error_param",
"message": "Invalid category. : should use leaf category",
"request_id": "4511f494b0b2f64ec979f3f25b633841",
"warning": ""
}
§15 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 |
§16 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. |
§17 Update log
Update log
| Date | Change |
|---|---|
| 2024-10-18 | New API |
