该API用于查看所设置的单份合同。
路径
GET
/v2/providers/fms/apis/api/v2/vendors/{vendorId}/contract
示例
请求参数
|
Name |
Required |
Type |
Description |
|
vendorId |
O |
String |
卖家ID 酷澎分配给卖家的固有代码 e.g. A00012345 |
链接查询参数
|
Name |
Required |
Type |
Description |
|
contractId |
O |
Number |
卖家合同ID |
请求体
无
返回消息
|
Name |
Type |
Description |
||
|
code |
Number |
服务器响应代码 |
||
|
message |
String |
服务器响应信息 |
||
|
httpStatus |
Number |
HTTP状态代码 (与服务器响应代码的值相同) |
||
|
httpStatusMessage |
String |
HTTP 状态信息 (与服务器响应信息的值相同) |
||
|
errorMessage |
String |
除HTTP Status 200以外，剩下Status 中包含服务器详细失败原因信息 |
||
|
data |
Object |
单份合同数据 |
||
|
|
success |
Boolean |
成功与否 True or false |
|
|
|
content |
Object |
单份合同 |
|
|
|
|
contractId |
Number |
卖家合同ID e.g. 1, 2 |
|
|
|
vendorContractId |
Number |
卖家合同代码 (酷澎管理代码) e.g. -1, 1, 2 |
|
|
|
sellerId |
String |
卖家ID e.g. A00012345 |
|
|
|
sellerShareRatio |
Number |
该合同中规定的卖家分摊比例(%) e.g. 100 |
|
|
|
coupangShareRatio |
Number |
该合同中规定的酷澎分摊比例(%) e.g. 100 |
|
|
|
gmvRatio |
Number |
单月销售额比率，单月预算基于酷澎的销售额自动生成 e.g. 100 |
|
|
|
start |
String |
开始时间 e.g. 2018-01-22 00:00:00 |
|
|
|
end |
String |
结束时间 e.g. 2018-12-31 23:59:59 |
|
|
|
type |
String |
合同类型 e.g. CONTRACT_BASED, NON_CONTRACT_BASED |
|
|
|
usedBudget |
Boolean |
是否使用预算限制 e.g. true, false 目前不使用的字段，true为基本值 |
|
|
|
modifiedAt |
String |
最终修改时间 e.g. 2017-09-25 11:40:01 |
|
|
|
modifiedBy |
String |
最终修改人ID |
|
|
Pagination |
null |
单件查看，因此无分页、 |
|
返回消息示例
{
"code": 200,
"message": "OK",
"httpStatus": 200,
"httpStatusMessage": "OK",
"errorMessage": "",
"data": {
"success": true,
"content": {
"contractId": 9962,
"vendorContractId": 7,
"sellerId": "A00012345",
"sellerShareRatio": 100,
"coupangShareRatio": 0,
"gmvRatio": 100,
"start": "2018-01-22 00:00:00",
"end": "2018-12-31 23:59:59",
"type": "CONTRACT_BASED",
"useBudget": true,
"modifiedAt": "2018-01-22 16:07:10",
"modifiedBy": "allie"
},
"pagination": null
}
}错误信息
|
HTTP status code (error type) |
Error message |
Solution |
|
401 (check requested parameter) |
请确认卖家权限。 |
查看卖家ID（vendorid）值是否输入正确 |
|
401 (check requested parameter) |
无法查看该合同ID |
查看合同ID（contractid）值是否输入正确 |
|
401 (check requested parameter) |
必需参数“contractId”不存在 |
查看合同ID（contractid）值是否已输入 |