v2.video.get_video_list

GET /api/v2/video/get_video_list

Get the list of video in draft status or video already post to Shopee Video.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/video/get_video_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.
user_id	int	1	Shopee's unique identifier for a user.
sign	string	e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2	Signature generated by(depends on different APIs) partner_id, api path, timestamp, access_token, user_id and partner_key via HMAC-SHA256 hashing algorithm.

Request Parameters

Name	Type	Required	Sample	Description
page_no	int32	True	1	The start index of request. Starting from 1.
page_size	int32	True	10	The number of affiliate returned by this request, Max is 20.
list_type	int32	True	1	Search tpye for video in draft status or video already post to Shopee Video. 1: draft 2: post

Response Parameters

Name	Type	Sample	Description
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.
request_id	string	2af852cd-7420-4714-b7cd-33317f6fe548	The identifier for an API request for error tracking.
response	object		Detail informations you are querying.
total_count	int64	1	The total count of video that match the condition.
has_more	boolean	false	This is to indicate whether the video list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of data.
list	object		The list of video that match the condition.
video_upload_id	string	id-11110201-6ko2m-mczrffx878mba3	ID of uploaded video.
post_id	string	YwOo_gZqCACXbM0UAAAAAA==	The unique identifier for post Shopee Video. Only have value when the video status is 300 (POSTED).
post_time	timestamp	1761188662147	The time when the video post to Shopee Video. Only have value when the video status is 300 (POSTED).
video_url	string	https://down-bs-id.vod.susercontent.com/c3/50007225/201/A3oxONdWALgpg8thEbEBACc.mp4	Video play url.
status	int32	300	Video current status. Applicable values: 200: DRAFT 300: POSTED 400: DELETED 500: SCHEDULED 600: SCHEDULED_FAILED
cover_image_url	string	https://down-sp-id.vod.susercontent.com/c3/50007225/201/A3oyOUXSAFAbg8thIfYBBgAn.jpg	Cover image url of the Shopee Video.
caption	string	#tt Tt1	Description of the Shopee Video.
duration	int64	6866	Video duration time in millisecond.
views	int64	1	View count of post Shopee Video. Only have value when the video status is 300 (POSTED).
likes	int64	1	Like count the post Shopee Video. Only have value when the video status is 300 (POSTED).
comments	int64	1	Comment count the post Shopee Video. Only have value when the video status is 300 (POSTED).
has_performance	boolean	false	Whether there is video metric data.
item_list	object		List of products linked with the Shopee Video.
shop_id	int64		Shopee's unique identifier for a shop of the item.
item_id	int64	34002	Shopee's unique identifier for an item.
item_name	string	seller discount	Name of the item.
custom_item_name	string		Name of the item displayed on Shopee Video (max 255 characters).
item_cover_image_url	string		Cover image url of the item.
min_price	float	100000.0	Min price of the item.
max_price	float	100000.0	Max price of the item.
stock	int64	10	Stock of the item.
allow_info	object		Whether allow stitch and duet.
allow_stitch	boolean	true	Whether allow stitch.
allow_duet	boolean	true	Whether allow duet.
scheduled_info	object		When scheduled_post is true, scheduled_post_time must not empty. When scheduled_post is false, scheduled_post_time must empty.
scheduled_post	boolean	true	Whether post it to Shopee Video at scheduled time.
scheduled_post_time	timestamp	1761734929450	Scheduled post time, millisecond timestamp.
update_time	timestamp	1761734929450	The lasted update time the video.