stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 v2.product.get_variations
Get the standardized tier variation defined by Shopee, which is currently a three-layer tree structure. The top layer is variations, the second layer is groups, groups are used to divide options, and the third layer is options.
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Product |
| API type | Shop |
| HTTP method | GET |
| Path | /api/v2/product/get_variation_tree |
| Production URL | https://partner.shopeemobile.com/api/v2/product/get_variation_tree |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/product/get_variation_tree |
| Permission | ERP System; Seller In House System; Product Management; Swam ERP |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| category_id | int | Yes | Leaf category id |
§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 | The identifier for an API request for error tracking. | ||
| data | object | standardized tier variation data | ||
| data.standardise_variation_list | object[] | standardized tier variation tree | ||
| data.standardise_variation_list.variation_id | int | 123 | ||
| data.standardise_variation_list.variation_name | string | Color | ||
| data.standardise_variation_list.variation_group_list | object[] | |||
| data.standardise_variation_list.variation_group_list.variation_group_id | int | 1234 | ||
| data.standardise_variation_list.variation_group_list.variation_group_name | string | group1 | ||
| data.standardise_variation_list.variation_group_list.variation_option_list | object[] | |||
| data.standardise_variation_list.variation_group_list.variation_option_list.variation_option_id | int | 12345 | ||
| data.standardise_variation_list.variation_group_list.variation_option_list.variation_option_name | string | yellow |
§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://open.admin.test.shopee.io/api/v2/product/get_variations?access_token=access_token&category_id=0&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://open.admin.test.shopee.io/api/v2/product/get_variations?access_token=access_token&category_id=0&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://open.admin.test.shopee.io/api/v2/product/get_variations?access_token=access_token&category_id=0&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp'
§10 Python
Python
import requests
url = "https://open.admin.test.shopee.io/api/v2/product/get_variations?access_token=access_token&category_id=0&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": "",
"warning": "success",
"request_id": "xxx",
"data": {
"standardise_variation_list": [
{
"variation_id": 101054,
"variation_name": "颜色",
"variation_group_list": [
{
"variation_group_id": 849982774362112,
"variation_group_name": "组别 1",
"variation_option_list": [
{
"variation_option_id": 6245,
"variation_option_name": "color-Green"
},
{
"variation_option_id": 6246,
"variation_option_name": "color-blue"
},
{
"variation_option_id": 6255,
"variation_option_name": "colorful"
},
{
"variation_option_id": 6242,
"variation_option_name": "红色"
}
]
}
]
},
{
"variation_id": 305033,
"variation_name": "尺寸",
"variation_group_list": [
{
"variation_group_id": 871392007506432,
"variation_group_name": "衣服",
"variation_option_list": [
{
"variation_option_id": 24472484,
"variation_option_name": "大码"
},
{
"variation_option_id": 24472485,
"variation_option_name": "中码"
},
{
"variation_option_id": 24472486,
"variation_option_name": "小码"
},
{
"variation_option_id": 24472487,
"variation_option_name": "加大码"
}
]
},
{
"variation_group_id": 871392023830528,
"variation_group_name": "鞋子码数",
"variation_option_list": [
{
"variation_option_id": 24472488,
"variation_option_name": "42码"
},
{
"variation_option_id": 24472489,
"variation_option_name": "41码"
},
{
"variation_option_id": 24472490,
"variation_option_name": "40码"
},
{
"variation_option_id": 24472491,
"variation_option_name": "39码"
}
]
}
]
},
{
"variation_id": 305034,
"variation_name": "颜色",
"variation_group_list": [
{
"variation_group_id": 871392669004800,
"variation_group_name": "纯色",
"variation_option_list": [
{
"variation_option_id": 24472492,
"variation_option_name": "蓝色"
},
{
"variation_option_id": 24472493,
"variation_option_name": "黄色"
},
{
"variation_option_id": 24472494,
"variation_option_name": "红色"
},
{
"variation_option_id": 24472495,
"variation_option_name": "绿色"
}
]
},
{
"variation_group_id": 871392669039616,
"variation_group_name": "混合色",
"variation_option_list": [
{
"variation_option_id": 24472496,
"variation_option_name": "蓝红"
},
{
"variation_option_id": 24472497,
"variation_option_name": "黄绿"
},
{
"variation_option_id": 24472498,
"variation_option_name": "黄红"
},
{
"variation_option_id": 24472499,
"variation_option_name": "红绿"
}
]
}
]
},
{
"variation_id": 305046,
"variation_name": "图案",
"variation_group_list": [
{
"variation_group_id": 871436002087936,
"variation_group_name": "动物",
"variation_option_list": [
{
"variation_option_id": 24474016,
"variation_option_name": "狗"
},
{
"variation_option_id": 24474017,
"variation_option_name": "猫"
},
{
"variation_option_id": 24474018,
"variation_option_name": "鸟"
},
{
"variation_option_id": 24474019,
"variation_option_name": "鱼"
}
]
},
{
"variation_group_id": 871436011700224,
"variation_group_name": "花朵",
"variation_option_list": [
{
"variation_option_id": 24474012,
"variation_option_name": "玫瑰"
},
{
"variation_option_id": 24474013,
"variation_option_name": "向日葵"
},
{
"variation_option_id": 24474014,
"variation_option_name": "郁金香"
},
{
"variation_option_id": 24474015,
"variation_option_name": "兰花"
}
]
}
]
}
]
}
}
§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-03-26 | New API |