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

프로모션 / 쿠폰

GET/v2/providers/fms/apis/api/v2/vendors/{vendorId}/{orderId}/coupons2609170000

[즉시할인쿠폰] 목록 조회(orderId)

KRTW

# 01

요약

# 02

상세

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

주문번호로 쿠폰 정보를 조회하기 위한 API입니다.

경로

GET/v2/providers/fms/apis/api/v2/vendors/{vendorId}/{orderId}/coupons

예시 엔드포인트

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

# 03

Path 파라미터

Name	Type	Description
vendorId*	string	판매자ID 쿠팡에서 업체에게 발급한 고유 코드 예) A00012345
orderId*	number	주문번호

# 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[]

쿠폰정보 데이터

contractId

data.content[].contractId

integer

업체의 계약서ID
예) 1, 2

couponId

data.content[].couponId

integer

쿠폰ID
예) 75, 80

discount

data.content[].discount

integer

할인율
예) 100.0, 20.0

endAt

data.content[].endAt

string

유효종료일
예)2017-09-01 00:00:00

maxDiscountPrice

data.content[].maxDiscountPrice

integer

최대 할인금액
예) 1000, 10000

promotionName

data.content[].promotionName

string

프로모션명
예) 원피스 1월 2째주 할인쿠폰

startAt

data.content[].startAt

string

유효시작일
예) 2017-08-04 01:00:00

status

data.content[].status

string

쿠폰상태

구분코드	설명
STANDBY	대기중
APPLIED	사용중
PAUSED	발행중지
EXPIRED	사용종료
DETACHED	아이템 파기

type

data.content[].type

string

할인방식
예) RATE(정률할인), FIXED_WITH_QUANTITY(수량별 정액할인), PRICE(정액할인)

wowExclusive

data.content[].wowExclusive

string

발행대상

false(전체 : 기본값)
true(로켓와우 회원)

vendorItemId

data.content[].vendorItemId

integer

옵션ID
예) 3223826213

Pagination

data.Pagination

string

orderId로 조회시에는 pagination이 제공되지 않음

Response Example

{
  "code": 200,
  "message": "OK",
  "httpStatus": 200,
  "httpStatusMessage": "OK",
  "errorMessage": "",
  "data": {
    "success": true,
    "content": [
      {
        "vendorItemId": 5500016112,
        "contractId": 10,
        "promotionName": "99%",
        "couponId": 91,
        "status": "PAUSED",
        "type": "RATE",
        "maxDiscountPrice": 1000000,
        "discount": 99,
        "startAt": "2017-11-22 00:00:00",
        "endAt": "2017-11-23 23:59:00",
        "wowExclusive": "false"
      },
      {
        "vendorItemId": 53000439458,
        "contractId": 7,
        "promotionName": "자유계약 원피스 폭탄 세일 시즌 1",
        "couponId": 65,
        "status": "PAUSED",
        "type": "RATE",
        "maxDiscountPrice": 1000,
        "discount": 10,
        "startAt": "2017-09-22 00:00:00",
        "endAt": "2017-09-23 23:59:00",
        "wowExclusive": "false"
      }
    ],
    "pagination": null
  }
}

# 05

에러 코드

HTTP	코드	메시지
400	HTTP_400	Bad Request

오류 사양

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