产品模块
- 2021-07-28 09:21:26
- 王于听
- 3420
- 最后编辑：刘若谷 于 2021-08-09 17:31:24
- 分享链接
一、获取产品列表
请求地址：GET /api.php/v1/crm/products
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
参数列表：
|
字段 |
必填 | 默认值 | 描述 |
| mode | 否 | browse |
browse:全部产品 |
| status |
否 |
all |
normal: 正常 developing: 研发中 offline: 下线 |
| category |
否 |
null | 产品分类 |
| orderBy |
否 |
id_desc |
按照 "_" 字符前面的字段进行排序 desc为降序 asc 为升序 |
|
timeFormat |
否 | null |
系统默认返回的日期格式: YYYY-MM-DD HH:ii:ss 传入参数utc后返回的日期格式:
YYYY-MM-DDTHH:ii:ssZ
|
|
total |
否 |
0 |
总条数 |
|
limit |
否 |
20 |
分页数量 |
|
page |
否 |
1 |
当前页数 |
curl --location --request GET 'https://biz.demo.zdoo.com/api.php/v1/crm/products/' \ --header 'Token: my-token' \ --header 'Accept-Language: zh-CN,zh' \ --header 'Content-Type: application/json'
返回结果(200)：
{
"status": "success",
"data": {Objects}
}
|
字段 |
类型 | 描述 |
|
title |
string | 标题 |
|
products |
object | 产品列表 |
| pager | object | 分页信息 |
|
appProducts |
array |
APP产品列表 |
|
categories |
array |
产品类型 |
|
subjects |
object |
收入科目 |
|
units |
object |
单位 |
|
store |
object |
仓库 |
二、获取产品详情
请求地址：GET /api.php/v1/crm/products/:id
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
请求示例：
curl --location --request GET 'https://biz.demo.zdoo.com/api.php/v1/crm/products/1' \ --header 'Token: my-token' \ --header 'Accept-Language: zh-CN,zh' \ --header 'Content-Type: application/json'
返回结果(200)：
{
"status": "success",
"data": {Objects}
}
|
字段 |
类型 | 描述 |
|
title |
string | 页面标题 |
| product | object | 产品信息 |
|
units |
array | 单位 |
| categories | object | 分类信息 |
| users | object | 相关用户名 |
三、创建产品信息
请求地址：POST /api.php/v1/crm/products
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
请求BODY：
| 字段 | 必填 | 类型 | 描述 |
| name | 是 | string | 名称 |
| code | 否 | string | 代号 |
| category | 否 | string |
分类 |
|
subject |
否 |
string | 收入科目 |
|
type |
是 |
string |
类型 |
|
status |
否 |
string | 状态 |
|
model |
是 |
string | 规格 |
|
brand
|
否 | string |
品牌 |
|
store |
否 |
string |
仓库 |
|
barcode |
否 |
string |
条形码 |
|
unit |
否 |
string |
单位 |
|
amount |
否 |
string |
数量 |
|
desc |
否 |
string |
简介 |
|
uid |
否 | string |
附件id |
请求示例：
curl --location --request POST 'https://biz.demo.zdoo.com/api.php/v1/crm/products' \
--header 'Token: my-token' \
--header 'Accept-Language: zh-CN,zh' \
--header 'Content-Type: application/json' \
--data-raw '{"name":"测试产品123","code":"","category":"0","subject":"0","type":"real","status":"normal","model":"0","brand":"","store":"0","barcode":"","unit":"0","amount":"","desc":"","uid":"test1627367100131"}'
返回结果(200)：
{
"result": "success",
"message": "保存成功",
"locate": "/crm/api.php?m=product&f=browse&t=",
}
返回结果(400)：
{
"error": errorMessage
}
四、修改产品信息
请求地址：PUT /api.php/v1/crm/products/:id
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
请求BODY：
| 字段 | 必填 | 类型 | 描述 |
| name | 是 | string | 名称 |
| code | 否 | string | 代号 |
| category | 否 | string |
分类 |
|
subject |
否 |
string | 收入科目 |
|
type |
是 |
string |
类型 |
|
status |
否 |
string | 状态 |
|
model |
是 |
string | 规格 |
|
brand
|
否 | string |
品牌 |
|
store |
否 |
string |
仓库 |
|
barcode |
否 |
string |
条形码 |
|
unit |
否 |
string |
单位 |
|
amount |
否 |
string |
数量 |
|
desc |
否 |
string |
简介 |
|
uid |
否 | string |
附件id |
请求示例：
curl --location --request PUT 'https://biz.demo.zdoo.com/api.php/v1/crm/products/1' \
--header 'Token: my-token' \
--header 'Accept-Language: zh-CN,zh' \
--header 'Content-Type: application/json' \
--data-raw '{"name":"测试产品123","code":"","category":"0","subject":"0","type":"real","status":"normal","model":"0","brand":"","store":"0","barcode":"","unit":"0","amount":"","desc":"","uid":"test1627367100131"}'
返回结果(200)：
{
"result": "success",
"message": "保存成功", "locate": "reload"
}
返回结果(400):{
"error": errorMessage
}
五、根据某合同关联的产品列表
请求地址：GET /api.php/v1/crm/contracts/:contractID/products
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
返回结果(200)：
{
"status": "success",
"products": [{"product":1, "amount": 10, "price": 10, "money": 10}]
}
|
字段 |
类型 | 描述 |
|
product |
number | 产品id |
| amount | number | 数量 |
| price | number | 单价 |
| money | number | 总价 |