该API用于查看目前设置的所有合同的优惠券预算情况。用于优惠券的预算是根据合同条件按月设置的，因此可按照合同及月份查看。
路径
GET
/v2/providers/fms/apis/api/v1/vendors/{vendorId}/budgets
示例
请求参数
|
Name |
|
Required |
Type |
Description |
|
vendorId |
O |
|
String |
卖家ID 酷澎分配给卖家的固有代码 e.g.) A00012345 |
链接查询参数
|
Name |
Required |
Type |
Description |
|
contractId |
|
Number |
卖家合同Id (自由合同，输入 -1) |
|
targetMonth |
|
String |
想要查看预算的月份 yyyy-MM 若不输入targetmonth，查看的就是当月预算 |
请求体
无
返回消息
|
Name |
Type |
Description |
||
|
code |
Number |
服务器响应代码 |
||
|
message |
String |
服务器响应信息 |
||
|
httpStatus |
Number |
HTTP状态代码 (与服务器响应代码的值相同) |
||
|
httpStatusMessage |
String |
HTTP 状态信息 (与服务器响应信息的值相同) |
||
|
errorMessage |
String |
除HTTP Status 200以外，剩下Status 中包含服务器详细失败原因信息 |
||
|
data |
Array |
预算情况列表数据 |
||
|
|
success |
Boolean |
成功与否 true or false |
|
|
|
content |
Array |
预算情况列表 |
|
|
|
|
contractId |
Number |
卖家合同Id e.g.) 1, 2 |
|
|
|
targetMonth |
String |
想要查看预算的月份 |
|
|
|
|
|
e.g.) 2017-08 |
|
|
|
vendorShareRatio |
Number |
分摊比例(%) : 合同中规定的与酷澎的分摊比例 e.g.) 100 |
|
|
|
totalBudgetAmount |
Number |
当月设置的预算 e.g.) 1000000 |
|
|
|
usedBudgetAmount |
Number |
当月使用了的预算 e.g.) 50.00 |
|
|
Pagination |
Array |
分页 |
|
|
|
|
countPerPage |
Number |
每页的数据数量 e.g.) 10, 20, 30 |
|
|
|
currentPage |
Number |
当前页面 e.g.) 1 |
|
|
|
totalPages |
Number |
总页数 e.g.) 1000 |
|
|
|
totalElements |
Number |
总数据数量 e.g.) 1000 |
返回消息示例
{
"code": 200,
"message": "OK",
"httpStatus": 200,
"httpStatusMessage": "OK",
"errorMessage": "",
"data": {
"success": true,
"content": [
{
"contractId": 2,
"targetMonth": "2017-08",
"vendorShareRatio": 100,
"totalBudgetAmount": 1000000,
"usedBudgetAmount": 50
}
],
"pagination": null
}
}错误信息
|
HTTP status code (error type) |
Error message |
Solution |
|
401 (Check the requested parameter) |
请确认卖家权限。 |
查看卖家ID（vendorid）值是否输入正确 |
|
400 (Check the requested parameter) |
无效格式: \"2020\"太短了 |
确认想要查看预算的月份（targetMonth）值是否输入正确。 |