This API queries coupon-attached items by coupon item ID.
Path
GET/v2/providers/fms/apis/api/v1/vendors/{vendorId}/coupons/{couponId}/items/{couponItemId}
Example Endpoint
https://api-gateway.coupang.com/v2/providers/fms/apis/api/v1/vendors/A00012345/coupons/77/items/80984?type=couponItemIdRequest Parameters
Path Segment Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| vendorId | O | String |
Seller ID
Unique code to Vendor by Couponag
ex) A00012345
|
||||
| couponId | O | Number |
Coupon ID
|
||||
| couponItemId | O | Number |
Coupon item ID
|
||||
Query String Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| type | O | String |
couponItemId
|
||||
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 as the server response code)
|
||||||||||||||
| httpStatusMessage | String |
HTTP Status Message (same as the server response message)
|
||||||||||||||
| errorMessage | String |
Detailed reason for error other than HTTP status 200
|
||||||||||||||
| data | Object |
Data on coupon item list
|
||||||||||||||
| success | Boolean |
Success or failure
true or false
|
||||||||||||||
| content | Object |
Coupon item list
|
||||||||||||||
| couponItemId | Number |
Coupon item ID
ex) 80984
|
||||||||||||||
| couponId | Number |
Coupon ID
ex) 75, 80
|
||||||||||||||
| vendorItemId | Number |
Option ID
ex) 3223826213
|
||||||||||||||
| startAt | String |
Effective start date/time
ex) 2017-08-04 01:00:00
|
||||||||||||||
| endAt | String |
Effective end date/time
ex)2017-09-01 00:00:00
|
||||||||||||||
| status | String |
Coupon status
|
||||||||||||||
| Pagination | Array |
No paging as it queries one coupon
|
||||||||||||||
Response Example
{
"code": 200,
"message": "OK",
"httpStatus": 200,
"httpStatusMessage": "OK",
"errorMessage": "",
"data": {
"success": true,
"content": {
"couponItemId": 80984,
"couponId": 77,
"vendorItemId": 3223826213,
"startAt": "2017-08-04 01:00:00",
"endAt": "2017-09-01 00:00:00",
"status": "APPLIED"
},
"pagination": null
}
}Error Spec
| HTTP status code (error type) | Error message | How to resolve |
|---|---|---|
| 400 (check request parameter) |
Check access to the vendor info. |
Check if the seller ID (vendorId) is correct. |
| 400 (check request parameter) | Check the coupon ID 208463****. | Check if the coupon ID (couponId) is correct. |
| 400 (check request parameter) | Cannot find an item for couponId 1875***. | Check if the coupon item ID (couponItemId) is correct. |