该API用于查看单个优惠券信息,不可查看其他卖家的优惠券。
路径
GET
/v2/providers/fms/apis/api/v2/vendors/{vendorId}/coupon
示例
https://api-gateway.coupang.com/v2/providers/fms/apis/api/v2/vendors/A00012345/coupon?couponId=91
请求参数
Name |
Required |
Type |
Description |
vendorId |
O |
String |
卖家ID 酷澎分配给卖家的固有代码 ex) A00012345 |
链接请求参数
Name |
Required |
Type |
Description |
||||
couponId |
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 |
|||||||||||||||
|
|
vendorContractId |
Number |
卖家合同代码 (酷澎管理代码) ex) -1, 1, 2 |
|||||||||||||||
|
|
couponId |
Number |
优惠券ID (Wing优惠券号码) |
|||||||||||||||
|
|
discount |
Number |
折扣率 |
|||||||||||||||
|
|
|
|
|
|||||||||||||||
|
|
endAt |
String |
有效期结束时间 ex)2017-09-01 00:00:00 |
|||||||||||||||
|
|
maxDiscountPrice |
Number |
最大折扣金额 ex) 1000, 10000 |
|||||||||||||||
|
|
promotionName |
String |
促销展名 ex) Dress discount coupon for the 2nd wk of Jan |
|||||||||||||||
|
|
startAt |
String |
有效期开始时间 ex) 2017-08-04 01:00:00 |
|||||||||||||||
|
|
status |
String |
优惠券状态
|
|||||||||||||||
|
|
type |
String |
折扣类型 ex) RATE (固定折扣率), FIXED_WITH_QUANTITY(按数量定额折扣), PRICE(定额折扣) |
|||||||||||||||
|
|
wowExclusive |
Boolean |
发放对象 false (全部:默认值) true (火箭Wow 会员) |
|||||||||||||||
|
Pagination |
Array |
单件优惠券查看,因此无分页 |
返回消息示例
{
"code": 200,
"message": "OK",
"httpStatus": 200,
"httpStatusMessage": "OK",
"errorMessage": "",
"data": {
"success": true,
"content": {
"contractId": 10,
"vendorContractId": null,
"promotionName": null,
"couponId": 91,
"status": "PAUSED",
"type": "RATE",
"maxDiscountPrice": 1000000,
"discount": 99,
"startAt": "2017-11-22 00:00:00",
"endAt": "2017-11-23 23:59:00",
"wowExclusive": "false"
},
"pagination": null
}
}
错误信息
HTTP status code (error type) |
Error message |
How to resolve |
400 (check request parameter) |
请确认卖家权限 |
查看卖家ID(vendorid)值是否输入正确 |
400 (check request parameter) |
该优惠券不存在,请确认优惠券号码。 |
查看优惠券ID(couponid)值是否输入正确 |