프로모션 할인

주문서 배송비 쿠폰 조회

post

기능설명

배송그룹별 배송비쿠폰 정보를 조회합니다.

상세설명

비회원은 해당 API를 사용할 수 없는 회원 전용 API입니다.
동일한 쿠폰이 하나 이상의 배송그룹에 노출 될 수 있습니다.
현재 정책에서는 주문당 하나의 배송비 쿠폰을 적용할 수 있습니다.
프로모션 유형에 따라 무료배송쿠폰, 무료반품쿠폰을 조회할 수 있습니다.

Header parameters

AuthorizationanyOptional

Access Token

Body

배송비쿠폰 조회 Request

mbrNostringRequired

회원번호

Example: 100000000

mbrGradeCdstring · enumRequired

회원등급코드(ME008) 10 : GREEN , 20 : FAMILY , 30 : GOLD , 40 : VIP , 50 : VVIP

Example: 10Possible values:

promoTypCdstring · enumRequired

프로모션 유형(무료배송쿠폰, 무료반품비쿠폰)

Example: 14Possible values:

baseDtmstring · date-timeRequired

기준일시

Responses

200

성공

*/*

usePsbDlvCpnCntinteger · int32Required

사용가능무료배송쿠폰수

usePsbClmDlvCpnCntinteger · int32Required

사용가능무료반품쿠폰수

900

업무처리 오류 내용

*/*

post/v1/marketing/orderDlvBenefitList

POST /api/order/v1/marketing/orderDlvBenefitList HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 157

{
  "mbrNo": "100000000",
  "mbrGradeCd": "10",
  "promoTypCd": "14",
  "baseDtm": "2026-01-01T00:00:00.000Z",
  "deliGrpInfoList": [
    {
      "deliNo": "100000001",
      "entrNo": "10000000"
    }
  ]
}

{
  "usePsbDlvCpnCnt": 1,
  "usePsbClmDlvCpnCnt": 1,
  "deliGrpInfo": [
    {
      "deliNo": "100000001",
      "entrNo": "10000000",
      "benefitList": [
        {
          "promoNo": "C1000000",
          "promoNm": "프로모션 명",
          "promoTypCd": "11",
          "ourChrgRate": 100,
          "entrChrgRate": 0,
          "cpnIsuNo": "100000",
          "ordCostGbCd": "10"
        }
      ]
    }
  ]
}

주문서 최대혜택가 조회

post

기능설명

조건에 따라 최대혜택조회/사용가능한 할인정보를 조회합니다.

상세설명

비회원은 해당 API를 사용할 수 없는 회원 전용 API입니다.
선택된 쿠폰/할인이 있는 경우 : 최대혜택 조회
선택된 쿠폰/할인이 없는 경우 : 선택된 쿠폰/할인 사용 가능 체크
전달받은 상품에 사용 가능한 혜택 정보를 체크하여 계산합니다.
할인으로 인해 상품의 역마진이 발생하는 혜택은 조회되지 않습니다.

수정번호

Release v1.03_231106: 임직원 할인 한도 관리 추가
Release v2.00_240530: 최대혜택 계산 시 주문 수량을 고려하도록 함

Header parameters

AuthorizationanyOptional

Access Token

Body

쿠폰혜택조회 Request

mbrNostringRequired

회원번호

Example: 100000000

mbrGradeCdstring · enumRequired

회원등급코드(ME008) 10 : GREEN , 20 : FAMILY , 30 : GOLD , 40 : VIP , 50 : VVIP

Example: 10Possible values:

comGbCdstringRequired

회사구분코드(ME038)

Example: P00

stafYnstringRequired

임직원여부

Example: Y

ordMediaCdstring · enumRequired

주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문

Example: 20Possible values:

ordTypeGbCdstring · enumRequired

주문 유형 10 : 장바구니 , 20 : 주문 , 30 : 클레임

Example: 10Possible values:

baseDtmstring · date-timeRequired

기준일시

Responses

200

성공

*/*

쿠폰혜택조회 Response

totalDcAmtinteger · int64Required

전체할인금액

Example: 10000

900

업무처리 오류 내용

*/*

post/v1/marketing/orderBenefitList

POST /api/order/v1/marketing/orderBenefitList HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 482

{
  "mbrNo": "100000000",
  "mbrGradeCd": "10",
  "comGbCd": "P00",
  "stafYn": "Y",
  "ordMediaCd": "20",
  "ordTypeGbCd": "10",
  "baseDtm": "2026-01-01T00:00:00.000Z",
  "goodsList": [
    {
      "goodsNo": "10000001",
      "itmNo": "001",
      "supPcost": 5000,
      "salePrc": 7000,
      "stdCtgNo": "EX00000000",
      "dispCtgNo": "000",
      "brandNo": "100000",
      "entrNo": "1000000",
      "chlNo": "1000000",
      "marketingDisplayNo": "1000000",
      "cnt": 1,
      "bnfList": [
        {
          "promoNo": "C1000000",
          "cpnIsuNo": "100000000"
        }
      ]
    }
  ],
  "orderBnfList": [
    {
      "promoNo": "C1000000",
      "cpnIsuNo": "100000000"
    }
  ]
}

