stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 v2.voucher.add_voucher
Add voucher
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Voucher |
| API type | Shop |
| HTTP method | POST |
| Path | /api/v2/voucher/add_voucher |
| Production URL | https://partner.shopeemobile.com/api/v2/voucher/add_voucher |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/voucher/add_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_name | string | Yes | testamount | The name of the voucher. |
| voucher_code | string | Yes | test | The code of the voucher. |
| start_time | timestamp | Yes | 1624719600 | 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 | Yes | 1624978800 | The timing until when the voucher is still valid. Any time after this end_time, buyer is not allowed to claim or to use. |
| voucher_type | int32 | Yes | 1 | The type of the voucher. The available values are: 1: shop voucher, 2: product voucher. |
| reward_type | int32 | Yes | 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 | Yes | 20000 | The number of times for this particular voucher could be used. |
| min_basket_price | float | Yes | 12.01 | The minimum spend required for using this voucher. |
| discount_amount | float | No | 1.55 | The discount amount set for this particular voucher. Only fill in when you are creating a fix amount voucher. |
| percentage | int32 | No | 22 | The discount percentage set for this particular voucher. Only fill in when you are creating a discount percentage voucher or coins cashback voucher. |
| max_price | float | No | 12.0 | The max amount of discount/value a user can enjoy by using this particular voucher. Only fill in when you are creating a discount percentage voucher or coins cashback voucher.If no cap limit, can set to be 0. |
| display_channel_list | int32[] | No | [1] | The FE channel where the voucher will be displayed. The available values are: 1: display_all 3: feed, 4: live streaming, [] (empty - which is hidden). |
| item_id_list | int64[] | No | [1223223,1223213] | The list of items which is applicable for the voucher. Only fill in when you are creating a product type of voucher. |
| display_start_time | int32 | No | 162078900 | The timing of when voucher is displayed on shop pages; so buyer is allowed to claim.display_start_time must be left empty if the display_channel_list is empty (when voucher is hidden), otherwise it will show error. |
§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 | 4e5d881ac1bc11ebba0dacde48001122 | The identifier of the API request for error tracking. | |
| response | object | Detailed informations you are querying. | ||
| response.voucher_id | int64 | 123 | The unique identifier for the created voucher. |
§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_name": "testamount",
"voucher_code": "test",
"start_time": 1624719600,
"end_time": 1624978800,
"voucher_type": 1,
"reward_type": 1,
"usage_quantity": 20000,
"min_basket_price": 12.01,
"discount_amount": 1.55,
"max_price": 12.12,
"display_channel_list": [
1
],
"display_start_time":162078900
}
§8 Response sample
Response sample
§9 JSON
JSON
{
"response": {
"voucher_id": 123
},
"request_id": "4e5d881ac1bc11ebba0dacde48001122",
"error": "",
"message": ""
}
§10 Error example
Error example
§11 JSON
JSON
{
"response": "",
"request_id": "6805364500d4841be6953c9d8a5f3d13",
"error": "voucher.voucher_min_price_error",
"message": "Min_basket_price must be higher than the fix amount if Min_basket_price is not 0."
}
§12 Errors
Errors
| Error | Description | Solution |
|---|---|---|
| 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. | |
| error_param | Wrong parameters, detail: {msg}. | |
| error_server | Something wrong. Please try later. | |
| error_shop | shopid is invalid | |
| error_param | request not from gateway | |
| voucher.voucher_min_price_error | Min_basket_price must be higher than the fix amount if Min_basket_price is not 0. | |
| voucher.voucher_btoc_item_blocked_error | Some items cannot be uploaded as they are b2c products in FBS shop | |
| voucher.voucher_code_duplicate_error | Duplicated voucher code. | |
| voucher.voucher_code_error | Voucher code doesn't meet the requirement. Only support 0-9 or A-Z or a-z. Up to 5 characters. | |
| voucher.voucher_coin_error | Cannot create coin cashback voucher. | |
| voucher.voucher_display_channel_error | Voucher display channel is set wrongly. | |
| voucher.voucher_end_time_error | Voucher valid period can not be longer than 3 months. | |
| voucher.fix_amount_low_qualtiy_errorr | Voucher cannot be saved as it is lower than {limit}%. Please adjust the percentage amount to be more than or equal to {limit}%. | |
| voucher.voucher_item_blocked_from_promotion_error | Some items cannot be uploaded as they are prohibited from promotions due to regulations | |
| voucher.voucher_item_duplication_error | Duplicated items in item_id_list. | |
| voucher.voucher_item_count_limit_error | The number of items in item_id_list exceeds the limit. | |
| voucher.voucher_item_not_exist | Some item in item_id_list doesn't exist | |
| voucher.voucher_item_status_error | Not all the items in item_id_list are in normal status. | |
| voucher.voucher_item_stock_error | Some item in item_id_list has 0 stock. | |
| voucher.voucher_max_discount_low_quality | To attract buyers to use your voucher, please increase maximum discount price to > {percentage_inputmin_spend0.01} or reduce minimum basket price to < {max_discount*100/percentage_input} to ensure buyers can enjoy the percentage discount configured. | |
| voucher.voucher_over_limit | The total number of ongoing voucher and upcoming voucher cannot exceed 1000. | |
| voucher.percentage_low_quality_error | Voucher cannot be saved as it is lower than {limit}.00%. Please adjust the percentage amount to be more than or equal to {limit}.00%. | |
| voucher.voucher_start_time_error | Voucher start time is earlier than current time. | |
| voucher.voucher_time_period_error | Voucher end time must be 1 hour later than the start time. |
§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 |
|---|---|
| 2022-07-27 | Add Error Example information |
| 2022-07-07 | Optimize the display_start_time of request parameters description |
| 2022-07-01 | Optimize the Sample information of Request Parameter and Response Parameter |
| 2021-12-15 | Request Parameter add new field display_start_time |
| 2021-06-24 | New API |