# 获取面单模板信息

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

接口英文名:ewaybill_gettemplate

可通过该接口获取面单模板信息

# 1. 调用方式

# HTTPS 调用

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

# 云调用

  • 本接口不支持云调用

# 第三方调用

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

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

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

# 2. 请求参数

# 查询参数 Query String parameters

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

# 请求体 Request Payload

参数名类型必填说明
delivery_idstring快递公司编码

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
total_templateobjarray所有快递公司模板信息汇总

# Res.total_template(Array) Object Payload

所有快递公司模板信息汇总

参数名类型说明
delivery_idstring某个快递公司模板信息汇总
default_template_idstring该快递公司的默认模板id
template_listobjarray模板信息列表

# Res.total_template(Array).template_listObject Payload

模板信息列表

参数名类型说明
template_idstring模板id
template_namestring模板名,同一快递公司下不可重复
template_descstring模板描述 默认填 "一联单标准模板"
template_typestring模板类型 默认填 "single"
create_timenumber模板创建时间
update_timenumber模板更新时间
is_defaultboolean是否为该快递公司默认模板
optionsobjarray模板信息选项,总数必须为8个,顺序按照数组序

# Res.total_template(Array).template_list.optionsObject Payload

模板信息选项,总数必须为8个,顺序按照数组序

参数名类型说明
option_idnumber信息类型,填0-7,枚举值详情请参考下文
font_sizenumber打印字号
is_boldboolean字体是否加粗
is_openboolean是否选用此信息

# 4. 注意事项

option_id信息类型

枚举值 描述
0 商品总数量
1 商品名称+规格+编码+数量
2 商品名称+规格+数量
3 商品名称+数量
4 店铺名称
5 订单号
6 买家留言
7 卖家备注

# 5. 代码示例

请求示例

{
   "delivery_id":"xxxx"
}

返回示例

{
	"errcode": 0,
	"errmsg": "ok",
	"total_template": [{
		"default_template_id": "66xxxxxxxxx",
		"delivery_id": "YTO",
		"template_list": [{
			"is_default": true,
			"template_desc": "一联单标准模板",
			"template_id": "66xxxxxxxx",
			"template_name": "一联单zzz",
			"template_type": "single",
			"update_time": "1690426204",
			"create_time": "1690426204",
			"options": [{
					"option_id": 0,
					"font_size": 0,
					"is_bold": false,
					"is_open": false
				},
				{
					"option_id": 1,
					"font_size": 0,
					"is_bold": false,
					"is_open": true
				},
				{
					"option_id": 2,
					"font_size": 0,
					"is_bold": false,
					"is_open": false
				},
				{
					"option_id": 3,
					"font_size": 0,
					"is_bold": false,
					"is_open": false
				},
				{
					"option_id": 4,
					"font_size": 0,
					"is_bold": false,
					"is_open": true
				},
				{
					"option_id": 5,
					"font_size": 0,
					"is_bold": false,
					"is_open": true
				},
				{
					"option_id": 6,
					"font_size": 0,
					"is_bold": false,
					"is_open": true
				},
				{
					"option_id": 7,
					"font_size": 0,
					"is_bold": false,
					"is_open": true
				}
			]
		}]
	}]
}

# 6. 错误码

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

错误码错误描述解决方案
10025102快递公司不支持
10025120电子面单帐号为空,请新增帐号
10025125模板列表为空,请新增模板

# 7. 适用范围

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