# 电子面单取号

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:ewaybill_createorder

可通过该接口发起电子面单取号

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/channels/ec/logistics/ewaybill/biz/order/create?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:130、159

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填说明
ewaybill_order_idstring电子面单订单id,全局唯一id(从预取号接口获取或者自定义),注意该字段类型用String传递,但是数据内容要求是Uint64
delivery_idstring快递公司id
site_codestring网点编码
ewaybill_acct_idstring电子面单账号id (从查询开通账号信息接口获取
senderobject寄件人,传明文
receiverobject收件人,传小店订单内的用户收件人的信息文本即可。注:此字段只做非空参数校验,实际使用的收件人地址是小店订单内的用户地址,若收件人地址有误,可以联系用户修改订单收件地址或者调用修改地址接口
ec_order_listobjarray订单信息
remarkstring备注
shop_idstring店铺id(从查询开通账号信息接口获取)
return_addressobject退货地址
template_idstring如果需要获取打印报文,则填该字段。回包返回print_info。 如无需使用后台模板,可直接传递template_type做为默认模板, 如‘single’
order_typenumber支持的类型,陆续更新中,枚举值详情请参考下文,默认为1,加盟型可以不填
order_vas_listobjarray保价等增值服务
ext_infoobject温层等补充字段
delivery_infoobject预约上门取件、子母件等发货信息字段

# Body.sender Object Payload

寄件人,传明文

参数名类型必填说明
namestring人名
mobilestring联系电话
provincestring
citystring
countystring
streetstring街道(收件人非必填)
addressstring详细地址

# Body.receiver Object Payload

收件人,传小店订单内的用户收件人的信息文本即可。注:此字段只做非空参数校验,实际使用的收件人地址是小店订单内的用户地址,若收件人地址有误,可以联系用户修改订单收件地址或者调用修改地址接口

参数名类型必填说明
namestring人名
mobilestring联系电话
provincestring
citystring
countystring
streetstring街道(收件人非必填)
addressstring详细地址

# Body.ec_order_list(Array) Object Payload

订单信息

参数名类型必填说明
ec_order_idnumber订单id
goods_listobjarray订单商品信息
ewaybill_order_codestring代发的订单密文
ewaybill_order_appidstring代发的订单所属店铺appid

# Body.return_address Object Payload

退货地址

参数名类型必填说明
namestring人名
mobilestring联系电话
provincestring
citystring
countystring
streetstring街道(收件人非必填)
addressstring详细地址

# Body.order_vas_list(Array) Object Payload

保价等增值服务

参数名类型必填说明
vas_typestring增值服务类型,目前支持的增值服务,详情参考下文
vas_valuestring增值服务描述
vas_detailstring增值服务值, 涉及金额单位一律为分

# Body.ext_info Object Payload

温层等补充字段

参数名类型必填说明
temperature_rangenumber0或不传则为月结账号的默认温层信息 1:普通/常温 5:鲜活 6:控温 7:冷藏 8:冷冻 9:深冷 使用条件:温层信息,京东专用
package_weight_gnumber包裹总重量:单位 g 使用条件:包裹信息字段仅支持与与菜鸟互有信任协议商家使用
package_space_xnumber包裹长度:单位 cm 使用条件:包裹信息字段仅支持与与菜鸟互有信任协议商家使用
package_space_ynumber包裹宽度:单位 cm 使用条件:包裹信息字段仅支持与与菜鸟互有信任协议商家使用
package_space_znumber包裹高度:单位 cm 使用条件:包裹信息字段仅支持与与菜鸟互有信任协议商家使用
package_volume_ccmnumber包裹体积:单位 cm3 使用条件:包裹信息字段仅支持与与菜鸟互有信任协议商家使用

# Body.delivery_info Object Payload

预约上门取件、子母件等发货信息字段

参数名类型必填说明
delivery_typenumber发货方式,0:仓库发货,1:门店预约发货 门店发货说明:delivery_type不传默认的发货方式是仓库发货,取件地址和取件联系人商家是和快递公司线下签约商定的地址;门店预约发货的取件地址以sender字段传入的地址为准,目前支持门店预约发货的快递公司有:顺丰速运
collected_time_beginnumber预约上门开始时间,秒级时间戳,delivery_type=1时必填
collected_time_endnumber预约上门结束时间,秒级时间戳,delivery_type=1时必填
package_quantitynumber子母件包裹的数量,要求 2 <= package_quantity <= 300 子母件说明:package_quantity不传默认是普通件,package_quantity>=2则生成子母件
subpackage_listobjarray包裹的体积和重量信息,顺丰支持该字段

# Body.ec_order_list(Array).goods_listObject Payload

订单商品信息

参数名类型必填说明
good_namestring商品名
good_countnumber商品个数
product_idnumber商品product_id
sku_idnumber商品sku_id
out_product_idstring商家自定义spu_id
out_sku_idstring商家自定义sku_id
out_goods_infostring商家自定义商品详情(如果不传平台的商品id的话,会展示该字段在面单商品区域)
goods_extstring商家自定义的额外的商品信息,向快递公司透传,限制长度512

# Body.delivery_info.subpackage_list(Array) Object Payload

包裹的体积和重量信息,顺丰支持该字段

参数名类型必填说明
weight_gnumber商品重量,单位克
space_xnumber商品长度,单位厘米
space_ynumber商品宽度,单位厘米
space_znumber商品高度,单位厘米
package_nostring包裹编号

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
ewaybill_order_idstring电子面单订单id
waybill_idstring快递单号
delivery_error_msgstring快递公司错误码
print_infostring如果请求参数填了template_id,则返回打印报文信息,可以传给打印组件打印面单。
waybill_id_listobjarray子母单号列表
order_risk_infoobjarray商品订单存被判断疑似存在风险时返回

# Res.waybill_id_list(Array) Object Payload

子母单号列表

参数名类型说明
waybill_idstring快递单号
waybill_typenumber快递单号类型,1:母单号,2:子单号
create_timenumber单号创建时间,秒级时间戳

# Res.order_risk_info(Array) Object Payload

商品订单存被判断疑似存在风险时返回

参数名类型说明
risk_ec_order_infoobject疑似存在风险的订单目录
risk_msgstring风险信息内容

# Res.order_risk_info(Array).risk_ec_order_info Object Payload

疑似存在风险的订单目录

参数名类型说明
ec_order_idnumber订单id
goods_listobjarray订单商品信息
ewaybill_order_codestring代发的订单密文
ewaybill_order_appidstring代发的订单所属店铺appid

# Res.order_risk_info(Array).risk_ec_order_info.goods_listObject Payload

订单商品信息

参数名类型说明
good_namestring商品名
good_countnumber商品个数
product_idnumber商品product_id
sku_idnumber商品sku_id
out_product_idstring商家自定义spu_id
out_sku_idstring商家自定义sku_id
out_goods_infostring商家自定义商品详情(如果不传平台的商品id的话,会展示该字段在面单商品区域)
goods_extstring商家自定义的额外的商品信息,向快递公司透传,限制长度512

# 4. 注意事项

  • 如果使用代发模式,填ewaybill_order_code和ewaybill_order_appid即可,不能填ec_order_id字段;
  • ewaybill_order_code可从小店订单详情接口获取;
  • 代发模式下,例如店铺A打印店铺B的订单,只有订单字段ewaybill_order_code和ewaybill_order_appid是店铺B的,其他参数(网点,模版等)均是店铺A的;
  • 增值服务在使用之前,请先和快递公司或者网点确认可用。
  • 目前支持子母单的快递公司有顺丰速运、德邦快递、京东快递
  • 子母单打印必须安装最新的微信小店打印组件,可在组件内更新或者前往打印组件内下载。打印组件指南

vas_type增值服务类型

快递公司 vas_type vas_detail vas_value
SF INSURE 基础保 {"value":"500"}
SF IN160 定额保 {"value":"500"}
SF IN159 足额保 {"value":"500"}
SF IN67 纸箱 -
CNSD VA002 标准保价 保价金额,单位:分
DBKD insuranceValue 保价 保价金额,单位:分
STO INSURE_SERVICE 保价业务 保价金额,单位:分
JD 1 普通保价-快递 保价金额,单位:分
JD 2 包装 -
EMS insuranceFlag 保价 保价金额,单位:分

order_type支持的类型

快递公司 枚举值 描述
JD - -
JD 1 京东标快
JD 2 京东特快
JD 3 生鲜标快
JD 4 生鲜特快
JD 5 电商标快
JD 6 特惠包裹
JD 7 京东特惠
JD 8 函速达
JD 11 特快零担
JD 12 特快重货
JD 17 特快专配
SF - 顺丰产品详情
SF 1 顺丰特快
SF 2 顺丰标快
SF 6 顺丰即日
SF 10 国际小包
SF 23 顺丰国际特惠(文件)
SF 24 顺丰国际特惠(包裹)
SF 60 顺丰特快(文件)
SF 144 当日配-门(80CM/1KG以内)
SF 199 特快包裹
SF 201 冷运标快
SF 231 陆运包裹
SF 242 丰网速运
SF 247 电商标快
SF 249 丰礼遇
SF 255 顺丰卡航
SF 263 同城半日达
SF 266 顺丰空配(新)
SF 283 填仓标快
SF 285 填舱电标
SF 303 专享急件
SF 304 特早达
SF 323 电商微小件
SF 325 温控包裹
EMS - -
EMS 1 特快专递(EMS)
EMS 2 快递包裹(youzhengguonei)
EMS 3 邮政电商标快(yzdsbk)
DBKD - -
DBKD 1 大件快递3.60
DBKD 2 标准快递
DBKD 3 特快专递
DBKD 4 航空大件隔日达
DBKD 5 特快次日
DBKD 6 重包入户
DBKD 7 精准卡航(新)
DBKD 8 精准重货(新)
DBKD 9 精准汽运(新)
DBKD 10 小件特惠
DBKD 11 泡货特惠
DBKD 12 重货特惠
DBKD 13 特快当日
DBKD 14 DP联运(K)
DBKD 15 DP联运(L)
KYSY - -
KYSY 1 当天达
KYSY 2 次日达
KYSY 3 隔日件
KYSY 4 陆运件
KYSY 5 空运
KYSY 6 专运
KYSY 7 省内次日
KYSY 8 省内即日
KYSY 9 同城次日
KYSY 10 同城即日
CNSD - -
CNSD 1 默认
CNSD 2 菜鸟电商标快
CNSD 3 菜鸟标快
CNSD 4 同城半日达

# 5. 代码示例

请求示例

{
	"ewaybill_order_id": "1111",
	"delivery_id": "xxxx",
	"site_code": "1111",
	"ewaybill_acct_id": "1111",
	"template_id": "xxx", // 如果需要获取打印报文,则填该字段。回包会返回 print_info。 如无需使用后台模板,可直接传递	template_type做为默认模板, 如‘single’
	"sender": {
		"name": "test",
		"mobile": "1111",
		"province": "静安区",
		"city": "上海市",
		"county": "静安区",
		"street": "xxxxx",
		"address": "xxxxxx"
	},
	"receiver": {
		"name": "test",
		"mobile": "11111",
		"province": "上海市",
		"city": "上海市",
		"county": "青浦区",
		"street": "xxxx",
		"address": "xxxxxxx"
	},
	"ec_order_list": [{
		"ec_order_id": 1111,
		"goods_list": [{
			"good_name": "电子资料书,",
			"good_count": 1,
			"product_id": 111,
			"sku_id": 11
		}]
	}],
	"remark": "test",
	"shop_id": "xxxx",
	"return_address": {
		"name": "test",
		"mobile": "13212778355",
		"province": "上海市",
		"city": "上海市",
		"county": "青浦区",
		"street": "xxxx",
		"address": "xxxxx"
	}
}

返回示例

{
    "errcode": 0,
    "errmsg": "ok",
    "ewaybill_order_id":"111",
    "waybill_id":"1212xzcxz",
    "delivery_error_msg":"xxxx",
    "waybill_id_list":[{
      "waybill_id":"xxxxxx",
      "waybill_type":1,
      "create_time":1732515904,
      "print_info":"xxxx"
    },{
      "waybill_id":"xxxxxx",
      "waybill_type":2,
      "create_time":1732515904,
      "print_info":"xxxx"
    }
    ]
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码

错误码错误描述解决方案
10025005下单失败,具体原因参考delivery_error_msg字段
10025012delivery_id错误
10025013网点信息错误
10025014网点账号编码错误
10025015寄件人信息错误
10025016收件人信息错误
10025017小店订单信息错误
10025018店铺id信息错误
10025019面单已存在
10025029快递公司不支持该功能(预约上门取件等)
10025030 取号请求快递公司接口超时,可稍后重试
10025031快递公司取号接口异常,可稍后重试
10025032快递公司的取号接口异常,可能存在故障,可稍后重试或者更换其他快递公司取号
10025033快递公司取号接口繁忙,可稍后重试或者更换其他快递公司取号
10025035快递公司的取号接口不可用,可稍后重试或者更换其他快递公司取号

# 7. 适用范围

本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。