金蝶订单100部API说明R2.1.docxVIP

订单100外部API说明产品版本金蝶订单100 V1.0系统名称订单100模块名称修订记录Ver. No日期编制/修订审核批准修改的章节号R1.02014-9-9曾晓东张建东、徐英R2.02014-9-17曾晓东张建东、徐英新增退款单接口，修正实体是否必须描述，实体Order新增一个字段oid，新增实体Refund。R2.12015-1-19张建东徐英更新了签名说明及个别实体字段名称与对应关系文档说明本文档的使用对象是第三方开发接入平台。第一部分系统参数的蓝色表格是要求每个API都要传入的参数，绿色表格是要求出现错误时返回的参数；第二部分是要求第三方实现的API列表，其中蓝色表格表示输入参数格式，绿色表格表示输出参数格式；第三部分是API要求返回的数据对应的实体。系统参数名称类型是否必须描述methodString是API名称。app_keyString是商城分配给应用的AppKey。sessionString是商城分配给用户的SessionKey。vString是API协议版本。可选值:1.0timestampString是时间戳，格式为yyyy-MM-dd HH:mm:ss，例如：2008-01-25 20:23:30。检查发起请求时间与服务器时间相差多大，判断是否回放请求signString是API输入参数签名结果。参考签名。sign_methodString是参数的加密方法选择。可选值:md5formatString否可选。指定参数格式。默认是json，支持格式为xml和json。名称类型是否必须描述sub_codeString否错误码。sub_msgString 否错误描述。错误返回{error_response:{sub_code:3,sub_msg:错误描述}}签名sign调用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 (下载商品)名称类型是否必须示例值默认值描述start_timeDate可选2000-01-0100:00:00开始时间，格式:yyyy-MM-dd HH:mm:ss。end_timeDate可选2000-12-0100:00:00结束时间，格式:yyyy-MM-dd HH:mm:ss。page_noNumber可选11页码。取值范围:大于零的整数。默认值为1,即默认返回第一页数据。page_sizeNumber可选100100每页条数。取值范围:大于零的整数; 默认值：100。statusNumber可选onsaleonsale表示上架，instock表示下架。不填写将返回包括上架和下架的所有商品。num_iidString可品数字Id。 填写这个参数，其它业务参数不传值名称类型是否必须示例值描述total_resultsNumber是200所有符合条件的商品数量。itemsItem[]是返回商品列表。Item类型要求返回的对象具体参照实体附录。{ items_get_response: { items: { item: [] }, total_results: 6 }}2. kingdee.item.quantity.update (修改商品库存) 名称类型是否必须示例值默认值描述num_iidNumber必品数字Id。quantityNumber必须50库存修改值。sku_idNumber可选12305要操作的sku 的数字ID。如果不填写，默认修改的是商品的库存，填写的话就是修改sku的库存。typeNumber可选21库存更新方式，可选。1为全量更新，2为增量更新。如果不填，默认为全量更新。名称类型是否必须示例值描述如更新成功没有错误返回{item_quantity_update_response: { is_success:true}}3. kingdee.trades.get (查询卖家已卖出的交易数据)名称类型是否必须示例值默认值描述start_timeDate可选2000-01-0100:00:00查询交易创建时间开始。格式:yyyy-MM-dd HH:mm:ss。默认返回3天数据end_timeDate可选2