![]() |
閑魚開放平臺
專用API
【更新時間: 2024.08.15】
閑魚開放平臺是阿里巴巴集團旗下閑魚項目的開放接口平臺,專為開發者提供技術支持和服務。通過開放的閑魚API,幫助開發者快速集成閑魚的多種功能。無論是商品發布、訂單管理還是用戶互動,閑魚API都能為開發者提供便捷的解決方案。
咨詢
去服務商官網采購>
|
瀏覽次數
304
采購人數
10
試用次數
3
試用
收藏
×
完成
取消
×
書簽名稱
確定
|
- API詳情
- 使用指南
- 常見 FAQ
- 關于我們
- 相關推薦


什么是閑魚開放平臺?
該服務是為閑魚小程序合作方提供的服務端接入文檔,詳細說明了如何在聚石塔環境中部署服務端服務,如何進行用戶登錄授權,以及如何使用閑魚提供的API進行訂單管理和用戶信息查詢等操作。文檔提供了詳細的API列表、消息匯總、API調用身份說明、TOPAPI環境地址確認、權限申請流程以及部分API的詳細說明,旨在幫助合作方快速接入閑魚平臺,實現業務的自動化和智能化管理。
什么是閑魚開放平臺接口?
閑魚開放平臺有哪些核心功能?
- 訂單創建:服務商可以通過TOP接口調用創單API創建閑魚訂單
- 發貨接口-虛擬發貨:該接口適用于無需物流發貨的場景。對應創單時不需要傳入deliver_id的情況。
- 發貨接口-有物流發貨:有實物物流的發貨場景,對應創單時需要傳入deliver_id的情況
- 物流公司編碼查詢:通過該接口可以查詢支持的物流公司編碼。
- 逆向訂單查詢:該接口用于查詢用戶退貨、換貨等逆向訂單信息。
- 正向訂單查詢:該接口用于查詢用戶購買的正向訂單信息。
- 退款單處理:通過該接口可以處理用戶的退款申請。
- 服務商主動取消訂單(未發貨):服務商在訂單未發貨的情況下,可以通過該接口主動取消訂單。
- 正向訂單變更消息:該接口用于查詢或監聽正向訂單的變更消息。
- 逆向訂單變更消息:該接口用于查詢或監聽逆向訂單的變更消息。
- 用戶基礎信息(性別、頭像、昵稱):該接口用于獲取用戶的基礎信息,包括性別、頭像和昵稱。
閑魚開放平臺的核心優勢是什么?
- 豐富的功能接口:閑魚開放平臺提供了多種接口,覆蓋商品管理、訂單處理、用戶管理等各個方面,滿足開發者的多樣化需求。
- 高效的開發支持:平臺提供詳細的開發文檔和技術支持,幫助開發者快速上手并高效完成開發任務。
- 穩定的系統性能:作為阿里巴巴旗下產品,閑魚開放平臺擁有強大的技術底蘊和穩定的系統性能,確保開發者在使用過程中能夠獲得良好的體驗。
在哪些場景會用到閑魚開放平臺?
電商平臺的二手商品專區:一個大型電商平臺想要增加一個二手商品交易專區,可以通過閑魚開放平臺的接口,將商品發布、訂單管理等功能接入到自己的平臺中,從而為用戶提供一個可靠的二手商品交易服務。
|
|
社交媒體的二手交易功能:一個社交媒體平臺希望增加用戶互動的多樣性,決定增加二手交易功能。通過閑魚開放平臺的用戶管理和商品發布接口,可以讓用戶在社交平臺上直接發布和管理自己的二手商品,增強平臺的用戶粘性。 |
|
二手商品市場分析:在電商平臺上,二手商品市場的需求不斷增長。利用“閑魚開放平臺”API接口,商家可以實時獲取閑魚上的商品信息,如價格、銷量和用戶評論。這些數據可以幫助商家分析市場趨勢、制定定價策略以及優化庫存管理。 |
|


