v2.follow_prize.get_follow_prize_list
GET /api/v2/follow_prize/get_follow_prize_list
OpenAPI get_follow_prize_list
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/follow_prize/get_follow_prize_list
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 |
|---|---|---|---|---|
| page_no | int32 | False | 1 | Specifies the page number of data to return in the current call. Default to be 1. |
| page_size | int32 | False | 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 | True | upcoming | The status filter for retrieving follow prize list. Available value: upcoming/ongoing/expired/all. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| response | object | Detailed informations you are querying. | |
| more | boolean | false | 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. |
| follow_prize_list | object | The list of follow prize. | |
| campaign_id | int32 | 27 | The unique identifier for the created follow prize. |
| campaign_status | string | upcoming | The status of follow prize,the campagin status have upcoming/ongoing/expired. |
| follow_prize_name | string | shop_follow_prize3 | The name of the follow prize,The follow prize name length max limit is 20. |
| 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." |
| 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." |
| usage_quantity | int32 | 2000 | Please enter a value between 1 and 200000. |
| 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. |