售后對賬vop幫助1.3通用版

1、VOP 幫助文檔京東商城所有注意文檔版本號：1.0.0文檔編號：文檔密級：歸屬部門/項目：大客戶部名：2.0VOP 幫助文檔子系統(tǒng)名：編寫人：編寫日期：2019/04/17修訂：版本號修訂人修訂日期修訂描述1.0劉波2019/04/17目錄2.0 VOP 幫助文檔1一、系統(tǒng)對接幫助文檔（實物）41、售后 API 接口4商品售后屬性41.1申請售后81.2售后申請單列表錯誤!未定義書簽。1.3售后概要141.4填寫運單信息231.5取消售后申請251.6確認售后完成251.72、對賬 API 接口30申請對賬302.1對賬結果接口342.23、信息推送 api 接口38推送信息383.1刪除推送

2、信息433.2一、1、1.1系統(tǒng)對接幫助文檔（實物）售后API 接口商品售后屬性1.1.1 接口描述批量訂單下商品可售后數(shù)量、支持的售后類型、支持的返回京東的方式。售后服務類型：退、換、修。1.1.2 URL htt/api/afterSaleNew/getGoodsAttributes1.1.3 參數(shù)格式請求參數(shù)格式：參數(shù)用&拼接（param 是 json 字符串），詳見請求示例方式：Content-Type, application/x-www-form-urlencoded1.1.4 HTTPS 請求方式POST1.1.5 請求參數(shù)參數(shù)名稱類型非空描述tokenString是paramS

3、tring是請求的 json 參數(shù)( json 格式)param 參數(shù)說明：1.1.6 請求示例1.1.7 響應參數(shù)SupportedInfo:參數(shù)名稱類型非空描述參數(shù)名稱類型非空描述successboolean是true：成功 false：失敗resultCodeString是業(yè)務處理結果編碼，詳細參見：【錯誤碼】resultMessageString否對 resultCode 的簡要說明resultList是商品售后屬性集合參數(shù)名稱非空描述類型orderIdLong是訂單號，即京東子訂單號customerPinString否京東 PIN。必須是相同合同下的pin。該字段用于驗證操作限。如果

4、傳入賬號，則賬號必須為訂單下單人；如果不傳入，則默認可操作主數(shù)據(jù)合同下所有的訂單wareIdsList是商品編碼集合1.1.8 響應示例success: true,resultMessage: 操作成功,resultCode: 0000,result: wareIdLong是商品編碼wareNumInterger是商品可售后數(shù)量。訂單 品發(fā)生退貨和換貨后，訂單的可售后數(shù)量會相應減少。如果商品換貨后需要再次售后，需要通過“售后換新訂單”發(fā)起售后。售后換新單的退款金額會 在原單，退貨數(shù)量在原單。建議清楚售后換新單與原始單的關系。customerExpectList否支持的服務類型。10 退貨，20

5、 換貨，30 維修預期為空可能代表當前沒有可以售后的商品pickupWareTypeList否支持的返回京東方式。4 上門取件，5 上門換新取件，7 客戶送貨，8 大家電上門取件，9 大家電換新取件，40 客戶發(fā)貨。 為空可能代表當前沒有可以售后的商品wareId: 6139455,wareNum: 1,customerExpect: 10,20,30,pickupWareType: 40,7,4,wareId: 1318871,wareNum: 1,customerExpect: 10,20,30,pickupWareType: 40,7,41.2 申請售后1.2.1 接口描述批量發(fā)起售后。

6、1.2.2 URL htt/api/afterSaleNew/createAfsApply1.2.3 參數(shù)格式請求參數(shù)格式：參數(shù)用&拼接（param 是 json 字符串），詳見請求示例方式：Content-Type, application/x-www-form-urlencoded1.2.4 HTTPS 請求方式POST1.2.5 請求參數(shù)param 參數(shù)說明：參數(shù)名稱類型非空描述customerPinString否京東 PIN。必須是相同合同下的pin。該字段用于驗證操作 限。如果傳入賬號，則賬號必須為訂單下單人；如果不傳入，則默認可操作主數(shù)據(jù)合同下所有的訂單orderIdString是

