[Downloadable Coupon] Expiring Download Coupon

# 01

Summary

# 02

Details

Available buyer market: Korea

Expire (terminate) the downloadable coupon created.

By using "requestTransactionId" received as a response, you can search 'downloadable coupon request status check API' to get the actual result of the API call.

Path

POST/v2/providers/marketplace_openapi/apis/api/v1/coupons/expire

Example endpoint

https://api-gateway.coupang.com/v2/providers/marketplace_openapi/apis/api/v1/coupons/expire

URL API Name

EXPIRE_COUPONS

# 03

Request body

Request parameters

Body parameter

Name	Type	Description
expireCouponList*	object[]	Data to expire the download coupon
couponId expireCouponList[].couponId	string	Coupon ID Shown on coupon creation response
reason expireCouponList[].reason	string	Input expired
userId expireCouponList[].userId	string	User account (WING ID)

Request exampleapplication/json

{
  "expireCouponList": [
    {
      "couponId": "16513129",
      "reason": "expired",
      "userId": "testId123"
    }
  ]
}

# 04

Response body

Response Example

[
  {
    "requestResultStatus": "SUCCESS",
    "body": {
      "couponId": 16513129,
      "requestTransactionId": "et5_165131291561017478962"
    },
    "errorCode": null,
    "errorMessage": null
  }
]

# 05

Error codes

HTTP	Code	Message
400	HTTP_400	Bad Request

Error specification

HTTP	Type	Error message	Solution
500	500 (Check Parameter Requested)	There is no coupon to expire.	Check whether CouponID is correctly input.