生成运单

调用本接口可以生成运单,详情可见快递接口-商家侧,使用过程中如遇到问题,可在开放平台服务商专区发帖交流。

请求地址

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

请求参数

属性 类型 默认值 必填 说明
access_token String 第三方平台接口调用令牌authorizer_access_token
add_source number 订单来源,0为小程序订单,2为App或H5订单,填2则不发送物流服务通知
wx_appid string App或H5的appid,add_source=2时必填,需和开通了物流助手的小程序绑定同一open帐号
order_id string 订单ID,须保证全局唯一,不超过512字节
openid string 用户openid,当add_source=2时无需填写(不发送物流服务通知)
delivery_id string 快递公司ID,可通过获取支持的快递公司列表接口获取
biz_id string 快递客户编码或者现付编码
custom_remark string 快递备注信息,比如"易碎物品",不超过1024字节
tagid number 订单标签id,用于平台型小程序区分平台上的入驻方,tagid须与入驻方账号一一对应,非平台型小程序无需填写该字段
sender Object 发件人信息
receiver Object 收件人信息
cargo Object 包裹信息,将传递给快递公司
shop Object 商品信息,会展示到物流服务通知和电子面单中
insured Object 保价信息
service Object 服务类型
expect_time number Unix 时间戳, 单位秒,顺丰必须传。
预期的上门揽件时间,0表示已事先约定取件时间;否则请传预期揽件时间戳,需大于当前时间,收件员会在预期时间附近上门。
例如expect_time为“1557989929”,表示希望收件员将在2019年05月16日14:58:49-15:58:49内上门取货。
说明:若选择 了预期揽件时间,请不要自己打单,由上门揽件的时候打印。
如果是下顺丰散单,则必传此字段,否则不会有收件员上门揽件。

sender 的结构

属性 类型 默认值 必填 说明
name string 发件人姓名,不超过64字节
tel string 发件人座机号码,若不填写则必须填写 mobile,不超过32字节
mobile string 发件人手机号码,若不填写则必须填写 tel,不超过32字节
company string 发件人公司名称,不超过64字节
post_code string 发件人邮编,不超过10字节
country string 发件人国家,不超过64字节
province string 发件人省份,比如:"广东省",不超过64字节
city string 发件人市/地区,比如:"广州市",不超过64字节
area string 发件人区/县,比如:"海珠区",不超过64字节
address string 发件人详细地址,比如:"XX路XX号XX大厦XX",不超过512字节

receiver 的结构

属性 类型 默认值 必填 说明
name string 收件人姓名,不超过64字节
tel string 收件人座机号码,若不填写则必须填写 mobile,不超过32字节
mobile string 收件人手机号码,若不填写则必须填写 tel,不超过32字节
company string 收件人公司名,不超过64字节
post_code string 收件人邮编,不超过10字节
country string 收件人所在国家,不超过64字节
province string 收件人省份,比如:"广东省",不超过64字节
city string 收件人地区/市,比如:"广州市",不超过64字节
area string 收件人区/县,比如:"天河区",不超过64字节
address string 收件人详细地址,比如:"XX路XX号XX大厦XX",不超过512字节

cargo 的结构

属性 类型 默认值 必填 说明
count number 包裹数量, 需要和detail_list size保持一致
weight number 包裹总重量,单位是千克(kg)
space_x number 包裹长度,单位厘米(cm)
space_y number 包裹宽度,单位厘米(cm)
space_z number 包裹高度,单位厘米(cm)
detail_list Array.<Object> 包裹中商品详情列表

detail_list 的结构

属性 类型 默认值 必填 说明
name string 商品名,不超过128字节
count number 商品数量

shop 的结构

属性 类型 默认值 必填 说明
wxa_path string 商家小程序的路径,建议为订单页面
img_url string 商品缩略图 url
goods_name string 商品名称, 不超过128字节
goods_count number 商品数量

insured 的结构

属性 类型 默认值 必填 说明
use_insured number 是否保价,0 表示不保价,1 表示保价
insured_value number 保价金额,单位是分,比如: 10000 表示 100 元

