쿠폰발행

쿠폰유형(couponType)을 선언

...

issueCountLimit	maxIssueCount	idPerIssueCount	발급가능여부
unlimited	0	-	o
unlimited	-	0	o
limited	0	-	x
limited	-	0	x
limited	1	0	x
limited	0	1	x
limited	N	N	o

할인방식 (discountType)

정액 (price)
- 할인금액 (discountPrice) 설정
정률 (rate)
- 할인율 (discountRate) 설정
- 최대할인금액 (maxDiscountPrice) : 정률인 경우 최대할인금액 제한을 할 수 있다.
  - ex) 할인율 10% 최대할인금액 2000원, 총 주문금액 50000 일때
  - 쿠폰할인금액 50000/100*10 = ~~5000~~ → 2000

...

	전시카테고리	상품카테고리	브랜드	공급사	판매사	상품
장바구니쿠폰	-	-	-	-	-	-
상품쿠폰	o	o	o	o	o	o
배송비쿠폰	-	-	-	o	o	-

쿠폰을 적용하거나 제외할 수 있는 범위를 지정할 수 있다.
- 포함된 적용범위 (includedCoverage)
- 제외된 적용범위 (excludedCoverage)
각 적용범위 별로 N개 선택 가능, 최대 100개 제한된다.

...

취소

재계산

장바구니쿠폰

정액 쿠폰만 존재 하므로

조건 해제 시 쿠폰 사용 취소

X

상품쿠폰

정률 쿠폰이고

조건 유지 되는 경우

배송비 무료 쿠폰

X

...

Coupon API

Download

Info
POST {{protocol}}://{{hostname}}:{{port}}/svc/coupon/download

Define
- 쿠폰유형 ID에 대하여 회원이 다운로드
- 회원 로그인 사용자만 사용 가능
parameters
- id : couponType ID

Expand

Code Block
{ "result": "200", "resultMessage": "SUCCESS" }

Code Block
{ "result": "400", "resultMessage": "쿠폰을 다운로드할 수 없습니다. : 117" }

Code Block
{ "result": "401", "resultMessage": "로그인이 필요합니다." }

Registration

Info
POST {{protocol}}://{{hostname}}:{{port}}/svc/coupon/registration

Define
- 회원이 쿠폰 코드를 등록하여 쿠폰을 받을 수 있다.
- 회원 로그인 사용자만 사용 가능
parameters
- couponCode : 발급방식이 쿠폰등록인 쿠폰에서 선발행된 쿠폰 코드

Expand

Code Block
{ "result": "200", "resultMessage": "SUCCESS" }

Code Block
{ "result": "400", "resultMessage": "쿠폰을 다운로드할 수 없습니다. : 27223021" }

Code Block
{ "result": "401", "resultMessage": "로그인이 필요합니다." }

UsableList

Info
POST {{protocol}}://{{hostname}}:{{port}}/svc/coupon/usableList

Define
- 임시주문서에 대하여 사용가능한 쿠폰 리스트를 반환
- 선택한 쿠폰이 없으면 “최대 혜택 가능한 쿠폰”을 기본으로 선택
- 회원 로그인 사용자만 조회 가능

parameters

tempOrderSheet : 임시주문서 ID
selectedCoupons : 선택한 쿠폰
- type : 쿠폰 유형
  - cart, product, deliveryFree
- id : 쿠폰 적용할 대상
  - 임시 주문서 ID, 임시 주문 상품 ID, 임시 주문 합배송 ID
- coupon : 선택한 쿠폰 ID

Code Block

[
    { "type":"cart", "id": "0f594031f61d4f4998f3dcf2e5594f53", "coupon": "210673746"},
    { "type":"product", "id": "1342159441", "coupon": "1032521039"},
    { "type":"deliveryFree", "id": "1258148033", "coupon": "2028237231"}
]

Description
- count : 사용가능한 쿠폰 수량
  - owned : 보유 수량
  - usable : 사용가능한 수량 (선택한 수량 제외)
  - selected : 선택한 수량
- finalTotalCouponDiscount : 선택한 쿠폰으로 예상되는 총 쿠폰 할인 금액
- cart : 장바구니 쿠폰 영역
  - id : 임시주문서 ID
  - totalOrderPrice : 쿠폰적용 기준 금액 (총 상품 주문 금액)
  - totalCouponDiscountPrice : 예상되는 장바구니 쿠폰 할인 금액
  - applicationCoupons : 선택 적용한 쿠폰 리스트
  - applicableCoupons : 선택 적용 가능한 쿠폰 리스트
- product : 상품 쿠폰 영역
  - id : 임시 주문 상품 ID
  - totalOrderPrice : 쿠폰적용 기준 금액 (상품 주문 금액)
  - totalCouponDiscountPrice : 예상되는 상품 쿠폰 할인 금액
  - applicationCoupons : 선택 적용한 쿠폰 리스트
  - applicableCoupons : 선택 적용 가능한 쿠폰 리스트
