![]() |
閑魚(yú)開(kāi)放平臺(tái)
專用API
【更新時(shí)間: 2024.08.15】
閑魚(yú)開(kāi)放平臺(tái)是阿里巴巴集團(tuán)旗下閑魚(yú)項(xiàng)目的開(kāi)放接口平臺(tái),專為開(kāi)發(fā)者提供技術(shù)支持和服務(wù)。通過(guò)開(kāi)放的閑魚(yú)API,幫助開(kāi)發(fā)者快速集成閑魚(yú)的多種功能。無(wú)論是商品發(fā)布、訂單管理還是用戶互動(dòng),閑魚(yú)API都能為開(kāi)發(fā)者提供便捷的解決方案。
|
瀏覽次數(shù)
455
采購(gòu)人數(shù)
14
試用次數(shù)
3
試用
收藏
×
完成
取消
×
書(shū)簽名稱
確定
|
- API詳情
- 使用指南
- 常見(jiàn) FAQ
- 關(guān)于我們
- 相關(guān)推薦


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


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






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





