stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.global_product.get_category
Get global category. Only for China mainland sellers and Korean sellers.
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | GlobalProduct |
| API type | Merchant |
| HTTP method | GET |
| Path | /api/v2/global_product/get_category |
| Production URL | https://partner.shopeemobile.com/api/v2/global_product/get_category |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/global_product/get_category |
| 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 |
|---|---|---|---|---|
| language | string | No | zh-hans | Display language. Language should be one of "zh-hans", "en" |
§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 message. | ||
| request_id | string | da6b348a4a5e4162b885ecc73c85297f | The identifier for an API request for error tracking. | |
| response | object | |||
| response.category_list | object[] | |||
| response.category_list.category_id | int | ID for category. | ||
| response.category_list.parent_category_id | int | ID for parent category. | ||
| response.category_list.original_category_name | string | English category name. | ||
| response.category_list.display_category_name | string | Display category name, it depends on what language you have uploaded | ||
| response.category_list.has_children | boolean | Whether this category has active children category. |
§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("https://partner.shopeemobile.com/api/v2/global_product/get_category?sign=sign&merchant_id=merchant_id&partner_id=partner_id&language=zh-hans&access_token=access_token×tamp=timestamp")
.asString();
§8 PHP
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/global_product/get_category?access_token=access_token&language=zh-hans&merchant_id=merchant_id&partner_id=partner_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/global_product/get_category?sign=sign&merchant_id=merchant_id&partner_id=partner_id&language=zh-hans&access_token=access_token×tamp=timestamp'
§10 Python
Python
import requests
url = "https://partner.shopeemobile.com/api/v2/global_product/get_category?access_token=access_token&language=zh-hans&merchant_id=merchant_id&partner_id=partner_id&sign=sign×tamp=timestamp"
payload={}
headers = {
}
response = requests.request("GET",url,headers=headers, data=payload, allow_redirects=False)
print(response.text)
§11 Response sample
Response sample
§12 JSON
JSON
{
"error": "",
"message": "",
"warning": "",
"request_id": "aaaaaaa",
"response": {
"category_list": [{
"category_id": 123,
"parent_category_id": 456,
"original_category_name": "aaa",
"display_category_name": "bbb",
"has_children": false
}]
}
}
§13 Error example
Error example
§14 JSON
JSON
{
"error": "product.error_invalid_language",
"message": "Invalid language.",
"request_id": "63e28372abb5fb9b075783eaf1768c0f"
}
§15 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_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. |
§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. | |
| 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. |
§17 Update log
Update log
| Date | Change |
|---|---|
| 2021-05-17 | Add CNSC introduction in API description |