{
  "totalDcAmt": 10000,
  "goodsBenefitList": [
    {
      "goodsNo": "10000001",
      "itmNo": "001",
      "dcAmt": 5000,
      "benefitList": [
        {
          "promoNo": "C1000000",
          "promoNm": "프로모션 명",
          "promoTypCd": "11",
          "ourChrgRate": 100,
          "entrChrgRate": 0,
          "fixamtFxrtGbCd": "01",
          "dcRateAmt": 5000,
          "minBuyAmt": 1000,
          "maxDcAmt": 5000,
          "isMaxYn": "Y",
          "dcAmt": 5000,
          "dcAmtPerCnt": 2500,
          "cpnIsuNo": "100000"
        }
      ]
    }
  ],
  "orderBenefitList": [
    {
      "promoNo": "C1000000",
      "promoNm": "프로모션 명",
      "promoTypCd": "11",
      "ourChrgRate": 100,
      "entrChrgRate": 0,
      "fixamtFxrtGbCd": "01",
      "dcRateAmt": 5000,
      "minBuyAmt": 1000,
      "maxDcAmt": 5000,
      "isMaxYn": "Y",
      "dcAmt": 5000,
      "cpnIsuNo": "100000",
      "goods": [
        {
          "goodsNo": "10000001",
          "itmNo": "001",
          "dcAmt": 5000
        }
      ]
    }
  ]
}

상품상세 최대혜택가조회

post

기능설명

상품에 사용 가능한 혜택중 할인금액이 가장 큰 할인정보를 계산합니다.

상세설명

상품에 사용 가능한 혜택중 할인금액이 가장 큰 할인정보를 계산합니다.
회원의 경우 최대혜택 계산 시 다운로드 가능한 쿠폰도 계산 대상에 포함합니다.
최대 혜택 계산에 적용 되는 할인 정보
- 비회원
  - 프로모션(할인) : 상품즉시할인(적용회원등급: 전체 선택, 전체 미선택(데이터 마이그레이션 고려))
- 회원
  - 프로모션(할인) : 임직원할인, 상품즉시할인
  - 보유한 쿠폰 : 상품할인쿠폰
  - 다운로드 가능한 쿠폰
    프로모션유형 : 상품할인쿠폰
    쿠폰발급주체 : 고정판촉쿠폰
  - 쿠폰발급방식 : 고객다운로드발급, 할인쿠폰코드발급

수정번호

Release v1.03_231106: 임직원 할인 한도 관리 추가

Header parameters

AuthorizationanyOptional

Access Token

Body

상품상세최대혜택가조회 Request

ordMediaCdstring · enumRequired

주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문

Example: 20Possible values:

Responses

200

성공

*/*

goodsNostringRequired

상품번호

Example: 10000001

itmNostringRequired

단품번호

Example: 001

salePrcinteger · int64Required

판매가

Example: 9000

maxBenefitAmtinteger · int64Required

최대할인혜택금액(최대혜택가)

Example: 8500

900

업무처리 오류 내용

*/*

post/v1/marketing/maxDcAmt

POST /api/order/v1/marketing/maxDcAmt HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 238

{
  "ordMediaCd": "20",
  "goodsList": [
    {
      "goodsNo": "10000001",
      "itmNo": "001",
      "supPcost": 8000,
      "salePrc": 9000,
      "cnt": 1,
      "stdCtgNo": "HT01020000",
      "dispCtgNo": "213",
      "brandNo": "100002",
      "entrNo": "1000002",
      "chlNo": "1000001",
      "marketingDisplayNo": "1000001"
    }
  ]
}

[
  {
    "goodsNo": "10000001",
    "itmNo": "001",
    "salePrc": 9000,
    "maxBenefitAmt": 8500,
    "promoList": [
      {
        "promoNo": "C1000000",
        "promoNm": "프로모션명",
        "promoTypCd": "11",
        "dcAmt": 500
      }
    ]
  }
]

상품별 즉시할인가 조회

post

기능설명

상품별 사용 가능한 상품즉시할인을 조회합니다.

상세설명

전달 받은 상품별로 할인율이 가장 큰 상품즉시할인을 조회하는 API입니다.

Header parameters

AuthorizationanyOptional

Access Token

Body

baseDtmstring · date-timeRequired

기준일시

Responses

200

성공

*/*

goodsNostringRequired

상품번호

itmNostringRequired

단품번호

salePrcinteger · int64Required

판매가

promoNostringRequired

프로모션번호

promoNmstringRequired

프로모션명

fixamtFxrtGbCdstring · enumRequired

정액정율구분 코드(MK005) 01 : 정액 , 02 : 정률

Example: 01Possible values:

dcRateAmtinteger · int64Required

할인율금액

dcAmtinteger · int64Required

할인금액

900

업무처리 오류 내용

*/*

post/v1/marketing/goodsDirectDiscountList

POST /api/order/v1/marketing/goodsDirectDiscountList HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "baseDtm": "2026-01-01T00:00:00.000Z",
  "goodsList": [
    {
      "goodsNo": "10000001",
      "itmNo": "001",
      "supPcost": 5000,
      "salePrc": 7000
    }
  ]
}

[
  {
    "goodsNo": "text",
    "itmNo": "text",
    "salePrc": 1,
    "promoNo": "text",
    "promoNm": "text",
    "fixamtFxrtGbCd": "01",
    "dcRateAmt": 1,
    "dcAmt": 1
  }
]

최대 배송비 혜택 조회

post

기능설명

주문서 쿠폰 목록 조회 API에서 배송비 쿠폰 정보만 조회하는 API입니다.

상세설명

배송비 쿠폰 정보 : 배송 그룹 별로 사용 가능한 배송비 쿠폰 정보를 조회하고, 아래 정렬 순서에 맞는 하나의 배송 그룹에 배송비 쿠폰을 세팅합니다.
- 배송비 Desc -> 추가 배송비 Desc -> 배송그룹번호 Asc

Header parameters

