The name of the follow prize,The follow prize name length max limit is 20.
start_time
timestamp
Yes
1621844677
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
Yes
1621944677
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
Yes
2000
Please enter a value between 1 and 200000.
min_spend
float
Yes
200.0
The minimum spend required for using this follow prize.
reward_type
int32
Yes
1
The reward type of the follow prize.The available values are:1:discount---fix amount,2:discount---by percentage,3:coin cash back.
discount_amount
float
No
50.0
The discount amount set for this particular follow prize.Only fill in when you are creating a fix amount follow prize.
percentage
int32
No
2
The discount percentage set for this particular follow prize. Only fill in when you are creating a discount percentage follow prize or coins cashback follow prize.Discount percentage (reward_type ==2) or Percentage of coins cash back (reward_type==3).
max_price
float
No
300.0
The max amount of discount/value a user can enjoy by using this particular follow prize. It is required to fill in when you are creating a discount percentage follow prize or coins cashback follow prize. max_price >=1
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.reward_type_coin_mx
Can't create coins cashback in MX
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.reward_type_coin_mx
Can't create coins cashback in MX
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.
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.
