GET
/v2/providers/fms/apis/api/v1/vendors/{vendorId}/coupons/{couponId}/items2609170000[Instant Discount Coupon] Query a list of items (status)
# 01
Summary
[Instant Discount Coupon] Query a list of items (status)
# 02
Details
Available buyer market: Korea
This API queries a list of coupon-attached option IDs by coupon status.
Path
GET/v2/providers/fms/apis/api/v1/vendors/{vendorId}/coupons/{couponId}/items
Example endpoint
https://api-gateway.coupang.com/v2/providers/fms/apis/api/v1/vendors/A00012345/coupons/99/items?status=APPLIED&page=1&size=10&sort=desc# 03
Path parameters
| Name | Type | Description |
|---|---|---|
| vendorId* | string | Seller ID Unique code issued to Vendor by Coupang ex) A00012345 |
| couponId* | number | Coupon ID
|
# 04
Query parameters
| Name | Type | Description |
|---|---|---|
| status* | string | Coupon status (STANDBY, APPLIED, PAUSED and EXPIRED)
|
| page | number | Page: 0 by default Key value to call the next page; enter nothing or '0' to call the 1st page，enter '1' to call the 2nd page，and so on |
| size | number | of results per page |
| sort | string | Sorting (asc, desc) Ascending by default |
# 05
Response body
Response message
| Name | Type | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| code | integer | Server response code
| ||||||||||
| message | string | Server response message
| ||||||||||
| httpStatus | integer | 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 data.success | boolean | Success or failure true or false | ||||||||||
| content data.content | object[] | Coupon item list
| ||||||||||
| couponItemId data.content[].couponItemId | integer | Coupon item ID ex) 80984 | ||||||||||
| couponId data.content[].couponId | integer | Coupon ID ex) 75, 80 | ||||||||||
| vendorItemId data.content[].vendorItemId | integer | Option ID ex) 3223826213 | ||||||||||
| startAt data.content[].startAt | string | Effective start date/time ex) 2017-08-04 01:00:00 | ||||||||||
| endAt data.content[].endAt | string | Effective end date/time ex) 2017-09-01 00:00:00 | ||||||||||
| status data.content[].status | string | Coupon status
| ||||||||||
| Pagination data.Pagination | object[] | Paging
| ||||||||||
| countPerPage data.Pagination[].countPerPage | number | Data count per page ex) 10, 20, 30 | ||||||||||
| currentPage data.Pagination[].currentPage | number | Current page ex) 1 | ||||||||||
| totalPages data.Pagination[].totalPages | number | Total page count ex) 1000 | ||||||||||
| totalElements data.Pagination[].totalElements | number | Total data count ex) 1000 |
Response Example
{
"code": 200,
"message": "OK",
"httpStatus": 200,
"httpStatusMessage": "OK",
"errorMessage": "",
"data": {
"success": true,
"content": [
{
"couponItemId": 81172,
"couponId": 84,
"vendorItemId": 3226138951,
"startAt": "2017-08-09 01:00:00",
"endAt": "2017-09-01 00:00:00",
"status": "APPLIED"
},
{
"couponItemId": 81171,
"couponId": 84,
"vendorItemId": 3226138847,
"startAt": "2017-08-09 01:00:00",
"endAt": "2017-09-01 00:00:00",
"status": "APPLIED"
}
],
"pagination": {
"currentPage": 0,
"countPerPage": 1000,
"totalPages": 1,
"totalElements": 2
}
}
}# 06
Error codes
| HTTP | Code | Message |
|---|---|---|
| 400 | HTTP_400 | Bad Request |
Error specification
| HTTP | Type | Error message | Solution |
|---|---|---|---|
| 400 | 400 (check request parameter) | Check access to the vendor info. | Check if the seller ID (vendorId) is correct. |