快工助手跨境电商知识与商机助手

Significant OpenAPI Updates of Return, Video

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-returnstopic/api-videotopic/changelogtopic/developertopic/openapi-updates

资料正文

§1 Significant OpenAPI Updates of Return, Video

Dear Developers,

Please find below the OpenAPI updates released this time. These changes aim to enhance functionality, improve flexibility, and provide better integration support.

#

§2 1. Return Refund Reason Field Updated

There may be cases where Shopee Agent updates the return request with a Reassessed Return Reason after reviewing more details about the buyer's return request and potentially after requesting evidence from the seller.

To help sellers better understand return judgments and dispute decisions, Shopee has added a new response parameter reassessed_request_reason to v2.returns.get_return_list and v2.returns.get_return_detail APIs. Details are as follows:

NameTypeDescription
reassessed_request_reasonstringIndicates the return reason reassessed by the platform as more suitable. The applicable values are the same as existing “reason” parameter. Note: If no reassessment exists, the value will be "NONE".

Related APIs:

v2.returns.get_return_list

v2.returns.get_return_detail

Effective Date on Live:

2025.12.15

#

§3 2. Shopee Video Support New Single Video Performance APIs

The Shopee Video APIs already provide sellers and affiliates with capabilities for video upload, management, and overall performance analysis. Developers can retrieve overall video performance data through the existing APIs.

To further enhance Shopee Video’s data analysis capabilities, we have added 4 new APIs to obtain performance data for individual videos, helping sellers and affiliates gain deeper insights into each video’s performance and enabling more precise data analysis and operational optimization.

The newly added APIs are as follows:

  1. v2.video.get_video_detail_performance: Retrieve content interaction (views, likes, comments, new followers, etc.) and transaction conversion (orders, sales, product clicks, conversion rate, etc.) performance for a single video, to evaluate its content effectiveness and sales impact.

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

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

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

For more API descriptions and integration guidelines, please refer to the Shopee Video API Integration Guide.

Related APIs:

v2.video.get_video_detail_performance

v2.video.get_video_detail_metric_trend

v2.video.get_video_detail_audience_distribution

v2.video.get_video_detail_product_performance

Effective Date on Live:

2025.12.19

尊敬的开发者,

请查收本次的 OpenAPI 功能更新。这些改动旨在提升功能灵活性、优化使用体验,并为集成提供更好的支持。

#

§4 1. 退货退款原因字段更新

在某些情况下,Shopee 客服在审核买家的退货请求详情 (并可能在向卖家索取相关证据) 后,可能会更新退货请求的 Reassessed Request Reason (重新评估的退货原因)。

为了帮助卖家更清楚地了解退货判定和处理结果, Shopee 在 v2.returns.get_return_listv2.returns.get_return_detail 接口新增了 reassessed_request_reason 响应参数。具体更新内容如下:

NameTypeDescription
reassessed_request_reasonstring平台重新评估后认为更合适的退货原因,枚举值同已有的 reason 响应参数。 注:若不存在重新评估,则返回为“NONE”。

影响接口:

v2.returns.get_return_list

v2.returns.get_return_detail

上线时间:

2025.12.15

#

§5 2. Shopee Video 新增单个 Video 表现数据接口

Shopee Video API 已为卖家和达人提供了视频上传、管理以及整体表现数据分析能力,开发者可通过现有接口获取所有 Video 的整体表现数据。

为进一步完善 Shopee Video 的数据分析能力,我们新增了 4 个接口用于获取单个 Video 的表现数据,帮助卖家和达人更深入地了解每个视频的表现,从而实现更精细化的数据分析与运营优化。

本次新增的接口包括:

1)v2.video.get_video_detail_performance:获取单个 Video 的内容互动 (播放量、点赞、评论、新增粉丝数等) 及交易转化 (订单数、销售额、商品点击量、转化率等) 表现数据,用于评估视频的内容效果与带货能力。

2)v2.video.get_video_detail_metric_trend:获取单个 Video 的内容互动与交易转化指标的趋势数据,用于分析视频表现随时间的变化;

3)v2.video.get_video_detail_audience_distribution:获取单个 Video 的观众分布数据,包括年龄、性别、地域、活跃时间及内容和商品偏好,用于分析视频的受众画像;

4)v2.video.get_video_detail_product_performance:获取单个 Video 关联商品的交易转化表现数据,用于评估视频对商品销售与转化的影响。

更多接口说明与对接指引,请参阅 Shopee Video API 对接指引

影响接口:

v2.video.get_video_detail_performance

v2.video.get_video_detail_metric_trend

v2.video.get_video_detail_audience_distribution

v2.video.get_video_detail_product_performance

上线时间:

2025.12.19

#