v2.voucher.update_voucher
POST /api/v2/voucher/update_voucher
Update voucher
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/voucher/update_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 the voucher which is going to be updated. |
| voucher_name | string | False | test | The name of the voucher |
| start_time | timestamp | False | 1624327200 | The timing from when the voucher is valid; so buyer is allowed to claim and to use. Field can only be updated if voucher has not started. |
| end_time | timestamp | False | 1632448798 | The timing until when the voucher is still valid. Any time after this end_time, buyer is not allowed to claim or to use. |
| usage_quantity | int32 | False | 11 | The number of times for this particular voucher could be used. |
| min_basket_price | float | False | 1.0 | The minimum spend required for using this voucher. |
| discount_amount | float | False | 1.0 | The discount amount set for this particular voucher. Only fill in when you are updating a fix amount voucher. |
| percentage | int32 | False | 11 | The discount percentage set for this particular voucher. Only fill in when you are updating a discount percentage voucher or coins cashback voucher. |
| max_price | float | False | 1.0 | The max amount of discount/value a user can enjoy by using this particular voucher. Only fill in when you are updating a discount percentage voucher or coins cashback voucher. |
| display_channel_list | int32[] | False | [3,4] | 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). |
| item_id_list | int64[] | False | [121331,12332323] | The list of items which is applicable for the voucher. Only fill in when you are updating a product type of voucher. |
| display_start_time | int64 | False | 162078900 | The timing of when voucher is displayed on shop pages; so buyer is allowed to claim. |
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 | 7d23ab68bf7b11eba385acde48001122 | 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 which is being updated. |