v2.push.set_app_push_config

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

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

打开官方原文 ↗

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

查看技术与溯源信息

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

资料正文

§1 v2.push.set_app_push_config

you can turn on or turn off your app push config setting through this open api

§2 Overview

Overview

Field	Value
Module	Push
API type	Public
HTTP method	POST
Path	/api/v2/push/set_app_push_config
Production URL	https://partner.shopeemobile.com/api/v2/push/set_app_push_config
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/push/set_app_push_config
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 Request parameters

Request parameters

Name	Type	Required	Sample	Description
callback_url	string	No	https://open.shopee.com/	The callback url of push mechanism. It is the address where the Shopee will send the push message to. If you don't set any callback_url before, this parameters is required.
set_push_config_on	int[]	No	[1,2,3,4,5,8,9,10]	Turn on push config, Shopee will send the push message into the callback url.; 1=Shop authorization for partners; 2=Shop deauthorization for partners; 3=Order status update push; 4=TrackingNo push; 5=Shopee Updates; 6=Banned item push; 7=item promotion push; 8=reserved stock change push; 9=promotionn update push; 10=webchat push; 11=video upload push; 12=openapi authorization expiry push; 13=brand register result
set_push_config_off	int[]	No	[6,7,11,12,13]	Turn off Push config, Shopee won't send the push message into the callback url.; 1=Shop authorization for partners; 2=Shop deauthorization for partners; 3=Order status update push; 4=TrackingNo push; 5=Shopee Updates; 6=Banned item push; 7=item promotion push; 8=reserved stock change push; 9=promotionn update push; 10=webchat push; 11=video upload push; 12=openapi authorization expiry push; 13=brand register result
blocked_shop_id_list	int[]	No	[10010,20020,30030]	Use this filed to set shops that need to be blocked.Please input no more than 500 shop id.

§4 Response parameters

Response parameters

Name	Type	Sample	Description
request_id	string	b937c04e554847789cbf3fe33a0ad5f1	The identifier for an API request for error tracking.
error	string	common.error_auth	Indicate error type if hit error. Empty if no error happened.
message	string	Invalid sign	Indicate error details if hit error. Empty if no error happened.
response	object		Detail informations you are querying.
response.result	string	success	Use this field to indicate whether the configuration is set successfully.

§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.
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

§6 Request samples

Request samples

§7 Payload

Payload

{
	"callback_url": "https://open.shopee.com/",
	"set_push_config_on": [
		1,
		2,
		3,
		4,
		5,
		8,
		9,
		10
	],
	"set_push_config_off": [
		6,
		7,
		11,
		12,
		13
	],
	"blocked_shop_id_list": [
		10010,
		20020,
		30030
	]
}

§8 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.uat.shopeemobile.com/api/v2/push/set_app_push_config?partner_id=partner_id&sign=sign&timestamp=timestamp")
.header("Content-Type","application/json")
.body("{
   \"blocked_shop_id_list\": [
      10010,
      20020,
      30030
   ],
   \"callback_url\": \"https://open.shopee.com/\",
   \"set_push_config_off\": [
      6,
      7,
      11,
      12,
      13
   ],
   \"set_push_config_on\": [
      1,
      2,
      3,
      4,
      5,
      8,
      9,
      10
   ]
}")
.asString();

§9 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.uat.shopeemobile.com/api/v2/push/set_app_push_config?partner_id=partner_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 => 'POST',
  CURLOPT_POSTFIELDS => '{
    "blocked_shop_id_list": [
        10010,
        20020,
        30030
    ],
    "callback_url": "https://open.shopee.com/",
    "set_push_config_off": [
        6,
        7,
        11,
        12,
        13
    ],
    "set_push_config_on": [
        1,
        2,
        3,
        4,
        5,
        8,
        9,
        10
    ]
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

§10 cURL

cURL

curl --location --request POST 'https://partner.uat.shopeemobile.com/api/v2/push/set_app_push_config?partner_id=partner_id&sign=sign&timestamp=timestamp' \
--header 'Content-Type: application/json' \
--data-raw '{
   "blocked_shop_id_list": [
      10010,
      20020,
      30030
   ],
   "callback_url": "https://open.shopee.com/",
   "set_push_config_off": [
      6,
      7,
      11,
      12,
      13
   ],
   "set_push_config_on": [
      1,
      2,
      3,
      4,
      5,
      8,
      9,
      10
   ]
}'

§11 Python

Python

import requests
import json

url = "https://partner.uat.shopeemobile.com/api/v2/push/set_app_push_config?partner_id=partner_id&sign=sign&timestamp=timestamp"

payload=json.dumps({
  "blocked_shop_id_list": [
    10010,
    20020,
    30030
  ],
  "callback_url": "https://open.shopee.com/",
  "set_push_config_off": [
    6,
    7,
    11,
    12,
    13
  ],
  "set_push_config_on": [
    1,
    2,
    3,
    4,
    5,
    8,
    9,
    10
  ]
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.request("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

§12 Response sample

Response sample

§13 JSON

JSON

{
	"request_id": "b937c04e554847789cbf3fe33a0ad5f1",
	"error": "",
	"message": "",
	"response": {
		"result": "success"
	}
}

§14 Error example

Error example

§15 JSON

JSON

{
	"request_id": "b937c04e554847789cbf3fe33a0ad5f1",
	"error": "common.error_auth",
	"message": "Invalid sign",
	"response": {
		"result": ""
	}
}

§16 Errors

Errors

Error	Description	Solution
error_param	{msg}
error_param	this callback_url is invalid, please check your callback_url.
error_param	Your app's callback_url is empty, please input a callback_url before you turn on push config.
error_data	parse data failed
error_data	data not exist
error_param	parameter invalid
error_param	The call back url can not be Shopee intranet address, please change another new call back url
error_param	The information you queried is not found.
error_param	Wrong parameters, detail: {msg}.
error_server	Something wrong. Please try later.
error_param	Shopee have sent a test push to this call back url, but we didn't get any response in 3 seconds with 2xx code, please check your service.
error_param	request not from gateway
error_param	{msg}
error_server	error server
error_param	Shopee have sent a test push to this call back url, the response code we get from this callback_url is not 2xx code, please check your service.

§17 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.

§18 Update log

Update log

Date	Change
2022-08-19	New API

这条内容对你有帮助吗？