stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 v2.add_on_deal.add_add_on_deal
Add Add-on Deal
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Add-On Deal |
| API type | Shop |
| HTTP method | POST |
| Path | /api/v2/add_on_deal/add_add_on_deal |
| Production URL | https://partner.shopeemobile.com/api/v2/add_on_deal/add_add_on_deal |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/add_on_deal/add_add_on_deal |
| 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 |
|---|---|---|---|---|
| add_on_deal_name | string | Yes | add on deal name test | Title of the add on deal |
| start_time | int | Yes | 1624864213 | The time when add on deal activity start. |
| end_time | int | Yes | 1625382613 | The time when add on deal activity end |
| promotion_type | int | Yes | 0 | The type of add on deal：add on discount =0；gift with mini spend=1 |
| purchase_min_spend | float | No | 11.1 | The minimum purchase amount that needs to be met to buy the gift with min.Spend |
| per_gift_num | int | No | 11 | Number of gifts that buyers can get |
| promotion_purchase_limit | int | No | 12 | promotion_purchase_limit |
§4 Response parameters
Response parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| error | string | add_on.add_on_deal_start_time_error | Error code | |
| message | string | The start time should be 1 hour later than current time | The description of error code | |
| request_id | string | c4fbe50a634200235c10a2b3e95ae99a | The identifier of the API request for error tracking | |
| response | object | |||
| response.add_on_deal_id | int | 20142 | Shopee's unique identifier for an add on deal activity. |
§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
{
"add_on_deal_name": "add on deal name test",
"start_time": "1624864213",
"end_time": "1625382613",
"promotion_type": "0",
"purchase_min_spend": "11.1",
"per_gift_num": "11",
"promotion_purchase_limit": "12"
}
§8 Response sample
Response sample
§9 JSON
JSON
{
"message": "",
"request_id": "c4fbe50a634200235c10a2b3e95ae99a",
"response": {
"add_on_deal_id": 20142
},
"error": ""
}
§10 Error example
Error example
§11 JSON
JSON
{
"message": "The name of add on deal can't exceed 25 characters",
"request_id": "3beee6455825dec0e07cc4417fd8f534",
"response": {},
"error": "add_on.add_on_deal_name_invalid"
}
§12 Errors
Errors
| Error | Description | Solution |
|---|---|---|
| add_on.add_on_deal_end_time_error | The end time should be 1 hour later than start time | |
| add_on.add_on_deal_name_invalid | The name of add on deal can't exceed 25 characters | |
| add_on.add_on_deal_over_size | A maximum of 1000 add on deals can be created | |
| add_on.add_on_deal_set_error | Please input per gift number between 1 to 50 | |
| add_on.add_on_edit_error | Please input correct promotion purchase limit | |
| add_on.add_on_deal_start_time_error | The start time should be 1 hour later than current time | |
| add_on.add_on_deal_set_error | Please input add on deal purchase limit between 1 to 100 | |
| add_on.add_on_deal_type_error | Please input correct promotion type: Add-on discount=0; Gift with min.spend=1 | |
| 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 |
§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-26 | Add Error Example information |
| 2022-06-30 | Optimize the Sample information of Request Parameter and Response Parameter |
| 2021-05-17 | New API |