v2.video.get_video_list

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

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

打开官方原文 ↗

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

查看技术与溯源信息

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

资料正文

§2 Overview

Overview

Field	Value
Module	Video
API type	User
HTTP method	GET
Path	/api/v2/video/get_video_list
Production URL	https://partner.shopeemobile.com/api/v2/video/get_video_list
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/video/get_video_list
Permission	Shopee Video Management

§3 Request parameters

Request parameters

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

§4 Response parameters

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

§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.
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.

§6 Request samples

Request samples

§7 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/video/get_video_list?access_token=access_token&list_type=0&page_no=0&page_size=0&partner_id=partner_id&sign=sign&timestamp=timestamp&user_id=user_id")
.asString();

§8 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/video/get_video_list?access_token=access_token&list_type=0&page_no=0&page_size=0&partner_id=partner_id&sign=sign&timestamp=timestamp&user_id=user_id',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

§9 cURL

cURL

curl --location --request GET 'https://partner.shopeemobile.com/api/v2/video/get_video_list?access_token=access_token&list_type=0&page_no=0&page_size=0&partner_id=partner_id&sign=sign&timestamp=timestamp&user_id=user_id'

§10 Python

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/video/get_video_list?access_token=access_token&list_type=0&page_no=0&page_size=0&partner_id=partner_id&sign=sign&timestamp=timestamp&user_id=user_id"

payload={}
headers = {

}
response = requests.RPCRequest("GET",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

§11 Response sample

Response sample

§12 JSON

JSON

{
	"error": "",
	"message": "",
	"request_id": "2af852cd-7420-4714-b7cd-33317f6fe548",
	"response": {
		"total_count": 1,
		"has_more": false,
		"list": {
			"video_upload_id": "id-11110201-6ko2m-mczrffx878mba3",
			"post_id": "YwOo_gZqCACXbM0UAAAAAA==",
			"post_time": 1761188662147,
			"video_url": "https://down-bs-id.vod.susercontent.com/c3/50007225/201/A3oxONdWALgpg8thEbEBACc.mp4",
			"status": 300,
			"cover_image_url": "https://down-sp-id.vod.susercontent.com/c3/50007225/201/A3oyOUXSAFAbg8thIfYBBgAn.jpg",
			"caption": "#tt Tt1",
			"duration": 6866,
			"views": 1,
			"likes": 1,
			"comments": 1,
			"has_performance": false,
			"item_list": {
				"item_id": 34002,
				"item_name": "seller discount",
				"item_cover_image_url": "-",
				"min_price": 100000,
				"max_price": 100000,
				"stock": 10,
				"shop_id": 0,
				"custom_item_name": "-"
			},
			"allow_info": {
				"allow_stitch": true,
				"allow_duet": true
			},
			"scheduled_info": {
				"scheduled_post": true,
				"scheduled_post_time": 1761734929450
			},
			"update_time": 1761734929450
		}
	}
}

§13 Error example

Error example

§14 JSON

JSON

{
	"error": "error_param",
	"message": "list_type must be 1,2",
	"request_id": "2af852cd-7420-4714-b7cd-33317f6fe548"
}

§15 Errors

Errors

Error	Description	Solution
error_param	list_type must be 1,2
error_param	page_no must over 1
error_param	page_size can not over 20

§16 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.
user_no_linked	Partner and user has no linked.
user_banned	This user account has been banned. Permissions for user authorization and API calls have been suspended until the user account is restored.
invalid_acceess_token	Invalid access_token, please have a check.
error_param	There is no user_id in query.
error_param	user_id is invalid, should be an integer between 0 and 4294967295.

§17 Update log

Update log

Date	Change
2025-09-10	New API

这条内容对你有帮助吗？

资料正文

§1 v2.video.get_video_list

§2 Overview

Overview

§3 Request parameters

Request parameters

§4 Response parameters

Response parameters

§5 Common parameters

Common parameters

§6 Request samples

Request samples

§7 Java

Java

§8 PHP

PHP

§9 cURL

cURL

§10 Python

Python

§11 Response sample

Response sample

§12 JSON

JSON

§13 Error example

Error example

§14 JSON

JSON

§15 Errors

Errors

§16 Common errors

Common errors

§17 Update log

Update log