v2.shop_flash_sale.get_shop_flash_sale_items

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 · 2026-09-06 12:15:32

打开官方原文 ↗

当前资料结构化阅读页
固定快照已留存，可追溯
官方原文可核对

查看技术与溯源信息

平台 / profile: Shopee / profile.shopee.api_reference
语言: en-US
发布版本: cn-20260909-2
标签: zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.shop_flash_sale.get_shop_flash_sale_items

get shop flash sale items and item detail

§2 Overview

Overview

Field	Value
Module	ShopFlashSale
API type	Shop
HTTP method	GET
Path	/api/v2/shop_flash_sale/get_shop_flash_sale_items
Production URL	https://partner.shopeemobile.com/api/v2/shop_flash_sale/get_shop_flash_sale_items
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/shop_flash_sale/get_shop_flash_sale_items
Permission	ERP System; Seller In House System; Marketing; Swam ERP

§3 Request parameters

Request parameters

Name	Type	Required	Description
flash_sale_id	int64	Yes
offset	int64	Yes	min=0,max=1000
limit	int64	Yes	min=1,max=100

§4 Response parameters

Response parameters

Name	Type	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.total_count	int64
response.models	object[]	If the item has variation, the infomation of model will be in this field
response.models.item_id	int64
response.models.model_id	int64
response.models.model_name	string
response.models.status	int32	the status of model in shop flash sale; 0: disable; 1: enable; 2: delete; 4: system_rejected, the model is rejected by system; 5: manual_rejected, the model is rejected manually
response.models.original_price	float
response.models.input_promotion_price	float	promotion price without tax
response.models.promotion_price_with_tax	float	promotion price with tax
response.models.purchase_limit	int64	0 means NO LIMIT
response.models.campaign_stock	int64
response.models.stock	int64	Active inventory
response.models.reject_reason	string	if the status is 4 or 5, this field will show the reason why this model was rejected
response.models.unqualified_conditions	object	if the model doesn't meet a criteria, will show the detail in this field
response.models.unqualified_conditions.unqualified_code	int32
response.models.unqualified_conditions.unqualified_msg	string
response.item_info	object[]
response.item_info.item_id	int64
response.item_info.item_name	string
response.item_info.status	int32	item status; 0: Deleted 1: Normal; 2: reviewing; 3: banned; 4: invalid; 5: invalid hide; 6: offensive hide; 7: auditing; 8: normal unlist
response.item_info.image	string	item image
response.item_info.item_status	int32	the status of item in shop flash sale. If the item has variation, this field will be empty; 0: disable; 1: enable; 2: delete; 4: system_rejected, the item is rejected by system; 5: manual_rejected, the item is rejected manually
response.item_info.original_price	float	original price of item, if the item has variation, this field will be empty
response.item_info.input_promotion_price	float	promotion price without tax of item, if the item has variation, this field will be empty
response.item_info.promotion_price_with_tax	float	promotion price with tax of item, if the item has no variation, this field will has value
response.item_info.purchase_limit	int64	0 means NO LIMIT; purchase limit of item, if the item has variation, this field will be empty
response.item_info.campaign_stock	int64	campaign stock of item, if the item has no variation, this field will has value
response.item_info.stock	int64	Active inventory of item, if the item has no variation, this field will has value
response.item_info.reject_reason	string	if the item_status is 4 or 5, this field will show the reason why this item was rejected; if the item has variation, this field will be empty
response.item_info.unqualified_conditions	object	if the item doesn't meet a criteria, will show the detail in this field; if the item has variation, this field will be empty
response.item_info.unqualified_conditions.unqualified_code	int32
response.item_info.unqualified_conditions.unqualified_msg	string

§5 Common parameters

Common 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

§6 Response sample

Response sample

§7 JSON

JSON

{
    "error": "",
    "message": "",
    "request_id": "688cd3b6725f12caadbe1e8e804c5041",
    "response": {
        "item_info": [
            {
                "image": "08b3fc410c8eaa7e3f52b06b486a8658",
                "item_id": 3744623870,
                "item_name": "platform sale product - 1723605523",
                "status": 1
            },
            {
                "image": "sg-11134201-7rbk0-lz7jo094tt1ubf",
                "item_id": 3744624265,
                "item_name": "2 Var diff price",
                "status": 1
            }
        ],
        "models": [
            {
                "campaign_stock": 2,
                "input_promotion_price": 69.3,
                "item_id": 3744623870,
                "model_id": 5414485721,
                "model_name": "Yellow",
                "original_price": 77,
                "promotion_price_with_tax": 75.54,
                "purchase_limit": 0,
                "reject_reason": "",
                "status": 1,
                "stock": 909
            },
            {
                "campaign_stock": 1234,
                "input_promotion_price": 1803.6,
                "item_id": 3744624265,
                "model_id": 438069048,
                "model_name": "tesr,33",
                "original_price": 2004,
                "promotion_price_with_tax": 1965.92,
                "purchase_limit": 0,
                "reject_reason": "",
                "status": 1,
                "stock": 0
            },
            {
                "campaign_stock": 1234,
                "input_promotion_price": 1800.9,
                "item_id": 3744624265,
                "model_id": 438069049,
                "model_name": "tes,22",
                "original_price": 2001,
                "promotion_price_with_tax": 1962.98,
                "purchase_limit": 0,
                "reject_reason": "",
                "status": 1,
                "stock": 0
            },
            {
                "campaign_stock": 1234,
                "input_promotion_price": 1801.8,
                "item_id": 3744624265,
                "model_id": 438069050,
                "model_name": "tes,33",
                "original_price": 2002,
                "promotion_price_with_tax": 1963.96,
                "purchase_limit": 0,
                "reject_reason": "",
                "status": 0,
                "stock": 1234
            },
            {
                "campaign_stock": 1234,
                "input_promotion_price": 1802.7,
                "item_id": 3744624265,
                "model_id": 438069051,
                "model_name": "tesr,22",
                "original_price": 2003,
                "promotion_price_with_tax": 1964.94,
                "purchase_limit": 0,
                "reject_reason": "",
                "status": 0,
                "stock": 1234
            }
        ],
        "total_count": 2
    }
}

§8 Error example

Error example

§9 JSON

JSON

{
    "error": "shop_flash_sale_param_error",
    "message": "The Wrong parameters, detail: request param error.",
    "request_id": "f0d66f0c0d7f49262bc49a902e765841",
    "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
2025-01-10	Support single item
2024-09-19	New API

这条内容对你有帮助吗？