stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.push.get_lost_push_message
Get the lost push messages that were lost within 3 days of the current time and not confirmed to have been consumed
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Push |
| API type | Public |
| HTTP method | GET |
| Path | /api/v2/push/get_lost_push_message |
| Production URL | https://partner.shopeemobile.com/api/v2/push/get_lost_push_message |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/push/get_lost_push_message |
| Permission | ERP System; Seller In House System; Product Management; Order Management; Accounting And Finance; Marketing; Customer Service; Brand Membership; Customized APP; Ads Service; Consignment Service System; Custom APP; Swam ERP; Livestream Management; Affiliate Marketing Solution Management; Shopee Video Management |
§3 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 | Indicate waring details if hit waring. Empty if no waring happened. | ||
| request_id | string | 1f34a2c99335ffe85744d98e07fe7d41 | The identifier for an API request for error tracking. | |
| response | object | |||
| response.push_message_list | object[] | Returns the earliest 100 lost push messages that were lost within 3 days of the current time and not confirmed to have been consumed. | ||
| response.push_message_list.shop_id | int | 727720655 | Shopee's unique identifier for a shop.; If it's a partner level push (such as code: 1, 2, 12), shop_id will not be returned. | |
| response.push_message_list.code | int | 3 | Shopee's unique identifier for a push notification. | |
| response.push_message_list.timestamp | timestamp | 1660123127 | Timestamp that indicates the message was lost. | |
| response.push_message_list.data | string | {"data":{"items":[],"ordersn":"220810QSK8S7BX","status":"PROCESSED","completed_scenario":"","update_time":1660123127},"shop_id":727720655,"code":3,"timestamp":1660123127} | Main Push message data. | |
| response.has_next_page | boolean | false | This is to indicate whether the lost push message to be consumed is more than 100. If this value is true, you may need to continue calling to get the remaining lost push messages to be consumed. | |
| response.last_message_id | int | 176610 | Specifies the end entry of data returned in the current call. |
§4 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. | |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
§5 Request samples
Request samples
§6 Java
Java
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://open.admin.shopee.io/api/v2/push/get_lost_push_message?partner_id=partner_id&sign=sign×tamp=timestamp")
.asString();
§7 PHP
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://open.admin.shopee.io/api/v2/push/get_lost_push_message?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;
§8 cURL
cURL
curl --location --request GET 'https://open.admin.shopee.io/api/v2/push/get_lost_push_message?partner_id=partner_id&sign=sign×tamp=timestamp'
§9 Python
Python
import requests
url = "https://open.admin.shopee.io/api/v2/push/get_lost_push_message?partner_id=partner_id&sign=sign×tamp=timestamp"
payload={}
headers = {
}
response = requests.RPCRequest("GET",url,headers=headers, data=payload, allow_redirects=False)
print(response.text)
§10 Response sample
Response sample
§11 JSON
JSON
{
"error": "-",
"message": "-",
"warning": "-",
"request_id": "1f34a2c99335ffe85744d98e07fe7d41",
"response": {
"push_message_list": [
{
"shop_id": 727720655,
"code": 3,
"timestamp": 1660123127,
"data": "{\"data\":{\"items\":[],\"ordersn\":\"220810QSK8S7BX\",\"status\":\"PROCESSED\",\"completed_scenario\":\"\",\"update_time\":1660123127},\"shop_id\":727720655,\"code\":3,\"timestamp\":1660123127}"
}
],
"has_next_page": false,
"last_message_id": 176610
}
}
§12 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_param | request not from gateway | |
| error_server | error server |
§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. |
§14 Update log
Update log
| Date | Change |
|---|---|
| 2023-11-17 | New API |
