You can use this API to remove certain items from the coupon. Being asynchronous, it only processes requests. To see the results, you should call a different API that is used to check request status, using the "requestId" value that has been returned in the response.
Path
PUT/v2/providers/fms/apis/api/v1/vendors/{vendorId}/coupons/{couponId}/items?action=expire
Example Endpoint
https://api-gateway.coupang.com/v2/providers/fms/apis/api/v1/vendors/A00012345/coupons/84/items?action=expireRequest Parameters
Path Segment Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| vendorId | O | String |
Seller ID
Unique ID issued by Coupang for each seller
e.g. A00012345
|
||||
| couponId | O | Number |
ID of the coupon from which you want to remove the item
|
||||
Query String Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| action | O | String |
expire
|
||||
Body Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| vendorItems | O | Array |
Item ID you want to remove from the coupon
The maximum number of item ID's you can remove each time is 10,000.
|
||||
Request Example
{
"vendorItems": [
3226138951,
3226138847
]
}Response Message
| Name | Type | Description | ||||
|---|---|---|---|---|---|---|
| code | Number |
server response code
|
||||
| message | String |
server response message
|
||||
| httpStatus | Number |
HTTP Status Code (same value as the server response code)
|
||||
| httpStatusMessage | String |
HTTP Status Message (same value as the server response message)
|
||||
| errorMessage | String |
It details the reason for error except for "http status 200"
|
||||
| data | Object |
Data that shows whether the request succeeded or not
|
||||
| success | Boolean |
true or false
|
||||
| content | Object |
Data about the requested ID for which you want to check statu
|
||||
| requestedId | String |
The ID you want to query the request status for
e.g. 1542675975663862164
|
||||
| success | Boolean |
true or false
|
||||
| Pagination | null |
no pagination
|
||||
Response Example
{
"code": 200,
"message": "OK",
"httpStatus": 200,
"httpStatusMessage": "OK",
"errorMessage": "",
"data": {
"success": true,
"content": {
"requestedId": "2837577763015251644",
"success": true
},
"pagination": null
}
}Error Spec
| HTTP Status Code (Error Type) | Error Message | Solution |
|---|---|---|
| 400 (check parameter requested) | vendorItems may not be empty, vendorItems size must be between 1 and 10000 | See if there are any issues with the vendor item ids you have entered. Please note that you cannot add more than 10,000 item id's at a time. |
| 400 (check parameter requested) | Please check if you're authorized for the vendor. | See if the VendorID is correct. |
| 400 (check parameter requested) | Please check CouponID 208463**** | See if the VendorID is correct. |