# 外卖类接口列表 # 外卖开启接单 #### **接口用途** - 外卖开启接单 #### **接口地址** - `https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/takeoutOpen` #### **action** - `takeoutOpen` **请求参数,中件间===>易百后台**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
#### **请求报文举例** ``` { "traceNo": "9900000910001010220150201" } ``` **返回参数,易百后台===>中件间**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
orderNoString交易订单号易百生成
transDateString交易时间格式为:yyyyMMddHHmmss
returnCodeString返回码00表示交易成功,其他表示失败
returnDescString返回信息交易结果描述或错误原因
#### **返回报文举例** ``` { "traceNo": "9900000910001010420150201", "orderNo": "171698602301", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS" } ``` # 外卖关闭接单 #### **接口用途** - 外卖关闭接单 #### **接口地址** - `https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/takeoutClose` #### **action** - `takeoutClose` **请求参数,中件间===>易百后台**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123" } ``` **返回参数,易百后台===>中件间**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
orderNoString交易订单号易百生成
transDateString交易时间格式为:yyyyMMddHHmmss
returnCodeString返回码00表示交易成功,其他表示失败
returnDescString返回信息交易结果描述或错误原因
#### **返回报文举例** ``` { "traceNo": "99000009100010101732123", "orderNo": "171698602301", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS" } ``` # 外卖订单列表 #### **接口用途** - 外卖订单列表 #### **接口地址** - `https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/takeoutList` #### **action** - `takeoutList` **请求参数,中件间===>易百后台**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
pageNoInteger页号当有多页数据显示时,可以由此参数来确认所要查看页的数据
pageSizeInteger每页记录数可以按终端实际的显示记录上限来设定
statusString按订单状态获取订单列表0:未处理订单(对应到新建订单),1:已处理订单
#### **请求报文举例** ``` { "traceNo": "9900000910001012920150201", "pageNo": "1", "pageSize": "8", "status": "1" } ``` **返回参数,易百后台===>中件间**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
orderNoString交易订单号易百生成
transDateString交易时间格式为:yyyyMMddHHmmss
returnCodeString返回码00表示交易成功,其他表示失败
returnDescString返回信息交易结果描述或错误原因
currentPageInteger当前页号标识当前显示是第几页数据
pageSizeInteger每页记录数原样回传
countPageInteger总页数
orderInfoListList<[orderInfo](https://book.e-buy.com/books/e-buy-B6z/page/3def1-IiK "orderInfo")>订单列表一页最多将有pageSize条记录
#### **返回报文举例** ``` { "traceNo": "9900000910001013020150201", "orderNo": "171698602301", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS", "currentPage": 1, "pageSize": 8, "countPage": 1, "orderInfoList": [ { "appOrderNo": "3371680886339521", "orderTime": "12:08", "orderAmount": "106.28", "platformName": "百度外卖" } ] } ``` # 外卖订单详情 #### **接口用途** - 外卖订单详情 #### **接口地址** - `https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/takeoutDetail` #### **action** - `takeoutDetail` **请求参数,中件间===>易百后台**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
appOrderNoString应用订单号变长
riderQrcodeString配送员出示电子凭证码当该字段有值时必须上送platformId字段
platformIdString各外卖平台的id变长
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "appOrderNo": "2321671337735755", "riderQrcode": "2017092237735723", "platformID":"001" } ``` **返回参数,易百后台===>中件间**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
orderNoString交易订单号易百生成
transDateString交易时间格式为:yyyyMMddHHmmss
returnCodeString返回码00表示交易成功,其他表示失败
returnDescString返回信息交易结果描述或错误原因
orderInfoObject<[orderInfo](https://book.e-buy.com/books/e-buy-B6z/page/3def1-IiK "orderInfo")>订单对象显示一条订单信息
#### **返回报文举例** ``` { "traceNo": "99000009100010101732123", "orderNo": "171698602301", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS", "orderInfo": { "platformName": "美团外卖", "status": "配送中", "appOrderNo": "2321671337735755", "rcptName": "张三", "orderAmount": "128.8", "orderTime": "16:13", "orderCreateTime": "2017-07-18 16:13:12", "packageDetailList": [ { "packId": "2200", "packName": "包裹2", "goodsInfoList": [ { "goodsId": "100001", "goodsName": "百雀羚草本精华", "goodsSpec": "150ML", "price": "38.5", "quantity": "1" } ] }, { "packId": "1100", "packName": "包裹1", "goodsInfoList": [ { "goodsId": "100002", "goodsName": "六神花露水", "goodsSpec": "100ML", "price": "20.8", "quantity": "1" } ] } ] } } ``` # 外卖拒绝接单 #### **接口用途** - 外卖拒绝接单 #### **接口地址** - `https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/takeoutReject` #### **action** - `takeoutReject` **请求参数,中件间===>易百后台**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
appOrderNoString应用订单号变长
#### **请求报文举例** ``` { "traceNo": "9900000910001010720150201", "appOrderNo": "2321671337735755" } ``` **返回参数,易百后台===>中件间**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
orderNoString交易订单号易百生成
transDateString交易时间格式为:yyyyMMddHHmmss
returnCodeString返回码00表示交易成功,其他表示失败
returnDescString返回信息交易结果描述或错误原因
statusString订单状态
#### **返回报文举例** ``` { "traceNo": "9900000910001010820150201", "orderNo": "171698602301", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS", "status": "已拒单" } ``` # 外卖确认接单 #### **接口用途** - 外卖确认接单 #### **接口地址** - `https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/takeoutConfirm` #### **action** - `takeoutConfirm` **请求参数,中件间===>易百后台**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
appOrderNoString应用订单号变长
statusString是否自动核销autoVerify
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "appOrderNo": "2321671337735755" } ``` **返回参数,易百后台===>中件间**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复
orderNoString交易订单号易百生成
transDateString交易时间格式为:yyyyMMddHHmmss
returnCodeString返回码00表示交易成功,其他表示失败
returnDescString返回信息交易结果描述或错误原因
statusString订单状态
#### **返回报文举例** ``` { "traceNo": "99000009100010101732123", "orderNo": "171698602301", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS", "status": "已确认接单" } ``` # 外卖取消接单 #### **接口用途** - 外卖取消接单 #### **接口地址** - `https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/takeoutCancel` #### **action** - `takeoutCancel` **请求参数,中件间===>易百后台**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
appOrderNoString应用订单号变长
#### **请求报文举例** ``` { "traceNo": "9900000910001010320150201", "appOrderNo": "2321671337735755" } ``` **返回参数,易百后台===>中件间**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
orderNoString交易订单号易百生成
transDateString交易时间格式为:yyyyMMddHHmmss
returnCodeString返回码00表示交易成功,其他表示失败
returnDescString返回信息交易结果描述或错误原因
statusString订单状态
#### **返回报文举例** ``` { "traceNo": "9900000910001010120150201", "orderNo": "171698602301", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS", "status": "已取消接单" } ``` # 骑手订单核销 #### **接口用途** - 外卖骑手订单核销 #### **接口地址** - `https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/takeoutVerify` #### **action** - `takeoutVerify` **请求参数,中件间===>易百后台**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
riderQrcodeString配送员出示电子凭证码变长
platformIdString各外卖平台的id变长
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "riderQrcode": "2321671337735755", "platformID":"001" } ``` **返回参数,易百后台===>中件间**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
orderNoString交易订单号易百生成
transDateString交易时间格式为:yyyyMMddHHmmss
returnCodeString返回码00表示交易成功,其他表示失败
returnDescString返回信息交易结果描述或错误原因
#### **返回报文举例** ``` { "traceNo": "99000009100010101732123", "orderNo": "171698602301", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS" } ``` # 外卖订单结算 #### **接口用途** - 外卖订单结算 #### **接口地址** - `https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/takeoutSettle` #### **action** - `takeoutSettle` **请求参数,中件间===>易百后台**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
settleBatchNoString需要结算的批次号打印失败时可重复同一批次号
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "settleBatchNo": "0001" } ``` **返回参数,易百后台===>中间件**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
transDateString交易时间格式为:yyyyMMddHHmmss
returnCodeString返回码00表示交易成功,其他表示失败
returnDescString返回信息交易结果描述或错误原因
settleRecordList<[settleRecord](https://book.e-buy.com/books/e-buy-B6z/page/02522 "settleRecord")>结算记录
beginDateString结算开始时间格式:yyyyMMddHHmmss
endDateString结算结束时间格式:yyyyMMddHHmmss
volumeInteger总交易笔数
totalReceiptAmountPrice商户实收总金额
totalAmountPrice总金额所有交易汇总的金额
printDetailString小票打印内容各外卖平台小结
#### **返回报文举例** ``` { "traceNo": "99000009100010101732123", "transDate": "20161231102201", "returnCode": "00", "returnDesc": "SUCCESS", "settleRecord": [ { "activityNo": "2016101201", "activityName": "百度外卖", "isRefund": false, "volume": 130, "totalReceiptAmount": "2082.10", "totalAmount": "2082.10" }, { "activityNo": "2016120301", "activityName": "美团外卖", "isRefund": false, "volume": 100, "totalReceiptAmount": "234.10", "totalAmount": "234.10" } ], "printDetail":"0020CCF5C2EBD6A7B8B62020B1CACAFD2020202020CAB5CAD52020202020BDF0B6EE0020CEA2D0C5D6A7B8B6202020203135202020363134 2E30302020203631342E30300020D6A7B8B6B1A620202020202031322020203530332E30302020203530332E30300020D7DCBCC6202020202020202032372020313131372E30302020313131372E303009001F0E652D42757920B5E7D7D3C6BED6A42F04BDE1CBE3", "beginDate": "20161029113602", "endDate": "20161030113602", "volume": 230, "totalReceiptAmount": 1900, "totalAmount": 2000, } ``` # 订单核销冲正 #### **接口用途** - 外卖骑手订单核销 #### **接口地址** - `https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/takeoutRollback` #### **action** - `takeoutRollback` **请求参数,中件间===>易百后台**
#### 字段 类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
riderQrcodeString配送员出示电子凭证码变长
platformIdString各外卖平台的id变长
#### **请求报文举例** ``` { "traceNo": "9900000910001010520150201", "riderQrcode": "2321671337735755", "platformID":"001" } ``` **返回参数,易百后台===>中件间**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
orderNoString交易订单号易百生成
transDateString交易时间格式为:yyyyMMddHHmmss
returnCodeString返回码00表示交易成功,其他表示失败
returnDescString返回信息交易结果描述或错误原因
#### **返回报文举例** ``` { "traceNo": "9900000910001010620150201", "orderNo": "171698602301", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS" } ```