AuthorizationanyOptional

Access Token

Body

쿠폰선택팝업 Request

mbrNostringRequired

회원번호

Example: 100000000

mbrGradeCdstring · enumRequired

회원등급코드(ME008) 10 : GREEN , 20 : FAMILY , 30 : GOLD , 40 : VIP , 50 : VVIP

Example: 10Possible values:

comGbCdstringRequired

회사구분코드(ME038)

Example: P00

stafYnstringRequired

임직원여부

Example: Y

ordMediaCdstring · enumOptional

주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문

Example: 20Possible values:

baseDtmstring · date-timeRequired

기준일시

cpnPopupGbCdstring · enumOptional

쿠폰팝업구분코드 10 : 주문서 , 20 : 쿠폰선택팝업

Example: 10Possible values:

Responses

200

성공

*/*

dlvCpnCntinteger · int64Required

사용 가능한 배송비 쿠폰 수

900

업무처리 오류 내용

*/*

post/v1/marketing/getMaxBenefitDeliveryCoupon

POST /api/order/v1/marketing/getMaxBenefitDeliveryCoupon HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 638

{
  "mbrNo": "100000000",
  "mbrGradeCd": "10",
  "comGbCd": "P00",
  "stafYn": "Y",
  "ordMediaCd": "20",
  "baseDtm": "2026-01-01T00:00:00.000Z",
  "goodsList": [
    {
      "goodsNo": "10000001",
      "itmNo": "001",
      "supPcost": 5000,
      "salePrc": 7000,
      "stdCtgNo": "EX00000000",
      "dispCtgNo": "000",
      "brandNo": "100000",
      "entrNo": "1000000",
      "chlNo": "1000000",
      "marketingDisplayNo": "1000000",
      "cnt": 1,
      "goodsNm": "상품명 예시",
      "brandNm": "브랜드명 예시"
    }
  ],
  "dlvGrpList": [
    {
      "deliNo": "100000001",
      "entrNo": "1000000",
      "benefitInfo": {
        "promoNo": "C1000000",
        "promoNm": "프로모션 명",
        "promoTypCd": "11",
        "ourChrgRate": 100,
        "entrChrgRate": 0,
        "cpnIsuNo": "100000",
        "ordCostGbCd": "10"
      }
    }
  ],
  "cpnPopupGbCd": "10"
}

{
  "dlvCpnCnt": 1,
  "dlvGrpInfo": [
    {
      "deliNo": "100000001",
      "entrNo": "1000000",
      "benefitInfo": {
        "promoNo": "C1000000",
        "promoNm": "프로모션 명",
        "promoTypCd": "11",
        "ourChrgRate": 100,
        "entrChrgRate": 0,
        "cpnIsuNo": "100000",
        "ordCostGbCd": "10"
      }
    }
  ]
}

주문서 쿠폰 목록 조회

post

기능설명

주문서 쿠폰 선택 팝업에서 사용하는 API입니다.

상세설명

쿠폰 선택 팝업 진입 시 사용 가능한 혜택정보를 조회하며, 조회 내용은 아래와 같습니다.
- 임직원 할인 : 상품별로 사용 가능한 임직원 할인 중, 할인 금액이 가장 큰 혜택 하나를 자동 계산하여 내립니다.
- 상품 즉시 할인 : 상품별로 사용 가능한 상품 즉시 할인 중, 할인 금액이 가장 큰 혜택 하나를 자동 계산하여 내립니다.
- 상품 단위 혜택 정보 : 상품별로 사용 가능한 쿠폰 정보를 내립니다. 이 정보를 토대로 script에서 실제 사용 가능한지 계산하여 노출합니다.
- 장바구니 단위 혜택 정보 : 주문서 단위로 사용 가능한 쿠폰 정보를 내립니다. 이 정보를 토대로 script에서 실제 사용 가능한지 계산하여 노출합니다.
- 회원 보유 쿠폰 정보 : 회원이 보유하고 있는 쿠폰(배송비 쿠폰 제외) 정보를 담고 있습니다. 이 정보를 토대로 script에서 실제 사용 가능한지 계산하여 노출합니다.
- 배송비 쿠폰 정보 : 배송 그룹 별로 사용 가능한 배송비 쿠폰 정보를 조회하고, 아래 정렬 순서에 맞는 하나의 배송 그룹에 배송비 쿠폰을 세팅합니다.
  - 배송비 Desc -> 추가 배송비 Desc -> 배송그룹번호 Asc
- 최대 혜택 정보 : 사용 가능한 혜택 정보들 중 최대 혜택인 할인 정보를 담고 있습니다.

수정번호

Release v1.03_231106: 임직원 할인 한도 관리 추가
Release v2.00_240509: 적용대상 - 기획전 정보 조회 추가
Release v2.00_241205: 쿠폰에서 설정한 최소구매수량/최소구매금액이 주문한 상품의 개수와 관계없이 무조건 한개 기준으로 체크하고 있었던 것을 수정

Header parameters

AuthorizationanyOptional

Access Token

Body

쿠폰선택팝업 Request

mbrNostringRequired

회원번호

Example: 100000000

mbrGradeCdstring · enumRequired

회원등급코드(ME008) 10 : GREEN , 20 : FAMILY , 30 : GOLD , 40 : VIP , 50 : VVIP

Example: 10Possible values:

comGbCdstringRequired

회사구분코드(ME038)

Example: P00

stafYnstringRequired

임직원여부

Example: Y

ordMediaCdstring · enumOptional

주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문

Example: 20Possible values:

baseDtmstring · date-timeRequired

기준일시

