# 获取面单模板信息

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：ewaybill_gettemplate

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

相关文档：
[微信小店「电子面单操作」使用指南](https://store.weixin.qq.com/chengzhang/webdoc/wiki/540/8928bda6d81898f4/growth_center_manual_for_store)

## 1. 调用方式

### HTTPS 调用

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

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口支持第三方平台代供货商调用。[第三方服务商调用模式介绍](/doc/store/supplier/product/service_market_desc)

- 该接口所属的权限集 id 为：130、159、192

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代供货商进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/doc/store/supplier/api/basics/api_getaccesstoken)（供货商）、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)（服务商代调用）"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "delivery_id",
    "类型": "string",
    "必填": "否",
    "说明": "快递公司编码"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "total_template",
    "类型": "objarray",
    "说明": "所有快递公司模板信息汇总"
  }
]
```

">

### Res.total_template(Array) `Object Payload`

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

```json
[
  {
    "参数名": "delivery_id",
    "类型": "string",
    "说明": "某个快递公司模板信息汇总"
  },
  {
    "参数名": "default_template_id",
    "类型": "string",
    "说明": "该快递公司的默认模板id"
  },
  {
    "参数名": "template_list",
    "类型": "objarray",
    "说明": "模板信息列表"
  }
]
```

__template_list">

### Res.total_template(Array).template_list `Object Payload`

模板信息列表

```json
[
  {
    "参数名": "template_id",
    "类型": "string",
    "说明": "模板id"
  },
  {
    "参数名": "template_name",
    "类型": "string",
    "说明": "模板名，同一快递公司下不可重复"
  },
  {
    "参数名": "template_desc",
    "类型": "string",
    "说明": "模板描述 默认填 \"一联单标准模板\""
  },
  {
    "参数名": "template_type",
    "类型": "string",
    "说明": "模板类型 默认填 \"single\""
  },
  {
    "参数名": "create_time",
    "类型": "number",
    "说明": "模板创建时间"
  },
  {
    "参数名": "update_time",
    "类型": "number",
    "说明": "模板更新时间"
  },
  {
    "参数名": "is_default",
    "类型": "boolean",
    "说明": "是否为该快递公司默认模板"
  },
  {
    "参数名": "options",
    "类型": "objarray",
    "说明": "模板信息选项，总数必须为8个，顺序按照数组序"
  }
]
```

__template_list__options">

### Res.total_template(Array).template_list.options `Object Payload`

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

```json
[
  {
    "参数名": "option_id",
    "类型": "number",
    "说明": "信息类型，填0-7",
    "枚举": "枚举值"
  },
  {
    "参数名": "font_size",
    "类型": "number",
    "说明": "打印字号",
    "枚举": "-"
  },
  {
    "参数名": "is_bold",
    "类型": "boolean",
    "说明": "字体是否加粗",
    "枚举": "-"
  },
  {
    "参数名": "is_open",
    "类型": "boolean",
    "说明": "是否选用此信息",
    "枚举": "-"
  }
]
```

## 4. 枚举信息

__template_list__options__option_id">

### Res.total_template(Array).template_list.options.option_id `Enum`

信息类型，填0-7

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

## 5. 注意事项

## 6. 代码示例

请求示例

```json
{
   "delivery_id":"xxxx"
}
```

返回示例

```json
{
	"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
				}
			]
		}]
	}]
}
```

## 7. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/store/shop/dev_before/commErrCode.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "10025102",
    "错误描述": "快递公司不支持"
  },
  {
    "错误码": "10025120",
    "错误描述": "电子面单帐号为空，请新增帐号"
  },
  {
    "错误码": "10025125",
    "错误描述": "模板列表为空，请新增模板"
  }
]
```

## 8. 适用范围

本接口在不同账号类型下的可调用情况：

```json
[
  {
    "微信小店": "✔",
    "小店供货商": "✔"
  }
]
```

- ✔：该账号可调用此接口。
- 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口。