API to delete a created coupon.
Since this is an asynchronous API that only handles requests, you will have to use the response's "requestedId" value to find actual API response through Request status check API.
Since this is an asynchronous API that only handles requests, you will have to use the response's "requestedId" value to find actual API response through Request status check API.
Failure can occur when attempting to delete coupon if there are other unfinished requests.
For example, if you have requested to add items after creating a coupon, coupon deletion will fail until all items have been added. ("success": displays false)
Path
PUT/v2/providers/fms/apis/api/v1/vendors/{vendorId}/coupons/{couponId}
Example Endpoint
https://api-gateway.coupang.com/v2/providers/fms/apis/api/v1/vendors/A00012345/coupons/684245?action=expireRequest Parameters
Path Segment Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| vendorId | O | String |
Vendor ID
Unique code issued to vendor by Coupang.
ex) A00012345
|
||||
| couponId | O | Number |
Coupon ID to be deleted
|
||||
Query String Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| action | O | String |
expire
|
||||
Request Example
not require body
Response Message
| Name | Type | Description | ||||
|---|---|---|---|---|---|---|
| code | Number |
server response code
|
||||
| message | String |
server response message
|
||||
| httpStatus | Number |
HTTP Status Code(same value as server response code)
|
||||
| httpStatusMessage | String |
HTTP Status Message (same value as server response message)
|
||||
| errorMessage | String |
Detailed message on server failure reasons for all statuses excluding HTTP Status 200.
|
||||
| data | Object |
run successful or not
|
||||
| success | Boolean |
successful or not
true or false
|
||||
| content | Object |
request ID data to query processing status
|
||||
| requestedId | String |
request ID to query processing status
ex) 1542675975663862164
|
||||
| success | Boolean |
successful or not
true or false
|
||||
| Pagination | null |
no pagination
|
||||
Response Example
{
"code": 200,
"message": "OK",
"httpStatus": 200,
"httpStatusMessage": "OK",
"errorMessage": "",
"data": {
"success": true,
"content": {
"requestedId": "649102321051192483",
"success": true
},
"pagination": null
}
}Error Spec
| HTTP status code (error type) | Error message | Solution |
|---|---|---|
| 400 (check request parameter) | Cannot find coupon.2325***23 | Check if correct couponID value was entered.. |