合同模版列表
| 拥有此API的权限集 |
|---|
| 订单管理-查询 |
请求方式及url
- 请求方式：
POST - 请求头：
Content-Type:application/json - 接口地址：
https://api.xiaoe-tech.com/xe.contract.template.list/1.0.0 - 频率限制：
10秒600次
在线调试工具
请求
响应
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| access_token | 是 | string | 专属token |
| resource_name | 否 | string | 课程名称(template_type=0生效) |
| template_id | 否 | string | 模拟id |
| template_name | 否 | string | 模版名称 |
| template_type | 否 | int | 0:文档列表，1:模版列表 |
| page | 是 | int | 页码 |
| page_size | 是 | int | 每页条数,最大100 |
请求示例
{
"template_type": 0,
"template_name": "雪糕",
"template_id": "",
"resource_name": "",
"page": 1,
"page_size": 10
}
返回参数
| 参数名 | 必选 | 类型 | 说明 | 备注 |
|---|---|---|---|---|
| code | 是 | int | 返回码 | 0-成功，其他失败 |
| msg | 是 | string | 返回信息 | ok |
| data | 是 | json对象 | 返回值 | ... |
| data.count | 是 | int | 总数 | 70 |
| data.list | 是 | array | 订单列表 | [...] |
| data.list[].app_id | 是 | string | 店铺ID | app_xxx |
| data.list[].created_at | 是 | string | 创建时间 | 2025-04-09 14:32:24 |
| data.list[].free_login | 是 | int | 1法大大签署页面免登录，0需要登录 | 0 |
| data.list[].goods_count | 是 | int | 关联商品数量(template_type=0有效) | 2 |
| data.list[].sign_step | 是 | string | BEFORE_PAY支付前签署,AFTER_PAY 支付后签署(template_type=0有效) | BEFORE_PAY |
| data.list[].sync_at | 是 | string | 同步时间 | 2025-04-09 14:32:24 |
| data.list[].template_id | 是 | string | 模板iD | 17441679063xxx95584 |
| data.list[].template_name | 是 | string | 模板名称 | 雪糕合同 |
| data.list[].template_state | 是 | string | 模板状态,valid启动，invalid停用 | invalid |
| data.list[].updated_at | 是 | string | 更新时间 | 2025-04-09 14:32:24 |
备注
code=0时，msg:code!=0时，msg:获取合同模板列表失败
返回示例
{
"code": 0,
"msg": "ok",
"data": {
"list": [
{
"app_id": "app***3009",
"created_at": "2025-04-02 17:00:22",
"free_login": 0,
"goods_count": 0,
"resource_type": [],
"sign_step": "AFTER_PAY",
"sync_at": "2025-04-02 17:01:42",
"template_id": "1743584422694185299",
"template_name": "冰棍儿文档_副本1",
"template_state": "valid",
"updated_at": "2025-04-02 17:01:16"
}
],
"count": 1
}
}