stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.global_product.update_tier_variation
Update global product tier variation. Only for China mainland sellers and Korean sellers.This api can only be used without changing the tier structure, you can add options, delete options, and update the option image by this api.
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | GlobalProduct |
| API type | Merchant |
| HTTP method | POST |
| Path | /api/v2/global_product/update_tier_variation |
| Production URL | https://partner.shopeemobile.com/api/v2/global_product/update_tier_variation |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/global_product/update_tier_variation |
| Rate limit | [0, 0, 0] |
| Permission | ERP System; Seller In House System; Product Management |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| global_item_id | int64 | Yes | 2200146923 | ID of global item. |
| model_list | object[] | No | ||
| model_list.model_id | int64 | Yes | 1002066586922 | ID of model |
| model_list.tier_index | int32 | Yes | Model's tier_variation | |
| standardise_tier_variation | object[] | No | item standardise tier variation; There is at least one standardise_tier_variation and tier_variation | |
| standardise_tier_variation.variation_id | int | Yes | standardise tier variation ID | |
| standardise_tier_variation.variation_name | string | No | standardise tier variation name | |
| standardise_tier_variation.variation_group_id | int | No | standardise tier variation group ID | |
| standardise_tier_variation.variation_option_list | object[] | Yes | standardise tier variation option list | |
| standardise_tier_variation.variation_option_list.variation_option_id | int | Yes | ||
| standardise_tier_variation.variation_option_list.variation_option_name | string | No | ||
| standardise_tier_variation.variation_option_list.image_id | string | 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 message. | ||
| request_id | string | 98eae35efff24dd0974c21a847127184 | The identifier for an API request for error tracking. |
§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 Payload
Payload
{
"standardise_tier_variation": [
{
"variation_id": 0,
"variation_group_id": 0,
"variation_name": "Color",
"variation_option_list": [
{ "variation_option_id": 0, "variation_option_name": "Cream stripe", "image_id": "img-cream" },
{ "variation_option_id": 0, "variation_option_name": "Blue stripe", "image_id": "img-blue" },
{ "variation_option_id": 0, "variation_option_name": "Mint stripe", "image_id": "img-mint" }
]
},
{
"variation_id": 0,
"variation_group_id": 0,
"variation_name": "Size",
"variation_option_list": [
{ "variation_option_id": 0, "variation_option_name": "S" },
{ "variation_option_id": 0, "variation_option_name": "M" },
{ "variation_option_id": 0, "variation_option_name": "L" }
]
}
],
"model": [
{ "tier_index": [0,0], "model_sku": "SKU-Cream-S", "original_price": 100000, "seller_stock": [{"stock":3}] },
{ "tier_index": [0,1], "model_sku": "SKU-Cream-M", "original_price": 100000, "seller_stock": [{"stock":2}] },
{ "tier_index": [0,2], "model_sku": "SKU-Cream-L", "original_price": 100000, "seller_stock": [{"stock":0}] },
{ "tier_index": [1,0], "model_sku": "SKU-Blue-S", "original_price": 100000, "seller_stock": [{"stock":1}] },
{ "tier_index": [1,1], "model_sku": "SKU-Blue-M", "original_price": 100000, "seller_stock": [{"stock":4}] },
{ "tier_index": [1,2], "model_sku": "SKU-Blue-L", "original_price": 100000, "seller_stock": [{"stock":3}] },
{ "tier_index": [2,0], "model_sku": "SKU-Mint-S", "original_price": 100000, "seller_stock": [{"stock":1}] },
{ "tier_index": [2,1], "model_sku": "SKU-Mint-M", "original_price": 100000, "seller_stock": [{"stock":2}] },
{ "tier_index": [2,2], "model_sku": "SKU-Mint-L", "original_price": 100000, "seller_stock": [{"stock":5}] }
]
"global_item_id": 100918870
}
§8 Response sample
Response sample
§9 JSON
JSON
{
"error": "",
"message": "",
"warning": "",
"request_id": "98eae35efff24dd0974c21a847127184"
}
§10 Error example
Error example
§11 JSON
JSON
{
"error": "product.error_busi_global_tier_option_image_not_equal_to_tier_one_option",
"message": "Image num of tier_variation option is not equal to option num of tier_variation.",
"request_id": "41e85712e206aa82bc91d9e8874150bb"
}
§12 Errors
Errors
| Error | Description | Solution |
|---|---|---|
| add_on.add_on_deal_expired | The expired add on deal can't be edited | |
| error_tier_index | The tier_index is not exist | |
| error_duplicate_modelid | The model_id is duplicate, model_id:{{.model_id}} | |
| error_wrong_modelid | The model_id is wrong or not related to this item, model_id:{{.model_id}} | |
| 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_param | Canot change the level of tier-variation. | |
| error_param | Image not exist. | |
| error_busi_global_item_model_not_allow_empty | Model can not be empty. | |
| error_duplicated_variation_option | Tier variation option duplicated. | |
| error_busi_global_tier_option_image_not_equal_to_tier_one_option | Image num of tier_variation option is not equal to option num of tier_variation. | |
| 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_permission | Global product related shop is not upgraded. | |
| error_param_validate | Your current merchant is a special merchant.Please ensure all your shop are under same region | |
| error_auth | Your shop can not use model level dts | |
| error_busi | The merchant/shop has multi warehouse, please input location id | |
| error_system_busy | Our system is taking some time to respond, please try later. |
§13 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. |
§14 Update log
Update log
| Date | Change |
|---|---|
| 2025-09-15 | The tier_variation structure in the documentation has been deprecated. Please use the standardise_tier_variation structure when uploading variations. |
| 2024-03-26 | Add standard variations |
| 2022-08-11 | add model list |
| 2022-01-27 | update define and tier_variation description |
| 2021-09-14 | update image type and request example |
