coupang
GET/v2/providers/marketplace_openapi/apis/api/v1/coupons/transactionStatus2609170000

[Downloadable Coupon] check requested status

# 01

Summary

[Downloadable Coupon] check requested status

# 02

Details

Available buyer market: Korea

Use requestTransactionId to check result of coupon item creation API request.

Path

GET/v2/providers/marketplace_openapi/apis/api/v1/coupons/transactionStatus

Example endpoint

https://api-gateway.coupang.com/v2/providers/marketplace_openapi/apis/api/v1/coupons/transactionStatus?requestTransactionId=et5_154210571558673553106

URL API Name

GET_REQUEST_STATUS_BY_TRANSACTION_ID
# 03

Query parameters

NameTypeDescription
requestTransactionId*number
ID to query result
# 04

Response body

Response message

NameTypeDescription
transactionStatusResponseobject
Details of response to call
type
transactionStatusResponse.type
string
API subject to health check
total
transactionStatusResponse.total
integer
The number of vendoritem requests
succeeded
transactionStatusResponse.succeeded
integer
The number of vendoritem succeeded in calling
status
transactionStatusResponse.status
string
The result of call
requestedId
transactionStatusResponse.requestedId
string
Response query key
couponFailedVendorItemIdResponses
transactionStatusResponse.couponFailedVendorItemIdResponses
object[]
Detailed reason why a vendoritemId failed registration
vendorItemId
transactionStatusResponse.couponFailedVendorItemIdResponses[].vendorItemId
integer
Option ID used for API call
failureReason
transactionStatusResponse.couponFailedVendorItemIdResponses[].failureReason
string
The reason for the call failure
failed
transactionStatusResponse.failed
integer
The number of vendoritem failed in calling
couponId
transactionStatusResponse.couponId
integer
The coupon ID

Response Example

{
  "transactionStatusResponse": {
    "type": "COUPON_ITEM_PUBLISH",
    "total": 1,
    "succeeded": 0,
    "status": "FAIL",
    "requestedId": "et5_154210571558673553106",
    "couponFailedVendorItemIdResponses": [
      {
        "vendorItemId": 4712512759,
        "failureReason": "[CIR14] 해당 옵션은 이미 다른 쿠폰(14434486 외 2건)에 발행되어져 있습니다."
      }
    ],
    "failed": 1,
    "couponId": 15421057
  }
}
# 05

Error codes

HTTPCodeMessage
400HTTP_400Bad Request

Error specification

HTTPTypeError messageSolution
500500 (check parameter requested)

system error

Check if requestTransactionId value is correctly inputted.