cpnPopupGbCdstring · enumOptional

쿠폰팝업구분코드 10 : 주문서 , 20 : 쿠폰선택팝업

Example: 10Possible values:

Responses

200

성공

*/*

쿠폰선택팝업 Response

900

업무처리 오류 내용

*/*

post/v1/marketing/getCouponPopupData

POST /api/order/v1/marketing/getCouponPopupData HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 638

{
  "mbrNo": "100000000",
  "mbrGradeCd": "10",
  "comGbCd": "P00",
  "stafYn": "Y",
  "ordMediaCd": "20",
  "baseDtm": "2026-01-01T00:00:00.000Z",
  "goodsList": [
    {
      "goodsNo": "10000001",
      "itmNo": "001",
      "supPcost": 5000,
      "salePrc": 7000,
      "stdCtgNo": "EX00000000",
      "dispCtgNo": "000",
      "brandNo": "100000",
      "entrNo": "1000000",
      "chlNo": "1000000",
      "marketingDisplayNo": "1000000",
      "cnt": 1,
      "goodsNm": "상품명 예시",
      "brandNm": "브랜드명 예시"
    }
  ],
  "dlvGrpList": [
    {
      "deliNo": "100000001",
      "entrNo": "1000000",
      "benefitInfo": {
        "promoNo": "C1000000",
        "promoNm": "프로모션 명",
        "promoTypCd": "11",
        "ourChrgRate": 100,
        "entrChrgRate": 0,
        "cpnIsuNo": "100000",
        "ordCostGbCd": "10"
      }
    }
  ],
  "cpnPopupGbCd": "10"
}

{
  "executivesDiscountInfo": {
    "totalDcAmt": 1,
    "goodsList": [
      {
        "goodsNo": "10000001",
        "goodsNm": "상품 명",
        "brandNm": "브랜드 명",
        "itmNo": "001",
        "dcAmt": 5000,
        "bnfInfo": {
          "promoNo": "C1000000",
          "promoNm": "프로모션 명",
          "promoTypCd": "11",
          "ourChrgRate": 100,
          "entrChrgRate": 0,
          "fixamtFxrtGbCd": "01",
          "dcRateAmt": 5000,
          "minBuyAmt": 1000,
          "maxDcAmt": 5000,
          "isMaxYn": "Y",
          "dcAmt": 5000,
          "dcAmtPerCnt": 2500,
          "cpnIsuNo": "100000"
        }
      }
    ]
  },
  "goodsDirectDiscountInfo": {
    "totalDcAmt": 1,
    "goodsList": [
      {
        "goodsNo": "10000001",
        "goodsNm": "상품 명",
        "brandNm": "브랜드 명",
        "itmNo": "001",
        "dcAmt": 5000,
        "bnfInfo": {
          "promoNo": "C1000000",
          "promoNm": "프로모션 명",
          "promoTypCd": "11",
          "ourChrgRate": 100,
          "entrChrgRate": 0,
          "fixamtFxrtGbCd": "01",
          "dcRateAmt": 5000,
          "minBuyAmt": 1000,
          "maxDcAmt": 5000,
          "isMaxYn": "Y",
          "dcAmt": 5000,
          "dcAmtPerCnt": 2500,
          "cpnIsuNo": "100000"
        }
      }
    ]
  },
  "goodsBenefitInfo": [
    {
      "goodsNo": "10000001",
      "itmNo": "001",
      "promoNoList": [
        "C1000000"
      ]
    }
  ],
  "basketCouponBenefitinfo": [
    {
      "promoNo": "C1000000",
      "goodsList": [
        {
          "goodsNo": "10000001",
          "itmNo": "001"
        }
      ]
    }
  ],
  "promoList": [
    {
      "promoNo": "C1000000",
      "promoNm": "프로모션 명",
      "promoTypCd": "11",
      "ourChrgRate": 100,
      "entrChrgRate": 0,
      "fixamtFxrtGbCd": "01",
      "dcRateAmt": 5000,
      "minBuyAmt": 1000,
      "maxDcAmt": 5000,
      "couponIssuedInfo": [
        {
          "cpnIsuNo": "100000000",
          "mbrNo": "100000000",
          "cpnNo": "C1000000",
          "cpnIsuDtm": "2026-01-01T00:00:00.000Z",
          "valiStrtDtm": "2026-01-01T00:00:00.000Z",
          "valiEndDtm": "2026-01-01T00:00:00.000Z",
          "useYn": "N"
        }
      ],
      "goodsNo": "10000001",
      "itmNo": "001",
      "baseAmt": 1
    }
  ],
  "dlvCouponInfo": {
    "dlvCpnCnt": 1,
    "dlvGrpInfo": [
      {
        "deliNo": "100000001",
        "entrNo": "1000000",
        "benefitInfo": {
          "promoNo": "C1000000",
          "promoNm": "프로모션 명",
          "promoTypCd": "11",
          "ourChrgRate": 100,
          "entrChrgRate": 0,
          "cpnIsuNo": "100000",
          "ordCostGbCd": "10"
        }
      }
    ]
  },
  "maxBenefitInfo": {
    "totalDcAmt": 10000,
    "goodsBenefitList": [
      {
        "goodsNo": "10000001",
        "itmNo": "001",
        "dcAmt": 5000,
        "benefitList": [
          {
            "promoNo": "C1000000",
            "promoNm": "프로모션 명",
            "promoTypCd": "11",
            "ourChrgRate": 100,
            "entrChrgRate": 0,
            "fixamtFxrtGbCd": "01",
            "dcRateAmt": 5000,
            "minBuyAmt": 1000,
            "maxDcAmt": 5000,
            "isMaxYn": "Y",
            "dcAmt": 5000,
            "dcAmtPerCnt": 2500,
            "cpnIsuNo": "100000"
          }
        ]
      }
    ],
    "orderBenefitList": [
      {
        "promoNo": "C1000000",
        "promoNm": "프로모션 명",
        "promoTypCd": "11",
        "ourChrgRate": 100,
        "entrChrgRate": 0,
        "fixamtFxrtGbCd": "01",
        "dcRateAmt": 5000,
        "minBuyAmt": 1000,
        "maxDcAmt": 5000,
        "isMaxYn": "Y",
        "dcAmt": 5000,
        "cpnIsuNo": "100000",
        "goods": [
          {
            "goodsNo": "10000001",
            "itmNo": "001",
            "dcAmt": 5000
          }
        ]
      }
    ]
  }
}

