v2.shop_flash_sale.get_shop_flash_sale_list
GET /api/v2/shop_flash_sale/get_shop_flash_sale_list
get shop flash sale list
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/shop_flash_sale/get_shop_flash_sale_list
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 |
|---|---|---|---|---|
| type | int32 | True | 1 | you can use this filed to search different state of shop flash sale 0: all state 1: upcoming state 2: ongoing state 3: expired state |
| start_time | timestamp | False | 1721978628 | you should use start_time and end_time together, and start_time shoule be < end_time |
| end_time | timestamp | False | 1727335428 | you should use start_time and end_time together, and start_time shoule be < end_time |
| offset | int64 | True | 0 | min=0,max=1000 |
| limit | int64 | True | 10 | min=1,max=100 |
Response Parameters
| Name | Type | 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 | ||
| total_count | int64 | 10 | the number of shop flash sale that the shop has |
| flash_sale_list | object[] | ||
| timeslot_id | int64 | ||
| flash_sale_id | int64 | ||
| status | int32 | 1 | the status of shop flash sale 0: deleted 1: enabled 2: disabled 3: system_rejected, you cannot edit the shop flash sale in 'system_rejected' status |
| start_time | timestamp | 1721978628 | the start time of shop flash sale |
| end_time | timestamp | 1727335428 | the end time of shop flash sale |
| enabled_item_count | int32 | 10 | the number of enabled items in shop flash sale |
| item_count | int32 | 20 | the number of items in shop flash sale |
| type | int32 | 1 | the state of shop flash sale 1: upcoming 2: ongoing 3: expired |
| remindme_count | int64 | 100 | No. of Reminders Set |
| click_count | int64 | 200 | No. of Product Clicks |
No Request Example Set.