仓储系统接口文档-白红宇

仓储系统接口文档

阅读量：5736 次

发布时间：2019-06-18

本文共 6000 字，大约阅读时间需要 20 分钟。

业务流程

第三方电商平台与中外运订单仓储系统的数据交换按照业务的需要主要有以下几个：推送采购单、取消采购单、采购单货物清点回调、线下发送提货单（保税模式）、提货单出库回调、推送订单、取消订单、缺货通知、打单回调、分拣回调、打包回调、打包回调、出库回调、海关扣留通知、库存查询、盘库结果回调、轨迹查询。

详细介绍

采购单

1.推送采购单

推送采购单是整个业务开始的第一步，采购单由第三方电商平台推送给中外运订单仓储系统，告知中外运该电商平台于何时有何商品及件数到达某个仓库，以便中外运仓库展开后续收货等操作。

2.取消采购单

取消采购单是指第三方电商平台对之前已经推送过的采购单（中外运仓库尚未收货）进行取消的操作。

3.采购单货物清点回调

采购单货物清点回调是指中外运仓库在收到第三方电商平台指定采购单的货物时，将货物的数量及货物的损坏情况推送/反馈给第三方电商平台，若仓库方在入库理货时发现商品数量与采购单上标识的不符，会与第三方电商平台先行线下沟通达成一致后，再调用采购单入库接口推送入库数据。

提货出库（保税模式）

该模式中外运方只负责将第三方电商平台在中外运国外仓库的商品按照提货单发送到电商平台国内指定保税仓，不涉订单及其他后续流程。

1.线下发送提货单

第三方电商平台可通过事先约定好的模式告知中外运方需要提货的商品及明细，以便中外运仓库进行相应操作。

2.提货单出库回调

提货单出库回调是指中外运仓库在将指定提货单的商品进行出库操作之后，将操作明细反馈给第三方电商平台。

订单

订单由第三方电商平台按照中外运方指定的格式及内容发送给中外运方，中外运方按照订单中的商品信息及收货信息进行后续的发货和申报操作。订单的状态按照操作的顺序（已取消状态不参与排序）有以下状态：待处理、已打单、已分拣、已打包、已出库、航空配载、已申报、海关扣留、已清关、转交国内快递、正在派送、已签收、已取消。这些状态分别对应操作流程中不同的环节。

1.推送订单

推送订单是指第三方电商平台将客户的订单中的部分信息推送给中外运订单仓储系统，以便中外运仓库进行订单商品的打包出库等后续操作。

2.取消订单

取消订单是指第三方电商平台将已发送的订单取消的操作，当订单的状态在

已打包及后续的某个状态时，该订单将不可取消。

3.缺货通知

缺货通知是指中外运方在某个订单对应的商品缺货时发送给第三方电商平台的通知，以便电商平台进行后续的采购或者其他操作。

4.打单回调

打单回调是指中外运方推送给第三方电商平台，告知某个订单已经开始在仓库中进行处理了。

5.分拣回调

分拣回调是指中外运方推送给第三方电商平台，告知某个订单已经在仓库中进行了分拣的操作以及分拣的商品的明细。

6.打包回调

打包回调是指中外运方推送给第三方电商平台，告知某个订单已经在仓库中进行了打包的操作以及打包的商品的明细。

7.出库回调

出库回调是指中外运方推送给第三方电商平台，告知某个订单已经在仓库中进行了出库的操作、订单的包裹信息（国内快递单号）以及出库的商品的明细，至此订单在中外运国外转运仓的操作结束。

8.海关扣留通知

海关扣留通知是指中外运方在订单对应的包裹到运抵国内指定海关关口，进行申报之后海关反馈的状态，扣留原因会在反馈的信息中展示。

库存信息

1.库存查询

库存查询是指第三方电商平台查询指定商品在中外运订单仓储系统中当前的库存信息。

2.盘库结果回调

盘库结果回调是指中外运仓库方根据第三方电商平台的要求进行指定商品的盘库，并将盘库的结果反馈给电商平台。

轨迹信息

1.轨迹查询

轨迹查询是指第三方电商平台根据订单号从中外运订单仓储系统中获取该订单当前的轨迹信息。

接口文档

第三方发送数据流程

身份验证，系统会给每个接入用户分配一个唯一的身份ID（AppID）及与之对应的访问秘钥（AuthCode），API用户在向接口正式发送或接收数据前，必须先把AppID和AuthCode发送到指定的验证地址，验证通过后，API接口会返回一个有时效的Token（两小时内有效）:

验证地址：https://efreight.cn/api/authRequest数据：{‘appid’:AppID, ‘auth_token’:AuthCode}测试系统：    AppID：*****      AuthCode: *****Response数据：Auth_token

2.发送接收数据，将请求报文和身份验证通过后获取的Token同时发送给数据处理接口，我们的平台处理完成后会返回成功或失败报文:

数据接口地址：https://efreight.cn/api/postRequest数据：{    ‘auth_token’: Auth_token,   //上一步生成的token    ‘platform’: ‘xxxx’,//xxxx：与订单系统约定好的平台名称 ‘function’: ‘xxxxOrder’ , ‘type’: ‘1’ ‘data’: XML报文 }

参数说明：

auth_token    上一步生成的tokenplatform:    生产环境：xxxx，测试环境：xxxx（需提前沟通约定）function    海淘订单接口： HTOrder            直邮订单接口： DMOrder            轨迹接口：LogisticTrace            身份证接口：IdentityUpload            商品备案信息接口：MerchantRegisterInfo            采购订单接口： InboundPlan             取消采购单： CancelPurchase             取消用户订单： CancelOrder            库存查询： Inventory            （以上接口在实际过程中可能根据接入用户的需求不同而不同，需双方提前约定）type    0: JSON,1: XML data 报文格式见下文说明

Response数据：

对于不同的请求报文有不同的返回数据，下述为默认情况下的标准报文。

接口明细

1.推送采购单

{    "purchase_id": "purchase_id", // 采购单号；String类型，建议预留40位    "transport_service_code": "ems", // 物流供应商代号，非必填；String类型 "transport_order_id": "qaws12345", // 物流单号，非必填；String类型 "remark": "集装箱号xxx，司机电话xxx", // String类型 "expect_arrival_time": "2014-11-06 16:16:20", // 预期抵达时间，非必填；String类型 "order_items": [// 物品列表 { "sku_id": "sku_id", // sku_id；String类型，建议预留40位 "product_no": "12345", // 自定义商品序列号 与sku一一对应 可打印成条形码；String类型，建议预留40位 "goods_name": "飞利浦电饭煲", // 商品名；String类型 "sku_name": "飞利浦电饭煲（白金内胆）", // 规格名称；String类型 "qty": 1000 // 数量；int类型 }, { "sku_id": "sku_id", "product_no": "12345", "goods_name": "飞利浦电饭煲", "sku_name": "飞利浦电饭煲（铝合金内胆）", "qty": 1000 } ] }

2.取消采购单报文

{    "purchase_id":"test_purchase_id"    // 采购单号}

3.海淘订单请求报文

4.直邮订单报文