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

[Update] [Important] Open API 1.0 Deprecation Plan

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/changelogtopic/developertopic/uncategorized

资料正文

§1 [Update] [Important] Open API 1.0 Deprecation Plan

Dear Developers

Following our announcements of updates to the Open Platform policies on 11 May 2022 on the [Important] Open API 1.0 Deprecation Plan (Phase 1 Open API will be deprecated on 11 August 2022), Shopee will begin deprecating the remaining Open API 1.0 in the next two phases:

  1. Phase 2 Open APIs will be deprecated on 31 October 2022

  2. Phase 3 Open APIs will be deprecated on 26 December 2022

Action required

  1. Complete the acknowledgment survey by 29 August 2022, or your APP(s) will no longer be able to access the below Phase 2 and Phase 3 Open API 1.0 from 30 August 2022 onwards.

  2. Review the attached list of Phase 2 and Phase 3 APIs and complete your migration before the APIs are deprecated.

FAQs

  1. Do I need to integrate Open API 2.0 Authorization with my APP(s) before migrating my APIs?

Yes, integration of Open API 2.0 Authorization with my APP(s) is necessary before migrating your APIs. Refer to Open API 2.0 Overview for the new authorization and authentication instructions.

  1. Do I need to create a new APP to integrate with Open API 2.0?

No, you do not need to. Also, note that APP(s) created after 28 March 2022 can only call Open API 2.0.

  1. How do I transfer existing seller authorizations from Open API 1.0 to Open API 2.0?

Here are 2 methods to transfer existing seller authorizations to Open API 2.0:

Method 1

i) Get the upgrade_code. You may refer to the announcement to learn how.

ii) Call the v2.public.get_refresh_token_by_upgrade_code to get existing shops’ refresh_token from sellers who have granted authorization.

Method 2

Get sellers’ refresh_token and access_token through the usual shop authorization process.

  1. If I lose the access_token or the refresh_token after migrating to Open API 2.0, how do I get a new valid token?

Here are 2 methods to get a new valid token:

Method 1

You can call the v2.public.get_token_by_resend_code to get a new valid refresh_token and access_token. Refer to this FAQ on resending code on the Shopee Open Platform for more information.

Method 2

Get sellers’ refresh_token and access_token through the usual shop authorization process.

尊敬的开发者

关于Open API 1.0下线计划更新(第一批下线接口将从2022年8月11日下线),Shopee将对剩余1.0接口分两个批下线:

  1. 第二批下线时间为2022年10月31日

  2. 第三批下线时间为2022年12月26日

接下来:

  1. 开发者需要在2022年8月29日之前完成第二批及第三批下线公告的知晓,否则从2022年8月30日起将无法调用以下第二批以及第三批Open API 1.0接口

  2. 查看第二批以及第三批1.0接口下线列表,并且于下线之前完成对应接口的迁移工作。

FAQ:

  1. 在接口切换至OpenAPI 2.0的过程中是否需要先对接 2.0的授权?

- 是的,需要先对接OpenAPI 2.0授权,详情请参考OpenAPI 2.0 Overview授权与鉴权

  1. 我是否需要创建新的App对接OpenAPI 2.0?

- 不需要。此外,自2022-03-28后创建的app仅能调用OpenAPI 2.0

3如何将存量的授权卖家从1.0的授权迁移到2.0?

- 方法一:拿到 upgrade_code, 并通过upgrade_code调用v2.public.get_refresh_token_by_upgrade_code获取存量店铺的refresh_token

- 方法二:通过OpenAPI 2.0的正常授权流程

  1. 将卖家授权迁移至2.0后,在使用的过程中如果token丢失,如何拿到新的可用token?

- 方法一:可以通过调用v2.public.get_token_by_resend_code拿到一组新的refresh_token与access_token,可参考FAQ

- 方法二:通过OpenAPI 2.0的正常流程重新授权

Attachment:

Offline List of Open API 1.0 Phase 2

ModuleOffline List of Open API 1.0 Phase 2Mapped Open API 2.0
Itemshopee.item.GetCommentv2.product.get_comment
Itemshopee.item.ReplyCommentsv2.product.reply_comment
Itemshopee.item.AddItemImgv2.product.update_item
Itemshopee.item.UpdateItemImgv2.product.update_item
Itemshopee.item.InsertItemImgv2.product.update_item
Itemshopee.item.DeleteItemImgv2.product.update_item
Itemshopee.item.UpdateVariationStockv2.product.update_stock
Itemshopee.item.UpdateStockv2.product.update_stock
Itemshopee.item.UpdateStockBatchv2.product.update_stock
Itemshopee.item.UpdateVariationStockBatchv2.product.update_stock
Itemshopee.item.UpdatePricev2.product.update_price v2.product.update_sip_item_price
Itemshopee.item.UpdateVariationPricev2.product.update_price v2.product.update_sip_item_price
Itemshopee.item.UpdatePriceBatchv2.product.update_price v2.product.update_sip_item_price
Itemshopee.item.UpdateVariationPriceBatchv2.product.update_price v2.product.update_sip_item_price
Itemshopee.item.GetItemsListv2.product.get_item_list v2.product.get_model_list v2.product.get_item_base_info v2.payment.get_item_installment_status
Itemshopee.Item.GetPromotionInfov2.product.get_item_promotion
Itemshopee.item.UpdateItemv2.product.update_item v2.product.init_tier_variation v2.media_space.upload_image
Itemshopee.item.Addv2.product.add_item v2.product.init_tier_variation v2.media_space.upload_image
Itemshopee.item.AddVariationsv2.product.init_tier_variation
Itemshopee.item.InitTierVariationv2.product.init_tier_variation
Itemshopee.item.AddTierVariationv2.product.update_tier_variation
Itemshopee.item.GetItemDetailv2.product.get_item_base_info v2.product.get_item_extra_info v2.product.get_model_list
Itemshopee.item.DeleteVariationv2.product.delete_model
Itemshopee.item.UpdateTierVariationListv2.product.update_tier_variation
Itemshopee.item.UpdateTierVariationIndexv2.product.update_tier_variation
Itemshopee.item.GetVariationsv2.product.get_model_list

