v2.push.set_app_push_config
POST /api/v2/push/set_app_push_config
you can turn on or turn off your app push config setting through this open api
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/push/set_app_push_config
Common Request 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 |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| callback_url | string | False | 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[] | False | [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[] | False | [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[] | False | [10010,20020,30030] | Use this filed to set shops that need to be blocked.Please input no more than 500 shop id. |
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. | |
| result | string | success | Use this field to indicate whether the configuration is set successfully. |