stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.global_product.get_global_item_list
Get global item id 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_item_list |
| Production URL | https://partner.shopeemobile.com/api/v2/global_product/get_global_item_list |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/global_product/get_global_item_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 |
|---|---|---|---|---|
| offset | string | No | AAAAFA== | Specifies the starting entry of data to return in the current call. Default is null. if data is more than one page, the offset can be some entry to start next call. |
| page_size | int | Yes | 10 | The size of one page. Limit is [1,50]. |
| update_time_from | timestamp | No | 1611311600 | The update_time_from and update_time_to fields specify a date range for retrieving orders (based on the item update time). The update_time_from field is the starting date range. |
| update_time_to | timestamp | No | 1611311631 | The update_time_from and update_time_to fields specify a date range for retrieving orders (based on the item update time). The update_time_to field is the ending date range |
§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 massage. | ||
| request_id | string | 79121bb8ce90449e81743a15067410f3 | The identifier of the API request for error tracking. | |
| response | object | |||
| response.global_item_list | object[] | |||
| response.global_item_list.global_item_id | int | 2300146833 | Shopee's unique identifier for an global item. | |
| response.global_item_list.update_time | timestamp | 1608967817 | Timestamp that indicates the last time that there was a change in value of the item, such as price/stock change. | |
| response.total_count | int | 826 | Total global item count. | |
| response.has_next_page | boolean | true | This is to indicate whether the item list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of items. | |
| response.offset | string | AAAAFA== | If has_next_page is true, this value need set to next request.offset. |
§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_item_list?partner_id=partner_id&update_time_from=1611311600&update_time_to=1611311631&merchant_id=merchant_id&page_size=10&access_token=access_token×tamp=timestamp&sign=sign&offset=AAAAFA==")
.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_item_list?access_token=access_token&merchant_id=merchant_id&offset=AAAAFA%3D%3D&page_size=10&partner_id=partner_id&sign=sign×tamp=timestamp&update_time_from=1611311600&update_time_to=1611311631',
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_item_list?update_time_from=1611311600&update_time_to=1611311631&merchant_id=merchant_id&partner_id=partner_id&access_token=access_token×tamp=timestamp&sign=sign&offset=AAAAFA==&page_size=10'
§10 Python
Python
import requests
url = "https://partner.shopeemobile.com/api/v2/global_product/get_global_item_list?access_token=access_token&merchant_id=merchant_id&offset=AAAAFA%3D%3D&page_size=10&partner_id=partner_id&sign=sign×tamp=timestamp&update_time_from=1611311600&update_time_to=1611311631"
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": "79121bb8ce90449e81743a15067410f3",
"response": {
"global_item_list": [
{
"global_item_id": 2300146833,
"update_time": 1608967817
},
{
"global_item_id": 2300146832,
"update_time": 1608967814
},
{
"global_item_id": 2300146831,
"update_time": 1608967813
},
{
"global_item_id": 2300146830,
"update_time": 1608967809
},
{
"global_item_id": 2300146829,
"update_time": 1608967809
},
{
"global_item_id": 2300146828,
"update_time": 1608967805
},
{
"global_item_id": 2300146827,
"update_time": 1608967802
},
{
"global_item_id": 2300146826,
"update_time": 1608967802
},
{
"global_item_id": 2300146825,
"update_time": 1608967801
},
{
"global_item_id": 2300146824,
"update_time": 1608967800
}
],
"total_count": 826,
"has_next_page": true,
"offset": "AAAAFA=="
}
}
§13 Error example
Error example
§14 JSON
JSON
{
"error": "product.error_param",
"message": "invalid field PageSize: value '100' must be less than '51'",
"request_id": "8413cb9fe65c600760722e0205e94f5d"
}
§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_param | update_time_from is required | |
| error_param | update_time_to is required | |
| error_get_global_item_list_failed | Get global item list failed. Please try later. | |
| 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_param | update_time_to is later than now, only display item updated from update_time_from to now | |
| error_param | category is prohibited | |
| 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_param | update_time_to is later than now, only display item updated from update_time_from to now | |
| error_param | Update_time_to should be later than update_time_from. | |
| 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 |
|---|---|
| 2022-03-07 | update page_size description |
| 2021-10-25 | update page_size description |
| 2021-09-22 | Add update_time_from & update_time_to field |
| 2021-05-17 | Add CNSC introduction in API description |