- deliveryFree : 배송비 무료 쿠폰 영역
  - id : 임시 주문 합배송 ID
  - totalOrderPrice : 쿠폰적용 기준 금액 (합배송 하위 총 상품 주문 금액)
  - totalCouponDiscountPrice : 예상되는 배송비 무료 쿠폰 할인 금액
  - applicationCoupons : 선택 적용한 쿠폰 리스트
  - applicableCoupons : 선택 적용 가능한 쿠폰 리스트

Expand

Code Block

{
    "result": "200",
    "resultMessage": "SUCCESS",
    "item": {
        "count": {
            "owned": 6,
            "usable": 1,
            "selected": 3
        },
        "finalTotalCouponDiscount": 148260,
        "cart": {
            "id": "0f594031f61d4f4998f3dcf2e5594f53",
            "totalOrderPrice": 943500,
            "totalCouponDiscountPrice": 50000,
            "applicationCoupons": [
                {
                    "id": "210673746",
                    "name": "장바구니-다운로드",
                    "discount": "50000원",
                    "duplicated": false,
                    "couponDiscountPrice": 50000
                }
            ],
            "applicableCoupons": []
        },
        "product": [
            {
                "id": "1342159441",
                "totalOrderPrice": 638400,
                "totalCouponDiscountPrice": 95760,
                "applicationCoupons": [
                    {
                        "id": "1032521039",
                        "name": "상품-다운로드",
                        "discount": "15%",
                        "duplicated": false,
                        "couponDiscountPrice": 95760
                    }
                ],
                "applicableCoupons": [
                    {
                        "id": "948578403",
                        "name": "상품-ID당발급건수제한",
                        "discount": "15%",
                        "duplicated": false,
                        "couponDiscountPrice": 95760
                    }
                ]
            },
            {
                "id": "702291891",
                "totalOrderPrice": 305100,
                "totalCouponDiscountPrice": 0,
                "applicationCoupons": [],
                "applicableCoupons": []
            }
        ],
        "deliveryFree": [
            {
                "id": "1258148033",
                "deliveryPrice": 2500,
                "totalOrderPrice": 638400,
                "totalCouponDiscountPrice": 2500,
                "applicationCoupons": [
                    {
                        "id": "2028237231",
                        "name": "배송비무료-다운로드",
                        "duplicated": false,
                        "couponDiscountPrice": 2500
                    }
                ],
                "applicableCoupons": []
            },
            {
                "id": "245162021",
                "deliveryPrice": 2500,
                "totalOrderPrice": 305100,
                "totalCouponDiscountPrice": 0,
                "applicationCoupons": [],
                "applicableCoupons": []
            }
        ]
    }
}

Code Block
{ "result": "401", "resultMessage": "로그인이 필요합니다." }

DownloadableList

Info
POST {{protocol}}://{{hostname}}:{{port}}/svc/coupon/downloadableList

Define
- 기준 데이터에 대하여 다운로드 가능한 쿠폰 리스트 반환
- 회원/비회원 조회 가능
parameters
- siteCategory : 전시 카테고리 ID
- productCategory : 상품 표준 카테고리 ID
- brand : 브랜드 코드
- vendor : 공급사 ID
- seller : 판매사 ID
- siteProduct : 전시 상품 ID
- product : 상품 ID
Description
- id : 쿠폰 ID
- couponKind : 쿠폰 종류
- name : 쿠폰 이름
- discount : 할인정보
- owned : 보유여부 (이미 다운로드)

Expand

Code Block

{
    "result": "200",
    "resultMessage": "SUCCESS",
    "totalCount": 6,
    "items": [
        {
            "id": "122",
            "couponKind": {
                "value": "product",
                "label": "상품쿠폰"
            },
            "name": "상품-할인방식,정액 (50,000)",
            "discount": "50000원",
            "owned": false
        },
        {
            "id": "123",
            "couponKind": {
                "value": "product",
                "label": "상품쿠폰"
            },
            "name": "상품-할인방식,정률 (20%)",
            "discount": "20%",
            "owned": false
        },
        {
            "id": "138",
            "couponKind": {
                "value": "product",
                "label": "상품쿠폰"
            },
            "name": "상품-중복가능4 (3,000)",
            "discount": "3000원",
            "owned": false
        },
        {
            "id": "104",
            "couponKind": {
                "value": "deliveryFree",
                "label": "배송비무료쿠폰"
            },
            "name": "배송비무료-다운로드",
            "owned": true
        },
        {
            "id": "110",
            "couponKind": {
                "value": "product",
                "label": "상품쿠폰"
            },
            "name": "상품-다운로드",
            "discount": "15%",
            "owned": true
        },
        {
            "id": "116",
            "couponKind": {
                "value": "cart",
                "label": "장바구니쿠폰"
            },
            "name": "장바구니-다운로드",
            "discount": "50000원",
            "owned": true
        }
    ]
}

Versions Compared

Old Version 5

New Version Current

Key

Coupon API

Download

Registration

UsableList

DownloadableList

Page Comparison

Versions Compared

Old Version 5

New Version Current

Key

Coupon API

Download

Registration

UsableList

DownloadableList