對接商城金蝶訂單100外部api說明r3

1、一、文檔說明本文檔的使用對象是第開發(fā)接入。第二部分系統(tǒng)參數(shù)的藍(lán)色表格是要求每個 API 都要傳入的參數(shù)，綠色表格是要求出現(xiàn)錯誤時返回的參數(shù)；第三部分是要求第實現(xiàn)的 API 列表，其中藍(lán)色表格表示輸入?yún)?shù)格式，綠色表格表示輸出參數(shù)格式；第四部分是 API 要求返回的數(shù)據(jù)對應(yīng)的實體。二、系統(tǒng)參數(shù)1、系統(tǒng)參數(shù)列表2、響應(yīng)錯誤格式錯誤返回error_response:sub_code:3,sub_msg:錯誤描述3、簽名 sign(可參考 demo)調(diào)用 API 時需要對請求參數(shù)進(jìn)行簽名驗證，TOP 服務(wù)器也會對該請求參數(shù)進(jìn)行驗證是否合法的。方法如下：根據(jù)參數(shù)名稱（除簽名和）將所有請求參數(shù)按照字母先后

2、順序排序:key + value key +value 例如：將 foo=1,bar=2,baz=3 排序為 bar=2,baz=3,foo=1，參數(shù)名和參數(shù)值字符串 bar2baz3foo1后，得到拼裝名稱類型是否必須描述sub_codeString否錯誤碼。sub_msgString否錯誤描述。名稱類型是否必須描述methodString是API 名稱。app_keyString是商城分配給應(yīng)用的 AppKey。sesString是商城分配給用戶的 SesKey。vString是API 協(xié)議版本?？蛇x值:1.0timestString是時間戳，格式為 yyyy-MM-dd HH:mm:ss

