金蝶订单100外部API说明R3.6
服务热线：400-665-0027
新购有特价、金蝶老客户升级金蝶云产品可以享受5折优惠，送手机、送话费，好礼不断！
一、文档说明本文档的使用对象是第三方开发接入平台。第二部分系统参数的蓝色表格是要求每个API都要传入的参数，绿色表格是要求出现错误时返回的参数；第三部分是要求第三方实现的API列表，其中蓝色表格表示输入参数格式，绿色表格表示输出参数格式；第四部分是API要求返回的数据对应的实体。二、系统参数1、系统参数列表[tr] [td=90]名称[td=74]类型[td=74]是否必须[td=459]描述
[tr] [td=90]method[td=74]String [td=74]是 [td=459]API名称。
[tr] [td=90]app_key[td=74]String [td=74]是 [td=459]商城分配给应用的AppKey。
[tr] [td=90]session[td=74]String [td=74]是 [td=459]商城分配给用户的SessionKey。
[tr] [td=90]v[td=74]String [td=74]是 [td=459]API协议版本。可选值:1.0
[tr] [td=90]timestamp[td=74]String [td=74]是 [td=459]时间戳，格式为yyyy-MM-dd HH:mm:ss，例如：2008-01-25 20:23:30。 检查发起请求时间与服务器时间相差多大，判断是否回放请求
[tr] [td=90]sign[td=74]String [td=74]是 [td=459]API输入参数签名结果。参考签名 。
[tr] [td=90]sign_method[td=74]String [td=74]否 [td=459]参数的加密方法选择。默认值:md5
[tr] [td=90]format[td=74]String [td=74]否 [td=459]可选。指定参数格式。默认是json，支持格式为xml和json。
[tr] [td=91]名称[td=71]类型[td=76]是否必须[td=142]描述[td=321]
[tr] [td=91]sub_code[td=71]String [td=76]否 [td=142]错误码。 [td=321]
[tr] [td=91]sub_msg[td=71]String [td=76]否 [td=142]错误描述。 [td=321]
错误返回{"error_response":{sub_code":"3","sub_msg":"错误描述"}}3、签名sign(可参考demo)调用API 时需要对请求参数进行签名验证，TOP服务器也会对该请求参数进行验证是否合法的。方法如下：
根据参数名称（除签名和图片）将所有请求参数按照字母先后顺序排序:key + value .... key + value例如：将foo=1,bar=2,baz=3排序为bar=2,baz=3,foo=1，参数名和参数值链接后，得到拼装字符串bar2baz3foo1
md5：将secret 拼接到参数字符串头、尾进行md5加密后，再转化成大写，格式是：(md5(secretkey1value1key2value2...secret)
三、API列表1. kingdee.items.get (下载商品)[table]
[tr] [td=97]名称[td=66]类型[td=75]是否必须[td=94]示例值[td=85]默认值[td=283]描述
[tr] [td=97]start_time[td=66]Date [td=75]可选 [td=94]2000-01-01 00:00:00 [td=85] [td=283]开始时间，格式:yyyy-MM-dd HH:mm:ss。
[tr] [td=97]end_time[td=66]Date [td=75]可选 [td=94]2000-12-01 00:00:00 [td=85] [td=283]结束时间，格式:yyyy-MM-dd HH:mm:ss。
[tr] [td=97]page_no[td=66]Number [td=75]可选 [td=94]1 [td=85]1 [td=283]页码。取值范围:大于零的整数。默认值为1,即默认返回第一页数据。
[tr] [td=97]page_size[td=66]Number [td=75]可选 [td=94]100 [td=85]100 [td=283]每页条数。取值范围:大于零的整数; 默认值：100。
[tr] [td=97]status[td=66]Number [td=75]可选 [td=94]onsale [td=85] [td=283]onsale表示上架，instock表示下架。不填写将返回包括上架和下架的所有商品。
[tr] [td=97]num_iid[td=66]String [td=75]可选 [td=94]29446852 [td=85] [td=283]商品数字Id。 填写这个参数，其它业务参数不传值
[table]
[tr] [td=106]名称[td=91]类型[td=2,1,71]是否必须[td=2,1,120]示例值[td=2,1,314]描述[td]
[tr] [td=106]total_results[td=91]Number [td=2,1,71]是 [td=2,1,120]200 [td=2,1,314]所有符合条件的商品数量。 [td]
[tr] [td=106]has_next[td=2,1,92]Bool [td=2,1,72]否 [td=2,1,121]true [td=2,1,313]是否存在下一页。
[tr] [td=106]items[td=91]Item[] [td=2,1,71]是 [td=2,1,120] [td=2,1,314]返回商品列表。Item类型要求返回的对象具体参照实体附录。 [td]
[tr] [td=106] [td=91] [td=1] [td=71] [td=1] [td=119] [td=2] [td=312] [td]
返回示例[table]
[tr] [td=712]{ "items_get_response": { "items": { "item": [] }, "total_results": 6 " has_next ": false, }}
2. kingdee.item.quantity.update (修改商品库存)[table]
[tr] [td=97]名称[td=66]类型[td=75]是否必须[td=94]示例值[td=85]默认值[td=283]描述
[tr] [td=97]num_iid[td=66]String [td=75]必须 [td=94]29446852 [td=85] [td=283]商品数字Id。
[tr] [td=97]quantity[td=66]Number [td=75]必须 [td=94]50 [td=85] [td=283]库存修改值。
[tr] [td=97]sku_id[td=66]String [td=75]可选 [td=94]12305 [td=85] [td=283]要操作的sku 的数字ID。如果不填写，默认修改的是商品的库存，填写的话就是修改sku的库存。
[tr] [td=97]type[td=66]Number [td=75]可选 [td=94]2 [td=85]1 [td=283]库存更新方式，可选。1为全量更新，2为增量更新。如果不填，默认为全量更新。
[table]
[tr] [td=91]名称[td=93]类型[td=73]是否必须[td=123]示例值[td=321]描述
[tr] [td=5,1,700]如更新成功没有错误返回
返回示例[table]
[tr] [td=712]{"item_quantity_update_response": { "is_success":true}}
3. kingdee.trades.get (查询卖家已卖出的交易数据)[table]
[tr] [td=99]名称[td=64]类型[td=72]是否必须[td=112]示例值[td=81]默认值[td=275]描述
[tr] [td=99]start_time[td=64]Date [td=72]可选 [td=112]2000-01-01 00:00:00 [td=81] [td=275]查询交易创建时间开始。格式:yyyy-MM-dd HH:mm:ss。默认返回3天数据
[tr] [td=99]end_time[td=64]Date [td=72]可选 [td=112]2000-01-01 00:00:00 [td=81] [td=275]查询交易创建时间结束。格式:yyyy-MM-dd HH:mm:ss。
[tr] [td=99]page_no[td=64]Number [td=72]可选 [td=112]10 [td=81]1 [td=275]页码。取值范围:大于零的整数。默认值为1,即默认返回第一页数据。
[tr] [td=99]page_size[td=64]Number [td=72]可选 [td=112]100 [td=81]100 [td=275]每页条数。取值范围:大于零的整数; 默认值：100。
[tr] [td=99]use_has_next[td=64]Bool [td=72]可选 [td=112]true [td=81]false [td=275]是否启用has_next的分页方式，如果指定true，则返回的结果中不包含总记录数，但是会新增一个是否存在下一页的的字段。
[tr] [td=99]status[td=64]String [td=72]可选 [td=112]TRADE_FINISHED [td=81] [td=275]TRADE_WAIT_BUYER_PAY 没有付款 TRADE_SELLER_SEND_GOODS 已付款 TRADE_WAIT_BUYER_CONFIRM_GOODS 已发货 TRADE_FINISHED 交易完成 TRADE_AUTOMATIC_CLOSED 交易关闭 目前第三方商城接口默认不下载 没有付款 状态的订单，同时在ERP的设置界面中也不提供设置支持。
[tr] [td=99]datatype[td=64]Number [td=72]可选 [td=112]1 [td=81]1 [td=275]1按创建时间，2按修改时间。
[tr] [td=99]tid[td=64]String [td=72]可选 [td=112]13365,4566 [td=81] [td=275]订单号。填写这个参数，其它业务参数不传值
[tr] [td=99]fields[td=64]String [td=72]可选 [td=112]tid,status [td=81] [td=275]返回字段（漏单检查使用，如只需返回tid，不传返回所有字段）
[table]
[tr] [td=106]名称[td=92]类型[td=72]是否必须[td=121]示例值[td=316]描述
[tr] [td=106]total_results[td=92]Number [td=72]否 [td=121]200 [td=316]所有符合条件的订单数量。
[tr] [td=106]has_next[td=92]Bool [td=72]否 [td=121]true [td=316]是否存在下一页。
[tr] [td=106]trades[td=92]Trade[] [td=72]是 [td=121] [td=316]返回商品列表。Trade类型要求返回的对象具体参照实体附录。
返回示例[table]
[tr] [td=712] { "trades_get_response": { "trades": { "trade":[{"tid": "123456", "orders":{ "order":[{"oid":"122" },{"oid": "14566"}]}} }, "has_next":true, "total_results": 100 }}
4. kingdee.logistics.offline.send (线下物流发货)[table]
[tr] [td=101]名称[td=70]类型[td=73]是否必须[td=92]示例值[td=83]默认值[td=277]描述
[tr] [td=101]tid[td=70]String [td=73]必须 [td=92]135468 [td=83] [td=277]交易编号。
[tr] [td=101]out_sid[td=70]String [td=73]必须 [td=92]SF05052 [td=83] [td=277]运单号。具体一个物流公司的真实运单号码。
[tr] [td=101]company_code[td=70]String [td=73]必须 [td=92]ZJS [td=83] [td=277]物流公司代码。如"POST"就代表中国邮政,"ZJS"就代表宅急送。
[tr] [td=101]is_split[td=70]Number [td=73]可选 [td=92]1 [td=83]0 [td=277]表明是否是拆单。1表示拆单 0表示不拆单，默认值0。
[tr] [td=101]sub_tid[td=70]String[] [td=73]可选 [td=92][1,2,3] [td=83] [td=277]需要拆单发货的子订单集合，为空表示不做拆单发货。
[table]
[tr] [td=90]名称[td=92]类型[td=72]是否必须[td=122]示例值[td=319]描述
[tr] [td=5,1,696]没有错误就是发货成功
返回示例[table]
[tr] [td=712]{"logistics_offline_send_response": { "is_success":true }}
5. kingdee.refunds.get (退款单获取)[table]
[tr] [td=101]名称[td=70]类型[td=73]是否必须[td=92]示例值[td=83]默认值[td=277]描述
[tr] [td=101]start_time[td=70]Date [td=73]可选 [td=92]2000-01-01 00:00:00 [td=83] [td=277]查询修改时间开始。格式:yyyy-MM-dd HH:mm:ss。默认返回7天数据
[tr] [td=101]end_time[td=70]Date [td=73]可选 [td=92]2000-01-01 00:00:00 [td=83] [td=277]查询修改时间结束。格式:yyyy-MM-dd HH:mm:ss。
[tr] [td=101]page_no[td=70]Number [td=73]可选 [td=92]10 [td=83]1 [td=277]页码。取值范围:大于零的整数。默认值为1,即默认返回第一页数据。
[tr] [td=101]page_size[td=70]Number [td=73]可选 [td=92]100 [td=83]100 [td=277]每页条数。取值范围:大于零的整数; 默认值：100。
[tr] [td=101]use_has_next[td=70]Bool [td=73]可选 [td=92]true [td=83]false [td=277]是否启用has_next的分页方式，如果指定true，则返回的结果中不包含总记录数，但是会新增一个是否存在下一页的的字段。
[tr] [td=101]refund_id[td=70]String [td=73]可选 [td=92] [td=83] [td=277]退款单号。填写这个参数，其它业务参数不传值
[table]
[tr] [td=106]名称[td=90]类型[td=71]是否必须[td=119]示例值[td=311]描述
[tr] [td=106]total_results[td=90]Number [td=71]否 [td=119]200 [td=311]所有符合条件的商品数量。
[tr] [td=106]has_next[td=90]Bool [td=71]否 [td=119]true [td=311]是否存在下一页。
[tr] [td=106]refunds[td=90]Refund[] [td=71]是 [td=119] [td=311]退款信息列表。Refund类型要求返回的对象具体参照实体附录。
返回示例[table]
[tr] [td=712] { "refunds_get_response": { "refunds": { "refund": [实体【Refund】] }, "total_results": 100 }}
6. kingdee.rp.returngoods.agree (卖家同意退货)第三方需将退款状态更新为待退货，ERP中走等待签收流程到待审核退款。[table]
[tr] [td=116]名称[td=70]类型[td=72]是否必须[td=106]示例值[td=81]默认值[td=250]描述
[tr] [td=116]refund_id[td=70]Number [td=72]必须 [td=106]328818231125 [td=81] [td=250]退款编号
[tr] [td=116]name[td=70]String [td=72]可选 [td=106]张三 [td=81] [td=250]卖家姓名，淘宝退款为必填项。
[tr] [td=116]address[td=70]String [td=72]可选 [td=106]浙江省杭州市西湖区XX路XX号XX小区 [td=81] [td=250]卖家提供的退货地址，淘宝退款为必填项。
[tr] [td=116]post[td=70]String [td=72]可选 [td=106]310000 [td=81] [td=250]卖家提供的退货地址的邮编，淘宝退款为必填项。
[tr] [td=116]tel[td=70]String [td=72]可选 [td=106]5718848388 [td=81] [td=250]卖家座机，淘宝退款为必填项。
[tr] [td=116]mobile[td=70]String [td=72]可选 [td=106]18628219999 [td=81] [td=250]卖家手机，淘宝退款为必填项。
[tr] [td=116]remark[td=70]String [td=72]可选 [td=106]没有问题，同意退货 [td=81] [td=250]卖家退货留言，天猫退款为必填项。
[tr] [td=116]refund_phase[td=70]String [td=72]可选 [td=106]onsale [td=81] [td=250]售中：onsale，售后：aftersale，天猫退款为必填项。
[tr] [td=116]refund_version[td=70]Number [td=72]可选 [td=106]1409231007325 [td=81] [td=250]退款版本号，天猫退款为必填项。
[tr] [td=116]seller_address_id[td=70]Number [td=72]可选 [td=106]123456 [td=81] [td=250]卖家收货地址编号，天猫退款为必填项。
[table]
[tr] [td=90]名称[td=92]类型[td=72]是否必须[td=122]示例值[td=319]描述
[tr] [td=5,1,696]没有错误就是同意退货成功
返回示例[table]
[tr] [td=712]{"rp_returngoods_agree_response": { "is_success":true }}
7. kingdee.rp.refunds.agree (卖家同意退款)第三方需将退款状态更新为退款成功，订单状态更新为交易关闭，如果已对接有支付接口，则需要自己调用支付接口将退款原路退回。[table]
[tr] [td=115]名称[td=70]类型[td=72]是否必须[td=106]示例值[td=82]默认值[td=269]描述
[tr] [td=115]refund_infos[td=70]String [td=72]必须 [td=106]43234234|20000|1409294148714,3123123|12000|1409294148715 [td=82] [td=269] 退款信息，格式：refund_id|amount|version，其中refund_id为退款编号，amount为退款金额（以分为单位），version为退款最后更新时间（时间戳格式），多个退款以半角逗号分隔。
[table]
[tr] [td=102]名称[td=143]类型[td=67]是否必须[td=111]示例值[td=289]描述
[tr] [td=102]succ[td=143]Boolean [td=67]是 [td=111]true [td=289]操作成功
[tr] [td=102]message[td=143]String [td=67]是 [td=111]信息 [td=289]信息
[tr] [td=102]results[td=143]RefundMappingResult[] [td=67]是 [td=111] [td=289]退款操作结果列表
[tr] [td=102]msg_code[td=143]String [td=67]是 [td=111]OP_SUCC [td=289]批量退款操作情况，可选值：OP_SUCC（全部成功），SOME_OP_SUCC（部分 成功），OP_FAILURE_UE（全部失败）