service 的结构

属性 类型 默认值 必填 说明
service_type number 服务类型ID,详见已经支持的快递公司基本信息
service_name string 服务名称,详见已经支持的快递公司基本信息

请求示例

{
  "add_source": 0,
  "order_id": "01234567890123456789",
  "openid": "oABC123456",
  "delivery_id": "SF",
  "biz_id": "xyz",
  "custom_remark": "易碎物品",
  "sender": {
    "name": "张三",
    "tel": "020-88888888",
    "mobile": "18666666666",
    "company": "公司名",
    "post_code": "123456",
    "country": "中国",
    "province": "广东省",
    "city": "广州市",
    "area": "海珠区",
    "address": "XX路XX号XX大厦XX栋XX"
  },
  "receiver": {
    "name": "王小蒙",
    "tel": "020-77777777",
    "mobile": "18610000000",
    "company": "公司名",
    "post_code": "654321",
    "country": "中国",
    "province": "广东省",
    "city": "广州市",
    "area": "天河区",
    "address": "XX路XX号XX大厦XX栋XX"
  },
  "shop": {
    "wxa_path": "/index/index?from=waybill&id=01234567890123456789",
    "img_url": "https://mmbiz.qpic.cn/mmbiz_png/OiaFLUqewuIDNQnTiaCInIG8ibdosYHhQHPbXJUrqYSNIcBL60vo4LIjlcoNG1QPkeH5GWWEB41Ny895CokeAah8A/640",
    "goods_name": "微信气泡狗抱枕&微信气泡狗钥匙扣",
    "goods_count": 2
  },
  "cargo": {
    "count": 2,
    "weight": 5.5,
    "space_x": 30.5,
    "space_y": 20,
    "space_z": 20,
    "detail_list": [
      {
        "name": "微信气泡狗抱枕",
        "count": 1
      },
      {
        "name": "微信气泡狗钥匙扣",
        "count": 1
      }
    ]
  },
  "insured": {
    "use_insured": 1,
    "insured_value": 10000
  },
  "service": {
    "service_type": 0,
    "service_name": "标准快递"
  }
}

返回值说明

属性 类型 说明
order_id string 订单ID,下单成功时返回
waybill_id string 运单ID,下单成功时返回
waybill_data Array.<Object> 运单信息,下单成功时返回
errcode number 微信侧错误码,下单失败时返回
errmsg string 微信侧错误信息,下单失败时返回
delivery_resultcode number 快递侧错误码,下单失败时返回
delivery_resultmsg string 快递侧错误信息,下单失败时返回

waybill_data 的结构

属性 类型 说明
key string 运单信息 key
value string 运单信息 value

返回示例

下单成功

{
  "order_id": "01234567890123456789",
  "waybill_id": "123456789",
  "waybill_data": [
    {
      "key": "SF_bagAddr",
      "value": "广州"
    },
    {
      "key": "SF_mark",
      "value": "101- 07-03 509"
    }
  ]
}

下单失败

{
  "errcode": 9300501,
  "errmsg": "delivery logic fail",
  "delivery_resultcode": 10002,
  "delivery_resultmsg": "客户密码不正确"
}

错误码说明

说明
0 成功
-1 系统失败
47001 解析 JSON/XML 格式错误
40003 openid无效
9300502 快递公司系统错误
9300501 快递侧逻辑错误,详细原因需要看 delivery_resultcode,
建议请先确认一下编码方式,python建议 json.dumps(b, ensure_ascii=False),php建议 json_encode($arr, JSON_UNESCAPED_UNICODE)
9300503 delivery_id 不存在
9300510 service_type 不存在
9300526 字段长度不正确
930561 参数错误
9300525 bizid未绑定
9300534 add_source=2时,wx_appid和当前小程序不同主体
9300535 shop字段商品缩略图 url、商品名称为空或者非法,或者商品数量为0
9300536 add_source=2时,wx_appid无效
9300531 bizid无效
930564 沙盒环境调用无配额
930559 沙盒环境openid无效
其他错误码 请查看全局错误码