Skip to main content

Shopee Video API Integration Guide

Last Updated: 2025-12-19

Language Supported:
English / 简体中文 / 繁體中文

1. Introduction to Shopee Video​

Shopee Video is a content creation and marketing tool that enables sellers and affiliates to showcase products through engaging short videos. It provides flexibility for both sellers and affiliates to produce and share content. By leveraging visual storytelling, creators can increase engagement and drive higher conversion rates.

Benefits:

  • Gain Buyers and Followers: Attract attention and build a loyal customer base.
  • Increase Awareness: Showcase products and brand dynamically.
  • Drive Sales: Build trust, improve conversion, and encourage purchases.

Open Platform offers a set of Open APIs for video management and analytics, allowing developers to upload and manage videos, publish content, and track performance to optimize video-driven marketing strategies.

2. Integration Overview​

Integration with Shopee Video APIs consists of two main stages:

  • Uploading Video via Public Video Upload APIs – Upload video files and obtain a video_upload_id.
  • Managing and Publishing Video via Shopee Video APIs – Use v2.video.* APIs to select covers, edit video info, publish, delete, query, and analyze video performance.

3. Public Video Upload APIs​

Open Platform provides a set of public video upload APIs and push mechanism, designed for all future video upload scenarios. Currently, these APIs are supported only for Shopee Video.

API and Push List:

Upload Workflow:

  1. Call v2.media.init_video_upload to initialize the upload task.
  2. Upload video parts via v2.media.upload_video_part.
  3. Call v2.media.complete_video_upload to finish the upload.
  4. System processes video asynchronously and pushes the final status via video_upload_result_push.
  5. Optionally, call v2.media.get_video_upload_result to check progress.
  6. After a successful upload, obtain the video_upload_id to call Shopee Video APIs.

Notes:

  • Use push mechanism to receive upload completion notifications asynchronously to avoid polling.
  • Each upload task corresponds to a unique video; avoid uploading the same video multiple times.

4. Shopee Video APIs​

Shopee Video APIs are divided into two modules: Video Management and Performance Analytics.

4.1 Video Management​

  1. v2.video.get_cover_list: Get frame-by-frame screenshots of uploaded videos and select a specific frame as the video cover.

  2. v2.video.edit_video_info: Set or edit video information before post, including the video caption, cover, linked products, post time, and whether allow stitch and duet.

Note: Draft videos can be edited multiple times; once published, they cannot be edited.

  1. v2.video.post_video: Publish a draft video to Shopee Video. Must upload the video and edit its info first.

  2. v2.video.get_video_list: Retrieve the list of videos for the account.

  3. v2.video.get_video_detail: Retrieve detailed information for a video.

  4. v2.video.delete_video: Delete draft or published videos.

4.2 Performance Analytics​

Overall performance of all videos:

  1. v2.video.get_overview_performance: Retrieve overall content interaction and transaction conversion performance for all post videos.

  2. v2.video.get_metric_trend: Retrieve trends of content interaction and transaction conversion for all post videos over time.

  3. v2.video.get_user_demographics: Retrieve audience distribution data (age, gender, location, active time, content and product preferences) for all post videos.

  4. v2.video.get_product_performance_list: Retrieve performance data for products linked with videos.

Performance of single video:

  1. v2.video.get_video_performance_list: Retrieve overview performance for a single video.

  2. v2.video.get_video_detail_performance: Retrieve content interaction and transaction conversion performance for a single video.

  3. v2.video.get_video_detail_metric_trend: Retrieve trends of content interaction and transaction conversion for a single video, to analyze performance changes over time.

  4. v2.video.get_video_detail_audience_distribution: Retrieve audience distribution data (age, gender, location, active time, content and product preferences) for a single video, to analyze its audience profile.

  5. v2.video.get_video_detail_product_performance: Retrieve transaction conversion performance of products linked to a single video, to evaluate the video’s impact on sales and conversions.

Note: All performance data usually has at least a one-day delay.

5. Authorization & Authentication (User-type APIs)​

Shopee Video APIs are User-type APIs, requiring user_id and access_token. The authorization and authentication logic is same as Livestream APIs with the following points:

  • Role-based Authorization

  • If the authorized role is Seller, set auth_type=seller when generating the authorization link. After successful authorization, calling v2.public.get_access_token will return both shop_id and user_id.

  • If the authorized role is Affiliate, set auth_type=user when generating the authorization link. After successful authorization, calling v2.public.get_access_token will only return user_id.

  • Common Request Parameter: user_id

  • All Shopee Video API calls must use user_id as common request parameter instead of shop_id.

  • API signature (sign) must also be generated based on user_id.

  • Access Token & Refresh Token Management

  • Tokens must be managed separately for each user_id.

For detailed authorization and authentication flow, refer to the Livestream API Integration Guide.

6. Developer Integration Notes​

  • Only Shopee Video Management applications can access Video OpenAPI. Create the corresponding app type in the console before integration.
  • Must agree to Shopee Video's Terms & Conditions in Seller Center before performing any Video-related API operations.