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

Significant OpenAPI Updates of Product, Payment, Logistics

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-logisticstopic/api-paymenttopic/api-producttopic/changelogtopic/developertopic/openapi-updates

资料正文

§1 Significant OpenAPI Updates of Product, Payment, Logistics

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. [Only for BR]Enable Kits Feature for local BR SIP Sellers

Shopee now supports whitelisted local Brazil (BR) SIP sellers in combining multiple standard products (Items / Models) into a single Kit Item (bundle product). The related Open API capabilities have been updated accordingly, as detailed below.

For whitelisted local Brazil (BR) SIP sellers: 1) Support calling v2.product.get_kit_item_limit API to get the limitation on kit item; 2) Support calling v2.product.add_kit_item API to create the kit item by selecting multiple items/models and setting main component and quantity per kit; 3) Support calling v2.product.update_kit_item API to update the kit basic information and kit components, only support adding kit variations and updating existing kit variation’s image, price, and model_sku, don’t support deleting existing kit variations and updating the items, main component and quantity per kit of existing kit variations; 4) Support calling v2.product.get_kit_item_info API to get the kit basic information and kit components; 5) Support calling v2.product.generate_kit_image API to generate a kit image by combining the main images of the selected products into a single bundle cover image.

Related APIs:

v2.product.get_kit_item_limit

v2.product.add_kit_item

v2.product.update_kit_item

v2.product.get_kit_item_info

v2.product.generate_kit_image

Effective Date on Live:

2025.12.20

#

§3 2.[Only for BR] "Net" Commission & Service Fee Display

2.[Only for BR] "Net" Commission & Service Fee Display

Background:

  • Shopee has standardized the display of BR commission and service fee between income documents and invoices, and the relevant Open API capabilities have been updated simultaneously.
  • Scope: BR local shop

Endpoint:

v2.payment.get_escrow_detail

v2.payment.get_escrow_detail_batch

New Field (response parameter):

FieldDescriptionUpdate Type
net_commission_feeThe respective fee amounts after the proportional rebate deduction. The total net commission fee applied to the order, calculated as the sum of all net commission fee items.New Field
net_service_feeThe respective fee amounts after the proportional rebate deduction. The total net service fee applied to the order, calculated as the sum of all net service fee items.New Field
net_commission_fee_info_listReturns the breakdown of the net commission ,Including: fee_amount/fee amount/rule_display_name /rule_idNew Field
net_service_fee_info_listReturns the breakdown of the net service fee, including: category/fee_amount/rule_display_name/rule_idNew Field
seller_product_rebateIncludes: amount (i.e. The rebate borne by seller), commission_fee_offset, service_fee_offsetNew Field

Update Field (response parameter):

FieldUpdate Detail
commission_feeFor local Brazilian Shop: The value is the gross amount of expenses (i.e., gross profit value).
service_feeFor local Brazilian Shop: The value is the gross amount of expenses (i.e., gross profit value).
shopee_discountFor local Brazilian Shop: Return the discount amount after deducting the rebate.

Effective Date:

2025.12.26

#

§4 3. Instant Mart Improvements: Support Setting Product Minimum/Maximum Purchase Quantity for Outlet Shop

Background

Support setting item Minimum/Maximum Purchase Quantity for Outlet shops via Open API.

Endpoint:v2.product.publish_item_to_outlet_shop

Update TypeAPIAPI Function
Existing API Updatesv2.product.publish_itemto_outlet_shopAdd new request parameters purchase_limit_info for sellers to set the maximum and minimum purchase quantities of products. purchase_limit_info >>min_purchase_limit >>max_purchase_limit >>purchase_limit Note: Currently, the maximum purchase quantity in the Open API only supports per-order settings, which is setting the maximum quantity that each buyer can purchase in a single order.

Effective Date

2025.12.26

#

§5 4. [Only for TW 30029 Logistics Channel] Support new request field for “v2.logistics.create_shipping_document_job” API & Self-Designed Label Policy Update

4. [Only for TW 30029 Logistics Channel] Support new request field for “v2.logistics.create_shipping_document_job” API & Self-Designed Label Policy Update

  1. To enhance sellers’ fulfillment experience when using the 30029 Logistics Channel, Shopee has implemented the following updates to label printing related APIs:

- v2.logistics.create_shipping_document_job: Supporting new “package_list” request parameter, allows developers to create “Unpackage SKU ID Label” print task after order creation.

- Affected APIs: v2.logistics.create_shipping_document_job

- Effective Date: 2025.12.26

  1. Self-designed "Unpackage SKU ID Label” Policy Update

- The display content of the "Unpackage SKU ID Label" used for the "Shopee Xpress - Package-free" (logistics channel 30029) channel will be updated to the "Tracking Number Mode" starting from 2026.01.12. This means the QR Code and related information will switch from displaying the "Unpackage SKU ID" to the "Tracking Number." (*If sellers still want to use the "Unpackaged SKU ID" mode, sellers should contact Shopee BD to apply. Developers should confirm the selected mode with sellers. For details regarding 'Unpackaged SKU ID' mode, please refer to the FAQ file.)

- Policy Change Detail: Please refer to the FAQ document on Open Platform.

- Effective Date: 2026.01.12 (Please note that if non-compliant labels have been dropped off after the effective date, it will affect the shipping process.)