7、京東子訂單號thirdApplyIdString是申請批次號，同一子訂單下不可重復isHasInvoiceBoolean否是否有customerInfoAfsCustomerInfo是用戶信息pickwareInfoAfsPickupWareInfo是取件信息，即原商品如何返回京東或者賣家參數(shù)名稱類型非空描述tokenString是paramString是請求的參數(shù)AfsCustomerInfo 說明：（申請時用戶信息）AfsPickupWareInfo 說明：（申請時取件信息）參數(shù)名稱類型非空描述pickwareTypeInteger是取件方式。4 上門取件，5 上門換新取參數(shù)名稱類型非空描

8、述customerNameString是是用戶名customerContactNameString人customerTelString否，與號不能同時為空customerMobilePhoneString否號，與號不能同時為空customerString否否customerPostcodeStringreturnWareInfoAfsReturnWareInfo是返件信息，商品如何返回客戶手中。當售后類型為換貨、維修時，表示商品如何返回客戶手中；當售后類型為退貨時，表示退貨失敗商品返回客戶手中的地址。afsApplyInfoItemListList是申請信息集合。一個 SKU 只能有一個條目，

9、一個 SKU 不能有兩個或兩個以上條目。AfsReturnWareInfo 說明： （申請時返件信息）參數(shù)名稱類型非空描述returnWareTypeInteger是是是是否返件方式。10 自營配送，20 第配送returnWareProvinceInteger返件省returnWareCityInteger返件市returnWareCountyInteger返件縣returnWareVillageInteger返件鄉(xiāng)鎮(zhèn)件，7 客戶送貨，8 大家電上門取件，9 大家電換新取件，40 客戶發(fā)貨。pickWareProvinceInteger是是是否是取件省pickWareCityInteger取

10、件市pickWareCountyInteger取件縣pickWareVillageInteger取件鄉(xiāng)鎮(zhèn)pickWareAddressString取件街道地址ateBeginString否預約取件開始時間。開始時間不可早于當前時間+2 小時。格式：2014-09-23 09:00:00ateEndString否預約取件結束時間。格式：2014-09-23 19:00:00AfsApplyInfoItem 說明：（申請時申請條目）WareDescInfo 說明：（商品狀況描述）WareDetailInfo 說明： （商品及其數(shù)量）參數(shù)名稱類型非空描述參數(shù)名稱類型非空描述isNeedDetecti

11、onReportBoolean否是否需要檢測報告lossPreventionTagFlagBoolean否是否有防損吊牌。isHasPackageBoolean否是否有包裝packageDescInteger否包裝描述questionDescString否問題描述文字questionPicString否問題描述圖片。多個圖片以“；”分隔參數(shù)名類型非空描述customerExpectInteger是客戶期望售后類型。10退貨，20 換貨，30 維修wareDescInfoWareDescInfo否商品描述信息wareDetailInfoWareDetailInfo是商品明細returnWareA

12、ddressString是返件街道地址1.2.6 請求示例暫無1.2.7 響應參數(shù)參數(shù)名稱類型非空描述successBoolean是true 成功 false 失敗resultCodeString是業(yè)務處理結果編碼，詳細參見：【錯誤碼】resultMessageString否對 resultCode 的簡要說明resultString否該字段為空wareIdLong是是是是否否商品編號mainWareIdLong主商品編號wareNameString商品名稱wareNumInteger商品申請數(shù)量wareDescribeString附件描述payPriceBigDecimal支付金額，即“商品

13、單價*數(shù)量”wareTypeWareType是商品類型。1 主商品，2 贈品。1.2.8 響應示例success: false,resultMessage: 數(shù)量超過訂單商品數(shù)量,resultCode: 6010,result: nullsuccess: true,resultMessage: 操作成功,resultCode: 0000,result: null1.3售后概要1.3.1 接口描述訂單售后情況概要。根據(jù)入?yún)⒉煌?，出參組裝規(guī)則不同：VOP 入?yún)⒊鰠rderId= orderId1orderId1 的訂單維度概要信息orderId= orderId1，thirdApplyId= t

14、hirdApplyId1thirdApplyId1 的申請單維度概要信息1.3.2 URL htt/api/afterSaleNew/getAfsOutline1.3.3 參數(shù)格式請求參數(shù)格式：參數(shù)用&拼接（param 是 json 字符串），詳見請求示例方式：Content-Type, application/x-www-form-urlencoded1.3.4 HTTPS 請求方式POST1.3.5 請求參數(shù)orderId= orderId1，wareId= wareId1wareId1 的商品維度概要信息orderId= orderId1，thirdApplyId= thirdApply

