New Shopee's Openapi Announcement (ID: 1462)
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.
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.
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 typeThe "auth_type" in the authorization link must be set to "principal".
2) Public request parameter: principal_idAll Brand Portal-related APIs use "principal_id' as a common request parameter.The API signature must also be generated based on the principal_id.
3) Access Token & Refresh Token ManagementThe 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".
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.
| Category |
API Name |
API Description |
| Sales Performance |
v2.principal.get_shop_sales_performance_detail |
Get shop-level sales performance data for one or more shops. |
| Sales Performance |
v2.principal.get_principal_sales_performance_detail |
Get principal-level sales performance data by region. |
| Affiliate Performance |
v2.principal.get_shop_affiliate_performance |
Get shop-level affiliate performance data. |
| Affiliate Performance |
v2.principal.get_principal_affiliate_performance |
Get principal-level affiliate performance data by region. |
| Affiliate Performance |
v2.principal.get_content_affiliate_performance |
Get content-level affiliate performance data. |
| Livestream Performance |
v2.principal.get_shop_livestream_performance |
Get shop-level livestream performance data. |
| Livestream Performance |
v2.principal.get_principal_livestream_performance |
Get principal-level livestream performance data by region. |
| Livestream Performance |
v2.principal.get_session_livestream_performance |
Get session-level livestream performance data. |
| Video Performance |
v2.principal.get_shop_video_performance |
Get shop-level video performance data. |
| Video Performance |
v2.principal.get_principal_video_performance |
Get principal-level video performance data by region. |
| Video Performance |
v2.principal.get_clip_video_performance |
Get clip-level video performance data. |
Announcement URL: https://open.shopee.com/announcements/1462
@junie-agent Please review the API changes described above. Focus ONLY on major updates such as adding new endpoints or removing/taking legacy APIs offline. You can safely ignore any other changes regarding request/response parameters or fields. Update the PHP code and create a new PR for review. Close issue if nothing changes applied.
New Shopee's Openapi Announcement (ID: 1462)
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.
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.
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 typeThe "auth_type" in the authorization link must be set to "principal".
2) Public request parameter: principal_idAll Brand Portal-related APIs use "principal_id' as a common request parameter.The API signature must also be generated based on the principal_id.
3) Access Token & Refresh Token ManagementThe 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".
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.
v2.principal.get_shop_sales_performance_detailv2.principal.get_principal_sales_performance_detailv2.principal.get_shop_affiliate_performancev2.principal.get_principal_affiliate_performancev2.principal.get_content_affiliate_performancev2.principal.get_shop_livestream_performancev2.principal.get_principal_livestream_performancev2.principal.get_session_livestream_performancev2.principal.get_shop_video_performancev2.principal.get_principal_video_performancev2.principal.get_clip_video_performanceAnnouncement URL: https://open.shopee.com/announcements/1462
@junie-agent Please review the API changes described above. Focus ONLY on major updates such as adding new endpoints or removing/taking legacy APIs offline. You can safely ignore any other changes regarding request/response parameters or fields. Update the PHP code and create a new PR for review. Close issue if nothing changes applied.