快工助手跨境电商知识与商机助手
快工云仓服务介绍

[Important] Brand Portal Service OpenAPI Now Available

Shopee 官方资料 · Shopee Open Platform 变更通知（Announcements） · 适合开发者

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

来自 Shopee 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存，可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
Shopee / profile.shopee.announcements
语言
en
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/shopeeaudience/developercategory/announcementtopic/apitopic/api-brandportaltopic/changelogtopic/developertopic/openapi-updates

资料正文

§1 [Important] Brand Portal Service OpenAPI Now Available

Dear Developers:

Shopee has launched a new set of Open APIs for Brand Portal performance data, covering sales, affiliate marketing, livestream, and video performance. Developers can use these APIs to retrieve relevant performance data from Brand Portal and build automated reporting, data monitoring, and analytics tools for brands, improving the efficiency of data access and analysis.

#

§2 1. Scope of Application

1. Scope of Application

  • Supported Markets: At present Brand Portal Basic Sales Performance Data API support Taiwan (TW)、Philippines (PH)、Vietnam (VN)、Indonesia (ID)、Singapore (SG)、Thailand (TH)、Malaysia (MY)、Brazil (BR)。
  • Supported Roles: Only roles with an APP Type of "Brand Portal Service" are permitted to access this API.
  • App Type: Developers need to create and configure a Brand Portal Service app in the Shopee Open Platform Console. After completing Principal authorization, developers can call the relevant Brand Portal APIs to retrieve performance data.
#

§3 2. Authorisation and Authentication

2. Authorisation and Authentication

The authorization process for the Brand Portal API is similar to the existing authorisation process, but differs in the following ways:

  1. Licence type
  • The "auth_type" in the authorization link must be set to "principal".
  1. Public request parameter: principal_id
  • All Brand Portal-related APIs use "principal_id' as a common request parameter.
  • The API signature must also be generated based on the principal_id.
  1. Access Token & Refresh Token Management
  • The usage of "access_token" and "refresh_token" is the same as in OpenAPI; a separate "access_token" and "refresh_token" must be managed for each "principle_id".
#

§4 3. Current API Capabilities

3. Current API Capabilities

This section provides an overview of the Brand Portal Performance Data APIs, including the supported performance categories, API names, and the core capability of each API.

CategoryAPI NameAPI Description
Sales Performancev2.principal.get_shop_sales_performance_detailGet shop-level sales performance data for one or more shops.
Sales Performancev2.principal.get_principal_sales_performance_detailGet principal-level sales performance data by region.
Affiliate Performancev2.principal.get_shop_affiliate_performanceGet shop-level affiliate performance data.
Affiliate Performancev2.principal.get_principal_affiliate_performanceGet principal-level affiliate performance data by region.
Affiliate Performancev2.principal.get_content_affiliate_performanceGet content-level affiliate performance data.
Livestream Performancev2.principal.get_shop_livestream_performanceGet shop-level livestream performance data.
Livestream Performancev2.principal.get_principal_livestream_performanceGet principal-level livestream performance data by region.
Livestream Performancev2.principal.get_session_livestream_performanceGet session-level livestream performance data.
Video Performancev2.principal.get_shop_video_performanceGet shop-level video performance data.
Video Performancev2.principal.get_principal_video_performanceGet principal-level video performance data by region.
Video Performancev2.principal.get_clip_video_performanceGet clip-level video performance data.

For more integration details, please refer to the Brand Portal Service API Integration Guide.

For any technical issues encountered during integration, please reach out to us through the Open Platform Ticket System.

Thank you for your continued partnership with Shopee.

Effective Date on Live:

2026.07.10

尊敬的开发者:

Shopee 现已上线 Brand Portal 表现数据相关 OpenAPI, 涵盖销售表现、联盟营销表现、直播表现及视频表现等数据。开发者可通过这些 API 获取 Brand Portal 中的相关表现数据,从而为品牌构建自动化报表、数据监控及数据分析工具,进一步提升数据获取与分析效率。

#

§5 1. 适用范围

1. 适用范围

  • 支持站点: 目前 Brand Portal Basic Sales Performance Data API 支持 Taiwan (TW)、Philippines (PH)、Vietnam (VN)、Indonesia (ID)、Singapore (SG)、Thailand (TH)、Malaysia (MY)、Brazil (BR)。
  • 支持角色: Principal (即 Brand Portal 中的品牌主体)。
  • 应用类型: 开发者需在 Shopee Open Platform Console 中创建并配置 Brand Portal Service 类型的应用。完成 Principal 授权后,即可调用 Brand Portal 相关 API 获取表现数据。
#

§6 2. 授权与鉴权

2. 授权与鉴权

Brand Portal API 的授权流程与现有授权流程类似,但有以下不同:

  1. 授权类型
  • 授权链接中的 auth_type 必须使用 principal。
  1. 公共请求参数: principal_id
  • 所有 Brand Portal 相关 API 均使用 principal_id 作为公共请求参数。
  • API 签名(sign)也必须基于 principal_id 生成。
  1. Access Token & Refresh Token 管理
  • access_token 与 refresh_token 的使用方式与 OpenAPI 相同,需要为每个 "principle_id" 管理独立的 access_token 与 refresh_token。
#

§7 3. 本次开放的 API 能力

3. 本次开放的 API 能力

本部分概述 Brand Portal Performance Data APIs 当前支持的表现数据类别、对应的 API 名称,以及每个 API 的核心能力。

分类API 名称API 说明
Sales Performancev2.principal.get_shop_sales_performance_detail获取 shop level 的销售表现数据。
Sales Performancev2.principal.get_principal_sales_performance_detail获取 principal level 按地区维度的销售表现数据。
Affiliate Performancev2.principal.get_shop_affiliate_performance获取 shop level 的 affiliate 表现数据。
Affiliate Performancev2.principal.get_principal_affiliate_performance获取 principal level 按地区维度的 affiliate 表现数据。
Affiliate Performancev2.principal.get_content_affiliate_performance获取 content level 的 affiliate 表现数据。
Livestream Performancev2.principal.get_shop_livestream_performance获取 shop level 的直播表现数据。
Livestream Performancev2.principal.get_principal_livestream_performance获取 principal level 按地区维度的直播表现数据。
Livestream Performancev2.principal.get_session_livestream_performance获取 session level 的直播表现数据。
Video Performancev2.principal.get_shop_video_performance获取 shop level 的视频表现数据。
Video Performancev2.principal.get_principal_video_performance获取 principal level 按地区维度的视频表现数据。
Video Performancev2.principal.get_clip_video_performance获取 clip level 的视频表现数据。

如需更多接入详情,请参考 Brand Portal Service API 对接指南。

如在接入过程中遇到任何技术问题,请通过 Open Platform 工单系统与我们联系。

感谢您持续与 Shopee 合作。

上线时间:

2026.07.10

#