v2.shop_flash_sale.get_shop_flash_sale_items

GET /api/v2/shop_flash_sale/get_shop_flash_sale_items

get shop flash sale items and item detail

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/shop_flash_sale/get_shop_flash_sale_items

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
flash_sale_id	int64	True
offset	int64	True		min=0,max=1000
limit	int64	True		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
models	object[]		If the item has variation, the infomation of model will be in this field
item_id	int64
model_id	int64
model_name	string
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
original_price	float
input_promotion_price	float		promotion price without tax
promotion_price_with_tax	float		promotion price with tax
purchase_limit	int64		0 means NO LIMIT
campaign_stock	int64
stock	int64		Active inventory
reject_reason	string		if the status is 4 or 5, this field will show the reason why this model was rejected
unqualified_conditions	object		if the model doesn't meet a criteria, will show the detail in this field
unqualified_code	int32
unqualified_msg	string
item_info	object[]
item_id	int64
item_name	string
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
image	string		item image
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
original_price	float		original price of item, if the item has variation, this field will be empty
input_promotion_price	float		promotion price without tax of item, if the item has variation, this field will be empty
promotion_price_with_tax	float		promotion price with tax of item, if the item has no variation, this field will has value
purchase_limit	int64		0 means NO LIMIT purchase limit of item, if the item has variation, this field will be empty
campaign_stock	int64		campaign stock of item, if the item has no variation, this field will has value
stock	int64		Active inventory of item, if the item has no variation, this field will has value
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
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
unqualified_code	int32
unqualified_msg	string

No Request Example Set.