logo资料库

京东 开放平台 api.doc

第1页 / 共26页
第2页 / 共26页
第3页 / 共26页
第4页 / 共26页
第5页 / 共26页
第6页 / 共26页
第7页 / 共26页
第8页 / 共26页
资料共26页,剩余部分请下载后查看
1使用说明
1.1在线文档
1.2接入说明
1.3技术说明
2订单API
2.1获取订单信息列表API
输入参数
查询的订单的状态
可选字段
输出参数
数据类型
API返回结果(ApiResult)
订单查询返回结果(ApiOrderQueryDetail)
订单信息(Order)
订单中商品(Ware)
订单中收货人信息(Consignee)
2.2获取单个订单信息API
输入参数
输出参数
2.3商家出库操作API
输入参数
输出参数
数据类型
出库信息(OrderOutData)(请注意不同类型商家可以输入的值)
2.4面单打印API(发货到京东)
输入参数
输出参数
数据类型
打印结果(PrintResult)
京东面单示例
2.5SOP发货操作API
输入参数
输出参数
数据类型
SOP发货信息(SopDeliveryData)
3商品API
3.1SKU信息查询API
输入参数
输出参数
数据类型
SKU信息(SkuInfo)
3.2SKU信息修改API
输入参数
输出参数
3.3通过条件查询商品ID列表 API(初版)
输入参数
输出参数
3.4通过商品ID查询商品信息API(初版)
输入参数
输出参数
数据类型
商品信息(WareInfo)
3.5商品上下架API
输入参数
输出参数
4库存API
4.1更新SKU库存API
输入参数
输出参数
数据类型
库存更新信息(SkuStockUpdata)
5售后API
5.1退货收货查询API
输入参数
查询字段(queryFields中Field类型的name)
输出参数
数据类型
字段键值对(Field)
退货单信息(ReturnInfo)
退货物品信息(ReturnItem)
5.2退货收货确认API
输入参数
输出参数
6其他API
6.1获取商家发货地址API
输入参数
输出参数
数据类型
AddressInfo类型
6.2获取商家物流公司API
输入参数
输出参数
数据类型
LogisticsCompany类型
7商家合作类型说明
8签名说明
签名用参数
加密算法
POPOpenAPI 京东商城 Open API (WebService 版) 1 使用说明...................................................................................................................................................................1 1.1 在线文档...........................................................................................................................................................1 1.2 接入说明...........................................................................................................................................................1 1.3 技术说明...........................................................................................................................................................1 2 订单 API................................................................................................................................................................... 2 2.1 获取订单信息列表 API.................................................................................................................................. 2 2.2 获取单个订单信息 API.................................................................................................................................. 6 2.3 商家出库操作 API...........................................................................................................................................7 2.4 面单打印 API(发货到京东)......................................................................................................................9 2.5 SOP 发货操作 API....................................................................................................................................... 13 3 商品 API.................................................................................................................................................................14 3.1 3.2 SKU 信息查询 API....................................................................................................................................... 14 SKU 信息修改 API....................................................................................................................................... 15 3.3 通过条件查询商品 ID 列表 API(初版)................................................................................................16 3.4 通过商品 ID 查询商品信息 API(初版)................................................................................................17 3.5 商品上下架 API............................................................................................................................................ 18 4 库存 API.................................................................................................................................................................19 4.1 更新 SKU 库存 API...................................................................................................................................... 19 5 售后 API.................................................................................................................................................................20 5.1 退货收货查询 API........................................................................................................................................ 20 5.2 退货收货确认 API........................................................................................................................................ 22 6 其他 API.................................................................................................................................................................23 6.1 获取商家发货地址 API................................................................................................................................23 6.2 获取商家物流公司 API................................................................................................................................24 7 商家合作类型说明............................................................................................................................................... 25 8 签名说明................................................................................................................................................................ 25
京东 POP Open API POPOpenAPI (WebService版)2011-05-20 1 使用说明 1.1 在线文档 主页:http://gw.shop.360buy.com/ 正式版:http://gw.shop.360buy.com/doc/doc.html 测试版:http://220.231.59.70/doc/doc.html 文档会进行定期更新,请以最新在线文档为准! 正式版文档里面包含正式发布的 API; 测试版文档一般要比正式版更新,里面包含了还没发布的新 API 或者更新。 1.2 接入说明 使用 API 需要提供商家编号(venderId) ,商家密钥(venderKey、secretcode),如何使 用,请参考签名说明。 测试时,向 API 产品经理提供商家基本信息(尤其是合作类型),API 产品经理会根据情况 给予测试环境的商家编号和密钥。商家的开发人员可以在测试环境的地址使用测试账号信息进行 测试。 正式对接时,商家编号可以在京东商家后台(http://shop.360buy.com/)中看到(首页“用 户 ID:10XXX”或者 我的店铺“商家编号:10XXX”,注意不是“店铺 ID”);正式环境的商 家密钥,在向 API 产品经理确认测试完成并且给予基本信息、IP 后,由 API 产品经理开通并将 密钥以邮件附件的形式发送给商家的京东负责人。 1.3 技术说明 京东开放平台 API,目前以 SOAP WebService 的方式提供。 目前主流语言平台,比如:.Net、Java、PHP、vb6、C/C++等,都可以接入。 由于要使用 IP 本 API 文档由 杨宇帆 整理 1
POPOpenAPI 2 订单 API 2.1 获取订单信息列表 API 功能说明: 根据检索条件,进行订单的查询,获取订单列表(支持分页)。 适用商家: 所有类型商家 注意事项: 开始时间和结束时间不得超过 1 个月!此查询类接口不能过于频繁的调用! 字段列表,如果为空,则返回默认字段;不为空,返回选择的字段,订单 ID 不选也会返回 查询的时候,时间是下单的时间,考虑到等待付款的问题,请把开始时间调整到当前时间 24个小时以上(一般26-48个小时应该没问题),就不会漏单了。请不要把间隔调太大, 否则很容易查询超时! 方法名: searchOrderInfo 正式 WSDL: http://gw.shop.360buy.com/services/services/orderSearchService?wsdl 测试 WSDL: http://220.231.59.70/services/services/orderSearchService?wsdl  输入参数 名称 venderSign tradeNo venderId startDate 类型 必填 描述 long √ string √ string √ string endDate orderState optionalFields page pageSize string string √ string string string  查询的订单的状态 状态码 ALL WAIT_BUYER_PAY WAIT_SELLER_STOCK_OUT TO_JD_DISTRIBUTION_CENTER 发往京东配送中心 2 商家签名,详见签名说明 流水号,用于生产变化的签名,详见签名说明 商家 ID,商家唯一标识,例如:10111,详见签名说明 用于查询时间段的开始时间(目前推荐为当前时间 26 个小时之前) (时间格式 yyyy-MM-dd hh:mm:ss,下同) 用于查询时间段的结束时间(相差不能超过一个月) 用于基于订单状态的查询(商家只需要录入等待出库的订单) 字段列表,选择需要哪些内容返回 查询的页数(不限页数)(默认是第一页) 每页的条数(一次最多 20 条,默认 10 条) 名称 备注 全部 等待付款 等待出库 正式环境不要查询全部订单 SOP 商家专用(最多 24 小时) 对于商家而言是新订单, 需要对这些订单进行“出库”操作 (LBP、SOPL 操作结束) LBP、SOPL 商家专用
POPOpenAPI JD_DISTRIBUTION_CENTER_RECEIVED 京东配送中心已收货 LBP、SOPL 商家专用 WAIT_SELLER_DELIVERY 等待发货 WAIT_BUYER_CONFIRM_GOODS 已发货 TRADE_FINISHED TRADE_CLOSED TRADE_BUYER_REFUSED  可选字段 买家已收货 已取消 拒收 SOP 商家需要对这个状态的订单 进行“发货”操作(SOP 操作结束) 等待买家确认(SOP 订单会在 一定时间后自动妥投) 妥投的订单 此项将删除,使用新 API 代替 LBP 商家专用 选择需要的字段,并且用逗号分开,比如:payType,totalDiscountFee,payment,skuOutId 商家承担的优惠+京东券礼券+用户余额 在结单之前,此项为空 京东不收取运费,目前两者相等 返回的是中文状态 对于非 SOP 商家,京东开发票,意义不大 字段名称 对于货到付款和自提,都是后款 京东目前免运费,所以此项为 0 备注 不用选择,必然返回 名称 orderId 订单编号 商家编号 venderId 支付方式 payType 订单运费 freightPrice 实际运费 factFreightPrice 优惠总金额 totalDiscountFee 用户实付金额 用户付款之前为 0 payment 商家订单备注 卖家自己在订单上的备注,买家看不见 sellerOrderRemark 结单时间 orderEndTime deliveryDateRemark 送货日期 wareTotalPrice orderTotalPrice orderState invoiceInfo buyerOrderRemark orderStartTime wareId skuOutId wareOutId skuId productNo giftPoint wareName jdPrice wareDiscountFee 商品总金额 订单总金额 订单状态 发票信息 买家订单备注 下单时间 商品 id SKU 外部 id 商品外部 id 预留字段,目前为空,请不要选择 SKU 京东 id 商品货号 赠送积分 商品名称规格 SKU 京东价 单件的京东价,不包括数量和优惠 优惠金额 商家承担的优惠,已经包括数量 在赠送积分促销是会有 3
wareTotal consigneeInfo 商品数量 用户信息 每个 wareInfo 的数量,不是 wareInfo 总数 包括了姓名、地址等信息 POPOpenAPI  输出参数  数据类型 名称 类型 必须 描述 apiOrderQueryDetail ApiOrderQueryDetail 是  API 返回结果(ApiResult) 名称 isSuccess* englishErrCode chineseErrCode numberCode 类型 boolean √ String String int √ 非空 描述 是否成功(成功返回 true,失败返回 false) 英文错误原因,如果成功,此字段为空 中文错误原因,如果成功,此字段为空 错误号码 *由于我们使用的 Java 服务框架会自动将 isSuccess 解析为 success,所以非 Java 用户,此项为 success!  订单查询返回结果(ApiOrderQueryDetail) 名称 orders apiResult orderTotal  订单信息(Order) 类型 描述 List 所有订单数据 ApiResult int 隐私 示例值 否 返回的处理信息 否 查询订单的数量 否 名称 orderId venderId wareInfos payType freightPrice factfreightPrice deliveryDateRemark wareTotalPrice orderTotalPrice totalDiscountFee payment consigneeInfo orderState 类型 默认 √ string string √ List √ string string string string string string string string Consignee string √ √ √ √ √ √ √ 描述 pop 的订单编号 商家唯一标识 参见“商品信息类型 Ware” 支付方式:货到付款/上门自提/在线支付等 运费金额 实际的运费,订单完成之前为 0 送货日期:只工作日/工作日等类型 商品总金额(各个商品的京东价累计和,不包括优惠) 订单总金额(商家后台的订单金额,不包括优惠) 优惠的总金额(包括京东券和余额) 用户实际支付金额,支付前为 0 参见“收货人基本信息类型” 订单的状态,返回的是中文状态 4
POPOpenAPI invoiceInfo buyerOrderRemark sellerOrderRemark orderStartTime orderEndTime string string string string string √ √ √ 发票信息,比如: 发票类型:普通发票;发票抬头:个人;发票内容:明细 买家下单时的备注 商家自己的订单备注(买家看不到) 订单创建时间 订单结束时间(妥投或者取消),之前为空  订单中商品(Ware) 名称 wareId wareOutId productNo wareName skuOutId skuId jdPrice wareDiscountFee giftPoint wareTotal 类型 默认 string √ string string string string √ string √ string √ string √ string string √ 描述 商品的京东 id 对应商家的商品 id 商品的货号 商品的名称和规格(比如:XXX 红 M) 对应商家的 SKU 的 id 京东内部 SKU id SKU 的京东价(没有乘以数量),不包括优惠 此 SKU 的优惠金额(目前只包含单品促销)(已经乘以数量) 赠送积分,购买此商品赠送的积分 商品的数量  订单中收货人信息(Consignee) 名称 userName userAddress userPost userTelephone userMobilephone userEmail 描述 类型 string 姓名 string 地址 string 邮编(一直为空) string 固定电话 string 手机 string Email 5
POPOpenAPI 2.2 获取单个订单信息 API 功能说明: 根据京东订单 ID 获取单笔交易订单的详细信息。 适用商家: 所有类型商家 注意事项: 此 API 必须通过批量查询 API 获取京东订单 ID 后才能使用 方法名: searchOrderInfoByOrderId 正式 WSDL: http://gw.shop.360buy.com/services/services/orderSearchService?wsdl http://220.231.59.70/services/services/orderSearchService?wsdl 名称 venderSign tradeNo venderId orderId optionalFields 类型 必须 string 是 string 是 long 是 string 否 string 否 描述 签名 流水号 商家 id 订单 id 字段列表,选择需要哪些内容返回 测试 WSDL:  输入参数  输出参数 名称 类型 必须 描述 apiOrderQueryDetail ApiOrderQueryDetail 是 订单列表,但本 API 只返回单个 6
POPOpenAPI 2.3 商家出库操作 API 功能说明: 通知京东订单已经出库,京东会按照订单信息,自动减去相应库存。 LBP 和 SOPL,由于发往京东配送中心,还需输入一些额外信息。 适用商家: 非 FBP(LBP、SOPL、SOP) 注意事项: 一次只能出库一个订单。各个类型商家输入的参数有所不同。 LBP、SOPL 商家必须设置默认发货地址! 方法名: outStorage http://gw.shop.360buy.com/services/services/orderSearchService?wsdl http://220.231.59.70/services/services/orderOutStorageService?wsdl 名称 类型 venderSign tradeNo venderId orderOutData OrderOutData string string long 必须 √ 签名 √ 流水号 √ 商家的 id √ 描述 LBP 出库数据最大长度为 20 名称 类型 非空 描述 apiResult ApiResult √ 请求是否正确接收 正式 WSDL: 测试 WSDL:  输入参数  输出参数  数据类型  出库信息(OrderOutData)(请注意不同类型商家可以输入的值) 类型 LBP long 必填 名称 orderId packageNum int int sendType addressId long 空 1-100 1 SOP 描述 SOPL 必填 必填 京东订单 ID(SOP 只需填写此项) 1-100 空 包裹数 1 可选 空 发货地址 ID(可通过获取商家发货地址接口获得) 空 发货类型(1 发往配送中心;2 通知京东取货) 0 表示默认发货地址(在后台设置) logisticsId int 可选 空 空 物流公司 ID(可通过获取商家物流公司接口获得) waybill string 见说明* 空 空 这次发往配送中心的运单号(20 个字符) “自送”时,必须为空,否则不能为空 0 为“自送”,SOP 不用 7
分享到:
收藏