stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 v2.follow_prize.update_follow_prize
update_follow_prize
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Follow Prize |
| API type | Shop |
| HTTP method | POST |
| Path | /api/v2/follow_prize/update_follow_prize |
| Production URL | https://partner.shopeemobile.com/api/v2/follow_prize/update_follow_prize |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/follow_prize/update_follow_prize |
| Rate limit | [0, 0, 0] |
| Permission | ERP System; Seller In House System; Marketing; Swam ERP |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| follow_prize_name | string | No | shop_follow_prize | The name of the follow prize,The follow prize name length max limit is 20. |
| campaign_id | int32 | Yes | 123344 | The unique identifier for the created follow prize. |
| start_time | timestamp | No | 1655341211 | The timing from when the follow prize is valid,the start time later than the current time.If the start time and end time passed in by the seller overlap with other upcoming/ongoing activities, it will prompt "Another Follow Prize voucher already exists during this time period, please set another period." |
| end_time | timestamp | No | 1657760411 | The timing until when the follow prize is still valid,the end time must be greater than the start time by at least 1 day and end time cannot exceed 3 months after start time.If the start time and end time passed in by the seller overlap with other upcoming/ongoing activities, it will prompt "Another Follow Prize voucher already exists during this time period, please set another period." |
| usage_quantity | int32 | No | 2000 | Please enter a value between 1 and 200000. |
| min_spend | float | No | The minimum spend required for using this follow prize. |
§4 Response parameters
Response parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| response | object | Detailed informations you are querying. | ||
| response.campagin_id | int32 | 123344 | The unique identifier for the created follow prize. | |
| 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. | ||
| request_id | string | bf3197ba056a884119dd8aea3d89dcb5 | The identifier of the API request for error tracking. |
§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. | |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. | |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, shop_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 Payload
Payload
{
"follow_prize_name":"shop_follow_prize_one",
"campaign_id":3434334,
"start_time":1621844677,
"end_time":1621944677,
"usage_quantity":2000,
"min_spend":200
}
§8 Response sample
Response sample
§9 JSON
JSON
{
"response": {
"campaign_id": 123344
},
"request_id": "bf3197ba056a884119dd8aea3d89dcb5",
"error": "",
"message": ""
}
§10 Error example
Error example
§11 JSON
JSON
{
"response": "",
"request_id": "825410ffa9ef4409c3f89a816029fd37",
"error": "follow_prize.campaign_none",
"message": "The promotion id is not existed"
}
§12 Errors
Errors
| Error | Description | Solution |
|---|---|---|
| follow_prize.campaign_none | The promotion id is not existed | |
| follow_prize.campaign_num_max_limit | Max number of follow Prize reached (1000 ongoing and upcoming follow Prize) | |
| follow_prize.campaign_overlap | Another Follow Prize voucher already exists during this time period, please set another period. | |
| Follow_prize_min_value_basket_price | Minimum basket price can not be smaller than 49 for coin cashback voucher in TH | |
| follow_prize.name_length_limit | please input up to 20 characters of follow prize name | |
| follow_prize.percentage_RANGE | Please enter a value between 1 and 99 | |
| follow_prize.end_time_min_limit | The end time must be greater than the start time by at least 1 day | |
| follow_prize.quota_out_range | Please enter a value between 1 and 200000 | |
| follow_prize.start_time_min_limit | Please enter a start time later than the current time | |
| follow_prize.time_future_limit | The start/end time should not exceed 2037-12-31 23:59:59 | |
| follow_prize.update_end_time_later | Promotion end time can only be changed to an earlier timing. | |
| follow_prize.update_expired_campaign | The expired follow prize can't be updated. | |
| follow_prize.update_min_spend_ongoing | Minimum Basket Price can't be updated which is ongoing | |
| follow_prize.update_prize_name_ongoing | Cannot rename follow prize name which is ongoing | |
| follow_prize.update_quantity_reduce | Cannot reduce dispatch quantity. | |
| follow_prize.update_start_time_earlier | Promotion start time can only be changed to a later timing. | |
| follow_prize.update_start_time_ongoing | Cannot update start time which is ongoing | |
| 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. | |
| common.error_not_found | The information you queried is not found. | |
| common.error_param | The Wrong parameters, detail: {msg}. | |
| error_param | Wrong parameters, detail: {msg}. | |
| error_server | Something wrong. Please try later. | |
| error_shop | shopid is invalid | |
| error_server | Something wrong. Please try late | |
| error_param | request not from gateway | |
| voucher.voucher_max_discount_low_quality | To attract buyers to use your voucher, please increase maximum discount price to > {percentage_inputmin_spend0.01} or reduce minimum basket price to < {max_discount*100/percentage_input} to ensure buyers can enjoy the percentage discount configured. |
§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. | |
| error_param | There is no access_token in query. | |
| error_auth | Invalid access_token. | |
| error_auth | Invalid partner_id or shopid. | |
| shop_no_linked | Partner and shop has no linked. | |
| shop_banned | The shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored. | |
| invalid_acceess_token | Invalid access_token, please have a check. | |
| partner_shop_no_link | Invalid partner_id or shop_id, please have a check. | |
| error_ashop_api_permission | The shop is Affiliate shop has no permission to call this API. | |
| error_kyc_auth | No permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API. | |
| error_auth | System error, please try again later. | |
| error_param | There is no shop_id in query. | |
| error_param | shop_id is invalid, should be an integer between 0 and 4294967295. |
§14 Update log
Update log
| Date | Change |
|---|---|
| 2025-09-08 | select type for some parameters |
| 2022-07-27 | Add Error Example information |
| 2022-06-16 | Optimize the response parameter type |
| 2022-06-14 | Optimize the request parameters and response parameters information |
| 2021-06-24 | New API |