상품 API 카테고리 API 브랜드 API 배송 / 주문 API 반품 API 교환 API 프로모션 / 쿠폰 물류 정보 고객 문의 정산 CGF / CGF lite Rocket Growth

프로모션 / 쿠폰

GET/v2/providers/fms/apis/api/v1/vendors/{vendorId}/requested/{requestedId}2609170000

[즉시할인쿠폰] 요청상태 확인

KRTW

# 01

요약

[즉시할인쿠폰] 요청상태 확인

# 02

상세

API 적용 가능한 구매자 사용자 지역: 한국

requestedId를 통해 즉시할인 쿠폰 API의 요청 결과를 확인합니다.
쿠폰생성, 쿠폰파기, 쿠폰아이템 생성, 쿠폰아이템 파기 API 요청 시에
반환되는 requestedId 값을 가지고 성공/실패(DONE/FAIL) 결과를 확인할 때 사용합니다.

경로

GET/v2/providers/fms/apis/api/v1/vendors/{vendorId}/requested/{requestedId}

예시 엔드포인트

https://api-gateway.coupang.com/v2/providers/fms/apis/api/v1/vendors/A00000001/requested/649102321051192483

# 03

Path 파라미터

Name	Type	Description
vendorId*	string	판매자ID 쿠팡에서 업체에게 발급한 고유 코드 예) A00012345
requestedId*	number	결과를 조회할 ID

# 04

응답 본문

응답 메시지

Name

Type

Description

code

integer

서버 응답 코드

message

string

서버 응답 메세지

httpStatus

integer

HTTP Status Code(서버 응답 코드와 동일한 값)

httpStatusMessage

string

HTTP Status Message (서버 응답 메세지와 동일한 값)

errorMessage

string

HTTP Status 200을 제외한 나머지 Status에서 서버 내 상세한 실패 이유 메세지가 담깁니다.

data

object

수행 성공 여부 데이터

success

data.success

boolean

성공 여부
true or false

content

data.content

object

처리 상태를 조회할 수 있는 요청ID 데이터

couponId

data.content.couponId

integer

쿠폰 ID(Wing의 쿠폰 번호)
예) 70, 85, 778

requestedId

data.content.requestedId

string

처리 상태 조회를 위한 요청ID
예) 1542675975663862164

status

data.content.status

string

처리 상태

구분코드	설명
REQUESTED	요청됨
FAIL	실패
DONE	성공

succeeded

data.content.succeeded

integer

성공 개수

total

data.content.total

integer

요청 건수(*쿠폰 아이템생성의 경우 vendorItemId의 전체 갯수)

type

data.content.type

string

요청타입

구분코드	설명
COUPON_PUBLISH	쿠폰생성
COUPON_EXPIRE	쿠폰파기
COUPON_ITEM_PUBLISH	쿠폰아이템생성
COUPON_ITEM_EXPIRE	쿠폰아이템 파기

failed

data.content.failed

integer

실패 개수

failedVendorItems

data.content.failedVendorItems

object[]

실패한 정보에 대한 상세 데이터

reason

data.content.failedVendorItems[].reason

string

실패 이유

vendorItemId

data.content.failedVendorItems[].vendorItemId

integer

실패한 vendorItemId

Pagination

data.Pagination

string

페이징 없음

Response Example

{
  "code": 200,
  "message": "OK",
  "httpStatus": 200,
  "httpStatusMessage": "OK",
  "errorMessage": "",
  "data": {
    "success": true,
    "content": {
      "couponId": 778,
      "requestedId": "4080133932843441",
      "type": "COUPON_PUBLISH",
      "status": "DONE",
      "total": 1,
      "succeeded": 1,
      "failed": 0,
      "failedVendorItems": []
    },
    "pagination": null
  }
}

# 05

에러 코드

HTTP	코드	메시지
400	HTTP_400	Bad Request

오류 사양

HTTP	유형	오류 메시지	해결 방법
400	400 (요청변수확인)	업체정보의 권한을 확인하세요.	올바른 판매자ID(vendorId) 값을 입력했는지 확인합니다.