상담원 주문서 프로모션 목록 조회

post

기능 설명

상담원이 입력한 주문에서 선택 가능한 프로모션을 조회하는 API입니다.

상세 설명

BO 상담원 주문 진행 도중 선택 가능한 프로모션을 조회합니다.

특이사항

getCouponPopupData(프로모션 할인) API와 동일 로직입니다.
다른점은 파라미터의 회원번호(mbrNo)로 주문을 생성하며, 회원번호는 필수 파라미터입니다.

Header parameters

AuthorizationanyOptional

Access Token

Body

쿠폰선택팝업 Request

mbrNostringRequired

회원번호

Example: 100000000

mbrGradeCdstring · enumRequired

회원등급코드(ME008) 10 : GREEN , 20 : FAMILY , 30 : GOLD , 40 : VIP , 50 : VVIP

Example: 10Possible values:

comGbCdstringRequired

회사구분코드(ME038)

Example: P00

stafYnstringRequired

임직원여부

Example: Y

ordMediaCdstring · enumOptional

주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문

Example: 20Possible values:

baseDtmstring · date-timeRequired

기준일시

cpnPopupGbCdstring · enumOptional

쿠폰팝업구분코드 10 : 주문서 , 20 : 쿠폰선택팝업

Example: 10Possible values:

Responses

200

성공

*/*

쿠폰선택팝업 Response

900

업무처리 오류 내용

*/*

post/v1/marketing/getCounselorOrderCouponPopupData

POST /api/order/v1/marketing/getCounselorOrderCouponPopupData HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 638

{
  "mbrNo": "100000000",
  "mbrGradeCd": "10",
  "comGbCd": "P00",
  "stafYn": "Y",
  "ordMediaCd": "20",
  "baseDtm": "2026-01-01T00:00:00.000Z",
  "goodsList": [
    {
      "goodsNo": "10000001",
      "itmNo": "001",
      "supPcost": 5000,
      "salePrc": 7000,
      "stdCtgNo": "EX00000000",
      "dispCtgNo": "000",
      "brandNo": "100000",
      "entrNo": "1000000",
      "chlNo": "1000000",
      "marketingDisplayNo": "1000000",
      "cnt": 1,
      "goodsNm": "상품명 예시",
      "brandNm": "브랜드명 예시"
    }
  ],
  "dlvGrpList": [
    {
      "deliNo": "100000001",
      "entrNo": "1000000",
      "benefitInfo": {
        "promoNo": "C1000000",
        "promoNm": "프로모션 명",
        "promoTypCd": "11",
        "ourChrgRate": 100,
        "entrChrgRate": 0,
        "cpnIsuNo": "100000",
        "ordCostGbCd": "10"
      }
    }
  ],
  "cpnPopupGbCd": "10"
}

