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

Significant OpenAPI Updates of Order, Return, and AMS

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

资料正文

§1 Significant OpenAPI Updates of Order, Return, and AMS

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. Order API Promotion Priority Logic Update

To ensure consistency of promotion information across all APIs and improve the accuracy of financial reconciliation, v2.order.get_order_detail returns “promotion_list[]” with all “promotion_type” and “promotion_id” values. The specific format is as follows:

Example:

"promotion_list": [

{

"promotion_id": 394813350817941,

"promotion_type": "add_on_deal_main"

},

{

"promotion_id": 786684204467200,

"promotion_type": "seller_discount"

}

]

NameTypeDescription
item_listobject[]/
>>promotion_listobject[]/
>>>>promotion_typestringIndicates the type of item or package-level promotion applied to a product. Each item can be associated with at most one item promotion and one package promotion at a time.
>>>>promotion_idint64Represents the unique identifier of a specific promotion applied to an item. Each promotion_id corresponds to a distinct promotion rule or campaign, defined under a particular promotion_type. The value is expressed in a numeric string format.

Affected API:

v2.order.get_order_detail

Release Date:

December 3, 2025

#

§4 3. AMS Performance Data APIs Update

The marker_type request parameter in the v2.ams.get_performance_data_update_time API has removed the AmsCampaignAnalyticsMarker option. Going forward, to retrieve the update time for all AMS performance data, please use marker_type = AmsMarker instead.

Related API:

v2.ams.get_performance_data_update_time

v2.ams.get_shop_performance

v2.ams.get_product_performance

v2.ams.get_affiliate_performance

v2.ams.get_content_performance

v2.ams.get_campaign_key_metrics_performance

v2.ams.get_open_campaign_performance

v2.ams.get_targeted_campaign_performance

Release Date:

2025.12.02

尊敬的开发者,

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

#

§5 1. 订单API的促销优先级逻辑更新

为确保促销信息在各 API 中一致并提升财务对账准确性,在v2.order.get_order_detail中,返回 promotion_list[] 以及所有 promotion_type 和 promotion_id 。具体的形式如下:

示例:

"promotion_list": [

{

"promotion_id": 394813350817941,

"promotion_type": "add_on_deal_main"

},

{

"promotion_id": 786684204467200,

"promotion_type": "seller_discount"

}

]

NameTypeDescription
item_listobject[]/
>>promotion_listobject[]/
>>>>promotion_typestringIndicates the type of item or package-level promotion applied to a product. Each item can be associated with at most one item promotion and one package promotion at a time.
>>>>promotion_idint64Represents the unique identifier of a specific promotion applied to an item. Each promotion_id corresponds to a distinct promotion rule or campaign, defined under a particular promotion_type. The value is expressed in a numeric string format.

影响接口:

v2.order.get_order_detail

上线时间:

2025.12.0

#

§6 2. Dispute 相关接口参数下线

先前公告所述,Shopee 将于 2025 年 12 月 16 日 正式停用以下请求/响应参数。

为避免影响您的服务,若您仍在使用这些参数,请务必在停用日期前切换至新的请求/响应参数。

Related APILocationSunset ParamNew Param
v2.returns.get_return_dispute_reasonResponsedispute_reasondispute_reason_list >>dispute_reason >>dispute_requirement >>sample_evidence >>type >>url >>thumbnail >>evidence_module_list >>module_index >>requirement >>is_required
v2.returns.disputeRequestimage>>image_list >>module_index >>requirement >>image_url
#

§7 3. AMS 表现数据接口更新

v2.ams.get_performance_data_update_time 接口的 marker_type 请求参数下线 AmsCampaignAnalyticsMarker 选项,后续获取所有 AMS 表现数据更新时间时,均改为使用 market_type = AmsMarker。

影响接口:

v2.ams.get_performance_data_update_time

v2.ams.get_shop_performance

v2.ams.get_product_performance

v2.ams.get_affiliate_performance

v2.ams.get_content_performance

v2.ams.get_campaign_key_metrics_performance

v2.ams.get_open_campaign_performance

v2.ams.get_targeted_campaign_performance

上线时间:

2025.12.02

#