订单模块
- 2021-07-28 09:19:06
- 王于听
- 2674
- 最后编辑：刘若谷 于 2021-08-09 17:23:11
- 分享链接
一、获取订单列表
请求地址：GET /api.php/v1/crm/orders
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
参数列表：
|
字段 |
必填 | 默认值 | 描述 |
| mode | 否 | all |
all:全部订单 assignedTo：指派给我的订单 contactedby：由我联系的订单 past：亟需联系的订单 today：今天联系的订单 tomorrow：明天联系的订单 thisweek：本周内联系的订单 thismonth：本月内联系的订单 public：公共客户 |
| orderBy |
否 |
id_desc |
按照 "_" 字符前面的字段进行排序 desc为降序 asc 为升序 |
|
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/orders/' \ --header 'Token: my-token' \ --header 'Accept-Language: zh-CN,zh' \ --header 'Content-Type: application/json'
返回结果(200)：
{
"data": {
"status": "success",
"data": {Objects}
}
}
|
字段 |
类型 | 描述 |
|
title |
string | 页面标题 |
| orders | object | 订单列表 |
| users | object | 相关的用户名 |
| pager | object | 分页信息 |
| mode | string |
筛选条 件
all:全部订单 assignedTo：指派给我的订单 contactedby：由我联系的订单 past：亟需联系的订单 today：今天联系的订单 tomorrow：明天联系的订单 thisweek：本周内联系的订单 thismonth：本月内联系的订单 public：公共客户
|
| orderBy | string |
按照 "_" 字符前面的字段进行排序 desc为降序 asc 为升序 |
|
currencySign |
object | 货币符号 |
|
currencyList |
object | 货币类型 |
|
totalAmount |
object | 当前结果中总订单的计划金额和成交金额 |
二、获取订单详情
请求地址：GET /api.php/v1/crm/orders/: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/orders/1' \ --header 'Token: my-token' \ --header 'Accept-Language: zh-CN,zh' \ --header 'Content-Type: application/json'
返回结果(200)：
{
"data": {
"status": "success",
"data": {Objects}
}
}
|
字段 |
类型 | 描述 |
|
title |
string | 页面标题 |
| order | object | 订单信息 |
| products | object | 相关的产品名 |
| customer | object | 所属客户信息 |
| conrtact | object | 所属合同信息 |
| contact | object | 所属联系人信息 |
| users | object | 相关用户名 |
|
currencySign |
object | 货币符号 |
|
currencyList |
object | 货币类型 |
|
preAndNext |
object | 上一条和下一条订单信息 |
|
appOperate |
array | 移动端所属该订单的动作 |
三、创建订单信息
请求地址：POST /api.php/v1/crm/orders
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
请求BODY：
| 字段 | 必填 | 类型 | 描述 |
| customer | 是 | int | 所属客户 |
| product | 是 | array | 产品ID |
| unit | 否 | array |
产品单位 |
|
price |
否 |
array | 产品单价 |
|
amount |
是 |
array |
产品数量 |
|
money |
否 |
array | 产品金额 |
|
currency |
否 |
string | 货币类型 |
|
plan |
否 | float |
计划金额 |
参数列表：
|
字段 |
必填 | 默认值 | 描述 |
|
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/orders' \
--header 'Token: my-token' \
--header 'Accept-Language: zh-CN,zh' \
--header 'Content-Type: application/json' \
--data-raw '{"customer": "1","currency": "rmb","plan": "15.00","product": ["1", "2"],"unit": ["件","次"],"price": ["11.00","2"],"amount": ["1","2"],"money": ["11.00","4.00"]}'
返回结果(200)：
{
"data": {
"result": "success",
"message": "保存成功",
"locate": "/crm/api.php?m=order&f=browse&t=",
"orderID": "57"
}
}
返回结果(400)：
{
"error": errorMessage
}
四、修改订单信息
请求地址：PUT /api.php/v1/crm/orders/:id
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
请求BODY：
| 字段 | 必填 | 类型 | 描述 |
| customer | 否 | int | 所属客户 |
| product | 否 | array | 产品ID |
| unit | 否 | array |
产品单位 |
|
price |
否 |
array | 产品单价 |
|
amount |
否 | array |
产品数量 |
|
money |
否 |
array | 产品金额 |
|
plan |
否 | float |
计划金额 |
参数列表：
|
字段 |
必填 | 默认值 | 描述 |
|
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/orders/1' \
--header 'Token: my-token' \
--header 'Accept-Language: zh-CN,zh' \
--header 'Content-Type: application/json' \
--data-raw '{"customer": "1","currency": "rmb","plan": "15.00","product": ["1", "2"],"unit": ["件","次"],"price": ["11.00","2"],"amount": ["1","2"],"money": ["11.00","4.00"]}'
返回结果(200)：
{
"data": {
"result": "success",
"message": "保存成功",
"locate": "/crm/api.php?m=order&f=view&t=&orderID=55"
}
}
返回结果(400):{
"error": errorMessage
}