Offline List of Open API 1.0 Phase 3

ModuleOffline List of Open API 1.0 Phase 3Mapped Open API 2.0
Returnsshopee.returns.GetReturnListv2.returns.get_return_list
Returnsshopee.returns.GetReturnDetailv2.returns.get_return_detail
Returnsshopee.returns.DisputeReturnv2.returns.dispute
Returnsshopee.returns.ConfirmReturnv2.returns.confirm
Paymentshopee.payment.GetTransactionListv2.payment.get_wallet_transaction_list
Paymentshopee.payment.GetPayoutDetailv2.payment.get_payout_detail
FirstMileTrackingGenerateFMTrackingNov2.first_mile.generate_first_mile_tracking_number
FirstMileTrackingGetShopFMTrackingNov2.first_mile.get_tracking_number_list
FirstMileTrackingFirstMileCodeBindOrderv2.first_mile.bind_first_mile_tracking_number
FirstMileTrackingFirstMileUnbindv2.first_mile.unbind_first_mile_tracking_number
FirstMileTrackingGetFmTnDetailv2.first_mile.get_detail
FirstMileTrackingGetFMTrackingNoWaybillv2.first_mile.get_waybill
FirstMileTrackingGetShopFirstMileChannelv2.first_mile.get_channel_list
Ordersshopee.orders.GetOrdersListv2.order.get_order_list
Ordersshopee.orders.GetOrdersByStatusv2.order.get_order_list
Ordersshopee.orders.GetOrderDetailsv2.order.get_order_detail v2.logistics.get_tracking_number v2.payment.get_escrow_detail
Ordersshopee.orders.GetEscrowDetailsv2.payment.get_escrow_detail
Ordersshopee.orders.AddOrderNotev2.order.set_note
Ordersshopee.orders.CancelOrderv2.order.cancel_order
Ordersshopee.orders.AcceptBuyerCancellationv2.order.handle_buyer_cancellation
Ordersshopee.orders.RejectBuyerCancellationv2.order.handle_buyer_cancellation
Ordersshopee.orders.GetForderInfov2.order.get_order_detail v2.logistics.get_tracking_number
Ordersshopee.orders.GetEscrowReleasedOrdersv2.payment.get_payout_detail
Ordersshopee.orders.SplitOrderv2.order.split_order
Ordersshopee.orders.UndoSplitOrderv2.order.unsplit_order
Ordersshopee.orders.GetUnbindOrderListv2.first_mile.get_unbind_order_list
Ordersshopee.orders.MyIncomev2.payment.get_escrow_detail
Ordersshopee.orders.AddInvoiceDatav2.order.add_invoice_data
Ordersshopee.orders.GetInvoiceOrderv2.order.get_order_list
Ordersshopee.order.get_pending_buyer_invoice_order_listv2.order.get_pending_buyer_invoice_order_list
Ordersshopee.order.upload_invoice_docv2.order.upload_invoice_doc
Ordersshopee.order.download_invoice_docv2.order.download_invoice_doc
Logisticsshopee.logistics.GetLogisticsv2.logistics.get_channel_list
Logisticsshopee.logistics.UpdateShopLogisticsv2.logistics.update_channel
Logisticsshopee.logistics.GetAddressv2.logistics.get_address_list
Logisticsshopee.logistics.SetAddressv2.logistics.set_address_config
Logisticsshopee.logistics.DeleteAddressv2.logistics.delete_address
Logisticsshopee.logistics.GetParameterForInitv2.logistics.get_shipping_parameter
Logisticsshopee.logistics.Initv2.logistics.ship_order v2.logistics.get_tracking_number
Logisticsshopee.logistics.GetTimeSlotv2.logistics.get_shipping_parameter
Logisticsshopee.logistics.GetBranchv2.logistics.get_shipping_parameter
Logisticsshopee.logistics.GetSlugsv2.logistics.get_shipping_parameter
Logisticsshopee.logistics.GetLogisticInfov2.logistics.get_shipping_parameter
Logisticsshopee.logistics.GetOrderLogisticsv2.logistics.get_shipping_document_info
Logisticsshopee.logistics.GetLogisticsMessagev2.logistics.get_tracking_info
Logisticsshopee.logistics.BatchInitv2.logistics.batch_ship_order
Logisticsshopee.logistics.GetAirwayBillv2.logistics.get_shipping_document_parameter v2.logistics.create_shipping_document v2.logistics.get_shipping_document_result v2.logistics.download_shipping_document
Logisticsshopee.logistics.GetForderWaybillv2.logistics.get_shipping_document_parameter v2.logistics.create_shipping_document v2.logistics.get_shipping_document_result v2.logistics.download_shipping_document
Imageshopee.image.UploadImgv2.media_space.upload_image
#