京东工采通(IOP):通过API等通用接口将京东工业品的商品、物流、金融在内的供应链各环节打包成通用接口,为自身具备研发能力或已有采购电商平台的企业提供内部采购延伸多场景的接入型解决方案。
白话解释:京东工业品将供应链能力进行模块化的封装打包,以商品、库存、价格、订单等接口方式与客户的电子商城功能模块进行联动,赋予客户实现数字化采购的能力。
IOP关系示意图
名词解释:Application Programming Interface是应用程序开发员为可以快速在操作系统中获取资源,并加以利用开发,所按照操作系统标准进行交互的一系列标准化程序语言(函数)。
同类接口:EDI(电子数据交换),cXML,OCI
白话解释:甲乙双方约定使用某一种基于java的系统语言进行沟通,这种沟通方式叫做API
名词解释:ISV英文全称是Independent Software Vendors ,意为“独立软件开发商”,特指专门从事软件的开发、生产、销售和服务的企业,如微软(Microsoft)、甲骨文(Oracle)等。
白话解释:ISV就是客户侧的软件开发商,对应京东的售前技术顾问ISC
出,入参是一种调取IOP接口的方法,简单理解就是通过特定的暗号互通信息(这个系统语法就是API)。入参=请求参数,即给出一个特定的请求问题,举个例子:
| 参数名称 | 类型 | 是否必填 | 描述 | 解释 |
|---|---|---|---|---|
| token | string | 是 | 授权时获取的access token | 密码,用于验明正身 |
| id | string | 是 | 一级地址ID | 问题:这个一级地址下的二级地址是啥 |
而出参=响应参数,即根据问题返回对应的接口信息
| 参数名称 | 类型 | 是否必填 | 描述 | 解释 |
|---|---|---|---|---|
| success | boolean | 是 |
状态码 true;false |
入参有没有问题 |
| resultMessage | string | 是 | 异常信息提示,(成功时是"") | 入参问题描述 |
| resultCode | string | 是 | 异常代码KEY(0000 :正常;) | 入参问题代码 |
| resultJson | string | 是 | 返回二级地址数据 | 答案二级地址 |
👉👉 IOP标准对接方案 👉👉
包括10个模块:授权、地址、商品、价格、库存、订单、支付、售后(售后1.0&售后2.0)、发票和信息推送。涵盖68个接口(含售后1.0)/66个接口(含售后2.0),其中 必须对接33个(含售后1.0)/32个(含售后2.0), 选择对接35个(含售后1.0)/34个(含售后2.0)。
📢标红色的接口为必接接口。
| 模块类型 | 序号 | 接口 | 是否必接 | 未对接影响 | 依赖项目组的内容 |
|---|---|---|---|---|---|
| 授权 | 1 | 获取AccessToken | 是 |
无法对接其余所有接口 注意事项:获取授权后,有效期24小时,超期后需要重新获取。 |
1、项目组完成主数据申请后,需要尽快创建PIN和申请clientid,以便配合客户侧进行IOP对接和联调。 2、信息准备流程:项目组创建PIN和密码——>项目组向JDKA发起IOP对接申请——>JDKA提供client_id、client_secret和接口最新文档给客户,项目组提供PIN和密码给客户。 |
| 2 | 更新Access token |
增大获取AccessToken的请求量,增大系统压力 |
|||
| 地址 | 1 | 查询一级地址 | 是 |
无法获取一级地址列表,导致二、三、四级地址也无法获取,京东的四级地址在查询商品库存、限售、下单时均需要用到,不对接此接口会导致下单失败 |
|
| 2 | 查询二级地址 | 是 |
无法获取二级地址列表,导致三、四级地址也无法获取,京东的四级地址在查询商品库存、限售、下单时均需要用到,不对接此接口会导致下单失败 |
||
| 3 | 查询三级地址 | 是 |
无法获取三级地址列表,导致四级地址也无法获取,京东的四级地址在查询商品库存、限售、下单时均需要用到,不对接此接口会导致下单失败 |
||
| 4 | 查询四级地址 | 是 |
无法获取四级地址列表,京东的四级地址在查询商品库存、限售、下单时均需要用到,不对接此接口会导致下单失败 |
||
| 5 | 验证地址有效性 | 是 |
京东的四级地址在查询商品库存、限售、下单时均需要用到,若四级地址无效会导致下单失败 |
||
| 6 | 地址详情转换京东地址编码 | 否 |
该接口的使用场景是:当无法逐级获取地址信息时,可根据地址详情调用该接口获取对应的京东地址,但是该方案无法保证所有地址都匹配上京东地址,也无法保证所有匹配的京东地址都正确,当该未接入该接口时,可能会由于地址获取失败导致后续校验库存,可售,下单等环节出现异常 |
||
| 商品 | 1 | 查询商品池编号 | 是 | 增加新的商品池时无法获取商品池中全量商品 | |
| 2 | 查询池内商品编号 | 是 | 增加新的商品池时无法获取商品池中全量商品 | ||
| 3 | 查询商品详情 | 是 | 无法展示商品信息 | ||
| 4 | 查询商品图片 | 是 | 无法展示商品图片 | ||
| 5 | 查询商品上下架状态 | 是 |
下架商品查不到价格等商品信息,下架商品会导致下单失败,需要过滤掉 |
||
| 6 | 验证商品可售性 | 否 |
因为业务逻辑较多,限制销售的因素比较多,除了库存原因和区域限制配送,验证商品可售性api还会校验其它因素,如商品在主站下架,不在商品池,合同限制,商品是黑名单,主站做预约抢购活动等等,如果不对接该api,可能会由于某些限售因素导致商品可见不可采,影响用户体验 |
||
| 7 | 查询商品区域购买限制 | 是 |
导致下单失败,商详页、结算页、下单前需要校验商品是否区域购买限制 |
||
| 8 | 查询赠品信息 | 否 |
无法通过主商品获取赠品sku,导致下单成功,无赠品 |
依赖主数据勾选“赠品” | |
| 9 | 查询延保信息 | 否 |
无法获取主商品下诸如延保等服务类的商品信息,导致无法购买延保等服务类的商品,会影响用户体验,也会导致GMV的减少 |
||
| 10 | 验证货到付款 | 否 |
无法获取商品是否支持货到付款的信息,可能导致支付方式减少,因此导致GMV的降低(可能客户就想用货到付款支付方式) |
依赖主数据勾选“货到付款” | |
| 11 | 批量验证货到付款 | 否 |
无法批量获取商品是否支持货到付款的信息,可能导致支付方式减少,因此导致GMV的降低(可能客户就想用货到付款支付方式) |
||
| 12 | 搜索商品 | 否 |
无法按特定条件去搜索满足条件的商品,例如按照价格区间,品牌,类目等搜索,导致无法快速定位商品 |
||
| 13 | 查询同类商品 | 否 | 该接口可查询同一商品下的不同sku,若未接入该接口,在无法查询对应的skuId(建议接入) | ||
| 14 | 查询分类信息 | 否 |
该接口可根据商品所在的分类编号,获取商品对应的分类信息,若未接入该接口,则无法获取相关信息 |
||
| 15 | 商品可采校验 | 是 |
导致下单失败,下单前实时调用此接口进行下单前的校验 |
||
| 16 | 第三方关联数据查询 | 否 | 如客户通过开阳进行映射(商品映射、类目映射等),必须对接此接口,否则无法获取映射关系;如客户自行映射,则不需要对接此接口 | ||
| 价格 | 1 | 查询商品的售卖价格 | 是 |
需在下单前,在商品详情页实时调取最新的商品价格,如果不接入,可能导致生成订单后的价格和商品详情的价格不一致,导致下单失败,影响用户体验,减少GMV |
具体取值依赖于客户主数据勾选的价格类型 |
| 库存 | 1 | 查询商品库存 | 是 |
在下单前,需通过该接口实时校验商品库存,若不对接该api会导致商品可见不可采(提交订单时商品库存不足,提交订单失败) |
|
| 订单 | 1 | 查询运费 | 是 |
导致下单后金额和提交时金额不一致,影响客户体验。 |
|
| 2 | 查询预约日历 | 否 |
该接口可查询准备购买商品的可选收货时间(预约上门派送),若未接入该接口,则无法使用该服务 |
||
| 3 | 提交订单 | 是 | 无法下单,交易主要核心接口 | ||
| 4 | 反查订单 | 否 |
如果因为超时等原因,调用“提交订单接口”未收到订单号,重新下单之前,需先调用“反查订单接口”检验订单是否生成,若未接入该接口,可能导致订单重复提交 |
||
| 5 | 确认预占库存订单 | 是 | 订单无法流转 | ||
| 6 | 取消未确认订单 | 否 | 订单未支付时,可调用该接口取消订单,若未接入该接口,则无法发起取消订单 | ||
| 7 | 查询订单详情 | 是 | 影响客户体验,导致订单信息不清晰 | ||
| 8 | 查询配送信息 | 否 | 该接口可查询订单的配送信息,若未接入,则无法查询相关的配送信息 | ||
| 9 | 确认收货 | 是 | 导致三方物流配送的订单状态客户侧与京东存在差异 | ||
| 10 | 批量确认收货 | 否 | 无法批量操作确认收货 | ||
| 11 | 更新采购单号 | 否 | 无法更新采购单号(采购单号可能用于配送单,发票等票面展示) | ||
| 12 | 更新订单扩展字段 | 否 | 无法更新订单扩展字段 | ||
| 13 | 查询新建订单列表 | 否 | 无法查询新建订单列表,则无法核对相关的订单状态 | ||
| 14 | 查询妥投订单列表 | 否 | 无法查询妥投订单列表,无法核对订单妥投的状态 | ||
| 15 | 查询拒收订单列表 | 否 | 无法查询拒收订单列表,则无法核对订单拒收状态 | ||
| 16 | 查询完成订单列表 | 否 | 无 | ||
| 17 | 查询配送预计送达时间 | 否 | 无法查询订单的预计配送达时间,降低用户体验 | ||
| 支付 | 1 | 查询余额 | 是 | 余额不足时会下单失败,及时联系运营提票 | |
| 2 | 查询余额变动明细 | 否 | 无法获取余额(预存款)的变动明细,即无法核对支付状态,退款状态等 | ||
| 3 | 发起支付 | 是 | 针对下单成功但支付失败的订单,无法再次发起支付 | ||
| 售后1.0 | 1 | 查询可售后商品 | 是 | 针对下单成功但支付失败的订单,无法再次发起支付 | |
| 2 | 查询商品售后类型 | 是 | 查询支持申请售后的商品,若不对接该接口,当选择了不支持售后的商品进行售后申请时,会导致售后失败 | ||
| 3 | 查询商品逆向配送 | 否 | 查询商品可支持的售后类型,若不对接该接口,当选择了不支持的售后类型时,会导致申请售后失败 | ||
| 4 | 申请售后 | 是 | |||
| 5 | 填写发运信息 | 否 | 无法进行线上售后,增加了运营工作量 | ||
| 6 | 查询服务单概要 | 是 | 申请售后需要退换货时,如果需要使用第三方物流将商品寄回,则需调用该接口,若不对接该接口可能会导致售后失败 | ||
| 7 | 查询服务单明细 | 否 | 通过该接口可查询订单,申请单,商品维度的售后概要,若不对接该接口,则无发获取相关信息 | ||
| 8 | 取消服务单 | 否 | 该接口可查询申请单维度的售后明细信息,包括用户发货,退款明细,售后地址,操作信息等,若不对接该接口,则无法获取相关信息 | ||
| 9 | 查询退款明细 | 是 | 该接口可取消已经申请的售后服务单,若不对接该接口,则无法取消售后服务单 | ||
| 10 | 确认服务单 | 是 | 无法查询售后成功的内容 | ||
| 11 | 查询服务单列表 | 否 | 导致售后单完成有延迟 | ||
| 售后2.0 | 1 | 查询商品售后属性 | 是 | 该接口可获取订单中商品的可售后数量,获取商品支持的售后类型,获取商品支持的返回京东的配送方式,若不接入该接口,则会导致无法获取相关信息,导致后续售后失败 | |
| 2 | 申请售后 | 是 | 无法进行线上售后,增加了运营工作量 | ||
| 3 | 查询售后概要 | 是 | 无法掌握售后信息 | ||
| 4 | 填写运单信息 | 否 | 申请售后需要退换货时,如果需要使用第三方物流将商品寄回,则需调用该接口,若不对接该接口可能会导致售后失败 | ||
| 5 | 确认售后完成 | 是 | 导致售后单完成有延迟 | ||
| 6 | 取消售后申请 | 否 | 该接口可取消已经申请的售后服务单,若不对接该接口,则无法取消售后服务单 | ||
| 7 | 查询物流信息 | 否 | 该接口可按申请单+订单号维度查询出对应的售后物流信息,若不对接该接口,则无法查询相关的物流信息 | ||
| 8 | 查询售后申请单明细 | 否 | 该接口可查询申请单维度的售后明细信息,包括用户发货,退款明细,售后地址,操作信息等,若不对接该接口,则无法获取相关信息 | ||
| 9 | 查询售后换新单订单号 | 是 | 无法获取售后换新后的新单订单号并造成订单状态不一致 | ||
| 发票 | 1 | 申请开票 | 是 | 无法进行线上开票,降低用户体验,也增加了运营工作量 | |
| 2 | 查询发票第三方申请单号 | 否 | 该接口可查询订单号对应的第三方申请单号(申请发票的唯一id标识)信息,若不对接该接口则无法获取相关信息 | ||
| 3 | 查询发票概要 | 是 | 该接口可获取第三方申请单号下的所有发票概要信息,若不对接该接口,则会导致相关信息无法获取 | ||
| 4 | 查询发票明细 | 是 | 该接口可获取纸质发票的详细信息(目前增值税专用发票为纸质发票,增值税普通发票为电子发票)若不对接该接口,则无法获取相关信息 | ||
| 5 | 查询电子发票明细 | 否 | 该接口可获取电子发票的详细信息(目前增值税专用发票为纸质发票,增值税普通发票为电子发票)若不对接该接口,则无法获取相关信息 | ||
| 6 | 查询发票运单号 | 否 | 该接口可获取纸质发票的物流单号,查询纸质发票的邮寄信息,若不接入该接口,则会导致无法获取相关信息 | ||
| 7 | 查询发票物流信息 | 否 | 该接口可查询纸质发票的物流信息,获取纸质发票的配送详情,若不接入该接口,会导致相关信息无法获取 | ||
| 8 | 取消发票申请 | 否 | 该接口可取消已经生成的发票申请,注意:只能用于取消“驳回状态”或是“异常状态”的申请单,如果markid已经在京东系统录入对应的发票申请单,则无法取消,该接口未接入,则无法发起取消发票申请 | ||
| 9 | 按照发票号查询发票物流信息 | 否 | 无法根据发票号获取发票物流信息(对于一个发票对应一个订单或者一个发票对应多个订单的情况,均可查询出来物流信息,物流信息包括物流单号、操作时间、操作备注、操作用户等) | ||
| 信息推送 | 1 | 查询推送信息 | 是 | 商品状态、商品信息、订单状态等内容不同步,导致下单失败 | |
| 2 | 删除推送信息 | 是 | 无法获取到最新的消息 |
IOP标准接口文档(研发版):
http://doc.jd.com/iopv2/iopv2/授权接口模块,包括 “获取授权” 和 “更新授权” 2个接口, 其中1个⭐ 必接接口 ( “获取授权”接口 ),1个选接接口,详细见下文说明:
📢 标红色的接口为必接接口。
| 序号 | 接口 | 是否必接 | 接口作用 |
|---|---|---|---|
| 1 | 获取AccessToken | 是 |
接口对接的口令,客户通过此接口获取京东侧的授权后,才能进行对接。 注意:token有效期是24小时,失效后需要重新获取或通过“刷新授权”接口更新授权信息 |
| 2 | 刷新AccessToken | 否 | 更新授权信息 |
字段说明:
①username:京东用户名(PIN), 由项目组创建完主数据后,创建PIN 。
②password:对应PIN的密码。
③client_id:用来标识对接iop的客户,通常一个主数据只有一个client_id, 由项目创建PIN后,向JDKA发起IOP对接申请 。
④client_secret:与client_id相对应的安全密钥,具有唯一性,与client_id系自动生成,不可人为修改。
地址接口模块,包括: “查询一级地址” 、 “查询二级地址” 、 “查询三级地址” 、 “查询四级地址” 、 “验证地址有效性” “地址详情转换京东地址编码” 和6个接口,其中5个⭐ 必接接口 ,1个为选接接口。
| 序号 | 接口 | 是否必接 | 接口作用 |
|---|---|---|---|
| 1 | 查询一级地址 | 是 |
地址接口,在查询商品库存、限售、下单和售后等场景中,需要调用地址接口获取地址信息。 注意事项: 1、在上述业务场景中,系统需要逐级查询1-4级地址,获取地址信息。 2、下单前调用地址校验接口校验地址准确性。 3、如果三级地址下有四级地址,则四级地址在下单接口和售后接口中必填,否则会下单失败或者申请售后失败。 4、建议调用京东四级地址获取接口将数据存到本地数据库中,并且务必接入type50京东地址变更消息,及时对地址库进行更新。 5、若系统无法逐级获取地址信息,可根据地址详情调用“地址详情转换京东地址编码”接口,解析并转换为京东的地址信息。 |
| 2 | 查询二级地址 | 是 | |
| 3 | 查询三级地址 | 是 | |
| 4 | 查询四级地址 | 是 | |
| 5 | 验证地址有效性 | 是 | |
| 6 | 地址详情转换京东地址编码 | 否 |
商品接口模块,包括: “查询商品池编号” 、 “查询池内商品编号” 、 “查询商品详情” 、 “查询商品图片” 、 “查询商品上下架状态” 、 “验证商品可售性” 、 “查询商品区域购买限制” 、 “查询赠品信息” 、 “查询延保信息” 、 “验证货到付款” 、 “批量验证货到付款” 、 “搜索商品” 、 “查询同类商品” 、 “查询分类信息” 、 “商品可采校验” 和 “第三方关联数据查询” 16个接口,其中7个⭐ 必接接口 ,9个选接接口。
| 序号 | 接口 | 是否必接 | 接口作用 |
|---|---|---|---|
| 1 | 查询商品池编号 | 是 |
通过此接口,获取客户商品池编号 如不对接,项目组为客户创建新的商品池时,客户侧无法获取商品池中全量商品 |
| 2 | 查询池内商品编号 | 是 |
通过此接口,获取客户商品池中的全量商品 如不对接,项目组为客户创建新的商品池时,客户侧无法获取商品池中全量商品 |
| 3 | 查询商品详情 | 是 |
获取商品信息在客户侧平台展示 如不对接,客户侧无法展示商品信息 |
| 4 | 查询商品图片 | 是 |
获取商品图片在客户侧平台展示 如不对接,客户侧无法无法展示商品图片 |
| 5 | 查询商品上下架状态 | 是 |
获取商品的上下架状态 如不对接,下架商品查不到价格等商品信息,下架商品会导致下单失败,需要过滤掉 |
| 6 | 验证商品可售性 | 否 |
校验商品的可售性, |
| 7 | 查询商品区域购买限制 | 是 |
在商详页、结算页、提单时系统会通过此接口,查询商品是否有区域购买限制。 如不对接,导致客户侧下单失败,商详页、结算页、下单前需要校验商品是否区域购买限制 |
| 8 | 查询赠品信息 | 否 |
通过主商品查询是否有赠品 依赖主数据勾选“货到付款” |
| 9 | 查询延保信息 | 否 |
通过主商品查询商品的延保等服务类商品信息 |
| 10 | 验证货到付款 | 否 |
验证商品是否支持货到付款 依赖主数据勾选“货到付款” |
| 11 | 批量验证货到付款 | 否 |
批量验证商品是否支持货到付款 |
| 12 | 搜索商品 | 否 |
通过此接口搜索商品 注意事项:此搜索范围仅限京东范围,因此不建议客户侧对接 |
| 13 | 查询同类商品 | 否 |
通过skuId可以聚合查询被指定为同一类的商品,如同一款式不同颜色的商品。调用“查询同类商品接口。 |
| 14 | 查询分类信息 | 否 |
查询商品对应的分类信息 |
| 15 | 商品可采校验 | 是 |
客户商品详情页面、加入购物车以及下单的时候,校验商品是不是可采购:包括是否在商品池、是否主站上架状态、是否预约预售、是否合同支持购买此商品、是否区域限售。所以整合商品可售验证+商品上下架接口+商品区域销售限制的校验,上述校验全都通过才会告诉客户商品可采购。 如不对接,导致客户侧下单失败,下单前实时调用此接口进行下单前的校验 |
| 16 | 第三方关联数据查询 | 否 |
客户调用此接口,查询第三方关联数据,例如:商品映射方案,包括:类目映射、SKU映射等。 |
👩🏫接口应用示例👩🏫
商详页展示的商品信息,是通过调用多个接口,将获取的信息组装成我们可见的完整的商详页面。
| 序号 | 接口 | 接口作用 |
|---|---|---|
| ① | 商品接口>查询商品图片 | 查询单个商品的主图、轮播图图片, 不包含商品商品详情的图片 |
| ② | 价格接口>查询商品的售卖价格 |
查询商品的售卖价格。查询在客户商品池中的商品价格。 特殊说明: 京东价(京东主站前台红字价)对应出参字段“jdPrice” 采购价对应出参字段“price” 税率,对应出参字段“tax”,当入参有“containstax”时,出参中有此字段,例如:此值为16时,代表税率为“16%”。 |
| ③ | 商品接口>查询赠品信息 |
根据此接口查询主商品附带的赠品。 特殊说明: ①区域项目组需要先在主数据勾选“有赠品”后,客户采购商品时才能看到&购买时附带赠品。 ②购买主商品数量大于赠品要求最多购买数量,不加赠品; ③购买数量小于赠品要求最少购买数量,不加赠品; ④下单时间不在促销时间范围内,不加赠品; |
| ④ | 库存接口>查询商品库存 |
查询商品库存 |
| 商品接口>查询商品区域购买限制 |
查询商品是否有区域购买限制。 |
|
| 商品接口>验证货到付款 |
验证商品是否支持货到付款 |
|
| ⑤ | 商品接口>查询同类商品 |
通过skuId可以聚合查询被指定为同一类的商品,如同一款式不同颜色的商品。调用“查询同类商品接口 |
| ⑥ | 商品接口>验证商品可售性 |
通过接口,获取无理由退货类型 依赖项:主数据>退换货勾选的值 |
📣 上述示例供参考,客户侧具体展示内容已其对接的接口和处理逻辑为准。
价格接口模块,包括: “查询商品的售卖价格” 1个接口,且为⭐ 必接接口 。
| 序号 | 接口 | 是否必接 | 接口作用 |
|---|---|---|---|
| 1 | 查询商品的售卖价格 | 是 |
查询商品的售卖价格 需在下单前,在商品详情页实时调取最新的商品价格,如果不接入,可能导致生成订单后的价格和商品详情的价格不一致,导致下单失败,影响用户体验,减少GMV 具体取值依赖于客户主数据勾选的价格类型 |
库存接口模块,包括:“查询商品库存” 1个接口,且为⭐ 必接接口 。
| 序号 | 接口 | 是否必接 | 接口作用 |
|---|---|---|---|
| 1 | 查询商品库存 | 是 |
查询商品库存 在下单前,需通过该接口实时校验商品库存,如果不接入,会导致商品可见不可采(提交订单时商品库存不足,提交订单失败) |
订单接口模块,包括: “查询运费” 、 “查询预约日历” 、 “提交订单” 、 “反查订单” 、 “确认预占库存” 、 “取消未确认订单” 、 “查询订单详情” 、 “查询配送信息” 、 “确认收货” 、 “批量确认收货” 、 “更新采购单号” 、 “更新订单扩展字段” 、 “查询新建订单列表” 、 “查询妥投订单列表” 、 “查询拒收订单列表” 、 “查询完成订单列表” 和 “查询配送预计送达时间” 17个接口,其中5个⭐ 必接接口,12个选接接口。
| 序号 | 接口 | 是否必接 | 接口作用 |
|---|---|---|---|
| 1 | 查询运费 | 是 |
查询准备提交的订单的运费 如不对接,导致客户侧下单后金额和提交时金额不一致,影响客户体验。 |
| 2 | 查询预约日历 | 否 |
查询准备购买的商品可选收货时间 |
| 3 | 提交订单 | 是 |
提交订单信息,生成京东订单。 如不对接,客户侧无法下单,是交易的核心接口 |
| 4 | 反查订单 | 否 |
订单反查接口,根据第三方订单号反查京东的订单号。 如果因为超时等原因,调用“提交订单接口”未收到订单号,重新下单之前,需先调用“反查订单接口”检验订单是否生成, 若未接入该接口,可能导致订单重复提交 |
| 5 | 取消未确认订单 | 否 |
取消未确认订单 注意事项:只针对未支付订单,如已支付,客户需要取消,需要联系客服申请 |
| 6 | 查询订单详情 | 是 |
查询京东订单明细信息 如不对接,客户侧无法查看订单明细,导致订单信息不清晰,影响客户体验 |
| 7 | 查询配送信息 | 否 |
查询京东订单的配送信息。 该接口可查询订单的配送信息, 若未接入,则无法查询相关的配送信息 |
| 8 | 查询订单详情 | 否 |
通过主商品查询是否有赠品 |
| 9 | 确认收货 | 是 |
此接口 仅适用于厂商直送订单。 厂商直送订单可使用此接口确认收货并将订单置为完成状态。 如不对接,导致三方物流配送的订单状态客户侧与京东存在差异 |
| 10 | 批量确认收货 | 否 |
同上 |
| 11 | 更新采购单号 | 否 |
更新订单上的PO单号,可选择用于配送单、发票等票面展示。 如不对接,无法更新采购单号(采购单号可能用于配送单,发票等票面展示) |
| 12 | 更新订单扩展字段 | 否 |
更新订单扩展字段,对于有订单扩展字段需求的客户,生成订单后调用此接口更新订单或者sku扩展字段 如不对接,无法更新订单扩展字段 |
| 13 | 查询新建订单列表 | 否 |
查询所有新建的订单列表,可用于核对订单。 如不对接,无法查询新建订单列表,则无法核对相关的订单状态 |
| 14 | 查询妥投订单列表 | 否 |
查询所有妥投的订单列表,可用于核对订单。 如不对接,无法查询妥投订单列表,无法核对订单妥投的状态 |
| 15 | 查询拒收订单列表 | 否 |
查询所有拒收的订单列表,可用于核对订单。 如不对接,无法查询拒收订单列表,则无法核对订单拒收状态 |
| 16 | 查询完成订单列表 | 否 |
查询所有完成的订单列表,可用于核对订单。 |
| 17 | 查询配送预计送达时间 | 否 |
查询商品的配送预计送达时间。 如不对接,无法查询订单的预计配送达时间,降低用户体验 |
👩🏫接口应用示例👩🏫
客户提单环节,系统调用多个接口,获取&校验相关信息。
| 序号 | 接口 | 接口作用 |
|---|---|---|
| ① | 订单接口>查询运费 | 查询准备提交的订单的运费 |
| ② | 订单接口>查询预约日历 | 查询准备购买的商品可选收货时间 |
| ③ | 订单接口>提交订单 | 提交订单信息,生成京东订单。 |
📣 上述示例供参考,客户侧具体展示内容已其对接的接口和处理逻辑为准。
支付接口模块,包括: “查询余额” 、 “查询余额变动明细” 和 “发起支付” 3个接口,其中2个⭐ 必接接口 ,1个选接接口。
| 序号 | 接口 | 是否必接 | 接口作用 |
|---|---|---|---|
| 1 | 查询余额 | 是 |
查询金采和预存款的余额。 如不对接,客户侧无法知晓金采和预存款的余额,当余额不足时会导致下单失败 |
| 2 | 查询余额变动明细 | 否 |
仅支持预存款余额明细查询,不支持金采余额明细查询。 如不对接,无法获取余额(预存款)的变动明细 ,即无法核对支付状态,退款状态等 |
| 3 | 发起支付 | 是 |
客户在提单成功但支付失败的情况,可以调用此接口重新支付 如不对接,针对下单成功但支付失败的订单,无法再次发起支付 |
售后定义:京东子订单完成后方可售后,拒收不属于售后。
售后服务类型:退货、换货、维修。
售后粒度:线上线下均是以一个京东子订单中的单个SKU(多数量)为最小颗粒。
线上售后:由采购平台发起售后申请,目前仅支持京东子订单下的,单SKU多数量的售后申请。
线下售后:客户通过400电话进行售后产生售后服务单;另一种是送货的部分拒收产生的售后服务单。
🔍接口释义售后模块分为售后1.0和售后2.0,两者区别主要在于:售后1.0,支持by SKU维度生成服务单,即客户发起售后,系统基于SKU的数量生成多个服务单;售后2.0,支持基于提交批次生成服务单。
售后1.0接口模块,包括: “查询可售后商品”、 “查询售后商品类型”、 “查询商品逆向配送”、 “申请售后”、 “填写发运信息”、 “查询服务单概要”、 “查询服务单明细”、 “取消服务单”、 “查询退款明细”、 “确认服务单”和 “查询服务单列表”11个接口,其中6个⭐ 必接接口 ,5个选接接口。
| 序号 | 接口 | 是否必接 | 接口作用 |
|---|---|---|---|
| 1 | 查询可售后商品 | 是 |
通过此接口,校验某订单中某商品是否可以提交售后服务 如不对接,当客户选择了不支持售后的商品进行售后申请时,会导致售后失败 |
| 2 | 查询商品售后类型 | 是 |
通过此接口,可基于订单号、商品编号查询支持的售后服务类型 如不对接,当客户选择了不支持的售后类型时,会导致申请售后失败 |
| 3 | 查询商品逆向配送 | 否 |
通过此接口,可基于订单号、商品编号查询支持的商品返回京东方式 |
| 4 | 申请售后 | 是 |
通过此接口,客户可发起售后申请(*需要订单已妥投)。 如不对接,客户侧无法进行线上售后,增加了运营工作量 |
| 5 | 填写发运信息 | 否 |
如果商品需要逆向发往京东,当选择第三方配送时,使用此接口填写配送信息。 |
| 6 | 查询服务单概要 | 是 |
通过此接口,可查询订单,申请单,商品维度的售后概要 如不对接,则无发获取相关信息 |
| 7 | 查询服务单明细 | 否 |
通过此接口,可查询申请单维度的售后明细信息。 该接口可查询申请单维度的售后明细信息,包括用户发货,退款明细,售后地址,操作信息等,若不对接该接口,则无法获取相关信息 |
| 8 | 取消服务单 | 否 |
通过此接口,可取消已经生成的服务单。 如不对接,则无法取消售后服务单 |
| 9 | 查询退款明细 | 是 | 通过此接口,可查询售后退款明细。 |
| 10 | 确认服务单 | 是 |
通过此接口,可确认售后服务单。 如不对接,客户侧无法查询售后成功的内容 |
| 11 | 查询服务单列表 | 否 |
通过此接口,可查询订单下服务单汇总列表信息。 如不对接,会导致售后单完成有延迟 |
售后2.0接口模块,包括: “查询商品售后属性”、 “申请售后”、 “查询售后概要”、 “填写运单信息”、 “确认售后完成”、 “取消售后申请”、 “查询物流信息”、 “查询售后申请单明细”和 “查询售后换新单订单号” 9个接口,其中5个⭐ 必接接口 ,4个选接接口。
| 序号 | 接口 | 是否必接 | 接口作用 |
|---|---|---|---|
| 1 | 查询商品售后属性 | 是 |
通过此接口,可批量查询订单下商品可售后数量、支持的售后类型、支持的返回京东的方式。售后服务类型:退、换、修 如不对接,则无法获取相关信息,导致后续客户发起售后失败 |
| 2 | 申请售后 | 是 |
通过此接口,客户可发起售后申请(*需要订单已妥投)。 如不对接,客户侧无法进行线上售后,增加了运营工作量 |
| 3 | 查询售后概要 | 是 |
通过此接口,可查询订单售后情况概要。 如不对接,客户侧无法掌握售后信息 |
| 4 | 填写运单信息 | 否 |
如果商品需要逆向发往京东,当选择第三方配送时,使用此接口填写配送信息。申请售后需要退换货时,如果需要使用第三方物流将商品寄回,则需调用该接口,若不对接该接口 可能会导致售后失败 |
| 5 | 确认售后完成 | 是 |
通过此接口,可批量确认售后完成。如果售后申请单在待确认状态超过15天,则会自动确认。 如不对接,导致售后单完成有延迟 |
| 6 | 取消售后申请 | 否 |
通过此接口,可取消售后申请。按照申请批次取消已发起的售后申请。返回京东方式为客户发货,客服审核完成前可执行取消操作;返回京东方式为上门取件时,配送员取件完成前可以执行取消操作。 该接口可取消已经申请的售后服务单,若不对接该接口,则无法取消售后服务单 |
| 7 | 查询物流信息 | 否 |
通过此接口,可基于申请单+订单号维度查询出所对应的物流信息。 该接口可按申请单+订单号维度查询出对应的售后物流信息,若不对接该接口,则无法查询相关的物流信息 |
| 8 | 查询售后申请单明细 | 否 |
通过此接口,可查询申请单维度售后明细信息,包括客户发货退款明细、售后地址操作信息。该接口可查询申请单维度的售后明细信息,包括用户发货,退款明细,售后地址,操作信息等,若不对接该接口, 则无法获取相关信息 |
| 9 | 查询售后换新单订单号 | 是 |
通过此接口,可查询售后换新订单号。可以在查询到type=116后,然后根据原始订单号查此接口获取新订单号 如不对接,无法获取售后换新后的新单订单号并造成订单状态不一致 |
👩🏫 接口应用示例 👩🏫
发起售后时,系统会通过相关的接口查验商品是否可以售后,以及支持售后的类型和可提交的数量等。
| 序号 | 接口 | 接口作用 |
|---|---|---|
| ① ③ | 售后接口>查询商品售后属性 | 批量查询订单下商品可售后数量、支持的售后类型、支持的返回京东的方式。售后服务类型:退、换、修 |
| ② ④ | 售后接口>申请售后接口 | 批量发起售后 |
📣 上述示例供参考,客户侧具体展示内容已其对接的接口和处理逻辑为准。
发票接口属于IOP必接接口之一,对接了发票以后,客户可以在线上申请开票,并且自主查询发票信息,以提高结算的效率和准确度,包括: “申请开票”、 “查询发票第三方申请单号”、 “查询发票概要”、 “查询发票明细”、 “查询电子发票明细”、 “查询发票运单号”、 “查询发票物流信息”、 “取消发票申请”和 “按照发票号查询发票物流信息” 9个接口,其中3个⭐必接接口,6个选接接口。
| 序号 | 接口 | 是否必接 | 接口作用 |
|---|---|---|---|
| 1 | 申请开票 | 是 |
通过此接口,客户可发起线上开票申请 如不对接,无法进行线上开票,降低用户体验,也增加了运营工作量 |
| 2 | 查询发票第三方申请单号 | 否 |
通过此接口,可基于订单号查询对应的第三方申请单号(申请发票的唯一id标识)。 如不对接,则无法获取相关信息 |
| 3 | 查询发票概要 | 是 |
通过此接口,可查询第三方申请单号下的发票概要信息,如:发品号码、发票代码等。 如不对接,则会导致相关信息无法获取 |
| 4 | 查询发票明细 | 是 |
通过此接口,可查询纸质发票明细信息,如:发票抬头、纳税人识别号等。 如不对接,则会导致相关信息无法获取 |
| 5 | 查询电子发票明细 | 否 |
通过此接口,可查询电子发票明细信息,如:发票抬头、纳税人识别号等。 如不对接,则无法获取相关信息 |
| 6 | 查询发票运单号 | 否 |
针对纸质发票如果需要邮寄,可使用此接口查询配送单号。 如不对接,则会导致无法获取相关信息 |
| 7 | 查询发票物流信息 | 否 |
通过此接口,可查询发票的物流信息 如不对接,则会导致无法获取相关信息 |
| 8 | 取消发票申请 | 否 |
通过此接口,可取消开票申请。 该接口可取消已经生成的发票申请,注意:只能用于取消“驳回状态”或是“异常状态”的申请单,如果markid已经在京东系统录入对应的发票申请单,则无法取消,如不对接, 则无法发起取消发票申请 |
| 9 | 按照发票号查询发票物流信息 | 否 |
通过此接口,可根据发票号查询发票的物流信息 如不对接, 则无法根据发票号获取发票物流信息 (对于一个发票对应一个订单或者一个发票对应多个订单的情况,均可查询出来物流信息,物流信息包括物流单号、操作时间、操作备注、操作用户等) |
信息推送接口,包括: “查询推送信息”和 “删除推送信息” 2个接口,且为⭐ 必接接口 。
| 序号 | 接口 | 是否必接 | 接口作用 |
|---|---|---|---|
| 1 | 查询推送信息 | 是 |
通过此接口,获取京东侧推送的消息,包括:商品价格变更、商品上下架变更、订单拆分、订单妥投等信息。 如不对接,商品状态、商品信息、订单状态等内容不同步,导致下单失败 |
| 2 | 删除推送信息 | 是 |
通过此接口,删除京东侧推送的消息,避免消息积压。 如不对接,客户侧无法获取到最新的消息 |