15、Id1，wareId= wareId1wareId1 的商品維度概要信息orderId= orderId1，thirdApplyId=1orderId1 下所有申請單概要列表orderId= orderId1，wareId= 1orderId1 下所有商品概要列表orderId= orderId1，thirdApplyId= thirdApplyId1，wareId= 1thirdApplyId1 下所有商品概要列表orderId= orderId1，thirdApplyId= 1，wareId= 1orderId1 下所有商品概要列表orderId= orderId1 ， thirdAppl

16、yId= 1 ， wareId=wareId1wareId1 的商品維度概要信息Param：參數(shù)名稱非空描述類型customerPinString否京東 PIN 必須是相同合同下的pin。該字段用于驗證操作人權限。如果傳入賬號，則賬號必須為訂單下單人；如果不傳入，則默認可操作主數(shù)據(jù)合同下所有的訂單orderIdLong是訂單號，即京東子訂單號thirdApplyIdString否第申請單號。thirdApplyId 值為申請單編號時，表示特定申請單；thirdApplyId=1 時表示選中所有申請單applyPageNoInteger否第申請單號當前頁號，默認為 1applyPageSizeI

17、nteger否第申請每頁行數(shù)，默認為 20 ，max: 100wareIdLong否商品編號。wareId 為 SKU 編號時，表示特定 SKU；wareId=1 時表示選中所有 SKUwarePageNoInteger否商品維度信息當前頁號，默認為 1warePageSizeInteger否商品維度信息每頁行數(shù)。默認為 20 ，最大 100參數(shù)名稱類型非空描述tokenString是paramString是請求的參數(shù)(json 格式)1.3.6 請求示例暫無1.3.7 響應參數(shù)Page 實體參數(shù)說明：訂單維度概要：參數(shù)名稱類型非空描述orderIdLong京東子單號originalOrder

18、IdLong原始單號。售后換新單對應的原始訂單編號。pinString京東 PINcustomerNameString客戶名稱ApplyNumInteger原始申請數(shù)量applicationNumInteger申請中數(shù)量參數(shù)名稱類型非空描述successboolean是true 成功 false 失敗resultCodeString是業(yè)務處理結果編碼，詳細參見：【錯誤碼】resultMessageString否對 resultCode 的簡要說明resultPage否業(yè)務內容申請單維度概要：ApplyInfo：參數(shù)名稱類型非空描述orderIdLong訂單號，京東子訂單號參數(shù)名稱類型非空描述r

19、esultList申請單概要信息集合pageNumLong總頁數(shù)totalLong總行數(shù)pageIndexInteger當前頁數(shù)pageSizeInteger分頁行數(shù)wareServiceNumInteger服務中數(shù)量confirmNumInteger待確認數(shù)量pleteNumInteger完成數(shù)量wareCancelNumInteger駁回或取消數(shù)量refundNumInteger退貨數(shù)量shouldRefundAmountBigDecimal退貨商品金額realRefundAmountBigDecimal退款金額pleteInteger是否完成originalOrderIdLong原始單號

20、。售后換新單對應的原始訂單編號。thirdApplyIdString第申請單號。子單下不可重復isOfflineBoolean申請途徑，1 人工發(fā)起，2發(fā)起newPickWareTypeInteger當前取件方式。即 審核完成后的貨物與返回京東方式。如果該值為空，代表取件方式仍在確認中搜索，請等待第 申請單狀態(tài)更新后再次。4 上門取件，5 上門換新取件，7 客戶送貨，8 大家電上門取件，9 大家電換新取件，40 客戶發(fā)貨。pinString京東 PINapplyTimeString申請時間completeTimeString完成時間applyStepInteger售后環(huán)節(jié)。10 申請中待審核；

