该API用于过期/禁用已创建的优惠券。因以异步方式,仅执行处理请求,
可使用响应的”requestedId” 值,通过确认请求状态API来查看实际API 执行结果值。
在过期/禁用优惠券时,如果该优惠券还有其它未完成请求,则可能导致失败。例如,在创建优惠券后申请添加商品,在完成所有商品添加之前,优惠券的过期/禁用请求将失败。 ("success":输出false)
路径
PUT
/v2/providers/fms/apis/api/v1/vendors/{vendorId}/coupons/{couponId}
示例
https://api-gateway.coupang.com/v2/providers/fms/apis/api/v1/vendors/A00012345/coupons/684245?action=expire
请求参数
Name |
Required |
Type |
Description |
vendorId |
O |
String |
卖家ID 酷澎分配给卖家的固有代码 ex) A00012345 |
couponId |
O |
Number |
销毁的优惠券ID |
链接请求参数
名称 |
必须 |
数据类型 |
描述 |
action |
O |
String |
失效 |
请求体
无
返回消息
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 |
可查看处理状态的请求ID数据 |
|
|
|
requestedId |
String |
查看处理状态的请求ID ex) 1542675975663862164 |
|
|
success |
Boolean |
成功与否 true or false |
Pagination | null |
无分页
|
返回消息示例
{
"code": 200,
"message": "OK",
"httpStatus": 200,
"httpStatusMessage": "OK",
"errorMessage": "",
"data": {
"success": true,
"content": {
"requestedId": "649102321051192483",
"success": true
},
"pagination": null
}
}
错误信息
HTTP状态代码(错误类型) |
错误信息 |
解决方案 |
400(确认请求参数) |
找不到该优惠券。2325***23 |
查看输入的优惠券ID(couponId)是否正确。 |