对接商城金蝶订单100外部api说明r3

1、一、文档说明本文档的使用对象是第开发接入。第二部分系统参数的蓝色表格是要求每个 API 都要传入的参数，绿色表格是要求出现错误时返回的参数；第三部分是要求第实现的 API 列表，其中蓝色表格表示输入参数格式，绿色表格表示输出参数格式；第四部分是 API 要求返回的数据对应的实体。二、系统参数1、系统参数列表2、响应错误格式错误返回error_response:sub_code:3,sub_msg:错误描述3、签名 sign(可参考 demo)调用 API 时需要对请求参数进行签名验证，TOP 服务器也会对该请求参数进行验证是否合法的。方法如下：根据参数名称（除签名和）将所有请求参数按照字母先后

2、顺序排序:key + value key +value 例如：将 foo=1,bar=2,baz=3 排序为 bar=2,baz=3,foo=1，参数名和参数值字符串 bar2baz3foo1后，得到拼装名称类型是否必须描述sub_codeString否错误码。sub_msgString否错误描述。名称类型是否必须描述methodString是API 名称。app_keyString是商城分配给应用的 AppKey。sesString是商城分配给用户的 SesKey。vString是API 协议版本。可选值:1.0timestString是时间戳，格式为 yyyy-MM-dd HH:mm:ss