{
  "executivesDiscountInfo": {
    "totalDcAmt": 1,
    "goodsList": [
      {
        "goodsNo": "10000001",
        "goodsNm": "상품 명",
        "brandNm": "브랜드 명",
        "itmNo": "001",
        "dcAmt": 5000,
        "bnfInfo": {
          "promoNo": "C1000000",
          "promoNm": "프로모션 명",
          "promoTypCd": "11",
          "ourChrgRate": 100,
          "entrChrgRate": 0,
          "fixamtFxrtGbCd": "01",
          "dcRateAmt": 5000,
          "minBuyAmt": 1000,
          "maxDcAmt": 5000,
          "isMaxYn": "Y",
          "dcAmt": 5000,
          "dcAmtPerCnt": 2500,
          "cpnIsuNo": "100000"
        }
      }
    ]
  },
  "goodsDirectDiscountInfo": {
    "totalDcAmt": 1,
    "goodsList": [
      {
        "goodsNo": "10000001",
        "goodsNm": "상품 명",
        "brandNm": "브랜드 명",
        "itmNo": "001",
        "dcAmt": 5000,
        "bnfInfo": {
          "promoNo": "C1000000",
          "promoNm": "프로모션 명",
          "promoTypCd": "11",
          "ourChrgRate": 100,
          "entrChrgRate": 0,
          "fixamtFxrtGbCd": "01",
          "dcRateAmt": 5000,
          "minBuyAmt": 1000,
          "maxDcAmt": 5000,
          "isMaxYn": "Y",
          "dcAmt": 5000,
          "dcAmtPerCnt": 2500,
          "cpnIsuNo": "100000"
        }
      }
    ]
  },
  "goodsBenefitInfo": [
    {
      "goodsNo": "10000001",
      "itmNo": "001",
      "promoNoList": [
        "C1000000"
      ]
    }
  ],
  "basketCouponBenefitinfo": [
    {
      "promoNo": "C1000000",
      "goodsList": [
        {
          "goodsNo": "10000001",
          "itmNo": "001"
        }
      ]
    }
  ],
  "promoList": [
    {
      "promoNo": "C1000000",
      "promoNm": "프로모션 명",
      "promoTypCd": "11",
      "ourChrgRate": 100,
      "entrChrgRate": 0,
      "fixamtFxrtGbCd": "01",
      "dcRateAmt": 5000,
      "minBuyAmt": 1000,
      "maxDcAmt": 5000,
      "couponIssuedInfo": [
        {
          "cpnIsuNo": "100000000",
          "mbrNo": "100000000",
          "cpnNo": "C1000000",
          "cpnIsuDtm": "2026-01-01T00:00:00.000Z",
          "valiStrtDtm": "2026-01-01T00:00:00.000Z",
          "valiEndDtm": "2026-01-01T00:00:00.000Z",
          "useYn": "N"
        }
      ],
      "goodsNo": "10000001",
      "itmNo": "001",
      "baseAmt": 1
    }
  ],
  "dlvCouponInfo": {
    "dlvCpnCnt": 1,
    "dlvGrpInfo": [
      {
        "deliNo": "100000001",
        "entrNo": "1000000",
        "benefitInfo": {
          "promoNo": "C1000000",
          "promoNm": "프로모션 명",
          "promoTypCd": "11",
          "ourChrgRate": 100,
          "entrChrgRate": 0,
          "cpnIsuNo": "100000",
          "ordCostGbCd": "10"
        }
      }
    ]
  },
  "maxBenefitInfo": {
    "totalDcAmt": 10000,
    "goodsBenefitList": [
      {
        "goodsNo": "10000001",
        "itmNo": "001",
        "dcAmt": 5000,
        "benefitList": [
          {
            "promoNo": "C1000000",
            "promoNm": "프로모션 명",
            "promoTypCd": "11",
            "ourChrgRate": 100,
            "entrChrgRate": 0,
            "fixamtFxrtGbCd": "01",
            "dcRateAmt": 5000,
            "minBuyAmt": 1000,
            "maxDcAmt": 5000,
            "isMaxYn": "Y",
            "dcAmt": 5000,
            "dcAmtPerCnt": 2500,
            "cpnIsuNo": "100000"
          }
        ]
      }
    ],
    "orderBenefitList": [
      {
        "promoNo": "C1000000",
        "promoNm": "프로모션 명",
        "promoTypCd": "11",
        "ourChrgRate": 100,
        "entrChrgRate": 0,
        "fixamtFxrtGbCd": "01",
        "dcRateAmt": 5000,
        "minBuyAmt": 1000,
        "maxDcAmt": 5000,
        "isMaxYn": "Y",
        "dcAmt": 5000,
        "cpnIsuNo": "100000",
        "goods": [
          {
            "goodsNo": "10000001",
            "itmNo": "001",
            "dcAmt": 5000
          }
        ]
      }
    ]
  }
}

상담원 주문 적립 정보 조회

post

기능설명

상담원 주문시 회원의 적립정보를 조회합니다.

상세설명

주문 시점에는 기본적립, 회원 등급 추가적립, 프로모션 적립 3가지가 있습니다.
- 기본 적립 : 별 다른 조건 없이 주문 시 정해진 적립율만큼 적립.
- 회원 등급 추가 적립 : 기준금액을 초과하는 경우 회원의 등급에 맞는 적립율만큼 추가 적립.
- 프로모션 적립 : 상품별로 적용 가능한 상품마일리지의 적립율 만큼 추가 적립. 단, 상품별로 하나의 프로모션 적립만 가능.

Header parameters

AuthorizationanyOptional

Access Token

Body

FO 주문서 적립 조회 Request DTO

ordMediaCdstring · enumOptional

주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문

Example: 20Possible values:

mbrNostringRequired

회원번호

Example: 100000000

mbrGradeCdstringRequired

회원등급코드

Responses

200

성공

*/*

적립정보

totalAccmAmtinteger · int64Required

전체적립금액

Example: 3000

900

업무처리 오류 내용

*/*

post/v1/marketing/getCounselorOrderAccumulationInfo

POST /api/order/v1/marketing/getCounselorOrderAccumulationInfo HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 2646