21、20 審核完成待收貨；30 收貨完成待處理；40 處理完成（如需退款則等待退款）；50 待用戶確認，60 用戶確認完成，70 取消customerNameString客戶名稱ApplyNumInteger原始申請數(shù)量applicationNumInteger申請中數(shù)量wareServiceNumInteger服務中數(shù)量商品維度概要：WareSummaryInfo：參數(shù)名稱類型非空描述orderIdLong是訂單號。京東子訂單號originalOrderIdLong否原始單號。售后換新單對應的原始訂單編號。參數(shù)名稱類型非空描述totalInteger是總數(shù)totalPageInteger是總頁數(shù)

22、pageNoInteger是當前頁數(shù)pageSizeInteger是分頁行數(shù)resultWareSummaryInfo商品概要信息集合ListconfirmNumInteger待確認數(shù)量pleteNumInteger完成數(shù)量wareCancelNumInteger駁回或取消數(shù)量refundNumInteger退貨數(shù)量shouldRefundAmountBigDecimal退貨商品金額realRefundAmountBigDecimal退款金額pleteInteger是否完成thirdApplyIdString否第申請單號isOfflineBoolean是申請途徑，申請或人工申請pinStrin

23、g是京東 PINcustomerNameString是客戶名稱customerExpectInteger否客戶期望售后類型。10 退貨，20 換貨，30維修afsServiceTypeInteger是最新期望售后類型wareIdLong是商品編號wareNameString是商品名稱mainWareIdLong否主商品編號ApplyNumInteger原始申請數(shù)量applicationNumInteger申請中數(shù)量wareServiceNumInteger服務中數(shù)量confirmNumInteger待確認數(shù)量pleteNumInteger完成數(shù)量wareCancelNumInteger駁回或取

24、消數(shù)量shouldRefundAmountBigDecimal退貨商品金額realRefundAmountBigDecimal退款金額pleteInteger是否完成completeTimeString完成時間1.3.8 響應示例success: true,resultMessage: null,resultCode: 0,result: code: 40,name: 客戶發(fā)貨,code: 7,name: 客戶送貨,code: 4,name: 上門取件1.4 填寫運單信息1.4.1 接口描述填寫發(fā)運信息，即客戶使用第物流將商品送回京東的信息。在選擇返回京東方式為客戶發(fā)貨的方式，審核通過后，會給

25、用戶通過推送郵寄地址。1.4.2 URL htt/api/afterSaleNew/updateSendInfo1.4.3 參數(shù)格式方式：Content-Type, application/x-www-form-urlencoded1.4.4 HTTPS 請求方式POST1.4.5 請求參數(shù)參數(shù)名稱類型非空描述TokenString是ParamString是請求參數(shù)（json 格式）WaybillInfo：參數(shù)名稱類型非空描述panyString是發(fā)貨公司expressCodeString是貨運單號，字段長度不超過 50deliverDateString是發(fā)貨日期，格式為 yyyy-MM-dd

26、 HH:mm:ssfreightMoneyBigDecimal是運費wareIdlong是商品編號wareTypeInteger是商品類型。10 主商品，20 贈品。wareNumInteger是商品數(shù)量參數(shù)名稱類型非空描述customerPinString否京東 PIN。必須是相同合同下的pin。該字段用于驗證操作 限。如果傳入賬號，則賬號必須為申請售后的訂單下單人；如果不傳入，則默認可操作主數(shù)據(jù)合同下所有的訂單orderIdLong是訂單號，即京東子單號thirdApplyIdString是第申請單號waybillInfoListList是運單信息集合1.4.6 請求示例請求示例，參照下方

27、代碼示例1.4.7 響應參數(shù)1.4.8 響應示例1.5 確認售后完成1.5.1 接口描述批量確認售后完成。如果售后申請單在待確認狀態(tài)超過 15 天，則會自動確認。1.5.2 URL htt/api/afterSaleNew/confirmAfsOrder參數(shù)名稱類型非空描述successBoolean是true 成功 false 失敗resultCodeString是業(yè)務處理結果編碼，詳細參見：【錯誤碼】resultMessageString否對 resultCode 的簡要說明resultString否該字段為空1.5.3 參數(shù)格式方式：Content-Type, application/x