3、，例如：2008-01-25 20:23:30。检查发起请求时间与服务器时间相差多大，判断是否回放请求signString是API 输入参数签名结果。参考签名。sign_method String否参数的加密方法选择。默认值:md5formatString否可选。指定参数格式。默认是 json，支持格式为 xml 和 json。md5：将 secret 拼接到参数字符串头、尾进行 md5 加密后，再转化成大写，格式是：(md5(secretkey1value1key2value2.secret)三、API 列表1. kingdee.items.get(商品)返回示例items_get_resp

4、onse: items: item: ,total_results: 6名称类型是否必须 示例值描述total_results Number是200所有符合条件的商品数量。itemsItem是返回商品列表。Item 类型要求返回的对象具体参照实体附录。名称类型是否必须示例值默认值描述start_timeDate可选2000-01-01开始时间，格式:yyyy-MM-dd HH:mm:ss。00:00:00end_timeDate可选2000-12-01结束时间，格式:yyyy-MM-dd HH:mm:ss。00:00:00page_noNumber可选11页码。取值范围:大于零的整数。默认值为

5、1,即默认返回第一页数据。page_sizeNumber可选100100每页条数。取值范围:大于零的整数; 默认值：100。susNumber可选onsaleonsale 表示上架，instock 表示下架。不填写将返回包括上架和下架的所有商品。num_iidString可选29446852商品数字 Id。 填写这个参数，其它业务参数不传值2. kingdee.item.ty.update(修改商品库存)返回示例3. kingdee.trades.get(查询卖家已卖出的交易数据)名称类型是否必须 示例值默认值描述start_timeDate可选2000-01-01查询交易创建时间开始。格式:

6、yyyy-MM-dd00:00:00HH:mm:ss。默认返回 3 天数据end_timeDate可选2000-01-01查询交易创建时间结束。格式:yyyy-MM-dd00:00:00HH:mm:ss。page_noNumber可选101页码。取值范围:大于零的整数。默认值为1,即默认返回第一页数据。page_sizeNumber可选100100每页条数。取值范围:大于零的整数; 默认值：100。use_has_next Bool可选truefalse是否启用 has_next 的分页方式，如果指定true，则返回的结果中不包含录数，但是会新增一存在下一页的的字段。susString可选TR

7、ADE_FINISHEDTRADE_WAIT_BUYER_PAY 没有付款TRADE_SELLER_SEND_GOODS已付款TRADE_WAIT_BUYER_CONFIRM_GOODS 已发货TRADE_FINISHED交易完成item_ty_update_response: is_sucs:true名称类型是否必须 示例值描述如更新成功没有错误返回名称类型是否必须示例值默认值描述num_iidString必须29446852商品数字 Id。tyNumber必须50库存修改值。sku_idString可选12305要操作的 sku 的数字 ID。如果不填写，默认修改的是商品的库存，填写的话就

8、是修改 sku的库存。typeNumber可选21库存更新方式，可选。1 为全量更新，2 为增量更新。如果不填，默认为全量更新。返回示例4. kingdee.logistics.offlind(线下物流发货)名称类型是否必须 示例值默认值描述tidString必须135468交易。out_sidString必须SF05052运单号。具体一个物流公司的真实运单号码。company_code String必须ZJS物流公司代码。如T 就代表中国邮政,ZJS就代表宅急送。is_splitNumber可选10表明是否是拆单。1 表示拆单 0 表示不拆单，默认值 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所有符合条件的订单数量。has_nextBool否true是否存在下一页。tradesTrade是返回商品列表。Trade 类型要求返回的对象具体参照实体附录。TRADE_AUTOMATIC_CLOSED交易关闭daypeNumber可选111 按创建时间，2 按修改时间。tidString可选13365,4566订单号。填写这个

10、参数，其它业务参数不传值fieldsString可选tid,sus返回字段（漏单检查使用，如只需返回 tid，不传返回所有字段）目前第 商城接口默认不 没有付款 状态的订单，同时在 的设置界面中也不提供设置支持。返回示例5. kingdee.refunds.get(退款单获取)返回示例refunds_get_response: refunds: refund: 实体【Refund】,名称类型是否必须 示例值描述total_results Number否200所有符合条件的商品数量。has_nextBool否true是否存在下一页。refundsRefund 是退款信息列表。Refund 类型要

11、求返回的对象具体参照实体附录。名称类型是否必须 示例值默认值描述start_timeDate可选2000-01-01查询修改时间开始。 格式 :yyyy-MM-dd00:00:00HH:mm:ss。默认返回 7 天数据end_timeDate可选2000-01-01查询修改时间结束。 格式 :yyyy-MM-dd00:00:00HH:mm:ss。page_noNumber可选101页码。取值范围:大于零的整数。默认值为1,即默认返回第一页数据。page_sizeNumber可选100100每页条数。取值范围:大于零的整数; 默认值：100。use_has_next Bool可选truefals

12、e是否启用 has_next 的分页方式，如果指定true，则返回的结果中不包含录数，但是会新增一存在下一页的的字段。refund_idString可选退款单号。填写这个参数，其它业务参数不传值logistics_offline_send_response: is_sucs:true 名称类型是否必须 示例值描述没有错误就是发货成功sub_tidString 可选1,2,3需要拆单发货的子订单集合，为空表示不做拆单发货。6. kingde.returngoods.agree(卖家同意退货)第需将退款状态更新为待退货，中走等待签收流程到待审核退款。返回示例7. kingde.refunds.ag

13、ree(卖家同意退款)第需将退款状态更新为退款成功，订单状态更新为交易关闭，如果已对接有支付接口，则需要自己调用支付接口将退款原路退回。名称类型是否必须 示例值默认值描述refund_infosString必须43234234|2000退款信息，格式：refund_id|amount|ver，rp_returngoods_agree_response: is_sucs:true 名称类型是否必须 示例值描述没有错误就是同意退货成功名称类型是否必须 示例值默认值描述refund_idNumber必须328818231125退款nameString可选卖家，淘宝退款为必填项。浙江省杭州市西addr

14、essString可选湖区 XX 路XX 号卖家提供的退货地址，淘宝退款为必填项。XX 小区tString可选310000卖家提供的退货地址的，淘宝退款为必填项。String可选5718848388卖家座机，淘宝退款为必填项。mobileString可选卖家，淘宝退款为必填项。remarkString可选没有问题，同意退卖家退货留言，天猫退款为必填项。货refund_phaseString可选onsale售中：onsale，售后：aftersale，天猫退款为必填项。refund_verNumber可选1409231007325退款版本号，天猫退款为必填项。seller_address_idN

15、umber可选123456卖家收货地址，天猫退款为必填项。total_results: 100返回示例8. kingdee.refund.refuse(卖家退款、退货)第需将退款状态更新为卖家退款。名称类型是否必须 示例值默认值描述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是退款操作结果列表msg_codeString是OP_SUCC批量退款操作情况，可选值：OP_SUCC（全部成功），SOME_OP_SUCC（部分成功），OP_FAILURE_UE（全部失败）0|其中refund_id 为退款，amount 为退款金14,3123123|120额（以分为），ver为退款最后更新时00|1409294148间（时间戳格式），多个退款以半角逗号分隔。715返回示例9

17、. kingdee.logistics.address.search(查询卖家地址库)同意退货前会先获取卖家收货地址，如需对接售后（同意退货）接口，则必须对接此接口。名称类型是 否 必 示例值描述须名称类型是否必须 示例值默认值描述可选，参数列表如下：no_def:查询非默认地址rdefString可选no_defget_def:查询默认取货地址，也即对应卖家地址库中发货地址（send_def 暂不起作用）cancel_def:查询默认退货地址,缺省此参数时，查询所有当前用户的地址库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:退款状态 可选值WAIT_SELLER_AGREE(买家已经申请退款，等待卖家同意) WAIT_BUYER_RETURN_GOODS(卖家已经同意退款，等待买家退货) WAIT_SELLER_CONFIRM_GOODS(买家已经退货，等待卖家确认收货) SELLER_REFUSE_BUYER(卖家 退款) CLOSED(退款关闭) SUC S(退款成功)我是被上传的文最大长度：退款时的退款凭证

19、，一般是卖家退款时refuse_proofbyte可选件内容130000使用的发货凭证，最大长度 130000 字节，支持的格式：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(核销门店自提订单)第核销提货码成功后需将订单的交易状态更新为“已发货”,保证中可以更新到状态。名称类型是否必须示例值默认值描述offline_shoplist_get_response: account_shop_offlines: account_shop_offline: 实体【AccountShopOffline】,total_results: 100名称类型是否必 示例值描述须total_resultsNumber否200所有符合条件的门店数量。account_shop_offlines AccountShopOffline是门店信息列表。AccountShopOffline

21、类型要求返回的对象具体参照实体附录。名称类型是否必须示例值默认值描述page_noNumber可选11页码。取值范围:大于零的整数。默认值为1,即默认返回第一页数据。page_sizeNumber可选100100每页条数。取值范围:大于零的整数。 默认值：100。logistics_address_search_response: addresses:address_result:实体【AddressResult】addressesAddressResult 是200一组地址库数据。AddressResult 类型要求返回的对象具体参照实体附录。返回示例12. kingdee.logistic

22、s.dummy.send(无需物流发货)返回示例四、实体附录1. Sku 实体名称类型是否必须示例值描述sku_idString是12305sku 数字 Id。num_iidString是29446852sku 所属商品 Id（网店货品 ID）。tyNumber否50sku 商品数量。pritring否200.07属 于 这 个 sku 的 商 品 的 价 格取 值 范围:0-100000000; 精确到 2 位小数;: 元。如:200.07，表示:200 元 7 分。createdDate否2013-11-10sku 创建日期，时间格式：yyyy-MM-dd HH:mm:ss。15:10:0

23、5logistics_dummy_send_response: is_sucs:true 名称类型是否必须 示例值描述没有错误就是发货成功名称类型是否必须 示例值默认值描述tidString必须135468交易。trade_selffetchcode_apply_response: is_sucs:true 名称类型是否必须 示例值描述没有错误返回就是核销成功codeString必须123提货码。2. Item 实体3. Order 实体名称类型是否必 示例值描述须名称类型是否必须示例值描述num_iidString是29446852商品数字 Id（网店货品 ID）。numNumber否888

24、商品数量。outer_idString否12345商家设置的外部 Id(商家编码)。pritring是5.00商品价格，格式：5.00；：元；精确到：分。skusSku否Sku 列表。Sku 类型要求返回的对象具体参考实体附录。approve_susString是onsale商品上传后的状态。商品上传后的状态。onsale 出售中，instock 库中。barcodeString否6903244981002商品条形码。titleString是测试商品商品标题，过 60 字节。descString否这是测试商品描述。createdDate否2013-11-10商品创建时间。（ 格式： 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 状态。 normal:正常 ；delet

26、e:删除。properties_name String是sku 所对应的销售属性的中文名字串。outer_idString否12345商家设置的外部 Id(商家编码)。barcodeString否6903244981002 商品条形码。oidString是I1200351子订单 Id 号。outer_iidString否12345商家设置的外部 Id（商家编码）。titleString是5s商品标题。pritring是200.07商品价格。精确到 2 位小数;:元。如:200.07，表示:200 元 7 分。num_iidString是29446852商品数字 Id。sku_idString否

27、12305商品的最小库存Sku 的 id。numNumber是1数量。取值范围：大于零的整数。outer_sku_idString否81893848外部网店自己定义的 Sku。total_feeString 是 200.07应付金额（商品价格 * 商品数量 + 手工调整金额 - 子订单级订单 金额）。精确到 2 位小数； :元。如:200.07，表示:200 元 7 分。paymentString是200.07子订单实付金额。精确到 2 位小数:元。如:200.07，表示:200 元 7 分。discount_feeString否200.07子订单级订单金额。精确到 2 位小数;:元。如: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子订单的交易结束时间。consign_timeString否2013-01-13 15:23:00子订单发货时间。refund_idString否1232退款 IDrefund_susString否WAIT_BUYER_RETURN_GOODS 可选值 WAIT_SELLER_AGRE

29、E(买家已经申请 退 款 ， 等 待 卖 家 同 意 ) WAIT_BUYER_RETURN_GOODS( 卖家已经同意 退 款 ， 等 待 买 家 退 货 ) WAIT_SELLER_CONFIRM_GOODS( 买家已经退 货 ， 等 待 卖 家 确 认 收 货 ) SELLER_REFUSE_BUYER( 卖家退款)CLOSED(退款关闭) SUCS(退款成功)is_fetchString否0门店自提标识。取值如下：门店自提订单=1，同城配送=2，默认普通=0fetch_shop_idString否123自提点(门店)id4. Trade 实体名称类型是否必须示例值描述tidString

30、是2231598456416交易。seller_nickString否测试账户卖家昵称。buyer_nickString是我是买家昵称。paymentString是200.07实付金额。精确到 2 位小数;:元。如:200.07，表示:200 元 7 分。t_feeString是15.00邮费。精确到 2 位小数;:元。如:200.07，表示:200 元 7 分。discount_feeString否200.07如打折，VIP，满就送等），精确到 2 位小数，：元。如：200.07，表示：200 元 7 分。total_feeString否200.07商品金额（商品价格乘以数量的总金额）。精确

31、到 2位小数;:元。如:200.07，表示:200 元 7 分。receiver_nameString是收货人。receiver_seString是浙江省收货人所在的省份。receiver_addressString是杭州淘宝城收货人的详细地址。receiver_zipString是515100收货人。receiver_mobileString是收货人号码。receiver_phoneString是收货人号码。receiver_cityString是杭州市收货人所在城市。receiver_district String是西湖区收货人所在地区。consign_timeDate否2000-01-0

32、1卖家发货时间。（格式:yyyy-MM-dd HH:mm:ss）00:00:00ordersOrder 是订单列表。Order 类型要求返回的对象具体参考实体附录。susString是TRADE_FINISHED 交易状态。可选值:TRADE_WAIT_BUYER_PAY 没有付款 TRADE_SELLER_SEND_GOODS已付款 TRADE_WAIT_BUYER_CONFIRM_GOODS 已发货 TRADE_FINISHED交易完成 TRADE_AUTOMATIC_CLOSED交易取消createdDate是2000-01-01交易创建时间。（格式: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 位小数;:元。如: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退款状态。可选值WAIT_SELLER_AGREE(买家已经申请退款，等待卖家同意)WAIT_BUYER_RETURN_GOODS(卖家已经同意退款，等待买家退货)WAIT_SELLER_CONFIRM_GOODS(买家已经退货，等待卖家确认收货) SELLER_REFUSE_BUYER(卖家

35、退款)CLOSED(退款关闭) SUCS(退款成功)。order_susString是WAIT_SELLER_SEND_GOODS退款对应的订单交易状态。可选值:TRADE_WAIT_BUYER_PAY 没有付款 TRADE_SELLER_SEND_GOODS已付款 TRADE_WAIT_BUYER_CONFIRM_GOODS 已发货00:00:00end_timeDate否2000-01-01交易结束时间。（格式: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是联系人provintring是浙江省省cityString是杭州市市TRADE_FINISHED交易完成TRADE_AUTOMATIC_CLOSED交易取消has_good_returnBool否true买家是否需要退货。可选值:t

37、rue(是),false(否)refund_feeString是10.00退还金额(退还给买家的金额)。精确到2 位小数;:元。如:200.07，表示:200元 7 分。paymentString否10.00支付给卖家的金额(交易总金额-退还给买家的金额)。精确到 2 位小数;:元。如:200.07，表示:200 元 7 分。reasonString是退款邮费退款原因。descString否这是退款说明退款说明。titleString否商品标题numNumber否1商品数量company_nameString否申通快递物流公司名称sidString否123456789退货运单号refund_phaseString否onsale退款阶段，可选值：onsale/aftersalerefund_verNumber否1411375308927退款版本号（时间戳）skuString否30004447689| 颜色分类: 商品 SKU 信息军绿色;尺码:XSattributeString否key1:value1,退款扩展属性key2:value2outer_idString否ISBN-001商品外部商家编码operation_contra String否退款约束，可选值：cannot_ref