3、，例如：2008-01-25 20:23:30。檢查發(fā)起請求時間與服務(wù)器時間相差多大，判斷是否回放請求signString是API 輸入?yún)?shù)簽名結(jié)果。參考簽名。sign_method String否參數(shù)的加密方法選擇。默認(rèn)值:md5formatString否可選。指定參數(shù)格式。默認(rèn)是 json，支持格式為 xml 和 json。md5：將 secret 拼接到參數(shù)字符串頭、尾進(jìn)行 md5 加密后，再轉(zhuǎn)化成大寫，格式是：(md5(secretkey1value1key2value2.secret)三、API 列表1. kingdee.items.get(商品)返回示例items_get_resp

4、onse: items: item: ,total_results: 6名稱類型是否必須 示例值描述total_results Number是200所有符合條件的商品數(shù)量。itemsItem是返回商品列表。Item 類型要求返回的對象具體參照實體附錄。名稱類型是否必須示例值默認(rèn)值描述start_timeDate可選2000-01-01開始時間，格式:yyyy-MM-dd HH:mm:ss。00:00:00end_timeDate可選2000-12-01結(jié)束時間，格式:yyyy-MM-dd HH:mm:ss。00:00:00page_noNumber可選11頁碼。取值范圍:大于零的整數(shù)。默認(rèn)值為

5、1,即默認(rèn)返回第一頁數(shù)據(jù)。page_sizeNumber可選100100每頁條數(shù)。取值范圍:大于零的整數(shù); 默認(rèn)值：100。susNumber可選onsaleonsale 表示上架，instock 表示下架。不填寫將返回包括上架和下架的所有商品。num_iidString可選29446852商品數(shù)字 Id。 填寫這個參數(shù)，其它業(yè)務(wù)參數(shù)不傳值2. kingdee.item.ty.update(修改商品庫存)返回示例3. kingdee.trades.get(查詢賣家已賣出的交易數(shù)據(jù))名稱類型是否必須 示例值默認(rèn)值描述start_timeDate可選2000-01-01查詢交易創(chuàng)建時間開始。格式:

6、yyyy-MM-dd00:00:00HH:mm:ss。默認(rèn)返回 3 天數(shù)據(jù)end_timeDate可選2000-01-01查詢交易創(chuàng)建時間結(jié)束。格式:yyyy-MM-dd00:00:00HH:mm:ss。page_noNumber可選101頁碼。取值范圍:大于零的整數(shù)。默認(rèn)值為1,即默認(rèn)返回第一頁數(shù)據(jù)。page_sizeNumber可選100100每頁條數(shù)。取值范圍:大于零的整數(shù); 默認(rèn)值：100。use_has_next Bool可選truefalse是否啟用 has_next 的分頁方式，如果指定true，則返回的結(jié)果中不包含錄數(shù)，但是會新增一存在下一頁的的字段。susString可選TR

7、ADE_FINISHEDTRADE_WAIT_BUYER_PAY 沒有付款TRADE_SELLER_SEND_GOODS已付款TRADE_WAIT_BUYER_CONFIRM_GOODS 已發(fā)貨TRADE_FINISHED交易完成item_ty_update_response: is_sucs:true名稱類型是否必須 示例值描述如更新成功沒有錯誤返回名稱類型是否必須示例值默認(rèn)值描述num_iidString必須29446852商品數(shù)字 Id。tyNumber必須50庫存修改值。sku_idString可選12305要操作的 sku 的數(shù)字 ID。如果不填寫，默認(rèn)修改的是商品的庫存，填寫的話就

8、是修改 sku的庫存。typeNumber可選21庫存更新方式，可選。1 為全量更新，2 為增量更新。如果不填，默認(rèn)為全量更新。返回示例4. kingdee.logistics.offlind(線下物流發(fā)貨)名稱類型是否必須 示例值默認(rèn)值描述tidString必須135468交易。out_sidString必須SF05052運(yùn)單號。具體一個物流公司的真實運(yùn)單號碼。company_code String必須ZJS物流公司代碼。如T 就代表中國郵政,ZJS就代表宅急送。is_splitNumber可選10表明是否是拆單。1 表示拆單 0 表示不拆單，默認(rèn)值 0。trades_get_respons

9、e: trades: trade:tid: 123456, orders: order:oid:122 ,oid: 14566,has_next:true,total_results: 100名稱類型是否必須 示例值描述total_results Number否200所有符合條件的訂單數(shù)量。has_nextBool否true是否存在下一頁。tradesTrade是返回商品列表。Trade 類型要求返回的對象具體參照實體附錄。TRADE_AUTOMATIC_CLOSED交易關(guān)閉daypeNumber可選111 按創(chuàng)建時間，2 按修改時間。tidString可選13365,4566訂單號。填寫這個

10、參數(shù)，其它業(yè)務(wù)參數(shù)不傳值fieldsString可選tid,sus返回字段（漏單檢查使用，如只需返回 tid，不傳返回所有字段）目前第 商城接口默認(rèn)不 沒有付款 狀態(tài)的訂單，同時在 的設(shè)置界面中也不提供設(shè)置支持。返回示例5. kingdee.refunds.get(退款單獲取)返回示例refunds_get_response: refunds: refund: 實體【Refund】,名稱類型是否必須 示例值描述total_results Number否200所有符合條件的商品數(shù)量。has_nextBool否true是否存在下一頁。refundsRefund 是退款信息列表。Refund 類型要

11、求返回的對象具體參照實體附錄。名稱類型是否必須 示例值默認(rèn)值描述start_timeDate可選2000-01-01查詢修改時間開始。 格式 :yyyy-MM-dd00:00:00HH:mm:ss。默認(rèn)返回 7 天數(shù)據(jù)end_timeDate可選2000-01-01查詢修改時間結(jié)束。 格式 :yyyy-MM-dd00:00:00HH:mm:ss。page_noNumber可選101頁碼。取值范圍:大于零的整數(shù)。默認(rèn)值為1,即默認(rèn)返回第一頁數(shù)據(jù)。page_sizeNumber可選100100每頁條數(shù)。取值范圍:大于零的整數(shù); 默認(rèn)值：100。use_has_next Bool可選truefals

12、e是否啟用 has_next 的分頁方式，如果指定true，則返回的結(jié)果中不包含錄數(shù)，但是會新增一存在下一頁的的字段。refund_idString可選退款單號。填寫這個參數(shù)，其它業(yè)務(wù)參數(shù)不傳值logistics_offline_send_response: is_sucs:true 名稱類型是否必須 示例值描述沒有錯誤就是發(fā)貨成功sub_tidString 可選1,2,3需要拆單發(fā)貨的子訂單集合，為空表示不做拆單發(fā)貨。6. kingde.returngoods.agree(賣家同意退貨)第需將退款狀態(tài)更新為待退貨，中走等待簽收流程到待審核退款。返回示例7. kingde.refunds.ag

13、ree(賣家同意退款)第需將退款狀態(tài)更新為退款成功，訂單狀態(tài)更新為交易關(guān)閉，如果已對接有支付接口，則需要自己調(diào)用支付接口將退款原路退回。名稱類型是否必須 示例值默認(rèn)值描述refund_infosString必須43234234|2000退款信息，格式：refund_id|amount|ver，rp_returngoods_agree_response: is_sucs:true 名稱類型是否必須 示例值描述沒有錯誤就是同意退貨成功名稱類型是否必須 示例值默認(rèn)值描述refund_idNumber必須328818231125退款nameString可選賣家，淘寶退款為必填項。浙江省杭州市西addr

14、essString可選湖區(qū) XX 路XX 號賣家提供的退貨地址，淘寶退款為必填項。XX 小區(qū)tString可選310000賣家提供的退貨地址的，淘寶退款為必填項。String可選5718848388賣家座機(jī)，淘寶退款為必填項。mobileString可選賣家，淘寶退款為必填項。remarkString可選沒有問題，同意退賣家退貨留言，天貓退款為必填項。貨refund_phaseString可選onsale售中：onsale，售后：aftersale，天貓退款為必填項。refund_verNumber可選1409231007325退款版本號，天貓退款為必填項。seller_address_idN

15、umber可選123456賣家收貨地址，天貓退款為必填項。total_results: 100返回示例8. kingdee.refund.refuse(賣家退款、退貨)第需將退款狀態(tài)更新為賣家退款。名稱類型是否必須 示例值默認(rèn)值描述refund_idNumber必須123456退款單號refuse_messageString可選退款說明最大長度：退款時的說明信息，長度 2-200200rp_refunds_agree_response: succ:true, message:信息, results:refund_map_result:refund_id:54324331233, message

16、:succ, succ:true,msg_code:OP_SUCC名稱類型是 否 必示例值描述須succ是true操作成功messageString是信息信息resultsRefundMapResult是退款操作結(jié)果列表msg_codeString是OP_SUCC批量退款操作情況，可選值：OP_SUCC（全部成功），SOME_OP_SUCC（部分成功），OP_FAILURE_UE（全部失?。?|其中refund_id 為退款，amount 為退款金14,3123123|120額（以分為），ver為退款最后更新時00|1409294148間（時間戳格式），多個退款以半角逗號分隔。715返回示例9

17、. kingdee.logistics.address.search(查詢賣家地址庫)同意退貨前會先獲取賣家收貨地址，如需對接售后（同意退貨）接口，則必須對接此接口。名稱類型是 否 必 示例值描述須名稱類型是否必須 示例值默認(rèn)值描述可選，參數(shù)列表如下：no_def:查詢非默認(rèn)地址rdefString可選no_defget_def:查詢默認(rèn)取貨地址，也即對應(yīng)賣家地址庫中發(fā)貨地址（send_def 暫不起作用）cancel_def:查詢默認(rèn)退貨地址,缺省此參數(shù)時，查詢所有當(dāng)前用戶的地址庫refund_refuse_response: refund:refund_id:83477, modified

18、:2000-01-01 00:00:00, sus:SUCS,is_sucs:true 名稱類型是否必須 示例值描述沒有錯誤就是退款成功 refund_id:退款單號 modified：更新時間s us:退款狀態(tài) 可選值WAIT_SELLER_AGREE(買家已經(jīng)申請退款，等待賣家同意) WAIT_BUYER_RETURN_GOODS(賣家已經(jīng)同意退款，等待買家退貨) WAIT_SELLER_CONFIRM_GOODS(買家已經(jīng)退貨，等待賣家確認(rèn)收貨) SELLER_REFUSE_BUYER(賣家 退款) CLOSED(退款關(guān)閉) SUC S(退款成功)我是被上傳的文最大長度：退款時的退款憑證

19、，一般是賣家退款時refuse_proofbyte可選件內(nèi)容130000使用的發(fā)貨憑證，最大長度 130000 字節(jié)，支持的格式：GIF, JPG, PNG。天貓退款為必填項。支持的文件類型：gif,jpg,pngrefund_phaseString可選onsale可選值為：售中：onsale，售后：aftersale，天貓退款為必填項。refund_verNumber可選1409278100627退款版本號，天貓退款為必填項。返回示例10. kingdee.offline.shoplist.get(獲取線下門店列表)返回示例11. kingdee.trade.selffetchcode.ap

20、ply(核銷門店自提訂單)第核銷提貨碼成功后需將訂單的交易狀態(tài)更新為“已發(fā)貨”,保證中可以更新到狀態(tài)。名稱類型是否必須示例值默認(rèn)值描述offline_shoplist_get_response: account_shop_offlines: account_shop_offline: 實體【AccountShopOffline】,total_results: 100名稱類型是否必 示例值描述須total_resultsNumber否200所有符合條件的門店數(shù)量。account_shop_offlines AccountShopOffline是門店信息列表。AccountShopOffline

21、類型要求返回的對象具體參照實體附錄。名稱類型是否必須示例值默認(rèn)值描述page_noNumber可選11頁碼。取值范圍:大于零的整數(shù)。默認(rèn)值為1,即默認(rèn)返回第一頁數(shù)據(jù)。page_sizeNumber可選100100每頁條數(shù)。取值范圍:大于零的整數(shù)。 默認(rèn)值：100。logistics_address_search_response: addresses:address_result:實體【AddressResult】addressesAddressResult 是200一組地址庫數(shù)據(jù)。AddressResult 類型要求返回的對象具體參照實體附錄。返回示例12. kingdee.logistic

22、s.dummy.send(無需物流發(fā)貨)返回示例四、實體附錄1. Sku 實體名稱類型是否必須示例值描述sku_idString是12305sku 數(shù)字 Id。num_iidString是29446852sku 所屬商品 Id（網(wǎng)店貨品 ID）。tyNumber否50sku 商品數(shù)量。pritring否200.07屬 于 這 個 sku 的 商 品 的 價 格取 值 范圍:0-100000000; 精確到 2 位小數(shù);: 元。如:200.07，表示:200 元 7 分。createdDate否2013-11-10sku 創(chuàng)建日期，時間格式：yyyy-MM-dd HH:mm:ss。15:10:0

23、5logistics_dummy_send_response: is_sucs:true 名稱類型是否必須 示例值描述沒有錯誤就是發(fā)貨成功名稱類型是否必須 示例值默認(rèn)值描述tidString必須135468交易。trade_selffetchcode_apply_response: is_sucs:true 名稱類型是否必須 示例值描述沒有錯誤返回就是核銷成功codeString必須123提貨碼。2. Item 實體3. Order 實體名稱類型是否必 示例值描述須名稱類型是否必須示例值描述num_iidString是29446852商品數(shù)字 Id（網(wǎng)店貨品 ID）。numNumber否888

24、商品數(shù)量。outer_idString否12345商家設(shè)置的外部 Id(商家編碼)。pritring是5.00商品價格，格式：5.00；：元；精確到：分。skusSku否Sku 列表。Sku 類型要求返回的對象具體參考實體附錄。approve_susString是onsale商品上傳后的狀態(tài)。商品上傳后的狀態(tài)。onsale 出售中，instock 庫中。barcodeString否6903244981002商品條形碼。titleString是測試商品商品標(biāo)題，過 60 字節(jié)。descString否這是測試商品描述。createdDate否2013-11-10商品創(chuàng)建時間。（ 格式： yyyy-

25、MM-dd15:10:05HH:mm:ss）modifiedDate是2013-11-11商品最后修改時間。（格式：yyyy-MM-dd15:10:05HH:mm:ss）pic_urlString否商品主地址。bao/uploaded/i3/T1HXdXXg PSt0JxZ2.8_070458.jpgdetail_urlString否http/商品 URL。item.htm?id=modifiedDate是2013-11-11sku 最后修改時間， 時間格式： yyyy-MM-dd15:10:05HH:mm:ss。susString是normalsku 狀態(tài)。 normal:正常 ；delet

26、e:刪除。properties_name String是sku 所對應(yīng)的銷售屬性的中文名字串。outer_idString否12345商家設(shè)置的外部 Id(商家編碼)。barcodeString否6903244981002 商品條形碼。oidString是I1200351子訂單 Id 號。outer_iidString否12345商家設(shè)置的外部 Id（商家編碼）。titleString是5s商品標(biāo)題。pritring是200.07商品價格。精確到 2 位小數(shù);:元。如:200.07，表示:200 元 7 分。num_iidString是29446852商品數(shù)字 Id。sku_idString否

27、12305商品的最小庫存Sku 的 id。numNumber是1數(shù)量。取值范圍：大于零的整數(shù)。outer_sku_idString否81893848外部網(wǎng)店自己定義的 Sku。total_feeString 是 200.07應(yīng)付金額（商品價格 * 商品數(shù)量 + 手工調(diào)整金額 - 子訂單級訂單 金額）。精確到 2 位小數(shù)； :元。如:200.07，表示:200 元 7 分。paymentString是200.07子訂單實付金額。精確到 2 位小數(shù):元。如:200.07，表示:200 元 7 分。discount_feeString否200.07子訂單級訂單金額。精確到 2 位小數(shù);:元。如:20

28、0.07，表示:200 元 7分。modifiedDate否2013-11-11訂單修改時間 。（ 格式： yyyy-MM-dd15:10:05HH:mm:ss）sku_properties_name String否顏色:桔色;尺碼:MSKU 的值。end_timeDate否2012-04-07 00:00:00子訂單的交易結(jié)束時間。consign_timeString否2013-01-13 15:23:00子訂單發(fā)貨時間。refund_idString否1232退款 IDrefund_susString否WAIT_BUYER_RETURN_GOODS 可選值 WAIT_SELLER_AGRE

29、E(買家已經(jīng)申請 退 款 ， 等 待 賣 家 同 意 ) WAIT_BUYER_RETURN_GOODS( 賣家已經(jīng)同意 退 款 ， 等 待 買 家 退 貨 ) WAIT_SELLER_CONFIRM_GOODS( 買家已經(jīng)退 貨 ， 等 待 賣 家 確 認(rèn) 收 貨 ) SELLER_REFUSE_BUYER( 賣家退款)CLOSED(退款關(guān)閉) SUCS(退款成功)is_fetchString否0門店自提標(biāo)識。取值如下：門店自提訂單=1，同城配送=2，默認(rèn)普通=0fetch_shop_idString否123自提點(門店)id4. Trade 實體名稱類型是否必須示例值描述tidString

30、是2231598456416交易。seller_nickString否測試賬戶賣家昵稱。buyer_nickString是我是買家昵稱。paymentString是200.07實付金額。精確到 2 位小數(shù);:元。如:200.07，表示:200 元 7 分。t_feeString是15.00郵費(fèi)。精確到 2 位小數(shù);:元。如:200.07，表示:200 元 7 分。discount_feeString否200.07如打折，VIP，滿就送等），精確到 2 位小數(shù)，：元。如：200.07，表示：200 元 7 分。total_feeString否200.07商品金額（商品價格乘以數(shù)量的總金額）。精確

31、到 2位小數(shù);:元。如:200.07，表示:200 元 7 分。receiver_nameString是收貨人。receiver_seString是浙江省收貨人所在的省份。receiver_addressString是杭州淘寶城收貨人的詳細(xì)地址。receiver_zipString是515100收貨人。receiver_mobileString是收貨人號碼。receiver_phoneString是收貨人號碼。receiver_cityString是杭州市收貨人所在城市。receiver_district String是西湖區(qū)收貨人所在地區(qū)。consign_timeDate否2000-01-0

32、1賣家發(fā)貨時間。（格式:yyyy-MM-dd HH:mm:ss）00:00:00ordersOrder 是訂單列表。Order 類型要求返回的對象具體參考實體附錄。susString是TRADE_FINISHED 交易狀態(tài)?？蛇x值:TRADE_WAIT_BUYER_PAY 沒有付款 TRADE_SELLER_SEND_GOODS已付款 TRADE_WAIT_BUYER_CONFIRM_GOODS 已發(fā)貨 TRADE_FINISHED交易完成 TRADE_AUTOMATIC_CLOSED交易取消createdDate是2000-01-01交易創(chuàng)建時間。（格式:yyyy-MM-dd HH:mm:s

33、s）00:00:00pay_timeDate否2000-01-01付款時間。（格式:yyyy-MM-dd HH:mm:ss）00:00:00modifiedDate是2000-01-01交易修改時間。（格式:yyyy-MM-dd HH:mm:ss）5. Refund 實體名稱類型是否必須示例值描述refund_idString是83477退款單號 Id（。目前只支持 Number 類型）tidString是2231598456416交易。oidString是2231598456416子訂單號total_feeString否10.00交易總金額。精確到 2 位小數(shù);:元。如:200.07，表示:

34、200 元 7 分。createdDate是2000-01-01 00:00:00退 款 申 請 時 間 。 格 式 :yyyy-MM-ddHH:mm:ss。modifiedDate是2000-01-01 00:00:00更新時間。格式:yyyy-MM-dd HH:mm:ss。susString是SUCS退款狀態(tài)?？蛇x值WAIT_SELLER_AGREE(買家已經(jīng)申請退款，等待賣家同意)WAIT_BUYER_RETURN_GOODS(賣家已經(jīng)同意退款，等待買家退貨)WAIT_SELLER_CONFIRM_GOODS(買家已經(jīng)退貨，等待賣家確認(rèn)收貨) SELLER_REFUSE_BUYER(賣家

35、退款)CLOSED(退款關(guān)閉) SUCS(退款成功)。order_susString是WAIT_SELLER_SEND_GOODS退款對應(yīng)的訂單交易狀態(tài)。可選值:TRADE_WAIT_BUYER_PAY 沒有付款 TRADE_SELLER_SEND_GOODS已付款 TRADE_WAIT_BUYER_CONFIRM_GOODS 已發(fā)貨00:00:00end_timeDate否2000-01-01交易結(jié)束時間。（格式:yyyy-MM-dd HH:mm:ss）00:00:00buyer_messageString否要送人的買家留言。buyer_memoString否上衣大一號買家備注。seller

36、_memoString否好的賣家備注。_nameString否某某公司抬頭。_typeString否類型buyer_paymodeString否線上支付付款方式iscodBool否true是否是貨到付款的訂單6. AddressResult 實體名稱類型是否必須示例值描述contact_idNumber是123456地址庫 IDcontact_nameString是聯(lián)系人provintring是浙江省省cityString是杭州市市TRADE_FINISHED交易完成TRADE_AUTOMATIC_CLOSED交易取消has_good_returnBool否true買家是否需要退貨。可選值:t

37、rue(是),false(否)refund_feeString是10.00退還金額(退還給買家的金額)。精確到2 位小數(shù);:元。如:200.07，表示:200元 7 分。paymentString否10.00支付給賣家的金額(交易總金額-退還給買家的金額)。精確到 2 位小數(shù);:元。如:200.07，表示:200 元 7 分。reasonString是退款郵費(fèi)退款原因。descString否這是退款說明退款說明。titleString否商品標(biāo)題numNumber否1商品數(shù)量company_nameString否申通快遞物流公司名稱sidString否123456789退貨運(yùn)單號refund_phaseString否onsale退款階段，可選值：onsale/aftersalerefund_verNumber否1411375308927退款版本號（時間戳）skuString否30004447689| 顏色分類: 商品 SKU 信息軍綠色;尺碼:XSattributeString否key1:value1,退款擴(kuò)展屬性key2:value2outer_idString否ISBN-001商品外部商家編碼operation_contra String否退款約束，可選值：cannot_ref