stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 v2.voucher.delete_voucher
Delete voucher
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Voucher |
| API type | Shop |
| HTTP method | POST |
| Path | /api/v2/voucher/delete_voucher |
| Production URL | https://partner.shopeemobile.com/api/v2/voucher/delete_voucher |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/voucher/delete_voucher |
| Rate limit | [0, 0, 0] |
| Permission | ERP System; Seller In House System; Marketing; Swam ERP |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| voucher_id | int64 | Yes | 1104340665 | The unique identifier for the voucher you want to delete. |
§4 Response parameters
Response parameters
| Name | Type | Required | 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 | 034f813abf5e11eb9c4eacde48001122 | The identifier of the API request for error tracking. | |
| response | object | Detail informations you are querying. | ||
| response.voucher_id | int64 | 1104340665 | The unique identifier for the voucher it is being deleted. |
§5 Common parameters
Common parameters
| Name | Type | Required | 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 |
§6 Request samples
Request samples
§7 Payload
Payload
{"voucher_id":1104340665}
§8 Response sample
Response sample
§9 JSON
JSON
{
"response": {
"voucher_id": 1104340665
},
"request_id": "034f813abf5e11eb9c4eacde48001122",
"error": "",
"message": ""
}
§10 Error example
Error example
§11 JSON
JSON
{
"response": "",
"request_id": "986c581c8bcc1286ea391cbcd7f1552f",
"error": "common.error_not_found",
"message": "The information you queried is not found."
}
§12 Errors
Errors
| Error | Description | Solution |
|---|---|---|
| voucher.delete_voucher_error | Can only delete upcoming voucher. | |
| 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. | |
| error_param | Wrong parameters, detail: {msg}. | |
| error_server | Something wrong. Please try later. | |
| common.error_server | Something is wrong. Please try later. | |
| common.error_shop | Shopid is invalid. | |
| error_shop | shopid is invalid | |
| error_param | request not from gateway | |
| voucher.operate_voucher_permission_error | The Voucher created in Shopee admin/Shop Game/Follow Prize/Member ship/Voucher campaign can't be updated |
§13 Common errors
Common errors
| Error | Description | Solution |
|---|---|---|
| error_auth | partner_id is invalid | |
| error_auth | 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. |
§14 Update log
Update log
| Date | Change |
|---|---|
| 2025-09-08 | select voucher_id type as int64 |
| 2022-07-27 | Add Error Example information |
| 2022-07-01 | Optimize the Sample information of Request Parameter and Response Parameter |
| 2021-06-24 | New API |