coupang
API 문서
상품 API카테고리 API브랜드 API배송 / 주문 API반품 API교환 API프로모션 / 쿠폰물류 정보고객 문의정산CGF / CGF liteRocket Growth
PUT/v2/providers/fms/apis/api/v1/vendors/{vendorId}/coupons/{couponId}2609170000

[즉시할인쿠폰] 파기

KRTW
# 01

요약

[즉시할인쿠폰] 파기

# 02

상세

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

생성되어 있던 쿠폰의 파기를 위한 API입니다. 본 API는 비동기방식으로 프로세스에 대한 요청 만을 수행하고 있어
실제 API 수행 결과값은 응답으로 받은 "requestedId" 값을 가지고 요청상태 확인 API를 통해서 확인 가능합니다.

쿠폰 파기 시 쿠폰에 아직 끝나지 않은 다른 요청이 있을 경우 실패가 발생할 수 있습니다. 예를 들어 쿠폰 생성 후 아이템들의 추가를 요청한 경우, 아이템 추가가 모두 완료되기 전에는 쿠폰 파기가 실패처리 됩니다. ("success": false 출력됨)

경로

PUT/v2/providers/fms/apis/api/v1/vendors/{vendorId}/coupons/{couponId}

예시 엔드포인트

https://api-gateway.coupang.com/v2/providers/fms/apis/api/v1/vendors/A00012345/coupons/684245?action=expire
# 03

Path 파라미터

NameTypeDescription
vendorId*string
판매자ID
쿠팡에서 업체에게 발급한 고유 코드
예) A00012345
couponId*number
파기할 쿠폰ID
# 04

Query 파라미터

NameTypeDescription
action*string
expire
# 05

응답 본문

응답 메시지

NameTypeDescription
codeinteger
서버 응답 코드
messagestring
서버 응답 메세지
httpStatusinteger
HTTP Status Code(서버 응답 코드와 동일한 값)
httpStatusMessagestring
HTTP Status Message (서버 응답 메세지와 동일한 값)
errorMessagestring
HTTP Status 200을 제외한 나머지 Status 에서 서버 내 상세한 실패 이유 메세지가 담깁니다.
dataobject
수행 성공 여부 데이터
success
data.success
boolean
성공 여부
true or false
content
data.content
object
처리 상태를 조회할 수 있는 요청ID 데이터
requestedId
data.content.requestedId
string
처리 상태 조회를 위한 요청ID
예) 1542675975663862164
success
data.content.success
boolean
성공 여부
true or false
Pagination
data.Pagination
string
페이징 없음

Response Example

{
  "code": 200,
  "message": "OK",
  "httpStatus": 200,
  "httpStatusMessage": "OK",
  "errorMessage": "",
  "data": {
    "success": true,
    "content": {
      "requestedId": "649102321051192483",
      "success": true
    },
    "pagination": null
  }
}
# 06

에러 코드

HTTP코드메시지
400HTTP_400Bad Request

오류 사양

HTTP유형오류 메시지해결 방법
400400 (요청변수확인)

조회되지 않는 쿠폰입니다.2325***23

올바른 쿠폰ID(couponId) 값을 입력했는지 확인합니다.