stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 v2.shop_flash_sale.get_shop_flash_sale
get shop flash sale detail
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | ShopFlashSale |
| API type | Shop |
| HTTP method | GET |
| Path | /api/v2/shop_flash_sale/get_shop_flash_sale |
| Production URL | https://partner.shopeemobile.com/api/v2/shop_flash_sale/get_shop_flash_sale |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/shop_flash_sale/get_shop_flash_sale |
| Permission | ERP System; Seller In House System; Marketing; Swam ERP |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| flash_sale_id | int64 | Yes |
§4 Response parameters
Response parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| request_id | string | The identifier for an API request for error tracking. | ||
| 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. | ||
| response | object | |||
| response.timeslot_id | int64 | |||
| response.flash_sale_id | int64 | |||
| response.status | int32 | 1 | the status of shop flash sale; 0: deleted; 1: enabled; 2: disabled | |
| response.start_time | timestamp | 1721978628 | the start time of shop flash sale | |
| response.end_time | timestamp | 1727335428 | the end time of shop flash sale | |
| response.enabled_item_count | int32 | 10 | the number of enabled items in shop flash sale | |
| response.item_count | int32 | 20 | the number of items in shop flash sale | |
| response.type | int32 | 1 | the state of shop flash sale; 1: upcoming; 2: ongoing; 3: expired |
§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 Response sample
Response sample
§7 JSON
JSON
{
"error": "",
"message": "",
"request_id": "4f0c979980b49d02f352fdc81dace741",
"response": {
"enabled_item_count": 0,
"end_time": 1725040799,
"flash_sale_id": 802063533822541,
"item_count": 0,
"start_time": 1725033600,
"status": 3,
"timeslot_id": 237859372232704,
"type": 1
}
}
§8 Error example
Error example
§9 JSON
JSON
{
"error": "shop_flash_sale_not_exist",
"message": "shop flash sale not exist",
"request_id": "8c45398058903b26f731b34931d24241",
"response": {}
}
§10 Errors
Errors
| Error | Description | Solution |
|---|---|---|
| error_data | parse data failed | |
| error_data | data not exist | |
| error_param | parameter invalid | |
| marketing_error_no_premission | You don't have permission for the operation | |
| error_param | 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 | |
| shop_flash_sale_not_exist | shop flash sale not exist | |
| shop_flash_sale_param_error | The Wrong parameters, detail: {msg}. |
§11 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. |
§12 Update log
Update log
| Date | Change |
|---|---|
| 2024-09-19 | New API |