coupang
API Documentation
ProductsCategoriesBrandsShipments & OrdersReturnsExchangesPromotions & CouponsLogistics InfoCustomer ServiceSettlementCGF / CGF liteRocket Growth
GET/v2/providers/fms/apis/api/v1/vendors/{vendorId}/coupons/{couponId}/items

[Instant Discount Coupon] Query a list of items (status)

# 01

Summary

Available buyer market: Korea This API queries a list of coupon-attached option IDs by coupon 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

Request Parameters

Path Segment Parameter

Name Type Description
vendorId* String
Seller ID
Unique code issued to Vendor by Coupang
ex) A00012345
couponId* Number
Coupon ID

Query String Parameter

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

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 Array
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
Code Description
STANDBY Standing by
APPLIED In use
PAUSED Issuance paused
EXPIRED Expired
  Pagination Array
Paging
    countPerPage Number
Data count per page
ex) 10, 20, 30
    currentPage Number
Current page
ex) 1
    totalPages Number
Total page count
ex) 1000
    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
    }
  }
}

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.