{
  "ordGoodsInfoList": [
    {
      "basketGoods": {
        "goodsNo": "100000001",
        "deliProcTypCd": "10",
        "deliPolcNo": "1",
        "deliNo": "100000021",
        "entrNo": "1000001",
        "ordQty": 1,
        "salePrc": 15000,
        "dcAmt": 3000,
        "sysModDtm": "2026-01-01T00:00:00.000Z",
        "itmNo": "001",
        "bsketNo": 100000001,
        "chlNo": "1",
        "chlDtlNo": "1",
        "infDispCtgNoGbCd": "01",
        "infDispCtgNo": "1",
        "repDispCtgNo": "1",
        "conrNo": "1",
        "bsketQty": 1,
        "goodsNm": "상품명",
        "stdCtgNo": "1",
        "goodsCompCd": "10",
        "goodsTypCd": "10",
        "saleMethCd": "10",
        "brandNo": "1",
        "brandNm": "브랜드명",
        "buyrAgeLmtCd": "0",
        "dispYn": "Y",
        "saleStatCd": "10",
        "saleStrDtm": "2026-01-01T00:00:00.000Z",
        "saleEndDtm": "2026-01-01T00:00:00.000Z",
        "buyTypCd": "10",
        "taxGbCd": "10",
        "stkMgrYn": "Y",
        "buyQtyLmtYn": "Y",
        "minLmtQty": 1,
        "maxLmtQty": 10,
        "safeStkNotiYn": "Y",
        "deliGoodsGbCd": "01",
        "deliWayCd": "01",
        "deliPsbRgnCd": "01",
        "deliDday": 1,
        "bpckPsbYn": "Y",
        "rtnPsbYn": "Y",
        "exchPsbYn": "Y",
        "supPcost": 10000,
        "norPrc": 20000,
        "preSalePrc": 20000,
        "mrgnRate": 4,
        "payMeanInfo": "11,12,32",
        "itmNm": "아이템명1>아이템명2>아이템명3",
        "stkQty": 999,
        "prestNm": "증정품명",
        "rsvStrtDtm": "2026-01-01T00:00:00.000Z",
        "rsvEndDtm": "2026-01-01T00:00:00.000Z",
        "fwdidcPrarDy": "2026-01-01",
        "hsCd": "1",
        "wishYn": "Y",
        "maxDcAmt": 1000,
        "goodsImg": "files/goods/2023/07/04/img",
        "itmSaleStatCd": "10",
        "gvgfPsbYn": "Y",
        "rglrDeliGoodsYn": "Y",
        "sngGoodsYn": "Y",
        "marketingDisplayNo": "1",
        "entrGoodsNo": "100042110583831",
        "entrItmNo": "100042110583831001",
        "ordCnclPsbYn": "N",
        "wthdYn": "N",
        "frgnDirPurGoodsYn": "text"
      },
      "aplyGoodsBnfInfo": {
        "goodsNo": "10000001",
        "itmNo": "001",
        "dcAmt": 5000,
        "benefitList": [
          {
            "promoNo": "C1000000",
            "promoNm": "프로모션 명",
            "promoTypCd": "11",
            "ourChrgRate": 100,
            "entrChrgRate": 0,
            "fixamtFxrtGbCd": "01",
            "dcRateAmt": 5000,
            "minBuyAmt": 1000,
            "maxDcAmt": 5000,
            "isMaxYn": "Y",
            "dcAmt": 5000,
            "dcAmtPerCnt": 2500,
            "cpnIsuNo": "100000"
          }
        ]
      },
      "aeEvtList": [
        {
          "goodsNo": "10000001",
          "itmNo": "001",
          "aeNo": "C1000000",
          "addEvtTypCd": "20",
          "aeStrDtm": "2026-01-01T00:00:00.000Z",
          "aeEndDtm": "2026-01-01T00:00:00.000Z",
          "payStrDt": "20231201",
          "payEndDt": "20231231",
          "tmEvtYn": "N",
          "aplyStrTm": "0800",
          "aplyEndTm": "2359",
          "aeDesc": "사은행사 설명",
          "aeNm": "사은행사 명",
          "aeGoodsList": [
            {
              "aeFvrSeq": "1",
              "aplyMinAmt": 5000,
              "aplyMaxAmt": 10000,
              "aeGoodsNm": "사은품 명",
              "aeGoodsNo": "10000001",
              "aeGoodsItmNo": "001",
              "aeGoodsImgPath": "/path/image001.png"
            }
          ]
        }
      ]
    }
  ],
  "benefitOrderPromotionInfo": {
    "promoNo": "C1000000",
    "promoNm": "프로모션 명",
    "promoTypCd": "11",
    "ourChrgRate": 100,
    "entrChrgRate": 0,
    "fixamtFxrtGbCd": "01",
    "dcRateAmt": 5000,
    "minBuyAmt": 1000,
    "maxDcAmt": 5000,
    "isMaxYn": "Y",
    "dcAmt": 5000,
    "cpnIsuNo": "100000",
    "goods": [
      {
        "goodsNo": "10000001",
        "itmNo": "001",
        "dcAmt": 5000
      }
    ]
  },
  "ordMediaCd": "20",
  "mbrNo": "100000000",
  "mbrGradeCd": "text"
}

{
  "totalAccmAmt": 3000,
  "accmList": [
    {
      "accmGbCd": "21",
      "accmRate": 10,
      "accmAmt": 3000,
      "promoNo": "C1000000",
      "promoNm": "프로모션 명",
      "promoTypCd": "40",
      "ourChrgRate": 100,
      "entrChrgRate": 0,
      "fixamtFxrtGbCd": "01",
      "rsrvStdAmt": 5000,
      "goodsAccmList": [
        {
          "goodsNo": "10000001",
          "itmNo": "001",
          "accmAmt": 3000
        }
      ]
    }
  ]
}

주문서 쿠폰 사용 처리

post

기능설명

주문에서 선택한 쿠폰들을 사용처리합니다.

상세설명

비회원은 해당 API를 사용할 수 없는 회원 전용 API입니다.
주문에서 선택한 쿠폰들을 사용처리합니다.
아래 조건에 부합하는 쿠폰만 사용이 가능합니다.
- 쿠폰 기간 : 유효
- 사용여부 : 미사용

Header parameters

AuthorizationanyOptional

Access Token

Body

사용 쿠폰정보 요청 DTO

mbrNostringRequired

회원번호

Example: 100000000

ordNostringRequired

주문번호

Example: 20230101O000001

cpnIsuNoListstring[]Optional

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

post/v1/marketing/cpnUse

POST /api/order/v1/marketing/cpnUse HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "mbrNo": "100000000",
  "ordNo": "20230101O000001",
  "cpnInfo": [
    {
      "cpnIsuNo": "0000001"
    }
  ],
  "cpnIsuNoList": [
    "text"
  ]
}

No content