*For PDF labels retrieved via Shopee OpenAPI, the system will automatically provide the file in the format matching the seller's selected mode.

尊敬的开发者

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

#

§6 1.[仅适用于 BR]本土巴西 SIP 卖家支持套装商品(Kit Item)功能

Shopee 现已支持 本土巴西(BR)SIP 白名单卖家 将多个普通商品(Items / Models)组合为一个 Kit Item(套装商品)。相关 Open API 能力已同步更新。

对于本土巴西(BR)SIP 白名单卖家:

1)支持调用 v2.product.get_kit_item_limit 接口,获取Kit Item的限制条件;

2)支持调用 v2.product.add_kit_item 接口,通过选择多个普通的Items/Models并设置Main Component和Quantity来创建Kit Item;

3)支持调用 v2.product.update_kit_item 接口,用于更新Kit Item的Basic Information和Kit Components,仅支持新增Kit Variation和更新已有Kit Variation的image、original_price和model_sku,不支持删除已有Kit Variation和更新已有Kit Variation的Kit Components、Main Component以及Quantity;

4)支持调用 v2.product.get_kit_item_info 接口,以获取Kit Item的Basic Information和Kit Components;

5)支持调用v2.product.generate_kit_image接口,合成生成套装图片,将所选商品的主图合并为一张套装主图。

影响接口:

v2.product.get_kit_item_limit

v2.product.add_kit_item

v2.product.update_kit_item

v2.product.get_kit_item_info

v2.product.generate_kit_image

生效日期:

2025.12.19

#

§7 2. [仅适用于 BR]净佣金及净服务费展示

背景:

- Shopee已统一BR佣金及服务费在收入单据与发票间的展示方式,相关Open API能力已同步更新。

- 适用范围:BR local shop

接口:v2.payment.get_escrow_detailv2.payment.get_escrow_detail_batch

新增字段(response parameter):

字段说明更新类型
net_commission_fee扣除按比例返利后的各项费用金额。 订单适用的净佣金总额,计算方法为所有净佣金项目之和。新增字段
net_service_fee扣除按比例返利后的各项费用金额。 订单适用的净服务费总额,计算方法为所有净服务费项目之和。新增字段
net_commission_fee_info_list返回净佣金的明细: fee_amount 费用金额 rule_display_name rule_id新增字段
net_service_fee_info_list返回净服务费的明细: category fee_amount rule_display_namerule_id新增字段
seller_product_rebateamount (i.e. The rebate borne by seller)金额(即卖家承担的返利): commission_fee_offset service_fee_offset新增字段

变更字段(response parameter):

字段更新详情
commission_fee对于巴西本土店铺:取值为费用 gross 金额(即毛利值)。
service_fee对于巴西本土店铺:取值为费用 gross 金额(即毛利值)。
shopee_discount对于巴西本土店铺:返回扣除返利后的折扣金额。

生效日期:

2025.12.26

#

§8 3. Instant Mart优化:支持设置商品最小/最大购买数量

背景:

- 支持通过OpenAPI为outlet 店铺商品设置商品最小/最大购买数量。

- 接口:v2.product.publish_item_to_outlet_shop

更新类型接口更新内容
更新接口v2.product.publish_item_to_outlet_shop新增 purchase_limit_info 请求参数,用于卖家设置商品的最大和最小购买量。 purchase_limit_info >>min_purchase_limit >>max_purchase_limit >>purchase_limit 注:最大购买量在 Open API 目前仅支持依订单-即设置每个买家在每一笔订单中最多可购买的数量。

生效日期:

2025.12.26

#

§9 4.【僅適用於 TW 30029 物流選項】在“v2.logistics.create_shipping_document_job” API 中支援新的 Request 欄位 & 自設 “蝦皮商品編碼標籤” 規範更新

4.【僅適用於 TW 30029 物流選項】在“v2.logistics.create_shipping_document_job” API 中支援新的 Request 欄位 & 自設 “蝦皮商品編碼標籤” 規範更新

1)為了提升賣家處理 30029 物流選項之訂單,蝦皮針對列印標籤相關 API 進行了以下更新:

- v2.logistics.create_shipping_document_job: 支援新的 Request 欄位 “package_list”,讓開發者也可以在訂單建立後透過此 API 列印 “蝦皮商品編碼標籤”。

- 影響接口:v2.logistics.create_shipping_document_job

- 生效日期:2025.12.26

2)自設 “蝦皮商品編碼標籤” 規範更新

- “蝦皮店到店 - 環保無包裝” (logistics channel 30029) 物流選項所使用的 “蝦皮商品編碼標籤” 展示內容,將於 2026.01.12 調整為 “物流訂單編號模式”,也就是 QR Code 等相關資訊的展示從 “蝦皮商品編碼” 調整為 “Tracking Number”。 (*若賣家仍欲使用 “蝦皮商品編碼” 模式,請賣家與蝦皮業務單位申請,並且請開發者與賣家確認其選用模式;“蝦皮商品編碼” 模式內容請參考 FAQ 檔案)

- 調整細節:請參考 Open Platform 網站上之 FAQ 檔案

- 生效日期:2026.01.12 (請注意,若在生效日期後交寄不合規之標籤,將影響交寄流程)

*若您是透過 Shopee OpenAPI 直接取得標籤 PDF 檔案,系統將自動根據賣家選用的模式返回對應格式之檔案。

#