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

[Instant Discount Coupon] Query one coupon (couponId)

# 01

Summary

Available buyer market: Korea This API queries info on one coupon and cannot query coupons by other vendors.

# 02

Details

Available buyer market: Korea
This API queries info on one coupon and cannot query coupons by other vendors.
 

Path

GET

/v2/providers/fms/apis/api/v2/vendors/{vendorId}/coupon

Example Endpoint

https://api-gateway.coupang.com/v2/providers/fms/apis/api/v2/vendors/A00012345/coupon?couponId=91

Request Parameters

Path Segment Parameter

Name Required Type Description
vendorId O String
Seller ID
Unique code issued to Vendor by Coupang
ex) A00012345

Query String Parameter

Name Required Type Description
couponId O Number
Coupon ID

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
Coupon data
  success Boolean
Success or failure
true or false
  content Object
Data on one coupon
    contractId Number
Contract ID
    vendorContractId Number
Vendor's contract code (Coupang management code)
ex) -1, 1, 2
    couponId Number
Coupon ID (Wing's coupon no.)
    discount Number
Discount rate
    endAt String
Effective end date/time
ex)2017-09-01 00:00:00
    maxDiscountPrice Number
Max. discount amount
ex) 1000, 10000
    promotionName String
Promotion name
ex) Dress discount coupon for the 2nd wk of Jan
    startAt String
Effective start date/time
ex) 2017-08-04 01:00:00
    status String
Coupon status
Code Description
STANDBY Standing by
APPLIED In use
PAUSED Issuance suspended
EXPIRED Expired
DETACHED Item Removed
    type String
Discount type
ex) RATE (fixed-rate discount), FIXED_WITH_QUANTITY(fixed-amount discount per quantity), PRICE(fixed-amount discount)
    wowExclusive Boolean
Issuance target
false (all: Default)
true (Rocket Wow members)
  Pagination Array
No paging as it queries one coupon

Response Example

{
  "code": 200,
  "message": "OK",
  "httpStatus": 200,
  "httpStatusMessage": "OK",
  "errorMessage": "",
  "data": {
    "success": true,
    "content": {
      "contractId": 10,
      "vendorContractId": null,
      "promotionName": null,
      "couponId": 91,
      "status": "PAUSED",
      "type": "RATE",
      "maxDiscountPrice": 1000000,
      "discount": 99,
      "startAt": "2017-11-22 00:00:00",
      "endAt": "2017-11-23 23:59:00",
      "wowExclusive": "false"     
    },
    "pagination": null
  }
}

Error Spec

HTTP status code (error type) Error message How to resolve
400 (check request parameter)

Check access to vendor info.

Check if the seller ID (vendorId) is correct.
400 (check request parameter)

The coupon doesn't exist. Check the coupon no.

Check if the coupon ID (couponId) is correct.