Specifies the page number of data to return in the current call. Default to be 1.
page_size
int32
No
100
Use the 'page_size' filters to control the maximum number of entries to retrieve per page (i.e., per call). Default to be 20 and allowed input is from 1- 100.
status
string
Yes
upcoming
The status filter for retrieving follow prize list. Available value: upcoming/ongoing/expired/all.
This is to indicate whether the comment 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 comments.
response.follow_prize_list
object
The list of follow prize.
response.follow_prize_list.campaign_id
int32
27
The unique identifier for the created follow prize.
response.follow_prize_list.campaign_status
string
upcoming
The status of follow prize,the campagin status have upcoming/ongoing/expired.
response.follow_prize_list.follow_prize_name
string
shop_follow_prize3
The name of the follow prize,The follow prize name length max limit is 20.
response.follow_prize_list.start_time
timestamp
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."
response.follow_prize_list.end_time
timestamp
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."
response.follow_prize_list.usage_quantity
int32
2000
Please enter a value between 1 and 200000.
response.follow_prize_list.claimed
int32
0
This is to indicate the quantity of voucher claimed.
error
string
Indicate error type if hit error. Empty if no error happened.
message
string
Indicate error type if hit error. Empty if no error happened.
request_id
string
57a48cf80bec43c7891909bd9acaedb6
The identifier of the API request for error tracking.
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.
