Products Categories Brands Shipments & Orders Returns Exchanges Promotions & Coupons Logistics Info Customer Service Settlement CGF / CGF lite Rocket Growth

Promotions & Coupons

GET/v2/providers/fms/apis/api/v1/vendors/{vendorId}/coupons/{couponId}/items/{couponItemId}2609170000

[Instant Discount Coupon] Query one coupon (couponItemId)

# 01

Summary

# 02

Details

Available buyer market: Korea

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=couponItemId

# 03

Path parameters

Name	Type	Description
vendorId*	string	Seller ID Unique code to Vendor by Couponag ex) A00012345
couponId*	number	Coupon ID
couponItemId*	number	Coupon item ID

# 04

Query parameters

Name	Type	Description
type*	string	couponItemId

# 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

Code	Description
STANDBY	Standing by
APPLIED	In use
PAUSED	Issuance paused
EXPIRED	Expired

Pagination

data.Pagination

object[]

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
  }
}

# 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.
400	400 (check request parameter)	Check the coupon ID 208463****.	Check if the coupon ID (couponId) is correct.
400	400 (check request parameter)	Cannot find an item for couponId 1875***.	Check if the coupon item ID (couponItemId) is correct.