v2.product.get_attribute_tree

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 · 2026-09-06 12:14:22

打开官方原文 ↗

当前资料结构化阅读页
固定快照已留存，可追溯
官方原文可核对

查看技术与溯源信息

平台 / profile: Shopee / profile.shopee.api_reference
语言: en-US
发布版本: cn-20260909-2
标签: zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.product.get_attribute_tree

Get the attribute tree for categories

§2 Overview

Overview

Field	Value
Module	Product
API type	Shop
HTTP method	GET
Path	/api/v2/product/get_attribute_tree
Production URL	https://partner.shopeemobile.com/api/v2/product/get_attribute_tree
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/product/get_attribute_tree
Permission	ERP System; Seller In House System; Product Management; Customized APP; Swam ERP

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
category_id_list	int[]	Yes		max count is 20
language	string	No	"en"	Language Support Lanuage: "SG": [ "en", "zh-Hans", "ms" ],; "MY": [ "en", "zh-Hans", "ms" ], "PH": [ "en", "zh-Hans" ], "VN": [ "vn", "en" ], "ID": [ "id", "en" ], "TH": [ "th", "en" ], "BR": [ "pt-BR", "en" ], "MX": [ "es-MX", "en" ], "CO": [ "es-CO", "en" ], "CL": [ "es-CL", "en" ], "TW": [ "zh-Hant", "zh-Hans", "en" ], "IN": [ "en", "hi" ]

§4 Response parameters

Response parameters

Name	Type	Sample	Description
error	string		Error
message	string		Message
warning	string		Warning
request_id	string		Request ID
response	object		Resopnse
response.list	object[]		Each result corresponds to one category in category_ids
response.list.attribute_tree	object[]		One category's attribute trees
response.list.attribute_tree.attribute_id	int		Attribute ID
response.list.attribute_tree.mandatory	boolean	true	Is mandatory or not
response.list.attribute_tree.name	string		Attribute Name
response.list.attribute_tree.attribute_value_list	object[]		All available values for this attribute
response.list.attribute_tree.attribute_value_list.value_id	int		Value ID
response.list.attribute_tree.attribute_value_list.name	string		Value name
response.list.attribute_tree.attribute_value_list.value_unit	string		Value unit
response.list.attribute_tree.attribute_value_list.child_attribute_list	object[]		Child attributes for the value of parent attribute The structure content is the same as attribute_tree
response.list.attribute_tree.attribute_value_list.multi_lang	object[]		Translate results for display
response.list.attribute_tree.attribute_value_list.multi_lang.language	string		Language
response.list.attribute_tree.attribute_value_list.multi_lang.value	string		Translate result
response.list.attribute_tree.attribute_info	object		Attribute extra info
response.list.attribute_tree.attribute_info.input_type	int		SINGLE_DROP_DOWN = 1 SINGLE_COMBO_BOX = 2 FREE_TEXT_FILED = 3 MULTI_DROP_DOWN = 4 MULTI_COMBO_BOX = 5
response.list.attribute_tree.attribute_info.input_validation_type	int		VALIDATOR_NO_VALIDATE_TYPE = 0 VALIDATOR_INT_TYPE = 1; VALIDATOR_STRING_TYPE = 2; VALIDATOR_FLOAT_TYPE = 3; VALIDATOR_DATE_TYPE = 4
response.list.attribute_tree.attribute_info.format_type	int		FORMAT_NORMAL = 1; FORMAT_QUANTITATIVE_WITH_UNIT = 2
response.list.attribute_tree.attribute_info.date_format_type	int		YEAR_MONTH_DATE = 0 (DD/MM/YYYY); YEAR_MONTH = 1 (MM/YYYY)
response.list.attribute_tree.attribute_info.attribute_unit_list	string[]		Attribute's available units list
response.list.attribute_tree.attribute_info.max_value_count	int		Max selected value count
response.list.attribute_tree.attribute_info.introduction	string		Introduction for special Attribute
response.list.attribute_tree.attribute_info.is_oem	boolean
response.list.attribute_tree.attribute_info.support_search_value	boolean		Indicates whether this attribute has searchable values.; If yes, please call v2.product.search_attribute_value_list to get the default values
response.list.attribute_tree.multi_lang	object[]		Attribute translate info
response.list.attribute_tree.multi_lang.language	string		Language
response.list.attribute_tree.multi_lang.value	string		Translate result
response.list.category_id	int		Category ID
response.list.warning	string		Warning msg

§5 Common parameters

Common parameters

Name	Type	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.uat.shopee.io/api/v2/product/get_attribute_tree?access_token=access_token&category_ids=1234,5678&language=en&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp")
.asString();

§8 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://open.admin.uat.shopee.io/api/v2/product/get_attribute_tree?access_token=access_token&category_ids=1234,5678&language=en&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=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.uat.shopee.io/api/v2/product/get_attribute_tree?access_token=access_token&category_ids=1234,5678&language=en&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp'

§10 Python

Python

import requests

url = "https://open.admin.uat.shopee.io/api/v2/product/get_attribute_tree?access_token=access_token&category_ids=1234,5678&language=en&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=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": "-",
	"response": {
		"list": [
			{
				"attribute_tree": [
					{
						"attribute_id": 0,
						"mandatory": true,
						"name": "-",
						"attribute_value_list": [
							{
								"value_id": 0,
								"name": "-",
								"value_unit": "-",
								"child_attribute_list": [
									{}
								],
								"multi_lang": [
									{
										"language": "-",
										"value": "-"
									}
								]
							}
						],
						"attribute_info": {
							"input_type": 0,
							"input_validation_type": 0,
							"format_type": 0,
							"date_format_type": 0,
							"attribute_unit_list": [
								"-"
							],
							"max_value_count": 0
						},
						"multi_lang": [
							{
								"language": "-",
								"value": "-"
							}
						]
					}
				],
				"category_id": 0
			}
		]
	}
}

§13 Error example

Error example

§14 JSON

JSON

{
    "error": "product.error_server",
    "message": "server internal error",
    "warning": "",
    "request_id": "ff09685a706edc8b422b2121b088979a"
}

§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
error_invalid_language	Invalid language.
error_invalid_category	Invalid category ID {{.error_info}}

§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
2025-01-13	Add new support_search_value field
2024-04-12	add introduction response parameter
2023-07-24	New API

这条内容对你有帮助吗？