stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.global_product.get_global_model_list
Get global model list. 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_global_model_list |
| Production URL | https://partner.shopeemobile.com/api/v2/global_product/get_global_model_list |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/global_product/get_global_model_list |
| 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 |
|---|---|---|---|---|
| global_item_id | int64 | Yes | 28001461 | The id of global item. |
§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. | |
| response | object | |||
| response.tier_variation | object[] | Tier variation information of global item. | ||
| response.tier_variation.name | string | tier name 1 | Tier name. | |
| response.tier_variation.option_list | object[] | Tier option list for corresponding tier name. | ||
| response.tier_variation.option_list.option | string | tier option 1 | Tier option. | |
| response.tier_variation.option_list.image | object | Image information of tier. | ||
| response.tier_variation.option_list.image.image_url | string | https://cf.shopee.sg/file/c54265d475b85e00ffb2404585e32b6f | Image url. | |
| response.tier_variation.option_list.image.image_id | string | c54265d475b85e00ffb2404585e32b6f | Id of image. | |
| response.global_model | object[] | Global models. | ||
| response.global_model.global_model_id | int64 | 20004490 | Id of global model. | |
| response.global_model.global_model_sku | string | model sku | Sku of global model. | |
| response.global_model.price_info | object | Price info of global model. | ||
| response.global_model.price_info.original_price | float | 100.5 | Original price of global model. | |
| response.global_model.stock_info | object[] | Stock info of global model. | ||
| response.global_model.stock_info.stock_type | int32 | 1 | Stock type. "1" means wms on hand, "2" means seller on hand. | |
| response.global_model.stock_info.stock_location_id | string | 1020 | Stock location id. | |
| response.global_model.stock_info.current_stock | int32 | 10 | Current stock. | |
| response.global_model.stock_info.normal_stock | int32 | 10 | Normal stock. | |
| response.global_model.stock_info.reserved_stock | int32 | 10 | Reserved stock. | |
| response.global_model.tier_index | int32[] | [0, 1] | Tier index of global model. | |
| response.global_model.weight | string | "1.1" | The weight of this global model, the unit is KG.; If don't set the weight of this global model, will use the weight of global item by default. | |
| response.global_model.dimension | object | The dimension of this global model.; If don't set the dimension of this global model, will use the dimension of global item by default. | ||
| response.global_model.dimension.package_height | int32 | 11 | The height of package for this global model, the unit is CM. | |
| response.global_model.dimension.package_length | int32 | 11 | The length of package for this global model, the unit is CM. | |
| response.global_model.dimension.package_width | int32 | 11 | The width of package for this global model, the unit is CM. | |
| response.global_model.pre_order | object | Pre-order information of this global model.; Notes: If don't set the DTS of this global model, will use the DTS of the global item by default. | ||
| response.global_model.pre_order.days_to_ship | int32 | 2 | Days to ship. | |
| response.global_model.is_fulfillment_by_shopee | boolean | If it it a FBS model | ||
| response.standardise_tier_variation | object[] | Standardise Tier variation information of global item. | ||
| response.standardise_tier_variation.variation_id | int32 | Standardise Tier variation ID. | ||
| response.standardise_tier_variation.variation_name | string | Standardise Tier variation Name. | ||
| response.standardise_tier_variation.variation_group_id | int32 | Standardise Tier variation Group ID. | ||
| response.standardise_tier_variation.variation_option_list | object[] | Standardise Tier variation Options List. | ||
| response.standardise_tier_variation.variation_option_list.variation_option_id | int32 | Standardise Tier variation Option ID. | ||
| response.standardise_tier_variation.variation_option_list.variation_option_name | string | Standardise Tier variation Option Name. | ||
| response.standardise_tier_variation.variation_option_list.image_id | string | ID of image | ||
| response.standardise_tier_variation.variation_option_list.image_url | string | URL of image |
§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_global_model_list?access_token=access_token×tamp=timestamp&sign=sign&global_item_id=2800146127&merchant_id=merchant_id&partner_id=partner_id")
.asString();
§8 PHP
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/global_product/get_global_model_list?access_token=access_token&global_item_id=2800146127&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_global_model_list?access_token=access_token×tamp=timestamp&sign=sign&global_item_id=2800146127&merchant_id=merchant_id&partner_id=partner_id'
§10 Python
Python
import requests
url = "https://partner.shopeemobile.com/api/v2/global_product/get_global_model_list?access_token=access_token&global_item_id=2800146127&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": "369c79e9a42147f6912e2bf21c96ba23",
"response": {
"tier_variation": [
{
"name": "tier name 1",
"option_list": [
{
"option": "tier option 1",
"image": {
"image_url": "https://cf.shopee.sg/file/c54265d475b85e00ffb2404585e32b6f",
"image_id": "c54265d475b85e00ffb2404585e32b6f"
}
},
{
"option": "tier option 2",
"image": {
"image_url": "https://cf.shopee.sg/file/c54265d475b85e00ffb2404585e32b61",
"image_id": "c54265d475b85e00ffb2404585e32b61"
}
}
]
},
{
"name": "tier name 2",
"option_list": [
{
"option": "tier option 1",
"image": {
"image_url": "https://cf.shopee.sg/file/c54265d475b85e00ffb2404585e32b66",
"image_id": "c54265d475b85e00ffb2404585e32b66"
}
},
{
"option": "tier option 2",
"image": {
"image_url": "https://cf.shopee.sg/file/c54265d475b85e00ffb2404585e32b69",
"image_id": "c54265d475b85e00ffb2404585e32b69"
}
}
]
}
],
"global_model": [
{
"global_model_id": 2000449065,
"global_model_sku": "model sku",
"price_info": {
"original_price": 100.5
},
"stock_info": [
{
"stock_type": 1,
"stock_location_id": 1020,
"current_stock": 10,
"normal_stock": 10,
"reserved_stock": 10
}
],
"tier_index": [0, 0]
},
{
"global_model_id": 2000449066,
"global_model_sku": "model sku",
"price_info": {
"original_price": 100.5
},
"stock_info": [
{
"stock_type": 1,
"stock_location_id": 1020,
"current_stock": 10,
"normal_stock": 10,
"reserved_stock": 10
}
],
"tier_index": [0, 1]
},
{
"global_model_id": 2000449067,
"global_model_sku": "model sku",
"price_info": {
"original_price": 100.5
},
"stock_info": [
{
"stock_type": 1,
"stock_location_id": 1020,
"current_stock": 10,
"normal_stock": 10,
"reserved_stock": 10
}
],
"tier_index": [1, 0]
},
{
"global_model_id": 2000449068,
"global_model_sku": "model sku",
"price_info": {
"original_price": 100.5
},
"stock_info": [
{
"stock_type": 1,
"stock_location_id": 1020,
"current_stock": 10,
"normal_stock": 10,
"reserved_stock": 10
}
],
"tier_index": [1, 1]
}
]
}
}
§13 Error example
Error example
§14 JSON
JSON
{
"error": "product.error_server",
"message": "server internal error mtsku no found",
"request_id": "c9a0df08a80c5d5955ac62420f644dbb"
}
§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_auth | shop is upgrading | |
| error_busi_global_item_not_found | Global item not found. | |
| 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 |
|---|---|
| 2025-02-17 | add is_fulfillment_by_shopee |
| 2024-06-21 | add model level DTS |
| 2024-05-29 | add model level weight and dimension |
| 2024-03-26 | Add standard variation fields |
| 2021-05-17 | Add CNSC introduction in API description |