1. 環境準備
1.1 聚石塔接入
-
所有服務端服務必須部署在聚石塔內。
-
用戶ID、訂單信息需存儲在聚石塔數據庫中。
-
訪問聚石塔外部資源需要審批。
1.2 相關文檔
2. 用戶登錄授權
2.1 授權流程
-
前端獲取授權碼(code)。
-
服務器使用code和AppSecret調用
taobao.top.auth.token.create
接口換取accessToken。 -
accessToken用于后續請求TOP接口。
2.2 注意事項
-
授權碼僅能使用一次,需重新獲取。
-
accessToken在過期之前無需重新獲取。
-
可使用
setStorage
和getStorage
API緩存用戶信息,避免頻繁獲取code。
3. API調用
3.1 API匯總
-
訂單創建:
alibaba.idle.isv.goosefish.order.create
-
訂單查詢(正向):
alibaba.idle.isv.order.query
-
虛擬發貨:
alibaba.idle.isv.goosefish.virtual.delivery
-
物流發貨:
alibaba.idle.isv.order.ship
-
訂單查詢(逆向):
alibaba.idle.isv.refund.query
-
發貨前關閉訂單:
alibaba.idle.isv.order.close
-
部分退款:
alibaba.idle.isv.order.part.refund
-
發貨后退款關單:
alibaba.idle.isv.order.after.send.refund
-
退貨退款處理:
alibaba.idle.isv.order.dealrefund
-
物流公司編碼查詢:
alibaba.idle.logistics.companies.query
-
用戶基礎信息:
alibaba.idle.goosefish.user.info.query
3.2 消息匯總
-
正向交易消息:
idle_autotrade_OrderStateSync
-
逆向交易消息:
idle_autotrade_RefundSync
4. API調用身份說明
-
訂單創建和用戶基礎信息接口需使用當前登錄用戶的accessToken。
-
其他涉及賣家的接口需使用賣家的accessToken。
5. TOPAPI 環境地址
-
正式地址:
https://gw.api.taobao.com/router/rest
-
預發地址:
https://pre-gw.api.taobao.com/top/router/rest
(僅在閑魚側更新或新增時使用)
5.1 預發聯調
-
在聯調前聯系閑魚開發同學開通預發環境聯調權限。
6. 權限申請
-
在閑魚三方開發平臺發起API權限申請,確保只申請必要的API。
7. 部分API詳細說明
7.1 訂單創建
-
調用
alibaba.idle.isv.goosefish.order.create
創建閑魚訂單。
7.2 訂單查詢
-
使用
alibaba.idle.isv.order.query
查詢訂單狀態。
7.3 發貨接口
-
虛擬發貨: 使用
alibaba.idle.isv.goosefish.virtual.delivery
接口。 -
有物流發貨: 使用
alibaba.idle.isv.order.ship
接口。
7.4 逆向訂單查詢
-
使用
alibaba.idle.isv.refund.query
查詢退款狀態。
7.5 退款處理
-
使用
alibaba.idle.isv.order.dealrefund
處理退款。
8. 消息處理
-
監聽
idle_autotrade_OrderStateSync
和idle_autotrade_RefundSync
消息以獲取訂單狀態變化。






1. 環境準備
1.1 聚石塔接入
-
所有服務端服務必須部署在聚石塔內。
-
用戶ID、訂單信息需存儲在聚石塔數據庫中。
-
訪問聚石塔外部資源需要審批。
1.2 相關文檔
2. 用戶登錄授權
2.1 授權流程
-
前端獲取授權碼(code)。
-
服務器使用code和AppSecret調用
taobao.top.auth.token.create
接口換取accessToken。 -
accessToken用于后續請求TOP接口。
2.2 注意事項
-
授權碼僅能使用一次,需重新獲取。
-
accessToken在過期之前無需重新獲取。
-
可使用
setStorage
和getStorage
API緩存用戶信息,避免頻繁獲取code。
3. API調用
3.1 API匯總
-
訂單創建:
alibaba.idle.isv.goosefish.order.create
-
訂單查詢(正向):
alibaba.idle.isv.order.query
-
虛擬發貨:
alibaba.idle.isv.goosefish.virtual.delivery
-
物流發貨:
alibaba.idle.isv.order.ship
-
訂單查詢(逆向):
alibaba.idle.isv.refund.query
-
發貨前關閉訂單:
alibaba.idle.isv.order.close
-
部分退款:
alibaba.idle.isv.order.part.refund
-
發貨后退款關單:
alibaba.idle.isv.order.after.send.refund
-
退貨退款處理:
alibaba.idle.isv.order.dealrefund
-
物流公司編碼查詢:
alibaba.idle.logistics.companies.query
-
用戶基礎信息:
alibaba.idle.goosefish.user.info.query
3.2 消息匯總
-
正向交易消息:
idle_autotrade_OrderStateSync
-
逆向交易消息:
idle_autotrade_RefundSync
4. API調用身份說明
-
訂單創建和用戶基礎信息接口需使用當前登錄用戶的accessToken。
-
其他涉及賣家的接口需使用賣家的accessToken。
5. TOPAPI 環境地址
-
正式地址:
https://gw.api.taobao.com/router/rest
-
預發地址:
https://pre-gw.api.taobao.com/top/router/rest
(僅在閑魚側更新或新增時使用)
5.1 預發聯調
-
在聯調前聯系閑魚開發同學開通預發環境聯調權限。
6. 權限申請
-
在閑魚三方開發平臺發起API權限申請,確保只申請必要的API。
7. 部分API詳細說明
7.1 訂單創建
-
調用
alibaba.idle.isv.goosefish.order.create
創建閑魚訂單。
7.2 訂單查詢
-
使用
alibaba.idle.isv.order.query
查詢訂單狀態。
7.3 發貨接口
-
虛擬發貨: 使用
alibaba.idle.isv.goosefish.virtual.delivery
接口。 -
有物流發貨: 使用
alibaba.idle.isv.order.ship
接口。
7.4 逆向訂單查詢
-
使用
alibaba.idle.isv.refund.query
查詢退款狀態。
7.5 退款處理
-
使用
alibaba.idle.isv.order.dealrefund
處理退款。
8. 消息處理
-
監聽
idle_autotrade_OrderStateSync
和idle_autotrade_RefundSync
消息以獲取訂單狀態變化。





