# 多场景明细数据加载
接口地址 /openapi/v1/order/initCustomerHomeThreeLeve
请求方式 POST
请求参数例子
{
"fromLocation": "113.841406,22.614303",
//用户发单经纬度
"sceneSonType": 23,
//场景子类型：1-快送 21-鲜花（两轮车）22-鲜花（小轿车）23-蛋糕（两轮车）24-蛋糕（小轿车）25-花篮（两轮车）26-花篮（小轿车） 31-三轮车 32-小轿车 33-小面 34-中面 35-小型平板 36-4.2米货车 41-宠物出行（两轮车）42-宠物出行（小轿车) 默认 1
"sceneType": 2
//1-快送 2：鲜花蛋糕 3-货运 4-宠物出行
}
返回参数例子
{
"code": 0,
"data": {
//第一楼数据明细-数据一排序（鲜花，花篮，蛋糕-尺寸，宠物）
"leve1Detail": [
{
"id": 1,
"message": "3寸蛋糕",
//显示描述
"val": 3
//对应参数值
}
],
//第二楼数据明细-数据一排序 （宠物-体重，蛋糕-层数）
"leve2Detail": [
{
"id": 1,
"message": "2层",
//显示描述
"val": 2
//显示描述
}
],
"sceneConType": 23
//场景类型 21-鲜花（两轮车）22-鲜花（小轿车）23-蛋糕（两轮车）24-蛋糕（小轿车）25-花篮（两轮车）26-花篮（小轿车）41-宠物出行（两轮车）42-宠物出行（小轿车）
},
"fail": true,
"msg": "",
"ok": true,
"timeStampNow": 1607929171334,
"timestamp": "2023-11-20 08:00:00",
"traceId": ""
}
# 订单计费
接口地址 /openapi/v1/order/price-calculate
请求方式 POST
请求参数例子
{
"fromPhone": "1341231231",
//创建订单时的发件人手机号
"fromLocation": "113.941369,22.527564",
//起始坐标(坐标格式:经度,纬度)
"goodsWeight": "3",
//物品(货物)重量（单位：公斤）
"tipFee": "100",
//小费(单位:分)
"toLocation": "113.929171,22.518621",
//终点坐标(坐标格式:经度,纬度)
"appointmentTime": 0,
//预约时间,为空则为非预约
"needSpecialDelivery": false,
//是否专送订单，true-是，false-否（默认-false）
"sceneType": 2,
//场景类型：1-快送 2：鲜花蛋糕 3-货运 4-宠物出行 不传默认为1
"sceneSonType": 23,
//场景子类型：1-快送 21-鲜花（两轮车）22-鲜花（小轿车）23-蛋糕（两轮车）24-蛋糕（小轿车）25-花篮（两轮车）26-花篮（小轿车） 31-三轮车 32-小轿车 33-小面 34-中面 35-小型平板 36-4.2米货车 41-宠物出行（两轮车）42-宠物出行（小轿车） 不传默认为1
"levelDetail1": {
"id": 1,
"val": 3
},
//一楼明细参数（鲜花花束，花篮对数，蛋糕尺寸，宠物体型）如果只传场景 传明细参数则默认取对应子场景最优商户方案 数据来源 /initCustomerHomeThreeLeve
"levelDetail2": {
"id": 1,
"val": 2
}
//二楼明细参数（蛋糕层数，宠物体重）如果只传场景 传明细参数则默认取对应子场景最优商户方案 数据来源 /initCustomerHomeThreeLeve
}
返回参数例子
{
"code": 0,
"msg": "操作成功",
"data": {
"planRouteMileageNum": "4",
//规划路线里程数(单位：公里)
"planRouteMinuteNum": "11",
//规划路线用时(单位：分钟)
"carriageFee": "1700",
//订单运费 = 重量费用+里程费用(单位：分)
"weightFee": "300",
//重量费用(单位：分)
"distanceFee": "1400",
//里程费用(单位：分)
"tipFee": "100",
//小费(单位：分)
"customerTotalOverflowAmount": "100",
//溢价总额
"expressOrderOverflowList": [
{
"planName": "场景溢价",
//溢价方案名称
"customerAmount": "100"
//溢价价格
}
],
//溢价集合
"payFee": "100",
//支付费用=优惠前的应付金额-优惠金额
"beforePreferentialFee": "100",
//优惠前的应付金额
"preferentialAmount": "100",
//优惠金额
"specialDeliveryFee": "4400"
//专送费用
},
"timestamp": "2020-12-16 16:52:20",
"timeStampNow": 1608108740413,
"fail": false,
"ok": true
}
# 订单提交
接口地址 /openapi/v1/order/create-and-pay
请求方式 POST
请求参数例子
{
"deliveryTime": 0,
//建议送达时间：毫秒时间戳
"appointmentTime": 0,
//预约时间,为空则为非预约
"customerNote": "test",
//客户备注
"fromAddress": "粤海街道602号",
//发件详细地址如：粤海街道602号
"fromAddressDetail": "魔都肯德基",
//发件地详细地址，如：店名（魔都肯德基）、坪洲地铁站 等等
"fromAddressExtra": "A栋-2203",
//发件地补充地址，如：A栋-2203
"fromLocation": "113.940951,22.527227",
//发件地经纬度
"fromName": "寄件人姓名",
//发件人姓名
"fromPhone": "13566668888",
//发件人手机号
"goodsInfo": "鲜花",
//物品名称，如：快餐，药品，鲜花 等等
"productList": "[{\"count\":1,\"name\":\"肉夹馍\",\"price\":5,\"unit\":\"个\"},{\"count\":1,\"name\":\"凉皮\",\"price\":12,\"unit\":\"份\"},{\"count\":1,\"name\":\"餐具\",\"price\":0,\"unit\":\"份\"}]",
//商品列表：最长不超过10240个字符，内容为JSON数组字符串格式，count表示货物数量，int类型，必填且必须大于0；name表示货品名称，string类型，必填且不能为空；price表示货品单价，double类型，选填，数值不小于0，精确到小数点后两位（如果小数点后位数多于两位，则四舍五入保留两位小数）；unit表示货品单位，string类型，选填，最长不超过20个字符；
"goodsWeight": "5",
//物品(货物)重量，单位公斤
"sourceOrderNo": "source001001",
//对接平台订单号
"sourceOrderPlatform": "饿了么的",
//订单来源平台 : 中文字符串值，如：美团、饿了么、百度、口碑
"sourceOrderSeq": "10",
//取货序号: 与sourceOrderPlatform配合使用,如：美团#10号单，表示为sourceOrderSeq=10
"tipFee": "200",
//小费
"toAddress": "七单元3-301",
//收件地地址，如：七单元3-301
"toAddressDetail": "南山区文海花园",
//收件地详细地址，如：南山区文海花园
"toAddressExtra": "招商银行对面西南门进",
//收件地补充细地址，如：招商银行对面西南门进
"toLocation": "113.940951,22.527227",
//收件地经纬度
"toName": "收件人姓名",
//收件人姓名
"toPhone": "18655559999",
//收件人手机号
"sourceOrderNoExtra": "sourcea001001",
//对接平台三方订单号，如美团、饿了么平台单号（可空）
"needSpecialDelivery": false,
//是否专送订单，true-是，false-否（默认-false）
"outFoodStatus": 1,
//出餐状态：1-已出餐，2-未出餐
"photoOrderImg":"https://www.img.com",
//多场景图片链接：鲜花，花篮，蛋糕，货运，宠物出行,最大长度不超过500
"sceneType": 2,
//场景类型：1-快送 2：鲜花蛋糕 3-货运 4-宠物出行 不传默认为1
"sceneSonType":23,
//场景子类型：1-快送 21-鲜花（两轮车）22-鲜花（小轿车）23-蛋糕（两轮车）24-蛋糕（小轿车）25-花篮（两轮车）26-花篮（小轿车） 31-三轮车 32-小轿车 33-小面 34-中面 35-小型平板 36-4.2米货车 41-宠物出行（两轮车）42-宠物出行（小轿车） 不传默认为1
"levelDetail1": {
"id": 1,
"val": 3
},
//一楼明细参数（鲜花花束，花篮对数，蛋糕尺寸，宠物体型）如果只传场景 传明细参数则默认取对应子场景最优商户方案 数据来源 /initCustomerHomeThreeLeve
"levelDetail2": {
"id": 1,
"val": 2
}
//二楼明细参数（蛋糕层数，宠物体重）如果只传场景 传明细参数则默认取对应子场景最优商户方案 数据来源 /initCustomerHomeThreeLeve
}
返回参数例子
{
"code": 0,
"msg": "操作成功",
"data": {
"customerNote": "客户备注",
//客户备注
"orderNo": "ON2009159200340432",
//裹小递订单号
"sourceOrderNo": "XF2009159200340432",
//对接平台订单号
"expressStatus": "WAIT_TAKE",
//当前订单状态：WAIT_PAY-待支付，WAIT_TAKE-待接单，REASSIGN-改派，WAIT_PICKUP-待取件，PICKING-取件中，DISTRIBUTION-配送中，RECEIVED-完成，CANCELED-已取消，REFUNDED-已退款
"carriageFee": "1700",
//订单运费 = 重量费用+里程费用(单位：分)
"distanceFee": "100",
//里程费
"weightFee": "100",
//续重费
"tipFee": "100",
//小费
"customerTotalOverflowAmount": "100",
//溢价总额
"expressOrderOverflowList": [
{
"planName": "场景溢价",
//溢价方案名称
"customerAmount": "100"
//溢价价格
}
],
//溢价集合
"payFee": "100",
//支付费用
"planRouteMileageNum": "10",
//规划路线里程公里数，单位公里
"planRouteMinuteNum": "28",
//规划路线里程分钟数，单位分钟
"timeCreateOrder": "10021414",
//下单时间（新增订单时间）
"beforePreferentialFee": "100",
// 优惠前的应付金额
"preferentialAmount": "100",
// 优惠金额
"specialDeliveryFee": "4400"
//专送费用
},
"timestamp": "2020-12-14 14:59:31",
"timeStampNow": 1607929171334,
"ok": true,
"fail": false
}
# 订单取消
接口地址 /openapi/v1/order/cancel
请求方式 POST
请求参数例子
{
"orderNo": "ON2009159200340432",
//裹小递订单号
"sourceOrderNo": "XF2009159200340432"
//对接平台订单号
}
返回参数例子
{
"code": 0,
"msg": "操作成功",
"data": {
"orderNo": "ON2009159200340432",
//裹小递订单号
"sourceOrderNo": "XF2009159200340432",
//对接平台订单号
"cancelDeductionsAmount": "120"
//取消订单扣款金额，单位分
},
"timestamp": "2020-12-14 14:59:31",
"timeStampNow": 1607929171334,
"ok": true,
"fail": false
}
# 订单状态查询
接口地址 /openapi/v1/order/query-status
请求方式 POST
请求参数例子
{
"orderNo": "ON2009159200340432",
//裹小递订单号
"sourceOrderNo": "XF2009159200340432"
//对接平台订单号
}
返回参数例子
{
"code": 0,
"msg": "操作成功",
"data": {
"accountNo": "GXD10086",
//商家ID
"orderNo": "ON2009159200340432",
//裹小递订单号
"sourceOrderNo": "XF2009159200340432",
//对接平台订单号
"expressStatus": "WAIT_TAKE",
//当前订单状态：WAIT_PAY-待支付，WAIT_TAKE-待接单，REASSIGN-改派，WAIT_PICKUP-待取件，PICKING-取件中，DISTRIBUTION-配送中，RECEIVED-完成，CANCELED-已取消，REFUNDED-已退款
"expressWorkerName": "",
//配送员名称
"expressWorkerPhone": ""
//配送员电话
},
"timestamp": "2020-12-14 14:59:31",
"timeStampNow": 1607929171334,
"ok": true,
"fail": false
}
# 订单状态流查询
接口地址 /openapi/v1/order/query-status-feed
请求方式 POST
请求参数例子
{
"orderNo": "ON2009159200340432",
//裹小递订单号
"sourceOrderNo": "XF2009159200340432"
//对接平台订单号
}
返回参数例子
{
"code": 0,
"msg": "操作成功",
"data": {
"orderNo": "ON2009159200340432",
//裹小递订单号
"sourceOrderNo": "XF2009159200340432",
//对接平台订单号
"feed": [
{
"expressStatus": "WAIT_TAKE",
//当前订单状态：WAIT_PAY-待支付，WAIT_TAKE-待接单，REASSIGN-改派，WAIT_PICKUP-待取件，PICKING-取件中，DISTRIBUTION-配送中，RECEIVED-完成，CANCELED-已取消，REFUNDED-已退款
"expressStatusDesc": "待接单",
"expressWorkerName": "",
//配送员名称
"expressWorkerPhone": "",
//配送员电话
"happenTime": 11234124124,
//发生时间
"recordDesc": "订单创建成功，待接单"
//记录描述
},
{
"expressStatus": "WAIT_PICKUP",
"expressStatusDesc": "待取件",
"expressWorkerName": "张三",
"expressWorkerPhone": "1333",
"happenTime": 11234124124,
"recordDesc": "订单已被接单，待取件"
},
{
"expressStatus": "PICKING",
"expressStatusDesc": "取件中",
"expressWorkerName": "张三",
"expressWorkerPhone": "1333",
"happenTime": 11234124124,
"recordDesc": "配送员已到店，取件中"
}
]
},
"timestamp": "2020-12-14 14:59:31",
"timeStampNow": 1607929171334,
"ok": true,
"fail": false
}
# 订单追加小费
接口地址 /openapi/v1/order/add-tip-fee
请求方式 POST
请求参数例子
{
"orderNo": "ON2009159200340432",
//裹小递订单号
"sourceOrderNo": "XF2009159200340432",
//对接平台订单号
"tipFee": "100"
//小费(单位：分)
}
返回参数例子
{
"code": 0,
"msg": "操作成功",
"data": {
"orderNo": "ON2009159200340432",
//裹小递订单号
"sourceOrderNo": "XF2009159200340432",
//对接平台订单号
"tipFee": "100"
//小费(单位：分)
},
"timestamp": "2020-12-14 14:59:31",
"timeStampNow": 1607929171334,
"ok": true,
"fail": false
}
# 获取订单追加小费信息
接口地址 /openapi/v1/order/query-tip-list
请求方式 POST
请求参数例子
{
"orderNo": "ON2009159200340432",
//裹小递订单号
"sourceOrderNo": "XF2009159200340432"
//对接平台订单号
}
返回参数例子
{
"code": 0,
"msg": "操作成功",
"data": {
"accountNo": "GXD10086",
//商家账号编码
"orderNo": "ON2009159200340432",
//裹小递订单号
"sourceOrderNo": "XF2009159200340432",
//对接平台订单号
"totalTipFee": "300"
//小费总额
"totalTipCount": 2,
//总的加小费次数
"tipList": [
{
"tipNo": "1231231",
//小费单号
"tipFee": "100",
//小费金额
"createTime": 131241241
//创建时间
},
{
"tipNo": "12343531",
"tipFee": "100",
"createTime": 131341211
}
]
},
"timestamp": "2020-12-14 14:59:31",
"timeStampNow": 1607929171334,
"ok": true,
"fail": false
}
# 订单状态通知
接口地址 对接平台报备回调域名
请求方式 POST
请求时间 总计通知5次：0s,5s,15s,35s,75s,超过5次之后则不再进行异步通知
接口说明 订单状态：REASSIGN-改派(改变配送员)，为瞬时状态，指订单发生了改派动作，订单实际状态不做变更
请求参数例子
{
"orderNo": "ON2009159200340432",
//裹小递订单号
"sourceOrderNo": "XF2009159200340432",
//对接平台订单号
"expressStatus": "RECEIVED",
//当前订单状态：WAIT_PAY-待支付，WAIT_TAKE-待接单，REASSIGN-改派，WAIT_PICKUP-待取件，PICKING-取件中，DISTRIBUTION-配送中，RECEIVED-完成，CANCELED-已取消，REFUNDED-已退款
"happenTime": 1607929171334,
//发生时间
"expressWorkerName": "张三",
//配送员名称(接单以后该字段不为空)
"expressWorkerPhone": "1888888888",
//配送员电话(接单以后该字段不为空)
"cancelDeductionsAmount": "120"
//取消订单扣款金额(订单支付后取消和退款推送携带,未支付为空)
}
返回参数例子
平台方接收数据成功后需返回字符串 OK ，不区分大小写
# 订单配送员实时定位查询
接口地址 /openapi/v1/order/query-worker-location
请求方式 POST
适用状态 取件中、配送中
请求参数例子
{
"orderNo": "ON2009159200340432",
//裹小递订单号
"sourceOrderNo": "XF2009159200340432"
//对接平台订单号
}
返回参数例子
{
"code": 0,
"msg": "操作成功",
"data": {
"orderNo": "ON2009159200340432",
//裹小递订单号
"sourceOrderNo": "XF2009159200340432",
//对接平台订单号
"workerLocation": "113.941369,22.527564",
//配送员经纬度
"locTime": "1607929171334",
//位置上报时间
"expressWorkerName": "张三",
//配送员名称
"expressWorkerPhone": "1888888888"
//配送员电话
},
"timestamp": "2020-12-29 14:59:31",
"timeStampNow": 1607929171334,
"ok": true,
"fail": false
}
# 商家出餐
页面地址 https://iguoxiaodi.com/openapi/v1/order/outFood
请求方式 POST 请求参数例子
{
"orderNo": "ON2009159200340432",
//裹小递订单号
"outFoodStatus": 1
//出餐状态：1-已出餐，2-未出餐
}
返回参数例子
{
"code": 0,
"msg": "操作成功",
"data": null,
"timestamp": "2020-12-14 14:59:31",
"timeStampNow": 1607929171334,
"ok": true,
"fail": false
}