stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.global_product.get_global_item_limit
Get global item upload control.
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | GlobalProduct |
| API type | Merchant |
| HTTP method | GET |
| Path | /api/v2/global_product/get_global_item_limit |
| Production URL | https://partner.shopeemobile.com/api/v2/global_product/get_global_item_limit |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/global_product/get_global_item_limit |
| Rate limit | [0, 0, 0] |
| 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 |
§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 | Warning massage. | ||
| request_id | string | d91449353c5243e6ad8b51b5491e372b | The identifier of the API request for error tracking. | |
| response | object | |||
| response.price_limit | object | |||
| response.price_limit.min_limit | float | 0.0 | Global item price min limit. | |
| response.price_limit.max_limit | float | 99.99 | Global item price max limit. | |
| response.stock_limit | object | |||
| response.stock_limit.min_limit | int64 | 0 | Global item stock min limit. | |
| response.stock_limit.max_limit | int64 | 50 | Global item stock max limit. | |
| response.global_item_name_length_limit | object | |||
| response.global_item_name_length_limit.min_limit | int64 | 1 | Global item name length min limit. | |
| response.global_item_name_length_limit.max_limit | int64 | 41 | Global item name length max limit. | |
| response.global_item_image_count_limit | object | |||
| response.global_item_image_count_limit.min_limit | int64 | 1 | Global item image count min limit. | |
| response.global_item_image_count_limit.max_limit | int64 | 5 | Global item image count max limit. | |
| response.global_item_description_length_limit | object | |||
| response.global_item_description_length_limit.min_limit | int64 | 1 | Global item description length min limit. | |
| response.global_item_description_length_limit.max_limit | int64 | 100 | Global item description length max limit. | |
| response.tier_variation_name_length_limit | object | |||
| response.tier_variation_name_length_limit.min_limit | int64 | 1 | Global item tier variation name length min limit. | |
| response.tier_variation_name_length_limit.max_limit | int64 | 20 | Global item tier variation name length max limit. | |
| response.tier_variation_option_length_limit | object | |||
| response.tier_variation_option_length_limit.min_limit | int64 | 1 | Global item tier variation option length min limit. | |
| response.tier_variation_option_length_limit.max_limit | int64 | 20 | Global item tier variation option length max limit. | |
| response.text_length_multiplier | float | 1.43 | Length ratio of Chinese characters to English characters in parameter verification. len(text)=len(Chinese characters)*text_length_multiplier+len(English characters ) | |
| response.extended_description_limit | object | |||
| response.extended_description_limit.description_text_length_min | int | length min limit for item extended description text part | ||
| response.extended_description_limit.description_text_length_max | int | length max limit for item extended description text part | ||
| response.extended_description_limit.description_image_num_min | int | length min limit for item extended description image num | ||
| response.extended_description_limit.description_image_num_max | int | length max limit for item extended description image num | ||
| response.extended_description_limit.description_image_width_min | int | length min limit for item extended description image width | ||
| response.extended_description_limit.description_image_height_min | int | length min limit for item extended description image hight | ||
| response.extended_description_limit.description_image_aspect_ratio_min | float | length min limit for item extended description image aspect (image width / image hight ) | ||
| response.extended_description_limit.description_image_aspect_ratio_max | float | length max limit for item extended description image aspect (image width / image hight ) | ||
| response.dts_limit | object | |||
| response.dts_limit.days_to_ship_range_list | object[] | Allowed limit scope for Pre order | ||
| response.dts_limit.days_to_ship_range_list.min_limit | int64 | |||
| response.dts_limit.days_to_ship_range_list.max_limit | int64 | |||
| response.weight_limit | object | |||
| response.weight_limit.weight_mandatory | boolean | weight is mandatory or not | ||
| response.dimension_limit | object | |||
| response.dimension_limit.dimension_mandatory | boolean | dimension is mandatory or not for the category | ||
| size_chart_limit | object | |||
| size_chart_limit.size_chart_mandatory | boolean | |||
| size_chart_limit.support_image_size_chart | boolean | |||
| size_chart_limit.support_template_size_chart | boolean |
§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. | |
| merchant_id | int | 1 | Shopee’s unique identifier for a merchant. Required for all merchant level requests(CB CNSC user calling global product related APIs). | |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, merchant_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("/api/v2/global_product/get_global_item_limit")
.asString();
§8 PHP
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => '/api/v2/global_product/get_global_item_limit',
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(
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
§9 cURL
cURL
curl --location --request GET '/api/v2/global_product/get_global_item_limit'
§10 Python
Python
import requests
url = "/api/v2/global_product/get_global_item_limit"
payload={}
headers = {
}
response = requests.request("GET",url,headers=headers, data=payload, allow_redirects=False)
print(response.text)
§11 Errors
Errors
| Error | Description | Solution |
|---|---|---|
| error_network | Inner http call failed | |
| 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_param | request not from gateway | |
| error_get_global_item_limit_failed | Get global item limit failed. please try later. | |
| error_inner | Our system is taking some time to respond, please try later. | |
| error_inner | System error, please try again later or contact the OpenAPI support team. | |
| error_inner | Update item failed {{.error_info}} | |
| error_inner | Update item failed {{.error_info}} | |
| error_inner | System error, please try again later or contact the OpenAPI support team. | |
| error_inner | System error, please try again later or contact the OpenAPI support team. | |
| error_auth | Your shop can not use model level dts | |
| error_system_busy | Our system is taking some time to respond, please try later. |
§12 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. | |
| merchant_no_linked | Partner and merchant has no linked. | |
| invalid_acceess_token | Invalid access_token, please have a check. | |
| partner_frozen | The Partner has been frozen. Permissions for merchant authorization and API calls have been suspended until permissions are restored. | |
| error_param | There is no merchant_id in query. | |
| error_param | merchant_id is invalid, should be an integer between 0 and 4294967295. |
§13 Update log
Update log
| Date | Change |
|---|---|
| 2025-01-08 | Add size_chart_limit to decide if size_chart is mandatory |
| 2024-11-29 | add size_chart_limit |
| 2024-06-27 | add category_id request parameter and weight_limit, dimension_limit, dts_limit response parameters |
| 2022-02-21 | add extended_description_limit |
| 2021-06-17 | update path |
