v2.shop_flash_sale.get_item_criteria
GET /api/v2/shop_flash_sale/get_item_criteria
get shop flash sale item criteria
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/shop_flash_sale/get_item_criteria
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 |
No Request Parameters Set.
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 | ||
| criteria | object[] | criteria detail | |
| criteria_id | int64 | ||
| min_product_rating | float | Product Rating(0.0-5.0), -1 means no limit | |
| min_likes | int32 | Likes(s), -1 means no limit | |
| must_not_pre_order | boolean | true | Pre-Order(s) |
| min_order_total | int32 | Orders in the last 30 day(s), -1 means no limit | |
| max_days_to_ship | int32 | Days to Ship, -1 means no limit | |
| min_repetition_day | int32 | Repetition Control (Same Product cannot Join ISFS within N Days) , -1 means no limit | |
| min_promo_stock | int32 | 1 | Promo Stock, -1 means no limit |
| max_promo_stock | int32 | 10 | Promo Stock, -1 means no limit |
| min_discount | int64 | 10 | Discount Limit, 10 means 10%, -1 means no limit |
| max_discount | int64 | 100 | Discount Limit, 100 means 100%, -1 means no limit |
| min_discount_price | int64 | 10000000 | Discount Limit, -1 means no limit, real min discount price = min_discount_price / 100000 |
| max_discount_price | int64 | 100000000 | Discount Limit, -1 means no limit, real max discount price = max_discount_price / 100000 |
| need_lowest_price | boolean | true | lower than lowest price in last 7 days (exclude Shopee Flash Deals) |
| pair_ids | object[] | the mapping relationship between criteria and category | |
| criteria_id | int64 | ||
| category_list | object[] | these are the categories that the shop has items, and the criteria will apply to these categories | |
| category_id | int64 | o means this is All category | |
| name | string | category name | |
| parent_id | int64 | the parent category id, 0 means this category is L1 category | |
| overlap_block_category_ids | int64[] | Due to regulations, the promotion of some products in these categories are prohibited in this region |
No Request Example Set.
No Response Example Set.