쿠폰 취소/복원

post

기능설명

쿠폰을 취소/복원합니다.

상세설명

주문서
- 복원구분코드가 10일 경우
- 기존의 쿠폰 발급 정보에서 사용 관련 정보 제거합니다.
클레임/기타
- 복원구분코드가 20(클레임) 이거나 99(기타) 일 경우
- 기존의 발급된 정보를 이용해 새로운 쿠폰 발급합니다.
  - 쿠폰번호, 원쿠폰발급번호, 회원알림여부, 회원번호
- 발급된 쿠폰의 유효기간이 지났다면, 현재 일자에서 ST001 의 쿠폰복원유효일수 만큼 유효한 쿠폰을 재발급합니다.

Header parameters

AuthorizationanyOptional

Access Token

Body

복원 쿠폰정보 요청 DTO

mbrNostringRequired

회원번호

Example: 100000000

ordNostringRequired

주문번호

Example: 20230101O000001

restoreGbCdstring · enumRequired

쿠폰복원유형 10 : 주문서 , 20 : 클레임 , 99 : 기타

Example: 10Possible values:

cpnIsuNoListstring[]Optional

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

post/v1/marketing/cpnCancel

POST /api/order/v1/marketing/cpnCancel HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "mbrNo": "100000000",
  "ordNo": "20230101O000001",
  "restoreGbCd": "10",
  "cpnInfo": [
    {
      "cpnIsuNo": "0000001"
    }
  ],
  "cpnIsuNoList": [
    "text"
  ]
}

No content

회원별 쿠폰 건수 조회

get

기능설명

BO API 에서 회원의 쿠폰과 배송 관련 쿠폰의 개수를 조회합니다.

상세설명

회원이 보유하고 있는 쿠폰들 중 미사용이면서 기간이 유효한 쿠폰의 개수를 조회합니다.

Query parameters

mbrNostringRequired

회원번호

Example: 100000000

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

성공

*/*

회원이 보유한 쿠폰 수량

dlvCntinteger · int32Optional

무료배송쿠폰수량

cpnCntinteger · int32Optional

일반쿠폰수량

900

업무처리 오류 내용

*/*

get/v1/marketing/mbrCpnCnt

GET /api/order/v1/marketing/mbrCpnCnt?mbrNo=100000000 HTTP/1.1
Host: api-order.x2bee.com/
Accept: */*

{
  "dlvCnt": 1,
  "cpnCnt": 1
}

쿠폰 기본 정보 조회

get

기능설명

전달받은 프로모션 번호의 기본 정보를 조회합니다.

상세설명

전달받은 프로모션 번호들로 현재 진행중인 프로모션의 기본 정보를 조회합니다.

수정번호

Release v2.00_240401: 이벤트 쿠폰 조회 적용가능매체 추가

Query parameters

promoNoListstring[]Optional

프로모션번호 리스트

Example: C1000000

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

성공

*/*

promoNostringRequired

프로모션번호

Example: C1000000

promoNmstringOptional

프로모션명

Example: 프로모션명

promoTypCdstring · enumRequired

프로모션 유형 코드(MK002) 11 : 상품할인쿠폰 , 12 : 장바구니쿠폰 , 13 : 중복할인쿠폰 , 14 : 무료배송쿠폰 , 15 : 무료반품쿠폰 , 20 : 임직원할인 , 21 : 상품즉시할인 , 40 : 상품마일리지

Example: 11Possible values:

promoStatCdstring · enumRequired

프로모션상태코드(MK003) 10 : 진행 , 20 : 중단

Example: 10Possible values:

promoDescstringOptional

프로모션설명

Example: 프로모션 설명

aplyTermGbCdstring · enumRequired

적용기간구분코드 코드(MK015) 01 : 기간기준 , 02 : 발급일기준

Example: 01Possible values:

issuDdStdCpnUseDdsinteger · int32Optional

발급일기준쿠폰사용일수

valiStrtDtmstring · date-timeRequired

유효시작일시

valiEndDtmstring · date-timeRequired

유효종료일시

fixamtFxrtGbCdstring · enumRequired

정액정율구분 코드(MK005) 01 : 정액 , 02 : 정률

Example: 01Possible values:

dcRateAmtinteger · int64Required

할인율금액

appOnlybooleanRequired

앱전용여부

minBuyQtyinteger · int32Required

최소구매수량

minBuyAmtinteger · int64Required

최소구매금액

maxDcAmtinteger · int64Required

최대할인금액

mediaCdNmArraystringOptional

적용가능매체

Example: Pc, Mobile, App

900

업무처리 오류 내용

*/*

get/v1/marketing/cpnInfoList

GET /api/order/v1/marketing/cpnInfoList HTTP/1.1
Host: api-order.x2bee.com/
Accept: */*

[
  {
    "promoNo": "C1000000",
    "promoNm": "프로모션명",
    "promoTypCd": "11",
    "promoStatCd": "10",
    "promoDesc": "프로모션 설명",
    "aplyTermGbCd": "01",
    "issuDdStdCpnUseDds": 1,
    "valiStrtDtm": "2026-01-01T00:00:00.000Z",
    "valiEndDtm": "2026-01-01T00:00:00.000Z",
    "fixamtFxrtGbCd": "01",
    "dcRateAmt": 1,
    "appOnly": true,
    "minBuyQty": 1,
    "minBuyAmt": 1,
    "maxDcAmt": 1,
    "mediaCdNmArray": "Pc, Mobile, App"
  }
]

이전프로모션 적립

다음프로모션 사은행사

마지막 업데이트 3개월 전