v2.voucher.get_voucher
GET /api/v2/voucher/get_voucher
Get Voucher Detail
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/voucher/get_voucher
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 |
|---|---|---|---|---|
| voucher_id | int64 | True | 123 | The unique identifier of a voucher used to query the voucher details. |
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. | |
| request_id | string | 6737e37ec1b411ebb7fbacde48001122 | The identifier of the API request for error tracking. |
| response | object | Detailed informations you are querying. | |
| voucher_id | int64 | 123 | The unique identifier of the voucher whose details are returned. |
| voucher_code | string | MKTSRWE | Voucher Code |
| voucher_name | string | test | Voucher Name |
| voucher_type | int32 | 1 | The type of the voucher. The available values are: 1: shop voucher, 2: product voucher. |
| reward_type | int32 | 1 | The reward type of the voucher. The available values are: 1: fix_amount voucher, 2: discount_percentage voucher, 3: coin_cashback voucher. |
| usage_quantity | int32 | 1 | The number of times for this particular voucher could be used. |
| current_usage | int32 | 0 | Up till now, how many times has this particular voucher already been used. |
| start_time | timestamp | 1622198847 | The timing from when the voucher is valid; so buyer is allowed to claim and to use. |
| end_time | timestamp | 1622807247 | The timing until when the voucher is still valid. Any time after this end_time, buyer is not allowed to claim or to use. |
| is_admin | boolean | false | If the voucher is created by Shopee or not. |
| voucher_purpose | int32 | 0 | The use case for the voucher. The available values are: 0: normal; 1: welcome, 2: referral; 3: shop_follow; 4:shop_game, 5: free_gift, 6: membership，7: Ads |
| display_channel_list | int32[] | [1,2] | The FE channel where the voucher will be displayed. The available values are: 1: display_all, 2: order page, 3: feed, 4: live streaming, [] (empty - which is hidden). |
| min_basket_price | float | 10.1 | The minimum spend required for using this voucher. |
| percentage | int32 | 22 | The discount percentage is set for this particular voucher. Only when it is a discount percentage voucher or coins cashback voucher, api will return a value. |
| max_price | float | 11.1 | The max amount of discount/value a user can enjoy by using this particular voucher. Only when it is a discount percentage voucher or coins cashback voucher, api will return a value. |
| discount_amount | float | 11.0 | The discount amount set for this particular voucher. Only when it is a fix amount voucher, api will return a value. |
| cmt_voucher_status | int32 | 1 | The voucher status in CMT. The available values are: 1:review, 2: approved, 3:reject. Only when this voucher is attending CMT campaign and not being rejected, api will return a value. |
| item_id_list | int64[] | [123422,122311] | The list of items which is applicable for the voucher. Only return a value when it is a product type of voucher. |
| display_start_time | timestamp | 162078900 | The timing of when voucher is displayed on shop pages; so buyer is allowed to claim. |
| target_voucher | int32 | The field is used to mark new user voucher/ repeat buyer voucher 1: new user voucher 2: repeat buyer voucher: with 1 orders 3. repeat buyer voucher: with 2 orders | |
| usecase | int32 | usecase indicates a specific business scenario that the voucher is created and used for, i.e., new buyer voucher, live voucher, follow shop voucher, etc. shop voucher:1 product voucher:2 new buyer voucher:3 repeat buyer voucher:4 private voucher:5 live voucher:6 video voucher:7 campaign voucher:8 follow prize voucher:9 membership voucher:10 game prize voucher:11 sample voucher:12 |