28、-www-form-urlencoded1.5.4 HTTPS 請求方式POST1.5.5 請求參數(shù)Param：參數(shù)名稱類型非空描述customerPinString否京東 PIN。必須是相同合同下的 pin。該字段用于驗證操作限。如果傳入賬號，則賬號必須為申請售后的訂單下單人；如果不傳入，則默認可操作主數(shù)據(jù)合同下所有的訂單orderIdLong是訂單號，即京東子單號thirdApplyIdsList是第申請單集合參數(shù)名稱類型非空描述tokenString是paramstring是json 格式1.5.6 請求示例請求示例，參照下方代碼示例1.5.7 響應參數(shù)1.5.8 響應參數(shù)1.6 取消售

29、后申請1.6.1 接口描述售后申請單取消。按照申請批次取消已發(fā)起的售后申請。返回京東方式為客戶發(fā)貨，審核完成前可執(zhí)行取消操作；返回京東方式為上門取件時，配送員取件完成前可以執(zhí)行取消操作。參數(shù)名稱類型非空描述successBoolean是true 成功 false 失敗resultCodeString是業(yè)務處理結果編碼，詳細參見：【錯誤碼】resultMessageString否對 resultCode 的簡要說明resultString否該字段為空1.6.2 URL htt/api/afterSaleNew/cancelAfsApply1.6.3 參數(shù)格式方式：Content-Type, ap

30、plication/x-www-form-urlencoded1.6.4 HTTPS 請求方式POST1.6.5 請求參數(shù)Param：參數(shù)名稱類型非空描述customerPinString否京東 PIN。必須是相同合同下的pin。該字段用于驗證操作限。如果傳入賬號，則賬號必須為申請售后的訂單下單人；如果不傳入，則默認可操作主數(shù)據(jù)合同下所有的訂單orderIdLong是訂單號，即京東子單號參數(shù)名稱類型非空描述TokenString是Paramstring是json 格式1.6.6 請求示例請求示例，參照下方代碼示例1.6.7 響應參數(shù)1.6.8 響應示例success: true,resultM

31、essage: 操作成功,resultCode: 0000, result: null參數(shù)名稱類型非空描述successBoolean是true 成功 false 失敗resultCodeString是業(yè)務處理結果編碼，詳細參見：【錯誤碼】resultMessageString否對 resultCode 的簡要說明resultString否該字段為空thirdApplyIdString是第申請單號RemarkString是備注“”可以默認寫取消“”2、對賬API 接口2.1 申請對賬2.1.1 接口描述申請對賬。每個批次訂單數(shù)不能超過 500，超過 500 要拆分多個批次。總批次超過 1 時，

32、當所有批次都收到后，金樹才會推送對賬。一個第申請單號可以對應多個當前批次，但總批次應該一樣。結算單號主要用于對賬，與開票無關。一個結算單號可以對應多個第申請單號。2.1.2 URL htt/api/reconciliation/submitInvoiceBill2.1.3 參數(shù)格式方式：Content-Type, application/x-www-form-urlencoded2.1.4 HTTPS 請求方式POST2.1.5 請求參數(shù)參數(shù)名稱類型非空描述param 參數(shù)參數(shù)名稱類型非空描述pinString是京東 PIN。必須是相同合同下的pin。checkIdString是對賬申請單號。

33、申請對賬的唯一 id 標識， 不可重復；如果多次提交核對，每次都需要更換 iddateBeginString否申請對賬開始時間。對賬申請單中訂單妥投是按的開始時間，格式 yyyy-MM-dddateEndString否申請對賬結束時間，對賬申請單中訂單妥投是按的結束時間，格式 yyyy-MM-ddsettlementIdString否結算單號。一個結算單號可對對應多個第申請單號。如果未傳則默認結算單號等同對賬申請單號。invoiceTypeInteger否類型。23 普通電子priceTypeInteger是稅價類型。1 含稅checkNumInteger否對賬申請訂單總數(shù)。訂單總數(shù)傳入后將被

34、校驗。tokenString是paramString是json 格式，參數(shù)Order 說明：參數(shù)名稱類型非空描述jdOrderIdString是京東子單號orderPriceBigDecimal否訂單可結算含稅總金額。稅價類型為含稅時必傳。orderNakedPriceBigDecimal否訂單可結算未稅總金額。稅價類型為未稅時必傳。checkTaxPriceBigDecimal否對賬申請單可結算含稅總金額。稅價類型為含稅時傳入。checkNakedPriceBigDecimal否對賬申請單可結算未不含稅總金額。稅價類型為未稅時傳入。totalBatchInteger是總批次數(shù)currentB

