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_154210571558673553106Request Parameters
Query String Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| requestTransactionId | O | Number |
ID to query result
|
||||
Request Example
not require body
Response Message
| Name | Type | Description | ||||
|---|---|---|---|---|---|---|
| transactionStatusResponse | Object |
Details of response to call
|
||||
| type | String |
API subject to health check
|
||||
| total | Number |
The number of vendoritem requests
|
||||
| succeeded | Number |
The number of vendoritem succeeded in calling
|
||||
| status | String |
The result of call
|
||||
| requestedId | String |
Response query key
|
||||
| couponFailedVendorItemIdResponses | Array |
Detailed reason why a vendoritemId failed registration
|
||||
| vendorItemId | Number |
Option ID used for API call
|
||||
| failureReason | String |
The reason for the call failure
|
||||
| failed | Number |
The number of vendoritem failed in calling
|
||||
| couponId | Number |
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
}
}Error Spec
| HTTP status code (error type) | error message | solution |
|---|---|---|
| 500 (check parameter requested) | system error | Check if requestTransactionId value is correctly inputted. |
URL API Name
GET_REQUEST_STATUS_BY_TRANSACTION_ID