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

[즉시할인쿠폰] 생성

# 01

요약

API 적용 가능한 구매자 사용자 지역: 한국 계약서ID(contractId)에 기반한 신규 쿠폰 생성을 위한 API입니다. 본 API는 비동기방식으로 프로세스에 대한 요청 만을 수행하고 있어 실제 API 수행 결과는 응답으로 받은 "requestedId" 값을 가지고 요청상태 확인 API를 통해서 확인 가능합니다. 즉시할인쿠폰은 최초 생성 시 설정한 쿠폰 적용 상품을 추후 삭제할 수 없습니다. 만약 쿠폰을 적용할 상품을 삭제하고 싶은 경우에는 기존에 발행한 쿠폰을 중지하고 새로운 쿠폰을 생성해야 합니다.

# 02

상세

API 적용 가능한 구매자 사용자 지역: 한국
계약서ID(contractId)에 기반한 신규 쿠폰 생성을 위한 API입니다. 본 API는 비동기방식으로 프로세스에 대한 요청 만을 수행하고 있어 실제 API 수행 결과는 응답으로 받은 "requestedId" 값을 가지고 요청상태 확인 API를 통해서 확인 가능합니다.
 
즉시할인쿠폰은 최초 생성 시 설정한 쿠폰 적용 상품을 추후 삭제할 수 없습니다.
만약 쿠폰을 적용할 상품을 삭제하고 싶은 경우에는 기존에 발행한 쿠폰을 중지하고 새로운 쿠폰을 생성해야 합니다.
최초 쿠폰 생성 시 쿠폰을 적용할 상품을 신중하게 설정해주세요!

Path

POST

/v2/providers/fms/apis/api/v2/vendors/{vendorId}/coupon

Example Endpoint

https://api-gateway.coupang.com/v2/providers/fms/apis/api/v2/vendors/A00012345/coupon

Request Parameters

Path Segment Parameter

Name Required Type Description
vendorId O String
판매자ID
쿠팡에서 업체에게 발급한 고유 코드
예) A00012345

Body Parameter

Name Required Type Description
contractId O Number
업체의 계약서ID
name O String
프로모션명(최대 45자)
maxDiscountPrice O Number
최대할인금액
최소 10원 이상
discount O Number
할인률
startAt O String
유효시작일
유효시작일은 다음날 00시부터 작동하도록 설정 가능 ex: 8월4일 15시에 쿠폰을 생성한다면 8월5일00시 부터 쿠폰이 적용되도록 생성
endAt O String
유효종료일
type O String
할인방식
RATE(정률할인), FIXED_WITH_QUANTITY(수량별 정액할인), PRICE(정액할인)
wowExclusive   Boolean
발행 대상
쿠폰을 사용할 수 있는 대상
false 전체고객 (기본값)
true 로켓와우회원한정
일반 다운로드 쿠폰은 false로 생성해주시기 바랍니다.  
true는 로켓와우 회원을 대상으로 골드박스 등 기획전에 선정된 상품에 대해 적용하는 값이며, 상품에 적용 시 사전 승인이 필요합니다. 

Request Example

{
  "contractId": "10",
  "name": "newCoupon 20180328",
  "maxDiscountPrice": "1000",
  "discount": "10",
  "startAt": "2017-12-08 00:00:00",
  "endAt": "2017-12-09 00:00:00",
  "type": "PRICE",
  "wowExclusive": "false"
}

Response Message

Name Type Description
code Number
서버 응답 코드
message String
서버 응답 메세지
httpStatus Number
HTTP Status Code(서버 응답 코드와 동일한 값)
httpStatusMessage String
HTTP Status Message (서버 응답 메세지와 동일한 값)
errorMessage String
HTTP Status 200을 제외한 나머지 Status에서 서버 내 상세한 실패 이유 메세지가 담깁니다.
data Object
수행 성공 여부 데이터
  success Boolean
성공 여부
true or false
  content Object
처리 상태를 조회할 수 있는 요청아이디 데이터
    requestedId String
처리 상태 조회를 위한 요청아이디
예) 1542675975663862164
    success Boolean
성공 여부
true or false
  Pagination null
페이징 없음

Response Example

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

Error Spec

HTTP 상태 코드 (오류 유형) 오류 메시지 해결 방법
400 (요청변수확인) 계약의 유효기간 안에 쿠폰이 존재해야 한다(계약서의 유효기간:2017-03-01 00:00:00~2017-12-31 23:59:59) (쿠폰의 유효기간:2016-12-05 00:00:00~2017-09-05 00:00:00) 계약서의 유효기간 안에 쿠폰의 유효시작일과 종료일이 포함되었는지 확인합니다.
400 (요청변수확인) Cannot parse "2017-13-05 00:00:00": Value 13 for monthOfYear must be in the range [1,12] 유효시작일 또는 종료일 값을 올바르게 입력했는지 확인합니다.
400 (요청변수확인) Cannot parse "2017-08-32 00:00:00": Value 32 for dayOfMonth must be in the range [1,31] 유효시작일 또는 종료일 값을 올바르게 입력했는지 확인합니다.
400 (요청변수확인)  startAt 패턴을 확인하세요. yyyy-MM-dd HH:mm:ss 유효시작일 값을 올바른 형식으로 입력했는지 확인합니다.
400 (요청변수확인)  endAt 패턴을 확인하세요. yyyy-MM-dd HH:mm:ss 유효종료일 값을 올바른 형식으로 입력했는지 확인합니다.
400 (요청변수확인) discount 양수만 입력 가능합니다. (정률은 1~100, 정액은 1이상) 할인율(discount) 값을 올바르게 입력했는지 확인합니다.