35、atchInteger是當前批次號，批次號編碼使用從 1 開始的整數(shù)，不要間斷currentBatchNumInteger是當前批次子訂單總數(shù)currentBatchPriceBigDecimal否當前批次可結算含稅總金額。稅價類型為含稅時必傳。currentBatchNakedPriceBigDecimal否當前批次可結算未不含稅總金額。稅價類型為未稅時必傳。ordersList是訂單集合 ListSkuInfo 說明：2.1.6 請求示例請求示例，參照下方代碼示例2.1.7 響應參數(shù)參數(shù)名稱類型非空描述successBoolean是接口是否正常響應;true 表示正常處理請求參數(shù)名稱類型非

36、空描述skuIdLong是商品 SKU 號skuNameString是商品名稱parentSkuIdLong否贈品對應的主品 SKU 編號skuPriceBigDecimal否商品含稅價格。稅價類型為含稅時必傳。nakedPriceBigDecimal否商品未稅價格。稅價類型為未稅時必傳。skuTaxRateBigDecimal是商品稅率skuNumint是商品數(shù)量skusList是SKU 信息2.1.8 響應示例“success”: true,“resultMessage”: “操作成功“,“resultCode”: “0000”,“result”: true2.2對賬結果接口2.2.1 接

37、口描述對賬結果。2.2.2 URL htt/api/reconciliation/queryReconciliations2.2.3 參數(shù)格式方式：”Content-Type”, “application/x-www-form-urlencoded”resultCodeString是業(yè)務處理結果編碼，詳細參見：【錯誤碼】resultMessageString是對 resultCode 的簡要說明：【錯誤碼】resultBoolean是提報成功2.2.4 HTTPS 請求方式POST2.2.5 請求參數(shù)param 參數(shù)參數(shù)名稱類型非空描述pinString否京東 PIN。必須是相同合同下的pin

38、。該字段用于驗證操作限。如果傳入賬號，則賬號必須為對賬申請人；如果不傳入，則默認可操作主數(shù)據(jù)合同下所有的對賬申請單checkIdString是對賬申請單號：申請對賬的唯一標識settlementIdString否結算單號，一個結算單號可對應多個第申請單號jdOrderIdString否京東子單號showTypeinteger否數(shù)據(jù)展示類型。1 僅返回有差異數(shù)據(jù)，2 僅返回無差異數(shù)據(jù)，0 或 null 返回所有數(shù)據(jù)。pageSizeint是每頁顯示條數(shù)，默認 100，最大 100參數(shù)名稱類型非空描述tokenString是paramStrinng是json 格式，請求參數(shù)2.2.6 請求示例請求

39、示例，參照下方代碼示例2.2.7 響應參數(shù)Page參數(shù)名稱類型非空描述pageNumInteger是總頁數(shù)pageNoInteger是當前頁數(shù)pageSizeInteger是分頁行數(shù)dataObject是對賬明細參數(shù)名稱類型非空描述successboolean是是否到第申請單號resultCodeString是業(yè)務處理結果編碼，詳細參見：【錯誤碼】resultMessageString是對 resultCode 的簡要說明resultPage是對賬數(shù)據(jù)pageNoint是當前頁數(shù)，默認從 1 開始對賬明細 data 集合：商品明細 SkuInfo 集合：參數(shù)名稱類型非空描述skuIdLong是

40、商品編號skuNameString是商品名稱parentSkuIdLong是贈品對應的主品 SKU 編號skuPriceBigDecimal否商品含稅價格。對賬申請單稅價類型為“含稅”時有值nakedPriceBigDecimal否商品未稅價格。對賬申請單稅價類型為“未稅”時有值skuTaxRateBigDecimal是商品稅率參數(shù)名稱類型非空描述jdOrderIdString是京東子單號orderPriceBigDecimal否訂單可結算含稅總金額。對賬申請單稅價類型為“含稅”時有值orderNakedPriceBigDecimal否訂單可結算未稅總金額。對賬申請單稅價類型為“未稅”時有值checkResultBoolean是對賬結果adjustResultString是處理結果。1 暫時剔除，2 不再結算skusList是商品明細集合2.2.8 響應示例3、信息推送 api 接口3.1推送信息3.1.1 接口描述推送信息接口。3.1.2