供应商模块
- 2021-07-28 09:19:06
- 王于听
- 4710
- 最后编辑：刘若谷 于 2021-08-09 17:29:32
- 分享链接
一、获取供应商列表
请求地址：GET /api.php/v1/crm/providers
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
参数列表：
|
字段 |
必填 | 默认值 | 描述 |
| mode | 否 | all |
all:全部订单 |
| sort |
否 |
id_desc |
按照 "_" 字符前面的字段进行排序 desc为降序 asc 为升序 |
|
showAll |
否 | yes |
yes:返回所有数据和字段 no: 仅返回部分数据和字段 |
|
page |
否 |
1 | 页码 |
| limit | 否 | 20 | 每页显示行数 |
|
timeFormat |
否 | null |
系统默认返回的日期格式: YYYY-MM-DD HH:ii:ss 传入参数utc后返回的日期格式:
YYYY-MM-DDTHH:ii:ssZ
|
curl --location --request GET 'https://biz.demo.zdoo.com/api.php/v1/crm/providers/' \ --header 'Token: my-token' \ --header 'Accept-Language: zh-CN,zh' \ --header 'Content-Type: application/json'
返回结果(200)：
{
"data": {
"status": "success",
"data": {Objects}
}
}
|
字段 |
类型 | 描述 |
|
title |
string | 页面标题 |
| providers | object | 供应商列表 |
| areas | object | 区域信息 |
|
industries |
object | 行业信息 |
|
treeMenu |
string | 类目信息 |
| pager | object | 分页信息 |
| mode | string |
筛选条 件
all:全部订单 |
| orderBy | string |
按照 "_" 字符前面的字段进行排序 desc为降序 asc 为升序 |
二、获取供应商详情
请求地址：GET /api.php/v1/crm/providers/:id
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
参数列表：
|
字段 |
必填 | 默认值 | 描述 |
|
showAll |
否 | yes |
yes:返回所有数据和字段 no: 仅返回部分数据和字段 |
|
timeFormat |
否 | null |
系统默认返回的日期格式: YYYY-MM-DD HH:ii:ss 传入参数utc后返回的日期格式:
YYYY-MM-DDTHH:ii:ssZ
|
请求示例：
curl --location --request GET 'https://biz.demo.zdoo.com/api.php/v1/crm/providers/1' \ --header 'Token: my-token' \ --header 'Accept-Language: zh-CN,zh' \ --header 'Content-Type: application/json'
返回结果(200)：
{
"data": {
"status": "success",
"data": {Objects}
}
}
|
字段 |
类型 | 描述 |
|
title |
string | 页面标题 |
| provider | object | 供应商信息 |
| areas | object | 区域信息 |
|
industries |
object | 行业信息 |
|
appOperate |
array | 移动端所属动作 |
三、创建供应商信息
请求地址：POST /api.php/v1/crm/providers
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
请求BODY：
| 字段 | 必填 | 类型 | 描述 |
| name | 否 | string | 名称 |
| category |
否 |
int | 类目 |
|
contact |
是 | string |
联系人名称 |
|
mobile |
否 |
string | 联系人手机 |
|
phone |
否 |
string |
联系人座机 |
|
email |
否 |
string | 联系人邮箱 |
|
qq |
否 |
string | 联系人QQ |
|
type |
否 |
string |
类型 |
|
size |
否 |
string | 规模 |
|
industry |
否 |
string | 行业 |
|
area |
否 | string | 区域 |
|
weibo |
否 | string | 微博 |
|
weixin |
否 |
string | 微信 |
|
site |
否 |
string | 网站 |
|
depositor |
否 | string | 对公账户 |
|
desc |
否 | string | 简介 |
| continue | 否 | bool | 是否跳过名称 验证 |
参数列表：
|
字段 |
必填 | 默认值 | 描述 |
|
showAll |
否 | yes |
yes:返回所有数据和字段 no: 仅返回部分数据和字段 |
|
timeFormat |
否 | null |
系统默认返回的日期格式: YYYY-MM-DD HH:ii:ss 传入参数utc后返回的日期格式:
YYYY-MM-DDTHH:ii:ssZ
|
请求示例：
curl --location --request POST 'https://biz.demo.zdoo.com/api.php/v1/crm/providers' \
--header 'Token: my-token' \
--header 'Accept-Language: zh-CN,zh' \
--header 'Content-Type: application/json' \
--data-raw '{"contact": "联系人名称", "continue": "ture", "phone": "13387786173"}'
返回结果(200)：
{
"data": {
"result": "success",
"message": "保存成功",
"locate": "/crm/api.php?m=provider&f=browse&t=",
"customerID": "1"
}
}
返回结果(400)：
{
"error": errorMessage
}
四、修改供应商信息
请求地址：PUT /api.php/v1/crm/providers/:id
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
请求BODY：
| 字段 | 必填 | 类型 | 描述 |
| name | 是 | string | 名称 |
| category |
否 |
int | 类目 |
| relation | 否 | string | 关系 |
|
type |
否 |
string |
类型 |
|
size |
否 |
string | 规模 |
|
industry |
否 |
string | 行业 |
|
area |
否 | string | 区域 |
|
weibo |
否 | string | 微博 |
|
weixin |
否 |
string | 微信 |
|
site |
否 |
string | 网站 |
|
depositor |
否 | string | 对公账户 |
|
desc |
否 | string | 简介 |
| continue | 否 | bool |
是否跳过名称
验证 |
参数列表：
|
字段 |
必填 | 默认值 | 描述 |
|
showAll |
否 | yes |
yes:返回所有数据和字段 no: 仅返回部分数据和字段 |
|
timeFormat |
否 | null |
系统默认返回的日期格式: YYYY-MM-DD HH:ii:ss 传入参数utc后返回的日期格式:
YYYY-MM-DDTHH:ii:ssZ
|
请求示例：
curl --location --request PUT 'https://biz.demo.zdoo.com/api.php/v1/crm/providers/1' \
--header 'Token: my-token' \
--header 'Accept-Language: zh-CN,zh' \
--header 'Content-Type: application/json' \
--data-raw '{"name": "供应商名称"}'
返回结果(200)：
{
"data": {
"result": "success",
"message": "保存成功",
"locate": "/crm/api.php?m=provider&f=view&t=&providerID=44" }
}
{
"error": errorMessage
}