v2.follow_prize.add_follow_prize
POST /api/v2/follow_prize/add_follow_prize
OpenAPI add Follow Prize
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/follow_prize/add_follow_prize
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. |
| 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 |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| follow_prize_name | string | True | shop_follow_prize_one | The name of the follow prize,The follow prize name length max limit is 20. |
| start_time | timestamp | True | 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 | True | 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 | True | 2000 | Please enter a value between 1 and 200000. |
| min_spend | float | True | 200.0 | The minimum spend required for using this follow prize. |
| reward_type | int32 | True | 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 | False | 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 | False | 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 | False | 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 |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| 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. | |
| response | object | Detailed informations you are querying. | |
| campagin_id | int32 | 2365452 | The unique identifier for the created follow prize. |
| request_id | string | 70ef2c3c6e461cd4258f9962409634d5 | The identifier of the API request for error tracking. |