immediateDelivery.addOrder

本接口应在服务器端调用,详细说明参见服务端API

下配送单接口

请求地址

  1. POST https://api.weixin.qq.com/cgi-bin/express/local/business/order/add?access_token=ACCESS_TOKEN

请求参数

属性类型默认值必填说明
access_tokenstring接口调用凭证
delivery_tokenstring预下单接口返回的参数,配送公司可保证在一段时间内运费不变
shopidstring商家id, 由配送公司分配的appkey
shop_order_idstring唯一标识订单的 ID,由商户生成, 不超过128字节
shop_nostring商家门店编号, 在配送公司登记,如果只有一个门店,可以不填
delivery_signstring用配送公司提供的appSecret加密的校验串说明
delivery_idstring配送公司ID
openidstring下单用户的openid
senderObject发件人信息,闪送、顺丰同城急送必须填写,美团配送、达达,若传了shop_no的值可不填该字段
receiverObject收件人信息
cargoObject货物信息
order_infoObject订单信息
shopObject商品信息,会展示到物流通知消息中
sub_biz_idstring子商户id,区分小程序内部多个子商户

sender 的结构

属性类型默认值必填说明
namestring姓名,最长不超过256个字符
citystring城市名称,如广州市
addressstring地址(街道、小区、大厦等,用于定位)
address_detailstring地址详情(楼号、单元号、层号)
phonestring电话/手机号,最长不超过64个字符
lngnumber经度(火星坐标或百度坐标,和 coordinate_type 字段配合使用,确到小数点后6位
latnumber纬度(火星坐标或百度坐标,和 coordinate_type 字段配合使用,精确到小数点后6位)
coordinate_typenumber0坐标类型,0:火星坐标(高德,腾讯地图均采用火星坐标) 1:百度坐标

receiver 的结构

属性类型默认值必填说明
namestring姓名,最长不超过256个字符
citystring城市名称,如广州市
addressstring地址(街道、小区、大厦等,用于定位)
address_detailstring地址详情(楼号、单元号、层号)
phonestring电话/手机号,最长不超过64个字符
lngnumber经度(火星坐标或百度坐标,和 coordinate_type 字段配合使用,确到小数点后6位
latnumber纬度(火星坐标或百度坐标,和 coordinate_type 字段配合使用,精确到小数点后6位)
coordinate_typenumber0坐标类型,0:火星坐标(高德,腾讯地图均采用火星坐标) 1:百度坐标

cargo 的结构

属性类型默认值必填说明
goods_valuenumber货物价格,单位为元,精确到小数点后两位(如果小数点后位数多于两位,则四舍五入保留两位小数),范围为(0-5000]
goods_heightnumber货物高度,单位为cm,精确到小数点后两位(如果小数点后位数多于两位,则四舍五入保留两位小数),范围为(0-45]
goods_lengthnumber货物长度,单位为cm,精确到小数点后两位(如果小数点后位数多于两位,则四舍五入保留两位小数),范围为(0-65]
goods_widthnumber货物宽度,单位为cm,精确到小数点后两位(如果小数点后位数多于两位,则四舍五入保留两位小数),范围为(0-50]
goods_weightnumber货物重量,单位为kg,精确到小数点后两位(如果小数点后位数多于两位,则四舍五入保留两位小数),范围为(0-50]
goods_detailObject货物详情,最长不超过10240个字符
goods_pickup_infostring货物取货信息,用于骑手到店取货,最长不超过100个字符
goods_delivery_infostring货物交付信息,最长不超过100个字符
cargo_first_classstring品类一级类目
cargo_second_classstring品类二级类目

goods_detail 的结构

属性类型默认值必填说明
goodsArray.<Object>货物列表

goods 的结构

属性类型默认值必填说明
good_countnumber货物数量
good_namestring货品名称
good_pricenumber货品单价,精确到小数点后两位(如果小数点后位数多于两位,则四舍五入保留两位小数)
good_unitstring货品单位,最长不超过20个字符

order_info 的结构

属性类型默认值必填说明
delivery_service_codestring配送服务代码 不同配送公司自定义,微信侧不理解
order_typenumber0订单类型, 0: 即时单 1 预约单,如预约单,需要设置expected_delivery_time或expected_finish_time或expected_pick_time
expected_delivery_timenumber0期望派单时间(达达支持,表示达达系统调度时间),unix-timestamp
expected_finish_timenumber0期望送达时间(美团、顺丰同城急送支持),unix-timestamp)
expected_pick_timenumber0期望取件时间(闪送、顺丰同城急送支持,顺丰同城急送只需传expected_finish_time或expected_pick_time其中之一即可,同时都传则以expected_finish_time为准),unix-timestamp
poi_seqstring门店订单流水号,建议提供,方便骑手门店取货,最长不超过32个字符
notestring备注,最长不超过200个字符
order_timenumber用户下单付款时间, 顺丰必填
is_insurednumber0是否保价,0,非保价,1.保价
declared_valuenumber保价金额,单位为元,精确到分
tipsnumber小费,单位为元, 下单一般不加小费
is_direct_deliverynumber是否选择直拿直送(0:不需要;1:需要。选择直拿直送后,同一时间骑手只能配送此订单至完成,配送费用也相应高一些,闪送必须选1,达达可选0或1,其余配送公司不支持直拿直送)
cash_on_deliverynumber骑手应付金额,单位为元,精确到分
cash_on_pickupnumber骑手应收金额,单位为元,精确到分
rider_pick_methodnumber物流流向,1:从门店取件送至用户;2:从用户取件送至门店
is_finish_code_needednumber收货码(0:不需要;1:需要。收货码的作用是:骑手必须输入收货码才能完成订单妥投)
is_pickup_code_needednumber取货码(0:不需要;1:需要。取货码的作用是:骑手必须输入取货码才能从商家取货)

shop 的结构

属性类型默认值必填说明
wxa_pathstring商家小程序的路径,建议为订单页面
img_urlstring商品缩略图 url
goods_namestring商品名称
goods_countnumber商品数量
wxa_appidstring即时配送第三方代结算模式,第三方用自己的开发小程序发起下单,物流消息回流到商家小程序wxa_appid

返回值

Object

属性类型说明
resultcodenumber错误码
resultmsgstring错误描述
feenumber实际运费(单位:元),运费减去优惠券费用
deliverfeenumber运费(单位:元)
couponfeenumber优惠券费用(单位:元)
tipsnumber小费(单位:元)
insurancefeenumber保价费(单位:元)
distancenumber配送距离(单位:米)
waybill_idstring配送单号
order_statusnumber配送状态
finish_codenumber收货码
pickup_codenumber取货码
dispatch_durationnumber预计骑手接单时间,单位秒,比如5分钟,就填300, 无法预计填0

使用场景

商家可调用本接口向配送公司请求下配送单,配送公司会返回这一单的配送单号、配送费、预计骑手接单时间等信息。

请求示例

  1. {
  2. "cargo": {
  3. "cargo_first_class": "美食宵夜",
  4. "cargo_second_class": "零食小吃",
  5. "goods_detail": {
  6. "goods": [
  7. {
  8. "good_count": 1,
  9. "good_name": "水果",
  10. "good_price": 10,
  11. "good_unit": "元"
  12. },
  13. {
  14. "good_count": 2,
  15. "good_name": "蔬菜",
  16. "good_price": 20,
  17. "good_unit": "元"
  18. }
  19. ]
  20. },
  21. "goods_height": 1,
  22. "goods_length": 3,
  23. "goods_value": 5,
  24. "goods_weight": 1,
  25. "goods_width": 2
  26. },
  27. "delivery_id": "SFTC",
  28. "delivery_sign": "01234567890123456789",
  29. "openid": "oABC123456",
  30. "order_info": {
  31. "delivery_service_code": "",
  32. "expected_delivery_time": 0,
  33. "is_direct_delivery": 0,
  34. "is_finish_code_needed": 1,
  35. "is_insured": 0,
  36. "is_pickup_code_needed": 1,
  37. "note": "test_note",
  38. "order_time": 1555220757,
  39. "order_type": 0,
  40. "poi_seq": "1111",
  41. "tips": 0
  42. },
  43. "receiver": {
  44. "address": "xxx地铁站",
  45. "address_detail": "2号楼202",
  46. "city": "北京市",
  47. "coordinate_type": 0,
  48. "lat": 40.1529600000,
  49. "lng": 116.5060300000,
  50. "name": "老王",
  51. "phone": "18512345678"
  52. },
  53. "sender": {
  54. "address": "xx大厦",
  55. "address_detail": "1号楼101",
  56. "city": "北京市",
  57. "coordinate_type": 0,
  58. "lat": 40.4486120000,
  59. "lng": 116.3830750000,
  60. "name": "刘一",
  61. "phone": "13712345678"
  62. },
  63. "shop": {
  64. "goods_count": 2,
  65. "goods_name": "宝贝",
  66. "img_url": "https://mmbiz.qpic.cn/mmbiz_png/xxxxxxxxx/0?wx_fmt=png",
  67. "wxa_path": "/page/index/index"
  68. },
  69. "shop_no": "12345678",
  70. "sub_biz_id": "sub_biz_id_1",
  71. "shop_order_id": "SFTC_001",
  72. "shopid": "122222222",
  73. "delivery_token": "xxxxxxxx"
  74. }

返回示例

下单成功

  1. {
  2. "resultcode": 0,
  3. "resultmsg": "ok",
  4. "fee": 10,
  5. "deliverfee": 10,
  6. "couponfee": 0,
  7. "tips": 0,
  8. "insurancfee": 0,
  9. "distance": 1000,
  10. "waybill_id": "123456789",
  11. "order_status": 101,
  12. "finish_code": 1024,
  13. "pickup_code": 2048,
  14. "dispatch_duration": 300
  15. }

下单失败

  1. {
  2. "resultcode": 1010,
  3. "resultmsg": "收件人信息不正确"
  4. }