Order Form

Place Order

post

Function Description

API for creating an order.

Detailed Description

Approves the payment and creates the order. If the order succeeds, an order-completion notification message and email are sent to the orderer.

Notes

Creates a non-member login-processing cookie upon successful non-member order.
If the isProcess value in the error response upon order failure is true, it is mainly a payment-related error; changing the payment method allows reordering with the same information. Redirect to the order form page.
If the isProcess value in the error response upon order failure is false, it is an error where ordering with the same information is not possible; redirect to the order failure page.
FO-only API that creates the order using the FO's login information.
Since login information is looked up internally within the API, the member number (mbrNo) is not required as a parameter.

Revision History

release_231009_01: Internal improvements.
Release v2.00_240401 : Added single-product status (snsGoodsYn) when looking up order detail product information
Release v2.00_240401 : Added and changed values needed for the order-completion email
Release v2.00_240509 : Removed nullable constraint on the request order promotion information value
Release v2.00_240530 : Added and changed values needed for the order-completion email when ordered via subscription order
Release v2.00_240530 : Added expected shipment completion datetime to order details for vendor evaluation purposes
Release v2.00_240613 : Added Toss payment approval
Release v2.00_240627 : Added Toss simple payment
Release v2.00_240725 : For E-coupon products, applied shipment-completion processing instead of order-completion for the order history status
Release v2.00_240808 : Added order-cancellation-allowed status and collection status columns to the order detail table for gift and gifting products
Release v2.00_250717 : Added issuance of supporting documents (tax invoices)
Release v2.00_250801 : Applied activation of supporting documents (tax invoices) based on configuration

Header parameters

AuthorizationanyOptional

Access Token

Body

Place Order Request

Responses

200

Order Successful

No content

900

Business processing error details

application/json

post/v1/order

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

{
  "ordBaseInfo": {
    "ordNo": "20230810O008148",
    "siteNo": "1",
    "ordMediaCd": "20",
    "ordGbCd": "10",
    "rfdBankCd": "104",
    "rfdActnNo": "000000000000",
    "rcdActnDepositorNm": "홍길동",
    "rglrDeliNo": "1",
    "chlNo": "1",
    "chlDtlNo": "1",
    "ordererInfo": {
      "mbrNo": "100001311",
      "ordManNm": "홍길동",
      "umemPwd": "password123!",
      "ordManEmailAddr": "nonmember@plateer.com",
      "cellSctNo": "010",
      "cellTxnoNo": "0000",
      "cellEndNo": "0000",
      "telRgnNo": "02",
      "telTxnoNo": "554",
      "telEndNo": "4583",
      "ordLmtYn": "N",
      "brth": "19961212",
      "adlCertiYn": "Y",
      "comGbCd": "P00",
      "stafYn": "Y",
      "nonMemberAge": 19,
      "nonMemberCertiYn": "Y"
    },
    "giftCard": {
      "prstTypCd": "10",
      "prstMsg": "생일 축하해요."
    },
    "ordGoodsGb": "10"
  },
  "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": 800,
          "aplyEndTm": "2359",
          "aeDesc": "사은행사 설명",
          "aeNm": "사은행사 명",
          "aeGoodsList": [
            {
              "aeFvrSeq": "1",
              "aplyMinAmt": 5000,
              "aplyMaxAmt": 10000,
              "aeGoodsNm": "사은품 명",
              "aeGoodsNo": "10000001",
              "aeGoodsItmNo": "001",
              "aeGoodsImgPath": "/path/image001.png"
            }
          ]
        }
      ]
    }
  ],
  "ordDlvInfoList": [
    {
      "dlvpSeq": "1",
      "mbrDlvpSeq": "1",
      "baseDlvpYn": "Y",
      "dlvpNm": "우리집",
      "zipNo": 5837,
      "zipAddr": "서울 송파구 법원로9길",
      "dtlAddr": "에이치비지니스파크 D동 6층",
      "rcvmnNm": "홍길동",
      "rcvmnEmailAddr": "receiver@plateer.com",
      "rcvmnCellSctNo": "010",
      "rcvmnCellTxnoNo": "0000",
      "rcvmnCellEndNo": "0000",
      "rcvmnTelRgnNo": "02",
      "rcvmnTelTxnoNo": "554",
      "rcvmnTelEndNo": "4583",
      "shopTrafMsg": "포장 안 해주셔도 돼요.",
      "deliMsgCd": "40",
      "deliMsg": "벨X, 노크X",
      "comnFrdrCogoMethodCd": "20",
      "comnFrdrEtcMethod": "뒷문 있어요.",
      "comnFrdrPwd": "123456",
      "pcccSeq": "text",
      "persCstmCd": "P100000000000",
      "newPersCstmCd": "P100000000000",
      "dlvGrpInfoList": [
        {
          "dlvpSeq": "1",
          "deliNo": "1",
          "deliKindCd": "10",
          "deliProcTypCd": "10",
          "deliMethodCd": "10",
          "basketGoodsList": [
            {
              "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"
            }
          ],
          "dlvAmtInfoList": [
            {
              "ordCostGbCd": "10",
              "dlexTypCd": "10",
              "stdAdtnAmt": 20000,
              "dlexAmt": 3500,
              "aplyAdtnAmt": 20000,
              "trdTypCd": "text",
              "entrNo": "1000211",
              "deliPolcNo": "10000431",
              "dlvBenefitInfo": {
                "promoNo": "C1000000",
                "promoNm": "프로모션 명",
                "promoTypCd": "11",
                "ourChrgRate": 100,
                "entrChrgRate": 0,
                "cpnIsuNo": "100000",
                "ordCostGbCd": "10"
              }
            }
          ]
        }
      ]
    }
  ],
  "ordBnfInfo": {
    "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
      }
    ]
  },
  "accmInfo": {
    "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
          }
        ]
      }
    ]
  },
  "paymentRequest": {
    "siteNo": "1",
    "orderInfo": {
      "ordNo": "20990101O000001",
      "claimNo": "20990101C000001",
      "goodsNm": "플래티어커피",
      "ordManNm": "김플래티어",
      "ordmnCellNo": 1012345678,
      "ordmnEmailAddr": "kim@plateer.com",
      "crcUnitCd": "KRW",
      "ordMediaCd": "30",
      "mbrNo": "100000001",
      "ordDtlGbCd": "10",
      "clientIp": "127.0.0.1",
      "taxFreeAmt": 1
    },
    "payInfoList": [
      {
        "payNo": "1",
        "payWayCd": "11",
        "payAmt": 1000,
        "mersNo": "1",
        "pgGbCd": "10",
        "trdNo": "INIMX_DBNKINIpayTest20990101090000685510",
        "selectCardCd": "01",
        "termlId": "INIBillTst",
        "billKey": "text",
        "authResultMap": "{P_STATUS:결과코드, P_RMESG1:결과메시지, P_TID:인증거래번호, P_AMT:거래금액, idc_name:IDC센터코드P_REQ_URL:승인요청 URL, P_NOTI:가맹점 임의 데이터}"
      }
    ]
  },
  "proofDocInfo": {
    "ordNo": "text",
    "mbrNo": "text",
    "ordManNm": "홍길동",
    "proofType": "text",
    "payWayCd": "11",
    "orderTaxInvoiceRequest": {
      "entrNo": "text",
      "goodsNm": "text",
      "goodsCount": 1,
      "payAmt": 1,
      "bmanNo": "text",
      "bmanNm": "text",
      "rpstmnNm": "text",
      "zipNo": "text",
      "zipAddr": "text",
      "dtlAddr": "text",
      "aempNm": "text",
      "aempTelRgnNo": "text",
      "aempTelTxnoNo": "text",
      "aempTelEndNo": "text",
      "aempEmailId": "text",
      "aempEmailDomain": "text",
      "aempEmail": "text",
      "validYn": "text"
    },
    "orderCashReceiptRequest": {
      "prsntPurpsCd": "text",
      "idefNo": "text",
      "prchsrNm": "text",
      "prchsrEmail": "text",
      "prchsrCell": "text",
      "smsTrnsYn": "text",
      "faxTrnsYn": "text",
      "valiYn": "text"
    }
  }
}

No content

Calculate Actual Business Day

post

Function Description

Receives a reference date and calculates and returns the actual business day.

Detailed Description

Adds the input number of days based on the reference date.
If a holiday falls within the date calculation, that date is excluded from the sum.
When calculating the expected shipment completion datetime for an order product, it is calculated at the time the order is completed.
When calculating the expected shipment completion datetime for an order product, for general products it is based on the order time, and for reserved products it is based on the requested delivery datetime.
Calculates the automatic approval scheduled date and the explanation-registration-allowed date in the vendor evaluation dispute-raising process in BO.

Revision History

Release v2.00_240613: Added holiday business type code parameter, changed URL

Header parameters

AuthorizationanyOptional

Access Token

Body

Actual Business Date DTO

standardDtmstring · date-timeRequired

Reference Date

dayCountinteger · int64Required

Number of Days

Example: 1

holiJobGbCdstringRequired

Holiday Business Classification Code (CM001)

Example: 03

Responses

200

Success

*/*

string · date-timeOptional

900

Business processing error details

*/*

post/v1/orderSheet/workingDay

POST /api/order/v1/orderSheet/workingDay HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "standardDtm": "2026-01-01T00:00:00.000Z",
  "dayCount": 1,
  "holiJobGbCd": "03"
}

2026-01-01T00:00:00.000Z

Validate Order Form Entry

post

Function Description

Performs user validation upon entering the order form.

Detailed Description

Validates the following information upon entering the order form.

Whether required order form request information exists
Non-member authentication status
Orderer's age
Whether the user is a member, for gifting orders

Revision History

release_231023 : For gifting orders, verifies whether the user is a member

Header parameters

AuthorizationanyOptional

Access Token

Body

Order Form Entry Validation Request DTO

deliMethodCdstring · enumRequired

LO010 (Delivery Method Code) * 10 : Courier Delivery * 30 : Store Pickup * 40 : Quick Delivery * 50 : Overseas Delivery * 60 : No Delivery

Example: 10Possible values:

ordGbCdstring · enumRequired

OM002 (Order Classification Code) 10: General Order , 20: Gift , 30: E-Coupon , 40: Affiliate

Example: 10Possible values:

ordMediaCdstring · enumRequired

Order Channel Code (OM007) 10 : Phone Consultation (CC) , 20 : PC , 30 : Mobile Web , 40 : Android App , 50 : iOS App , 60 : Subscription Order

Example: 20Possible values:

bsketNoListinteger · int64[]Required

Cart No.

Example: [100009929]

Responses

200

Success

No content

900

Business processing error details

*/*

post/v1/orderSheet/validateOrderSheet

POST /api/order/v1/orderSheet/validateOrderSheet HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "deliMethodCd": "10",
  "ordGbCd": "10",
  "ordMediaCd": "20",
  "bsketNoList": [
    100009929
  ]
}

No content

Look Up Tax-exempt Payment Amount

post

Function Description

Looks up the tax-exempt amount for payment based on the product's taxable/tax-exempt/zero-rated classification.

Detailed Description

Looks up the tax-exempt amount for payment based on the product's taxable/tax-exempt/zero-rated classification.
Sums the amount of tax-exempt products using the payment allocation process.

Header parameters

AuthorizationanyOptional

Access Token

Body

Place Order Request

Responses

200

Success

*/*

integer · int64Optional

900

Business processing error details

*/*

post/v1/orderSheet/taxFreeAmount

POST /api/order/v1/orderSheet/taxFreeAmount HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 7417

{
  "ordBaseInfo": {
    "ordNo": "20230810O008148",
    "siteNo": "1",
    "ordMediaCd": "20",
    "ordGbCd": "10",
    "rfdBankCd": "104",
    "rfdActnNo": "000000000000",
    "rcdActnDepositorNm": "홍길동",
    "rglrDeliNo": "1",
    "chlNo": "1",
    "chlDtlNo": "1",
    "ordererInfo": {
      "mbrNo": "100001311",
      "ordManNm": "홍길동",
      "umemPwd": "password123!",
      "ordManEmailAddr": "nonmember@plateer.com",
      "cellSctNo": "010",
      "cellTxnoNo": "0000",
      "cellEndNo": "0000",
      "telRgnNo": "02",
      "telTxnoNo": "554",
      "telEndNo": "4583",
      "ordLmtYn": "N",
      "brth": "19961212",
      "adlCertiYn": "Y",
      "comGbCd": "P00",
      "stafYn": "Y",
      "nonMemberAge": 19,
      "nonMemberCertiYn": "Y"
    },
    "giftCard": {
      "prstTypCd": "10",
      "prstMsg": "생일 축하해요."
    },
    "ordGoodsGb": "10"
  },
  "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": 800,
          "aplyEndTm": "2359",
          "aeDesc": "사은행사 설명",
          "aeNm": "사은행사 명",
          "aeGoodsList": [
            {
              "aeFvrSeq": "1",
              "aplyMinAmt": 5000,
              "aplyMaxAmt": 10000,
              "aeGoodsNm": "사은품 명",
              "aeGoodsNo": "10000001",
              "aeGoodsItmNo": "001",
              "aeGoodsImgPath": "/path/image001.png"
            }
          ]
        }
      ]
    }
  ],
  "ordDlvInfoList": [
    {
      "dlvpSeq": "1",
      "mbrDlvpSeq": "1",
      "baseDlvpYn": "Y",
      "dlvpNm": "우리집",
      "zipNo": 5837,
      "zipAddr": "서울 송파구 법원로9길",
      "dtlAddr": "에이치비지니스파크 D동 6층",
      "rcvmnNm": "홍길동",
      "rcvmnEmailAddr": "receiver@plateer.com",
      "rcvmnCellSctNo": "010",
      "rcvmnCellTxnoNo": "0000",
      "rcvmnCellEndNo": "0000",
      "rcvmnTelRgnNo": "02",
      "rcvmnTelTxnoNo": "554",
      "rcvmnTelEndNo": "4583",
      "shopTrafMsg": "포장 안 해주셔도 돼요.",
      "deliMsgCd": "40",
      "deliMsg": "벨X, 노크X",
      "comnFrdrCogoMethodCd": "20",
      "comnFrdrEtcMethod": "뒷문 있어요.",
      "comnFrdrPwd": "123456",
      "pcccSeq": "text",
      "persCstmCd": "P100000000000",
      "newPersCstmCd": "P100000000000",
      "dlvGrpInfoList": [
        {
          "dlvpSeq": "1",
          "deliNo": "1",
          "deliKindCd": "10",
          "deliProcTypCd": "10",
          "deliMethodCd": "10",
          "basketGoodsList": [
            {
              "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"
            }
          ],
          "dlvAmtInfoList": [
            {
              "ordCostGbCd": "10",
              "dlexTypCd": "10",
              "stdAdtnAmt": 20000,
              "dlexAmt": 3500,
              "aplyAdtnAmt": 20000,
              "trdTypCd": "text",
              "entrNo": "1000211",
              "deliPolcNo": "10000431",
              "dlvBenefitInfo": {
                "promoNo": "C1000000",
                "promoNm": "프로모션 명",
                "promoTypCd": "11",
                "ourChrgRate": 100,
                "entrChrgRate": 0,
                "cpnIsuNo": "100000",
                "ordCostGbCd": "10"
              }
            }
          ]
        }
      ]
    }
  ],
  "ordBnfInfo": {
    "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
      }
    ]
  },
  "accmInfo": {
    "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
          }
        ]
      }
    ]
  },
  "paymentRequest": {
    "siteNo": "1",
    "orderInfo": {
      "ordNo": "20990101O000001",
      "claimNo": "20990101C000001",
      "goodsNm": "플래티어커피",
      "ordManNm": "김플래티어",
      "ordmnCellNo": 1012345678,
      "ordmnEmailAddr": "kim@plateer.com",
      "crcUnitCd": "KRW",
      "ordMediaCd": "30",
      "mbrNo": "100000001",
      "ordDtlGbCd": "10",
      "clientIp": "127.0.0.1",
      "taxFreeAmt": 1
    },
    "payInfoList": [
      {
        "payNo": "1",
        "payWayCd": "11",
        "payAmt": 1000,
        "mersNo": "1",
        "pgGbCd": "10",
        "trdNo": "INIMX_DBNKINIpayTest20990101090000685510",
        "selectCardCd": "01",
        "termlId": "INIBillTst",
        "billKey": "text",
        "authResultMap": "{P_STATUS:결과코드, P_RMESG1:결과메시지, P_TID:인증거래번호, P_AMT:거래금액, idc_name:IDC센터코드P_REQ_URL:승인요청 URL, P_NOTI:가맹점 임의 데이터}"
      }
    ]
  },
  "proofDocInfo": {
    "ordNo": "text",
    "mbrNo": "text",
    "ordManNm": "홍길동",
    "proofType": "text",
    "payWayCd": "11",
    "orderTaxInvoiceRequest": {
      "entrNo": "text",
      "goodsNm": "text",
      "goodsCount": 1,
      "payAmt": 1,
      "bmanNo": "text",
      "bmanNm": "text",
      "rpstmnNm": "text",
      "zipNo": "text",
      "zipAddr": "text",
      "dtlAddr": "text",
      "aempNm": "text",
      "aempTelRgnNo": "text",
      "aempTelTxnoNo": "text",
      "aempTelEndNo": "text",
      "aempEmailId": "text",
      "aempEmailDomain": "text",
      "aempEmail": "text",
      "validYn": "text"
    },
    "orderCashReceiptRequest": {
      "prsntPurpsCd": "text",
      "idefNo": "text",
      "prchsrNm": "text",
      "prchsrEmail": "text",
      "prchsrCell": "text",
      "smsTrnsYn": "text",
      "faxTrnsYn": "text",
      "valiYn": "text"
    }
  }
}

Look Up Order Form

post

Function Description

Looks up member and non-member order form information.

Detailed Description

Looks up member and non-member order form information upon entering the order form. The order form information includes member, payment method, order basic, order product, order delivery, order promotion, and accrual information.

If multiple products are ordered, looks up payment methods commonly available for all products.
For member orders, looks up maximum benefit information.
For non-member orders, sub-payment-method information is not looked up.
For non-member orders, benefit and accrual information is not looked up.

Revision History

Release v2.00_240401 : Applied purchase quantity check and error message display upon entering the order form
Release v2.00_240725 : Set order product classification based on product type code upon entering the order form

Header parameters

AuthorizationanyOptional

Access Token

Body

Search Order Form Request DTO

deliMethodCdstring · enumOptional

LO010 (Delivery Method Code) * 10 : Courier Delivery * 30 : Store Pickup * 40 : Quick Delivery * 50 : Overseas Delivery * 60 : No Delivery

Example: 10Possible values:

ordGbCdstring · enumOptional

OM002 (Order Classification Code) 10: General Order , 20: Gift , 30: E-Coupon , 40: Affiliate

Example: 10Possible values:

ordMediaCdstring · enumOptional

Order Channel Code (OM007) 10 : Phone Consultation (CC) , 20 : PC , 30 : Mobile Web , 40 : Android App , 50 : iOS App , 60 : Subscription Order

Example: 20Possible values:

ordGoodsGbstringOptional

Order Product Type (OM029)

Example: 10

bsketNoListinteger · int64[]Optional

Cart No.

Example: [100009929]

Responses

200

Success

*/*

Search Order Form Response DTO

900

Business processing error details

*/*

post/v1/orderSheet/orderSheet

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

{
  "deliMethodCd": "10",
  "ordGbCd": "10",
  "ordMediaCd": "20",
  "ordGoodsGb": "10",
  "bsketNoList": [
    100009929
  ],
  "dlvpInfoList": [
    {
      "dlvpSeq": "1",
      "dlvpNm": "플래티어",
      "mbrDlvpSeq": "1",
      "baseDlvpYn": "Y",
      "zipNoSeq": 1,
      "zipNo": 5836,
      "zipAddr": "서울 송파구 법원로9길 26",
      "dtlAddr": "101동",
      "emailAddr": "mac9692@plateer.com",
      "rcvmnNm": "박진성",
      "cellSctNo": "010",
      "cellTxnoNo": "2023",
      "cellEndNo": "4046",
      "telRgnNo": "031",
      "telTxnoNo": "406",
      "telEndNo": "4129",
      "deliMsgCd": "10",
      "deliMsg": "초인종누르지마세요.",
      "comnFrdrCogoMethodCd": "10",
      "comnFrdrEtcMethod": "조심히 오세요.",
      "comnFrdrPwd": "2321",
      "comnFrdrPwdMask": "****",
      "deliMsgCdNm": "부재 시 경비실에 맡겨주세요",
      "comnFrdrCogoMethodCdNm": "자유출입가능",
      "aplyBsketInfoList": [
        {
          "bsketNum": 1,
          "aplyCnt": 1
        }
      ],
      "pcccSeq": "text",
      "persCstmCd": "text",
      "newPersCstmCd": "text"
    }
  ]
}

{
  "orderSheetInfo": {
    "ordGbCd": "10",
    "mainPayMethodInfoList": [
      {
        "payWayCd": "11",
        "useYn": "Y",
        "langCd": "ko",
        "cdNm": "text",
        "cdDesc": "text",
        "pgGbCd": "text",
        "memberSubPaymethodAmount": 1,
        "cardCompanyList": [
          {
            "cd": "302",
            "cdNm": "색상변경",
            "cdDesc": "[단순변심]",
            "sortSeq": "22",
            "ref1Val": "30",
            "ref2Val": "10",
            "ref3Val": "10",
            "ref4Val": "10",
            "ref5Val": "Y",
            "ref6Val": "null",
            "ref7Val": "null"
          }
        ],
        "mainPaymethod": true
      }
    ],
    "subPayMethodInfoList": [
      {
        "payWayCd": "11",
        "useYn": "Y",
        "langCd": "ko",
        "cdNm": "text",
        "cdDesc": "text",
        "pgGbCd": "text",
        "memberSubPaymethodAmount": 1,
        "cardCompanyList": [
          {
            "cd": "302",
            "cdNm": "색상변경",
            "cdDesc": "[단순변심]",
            "sortSeq": "22",
            "ref1Val": "30",
            "ref2Val": "10",
            "ref3Val": "10",
            "ref4Val": "10",
            "ref5Val": "Y",
            "ref6Val": "null",
            "ref7Val": "null"
          }
        ],
        "mainPaymethod": true
      }
    ],
    "memberInfo": {
      "mbrNo": "100000551",
      "mbrGradeCd": "10",
      "mbrGradeNm": "GREEN",
      "mbrGbCd": "10",
      "mbrGbNm": "정회원",
      "mbrMgrCd": "20",
      "mbrMgrNm": "일반회원",
      "mgrGbCd": "10",
      "brth": "19890506",
      "sexGbCd": "F",
      "sexGbNm": "여",
      "nafrGbCd": "10",
      "nafrGbNm": "내국인",
      "stafYn": "Y",
      "comGbCd": "P00",
      "comGbNm": "플래티어",
      "frstLoginDtm": "2023-06-14 10:09:00",
      "mbrNm": "박슬기",
      "loginId": "id089",
      "zipNo": 5831,
      "zipAddr": "서울 송파구 동남로 99",
      "dtlAddr": "111",
      "cellSctNo": "010",
      "cellTxnoNo": "1234",
      "cellEndNo": "4321",
      "telRgnNo": "02",
      "telTxnoNo": "123",
      "telEndNo": "1234",
      "emailAddr": "x2bee@plateer.com",
      "emailRecvAgrYn": "N",
      "smsRecvAgrYn": "N",
      "histStrDt": "2023-04-01",
      "histEndDt": "2023-09-30",
      "smpctAcctLinkGbCd": "10",
      "smpctAcctLinkGbNm": "카카오톡",
      "frstOrdDt": "20230808",
      "lstOrdDt": "20230908",
      "loginCnt": 99,
      "ordCnt": 0,
      "mbrJoinDtm": "2026-01-01T00:00:00.000Z",
      "ordLmtYn": "N",
      "ciCtacValYn": "Y",
      "appPushAgrYn": "N",
      "pwdChgDtm": "2026-01-01T00:00:00.000Z",
      "bmanRegNo": "10000001",
      "bmanNm": "플래티어",
      "bmanRegDt": "20230524",
      "rpstmnNm": "이상훈",
      "repTelSctNo": "010",
      "repTelTxnoNo": "1234",
      "repTelEndNo": "4321"
    }
  },
  "orderRegisterRequest": {
    "ordBaseInfo": {
      "ordNo": "20230810O008148",
      "siteNo": "1",
      "ordMediaCd": "20",
      "ordGbCd": "10",
      "rfdBankCd": "104",
      "rfdActnNo": "000000000000",
      "rcdActnDepositorNm": "홍길동",
      "rglrDeliNo": "1",
      "chlNo": "1",
      "chlDtlNo": "1",
      "ordererInfo": {
        "mbrNo": "100001311",
        "ordManNm": "홍길동",
        "umemPwd": "password123!",
        "ordManEmailAddr": "nonmember@plateer.com",
        "cellSctNo": "010",
        "cellTxnoNo": "0000",
        "cellEndNo": "0000",
        "telRgnNo": "02",
        "telTxnoNo": "554",
        "telEndNo": "4583",
        "ordLmtYn": "N",
        "brth": "19961212",
        "adlCertiYn": "Y",
        "comGbCd": "P00",
        "stafYn": "Y",
        "nonMemberAge": 19,
        "nonMemberCertiYn": "Y"
      },
      "giftCard": {
        "prstTypCd": "10",
        "prstMsg": "생일 축하해요."
      },
      "ordGoodsGb": "10"
    },
    "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": 800,
            "aplyEndTm": "2359",
            "aeDesc": "사은행사 설명",
            "aeNm": "사은행사 명",
            "aeGoodsList": [
              {
                "aeFvrSeq": "1",
                "aplyMinAmt": 5000,
                "aplyMaxAmt": 10000,
                "aeGoodsNm": "사은품 명",
                "aeGoodsNo": "10000001",
                "aeGoodsItmNo": "001",
                "aeGoodsImgPath": "/path/image001.png"
              }
            ]
          }
        ]
      }
    ],
    "ordDlvInfoList": [
      {
        "dlvpSeq": "1",
        "mbrDlvpSeq": "1",
        "baseDlvpYn": "Y",
        "dlvpNm": "우리집",
        "zipNo": 5837,
        "zipAddr": "서울 송파구 법원로9길",
        "dtlAddr": "에이치비지니스파크 D동 6층",
        "rcvmnNm": "홍길동",
        "rcvmnEmailAddr": "receiver@plateer.com",
        "rcvmnCellSctNo": "010",
        "rcvmnCellTxnoNo": "0000",
        "rcvmnCellEndNo": "0000",
        "rcvmnTelRgnNo": "02",
        "rcvmnTelTxnoNo": "554",
        "rcvmnTelEndNo": "4583",
        "shopTrafMsg": "포장 안 해주셔도 돼요.",
        "deliMsgCd": "40",
        "deliMsg": "벨X, 노크X",
        "comnFrdrCogoMethodCd": "20",
        "comnFrdrEtcMethod": "뒷문 있어요.",
        "comnFrdrPwd": "123456",
        "pcccSeq": "text",
        "persCstmCd": "P100000000000",
        "newPersCstmCd": "P100000000000",
        "dlvGrpInfoList": [
          {
            "dlvpSeq": "1",
            "deliNo": "1",
            "deliKindCd": "10",
            "deliProcTypCd": "10",
            "deliMethodCd": "10",
            "basketGoodsList": [
              {
                "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"
              }
            ],
            "dlvAmtInfoList": [
              {
                "ordCostGbCd": "10",
                "dlexTypCd": "10",
                "stdAdtnAmt": 20000,
                "dlexAmt": 3500,
                "aplyAdtnAmt": 20000,
                "trdTypCd": "text",
                "entrNo": "1000211",
                "deliPolcNo": "10000431",
                "dlvBenefitInfo": {
                  "promoNo": "C1000000",
                  "promoNm": "프로모션 명",
                  "promoTypCd": "11",
                  "ourChrgRate": 100,
                  "entrChrgRate": 0,
                  "cpnIsuNo": "100000",
                  "ordCostGbCd": "10"
                }
              }
            ]
          }
        ]
      }
    ],
    "ordBnfInfo": {
      "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
        }
      ]
    },
    "accmInfo": {
      "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
            }
          ]
        }
      ]
    },
    "paymentRequest": {
      "siteNo": "1",
      "orderInfo": {
        "ordNo": "20990101O000001",
        "claimNo": "20990101C000001",
        "goodsNm": "플래티어커피",
        "ordManNm": "김플래티어",
        "ordmnCellNo": 1012345678,
        "ordmnEmailAddr": "kim@plateer.com",
        "crcUnitCd": "KRW",
        "ordMediaCd": "30",
        "mbrNo": "100000001",
        "ordDtlGbCd": "10",
        "clientIp": "127.0.0.1",
        "taxFreeAmt": 1
      },
      "payInfoList": [
        {
          "payNo": "1",
          "payWayCd": "11",
          "payAmt": 1000,
          "mersNo": "1",
          "pgGbCd": "10",
          "trdNo": "INIMX_DBNKINIpayTest20990101090000685510",
          "selectCardCd": "01",
          "termlId": "INIBillTst",
          "billKey": "text",
          "authResultMap": "{P_STATUS:결과코드, P_RMESG1:결과메시지, P_TID:인증거래번호, P_AMT:거래금액, idc_name:IDC센터코드P_REQ_URL:승인요청 URL, P_NOTI:가맹점 임의 데이터}"
        }
      ]
    },
    "proofDocInfo": {
      "ordNo": "text",
      "mbrNo": "text",
      "ordManNm": "홍길동",
      "proofType": "text",
      "payWayCd": "11",
      "orderTaxInvoiceRequest": {
        "entrNo": "text",
        "goodsNm": "text",
        "goodsCount": 1,
        "payAmt": 1,
        "bmanNo": "text",
        "bmanNm": "text",
        "rpstmnNm": "text",
        "zipNo": "text",
        "zipAddr": "text",
        "dtlAddr": "text",
        "aempNm": "text",
        "aempTelRgnNo": "text",
        "aempTelTxnoNo": "text",
        "aempTelEndNo": "text",
        "aempEmailId": "text",
        "aempEmailDomain": "text",
        "aempEmail": "text",
        "validYn": "text"
      },
      "orderCashReceiptRequest": {
        "prsntPurpsCd": "text",
        "idefNo": "text",
        "prchsrNm": "text",
        "prchsrEmail": "text",
        "prchsrCell": "text",
        "smsTrnsYn": "text",
        "faxTrnsYn": "text",
        "valiYn": "text"
      }
    }
  }
}

Look Up Gift Event for Agent Order Form

post

Function Description

Looks up whether an ongoing gift event exists for a product ordered by an agent.

Detailed Description

Looks up whether an ongoing gift event exists for the product upon completion of product selection in an agent order.

Notes

Identical logic to the aeEvtList (order form gift event lookup) API, except for the method of retrieving member information.

Header parameters

AuthorizationanyOptional

Access Token

Body

FO Order Form Gift Event Search Request DTO

ordMediaCdstring · enumOptional

Order Channel Code (OM007) 10 : Phone Consultation (CC) , 20 : PC , 30 : Mobile Web , 40 : Android App , 50 : iOS App , 60 : Subscription Order

Example: 20Possible values:

mbrNostringOptional

Member No.

mbrGradeCdstring · enumOptional

Member Grade Code (ME008) 10 : GREEN , 20 : FAMILY , 30 : GOLD , 40 : VIP , 50 : VVIP

Example: 10Possible values:

siteNostringOptional

Site No.

Example: 1

stafYnstringOptional

Employee Status

Example: Y

Responses

200

Success

*/*

Gift Promotion Information

goodsNostringRequired

Product No.

Example: 10000001

itmNostringRequired

Item No.

Example: 001

aeNostringRequired

Gift Promotion No.

Example: C1000000

addEvtTypCdstring · enumRequired

Gift Event Type Code (MK012) 10 : Purchase Amount Gift , 20 : Product Gift

Example: 20Possible values:

aeStrDtmstring · date-timeRequired

Gift Event Start Date/Time

aeEndDtmstring · date-timeRequired

Gift Event End Date/Time

payStrDtstringOptional

Payment Start Date

Example: 20231201

payEndDtstringOptional

Payment End Date

Example: 20231231

tmEvtYnstring · nullableRequired

Time Event Status

Example: N

aplyStrTmstring · nullableOptional

Application Start Time

Example: 800

aplyEndTmstring · nullableOptional

Application End Time

Example: 2359

aeDescstringRequired

Gift Promotion Description

Example: 사은행사 설명

aeNmstringRequired

Gift Event Name

Example: 사은행사 명

900

Business processing error details

*/*

post/v1/orderSheet/getCounselorOrderAeEvtList

POST /api/order/v1/orderSheet/getCounselorOrderAeEvtList HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 2350

{
  "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": 800,
          "aplyEndTm": "2359",
          "aeDesc": "사은행사 설명",
          "aeNm": "사은행사 명",
          "aeGoodsList": [
            {
              "aeFvrSeq": "1",
              "aplyMinAmt": 5000,
              "aplyMaxAmt": 10000,
              "aeGoodsNm": "사은품 명",
              "aeGoodsNo": "10000001",
              "aeGoodsItmNo": "001",
              "aeGoodsImgPath": "/path/image001.png"
            }
          ]
        }
      ]
    }
  ],
  "ordMediaCd": "20",
  "mbrNo": "text",
  "mbrGradeCd": "10",
  "siteNo": "1",
  "stafYn": "Y"
}

[
  {
    "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": 800,
    "aplyEndTm": "2359",
    "aeDesc": "사은행사 설명",
    "aeNm": "사은행사 명",
    "aeGoodsList": [
      {
        "aeFvrSeq": "1",
        "aplyMinAmt": 5000,
        "aplyMaxAmt": 10000,
        "aeGoodsNm": "사은품 명",
        "aeGoodsNo": "10000001",
        "aeGoodsItmNo": "001",
        "aeGoodsImgPath": "/path/image001.png"
      }
    ]
  }
]

Order Form Gift Promotion Retrieval

post

Function Description

Looks up whether an ongoing gift event exists for the ordered product.

Detailed Description

Looks up whether an ongoing gift event exists for the ordered product upon entering the order form.

Gift event information is not looked up for non-member orders.

Header parameters

AuthorizationanyOptional

Access Token

Body

FO Order Form Gift Event Search Request DTO

ordMediaCdstring · enumOptional

Order Channel Code (OM007) 10 : Phone Consultation (CC) , 20 : PC , 30 : Mobile Web , 40 : Android App , 50 : iOS App , 60 : Subscription Order

Example: 20Possible values:

mbrNostringOptional

Member No.

mbrGradeCdstring · enumOptional

Member Grade Code (ME008) 10 : GREEN , 20 : FAMILY , 30 : GOLD , 40 : VIP , 50 : VVIP

Example: 10Possible values:

siteNostringOptional

Site No.

Example: 1

stafYnstringOptional

Employee Status

Example: Y

Responses

200

Success

*/*

Gift Promotion Information

goodsNostringRequired

Product No.

Example: 10000001

itmNostringRequired

Item No.

Example: 001

aeNostringRequired

Gift Promotion No.

Example: C1000000

addEvtTypCdstring · enumRequired

Gift Event Type Code (MK012) 10 : Purchase Amount Gift , 20 : Product Gift

Example: 20Possible values:

aeStrDtmstring · date-timeRequired

Gift Event Start Date/Time

aeEndDtmstring · date-timeRequired

Gift Event End Date/Time

payStrDtstringOptional

Payment Start Date

Example: 20231201

payEndDtstringOptional

Payment End Date

Example: 20231231

tmEvtYnstring · nullableRequired

Time Event Status

Example: N

aplyStrTmstring · nullableOptional

Application Start Time

Example: 800

aplyEndTmstring · nullableOptional

Application End Time

Example: 2359

aeDescstringRequired

Gift Promotion Description

Example: 사은행사 설명

aeNmstringRequired

Gift Event Name

Example: 사은행사 명

900

Business processing error details

*/*

post/v1/orderSheet/aeEvtList

POST /api/order/v1/orderSheet/aeEvtList HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 2350

{
  "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": 800,
          "aplyEndTm": "2359",
          "aeDesc": "사은행사 설명",
          "aeNm": "사은행사 명",
          "aeGoodsList": [
            {
              "aeFvrSeq": "1",
              "aplyMinAmt": 5000,
              "aplyMaxAmt": 10000,
              "aeGoodsNm": "사은품 명",
              "aeGoodsNo": "10000001",
              "aeGoodsItmNo": "001",
              "aeGoodsImgPath": "/path/image001.png"
            }
          ]
        }
      ]
    }
  ],
  "ordMediaCd": "20",
  "mbrNo": "text",
  "mbrGradeCd": "10",
  "siteNo": "1",
  "stafYn": "Y"
}

[
  {
    "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": 800,
    "aplyEndTm": "2359",
    "aeDesc": "사은행사 설명",
    "aeNm": "사은행사 명",
    "aeGoodsList": [
      {
        "aeFvrSeq": "1",
        "aplyMinAmt": 5000,
        "aplyMaxAmt": 10000,
        "aeGoodsNm": "사은품 명",
        "aeGoodsNo": "10000001",
        "aeGoodsItmNo": "001",
        "aeGoodsImgPath": "/path/image001.png"
      }
    ]
  }
]

Retrieve Order Accrual Information

post

Function Description

Looks up accrual information matching the order information.

Detailed Description

Looks up accrual information matching the order information when the applied benefit information is changed on the order form screen.

Accrual information is not looked up for non-member orders.

Header parameters

AuthorizationanyOptional

Access Token

Body

FO Order Accrual Retrieval Request DTO

ordMediaCdstring · enumOptional

Order Channel Code (OM007) 10 : Phone Consultation (CC) , 20 : PC , 30 : Mobile Web , 40 : Android App , 50 : iOS App , 60 : Subscription Order

Example: 20Possible values:

Responses

200

Success

*/*

Accrual Information

totalAccmAmtinteger · int64Required

Total Accrual Amount

Example: 3000

900

Business processing error details

*/*

post/v1/orderSheet/accumulationInfo

POST /api/order/v1/orderSheet/accumulationInfo HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 2603

{
  "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": 800,
          "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"
}

{
  "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
        }
      ]
    }
  ]
}

Look Up Order-Completion Information

post

Function Description

API for looking up order-completion information after a successful order.

Detailed Description

An exception occurs if a claim is in progress for the requested order.
For non-members, the cookie value created via the non-member login processing API is required.

Revision History

Release v2.00_240401 : Added gift name (prestNm) to the product list (OrderCompleteGoodsInfo)
Release v2.00_240401 : Added order sequence no. (ordSeq) and main-product order sequence no. (aeOrdSeq) so the gift list can be displayed per purchased product
Release v2.00_240401 : Added lookup of single-product status (snsGoodsYn)

nonmemberInfoStringOptional

Non-member Order Information. Required When Looking Up Non-member Order Completion

Header parameters

AuthorizationanyOptional

Access Token

Body

Search Order Completion Request

ordNostringRequired

Order No.

Example: 20230809O007055

systemTypestring · enumOptional

System Type Code 10: FO, 20: BO

Default: 10Possible values:

Responses

200

Order Completion Retrieved Successfully

application/json

Order Completion Info

ordNostringOptional

Order No.

Example: 20230809O007055

ordSeqinteger · int32Optional

Order Sequence No.

Example: 1

ordManNmstringOptional

Orderer Name

Example: 홍길동

ordGbCdstringOptional

Order Classification Code (OM002)

Example: 10

ordAccpDtmstring · date-timeOptional

Order Date/Time

aeOrdSeqinteger · int32Optional

Main Item Order Sequence No.

Example: 1

ordGoodsGbstringOptional

Order Product Type (OM029)

Example: 10

900

Business processing error details

application/json

post/v1/order/getOrderCompleteInfo

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

{
  "ordNo": "20230809O007055",
  "systemType": "10"
}

{
  "ordNo": "20230809O007055",
  "ordSeq": 1,
  "ordManNm": "홍길동",
  "ordGbCd": "10",
  "ordAccpDtm": "2026-01-01T00:00:00.000Z",
  "giftCard": {
    "prstTypCd": "10",
    "prstMsg": "생일 축하해요.",
    "cardImgPath": "/card-image.png"
  },
  "deliveryPlaceList": [
    {
      "dlvpSeq": "1",
      "dlvpNm": "플래티어",
      "rcvmnNm": "홍길동",
      "rcvmnCellSctNo": "010",
      "rcvmnCellTxnoNo": "0000",
      "rcvmnCellEndNo": "0000",
      "zipNo": 5837,
      "zipAddr": "서울 송파구 법원로9길",
      "dtlAddr": "에이치비지니스파크 D동 6층",
      "deliMsgCd": "40",
      "deliMsgCdNm": "부재 시 경비실에 맡겨주세요",
      "deliMsg": "벨X, 노크X",
      "comnFrdrCogoMethodCd": "20",
      "comnFrdrCogoMethodCdNm": "자유출입 가능",
      "comnFrdrPwd": "123456",
      "persCstmCd": "text",
      "deliveryGroupList": [
        {
          "deliNo": "1",
          "goodsInfoList": [
            {
              "ordQty": 1,
              "goodsNo": "10002293",
              "itmNo": "001",
              "itmNm": "F",
              "ordSaleTypCd": "10",
              "saleMethCd": "10",
              "prestNm": "증정품",
              "goodsNm": "초코파이",
              "goodsImg": "text",
              "brandNm": "**제과",
              "norPrc": 3000,
              "salePrc": 2700,
              "ordSeq": 1,
              "aeOrdSeq": 1,
              "sngGoodsYn": "Y"
            }
          ]
        }
      ]
    }
  ],
  "payInfoList": [
    {
      "ordNo": "text",
      "payAmt": 2700,
      "payWayCd": "11",
      "payWayNm": "신용카드",
      "cardNm": "국민카드",
      "divMonCnt": 3,
      "bankCd": "201",
      "bankNm": "신한은행",
      "actnNo": "계좌번호 암호화",
      "dpmnNm": "김플래티어",
      "dptFcstDt": "20990101"
    }
  ],
  "orderAmount": {
    "ordNo": "20230809O007055",
    "saleAmt": 2700,
    "deliveryAmt": 0,
    "benefitAmt": 0,
    "accmAmt": 270,
    "payAmt": 2700
  },
  "aeOrdSeq": 1,
  "ordGoodsGb": "10"
}

Look Up Delivery Group Delivery Fee

post

Function Description

Looks up the delivery fee for each delivery group.

Detailed Description

Additional delivery fees are charged if the requested delivery group's postal code is in a remote area.

Header parameters

AuthorizationanyOptional

Access Token

Body

Search Delivery Group Shipping Fee DTO

deliMethodCdstring · enumRequired

LO010 (Delivery Method Code) * 10 : Courier Delivery * 30 : Store Pickup * 40 : Quick Delivery * 50 : Overseas Delivery * 60 : No Delivery

Example: 10Possible values:

Responses

200

Success

*/*

dlvpSeqstringOptional

Delivery Address Sequence No.

Example: 1

deliNostringOptional

Delivery No.

Example: 1

entrNostringOptional

Vendor No.

Example: 10000002

deliPolcNostringOptional

Delivery Policy No.

Example: 10000431

900

Business processing error details

*/*

post/v1/delivery/deliveryGroupAmountList

POST /api/order/v1/delivery/deliveryGroupAmountList HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 156

{
  "deliMethodCd": "10",
  "deliveryGroupFeeRequestList": [
    {
      "dlvpSeq": "1",
      "deliNo": "1",
      "deliPolcNo": "10000431",
      "entrNo": "10000002",
      "zipNo": "12345",
      "amount": 1000
    }
  ]
}

[
  {
    "dlvpSeq": "1",
    "deliNo": "1",
    "entrNo": "10000002",
    "deliPolcNo": "10000431",
    "adtnCostInfoList": [
      {
        "ordCostGbCd": "10",
        "dlexTypCd": "10",
        "stdAdtnAmt": 20000,
        "dlexAmt": 3500,
        "aplyAdtnAmt": 20000,
        "trdTypCd": "10"
      }
    ]
  }
]

Retrieve Order Delivery Fee

post

Function Description

Looks up the delivery fee when the user changes the order delivery address information on the order form screen.

Detailed Description

Looks up the delivery fee when the user selects order delivery address information on the order form.
Creates a delivery group per product and looks up the delivery fee for each delivery group.
Additional delivery fees may apply if the changed delivery address is a remote area.

Header parameters

AuthorizationanyOptional

Access Token

Body

Retrieve Delivery Fee Request DTO

deliMethodCdstring · enumRequired

LO010 (Delivery Method Code) * 10 : Courier Delivery * 30 : Store Pickup * 40 : Quick Delivery * 50 : Overseas Delivery * 60 : No Delivery

Example: 10Possible values:

allClaimbooleanOptional

Full Claim Status

allNonReturnablebooleanOptional

Responses

200

Success

*/*

Delivery Address List

dlvpSeqstringOptional

Delivery Address Sequence No.

Example: 1

mbrDlvpSeqstringOptional

Member Delivery Address Sequence No.

Example: 1

baseDlvpYnstringOptional

Default Delivery Address Status

Example: Y

dlvpNmstringRequired

Delivery Address Name. Required for General Orders

Example: 우리집

zipNostringRequired

Postal Code. Required for General Orders

Example: 5837

zipAddrstringRequired

Postal Address. Required for General Orders

Example: 서울 송파구 법원로9길

dtlAddrstringRequired

Detailed Address. Required for General Orders

Example: 에이치비지니스파크 D동 6층

rcvmnNmstringRequired

Recipient Name

Example: 홍길동

rcvmnEmailAddrstringOptional

Recipient Email Address

Example: receiver@plateer.com

rcvmnCellSctNostringRequired

Recipient's Mobile Phone Prefix Code

Example: 010

rcvmnCellTxnoNostringRequired

Recipient's Mobile Phone Exchange Code

Example: 0000

rcvmnCellEndNostringRequired

Recipient Mobile Phone Last Digits

Example: 0000

rcvmnTelRgnNostringOptional

Recipient Phone Area Code

Example: 02

rcvmnTelTxnoNostringOptional

Recipient Phone Exchange Code

Example: 554

rcvmnTelEndNostringOptional

Recipient Phone Last Digits

Example: 4583

shopTrafMsgstringOptional

Store Delivery Message

Example: 포장 안 해주셔도 돼요.

deliMsgCdstringOptional

Delivery Message Code (ME039) 20: Please Call Before Delivery, 30: Leave at the Door if Absent, 40: Leave with Security Office if Absent, 50: Please Deliver Quickly, 60: Call My Mobile Phone if Absent, 70: Custom Input

Example: 40

deliMsgstring · nullableOptional

Delivery Message

Example: 벨X, 노크X

comnFrdrCogoMethodCdstring · nullableOptional

Common Entrance Access Method Code (ME040) 10: Common Entrance Passcode, 20: Free Access, 30: Other

Example: 20

comnFrdrEtcMethodstring · nullableOptional

Other Common Entrance Access Method

Example: 뒷문 있어요.

comnFrdrPwdstring · nullableOptional

Common Entrance Password

Example: 123456

pcccSeqstringOptional

Member Customs Clearance Code Sequence No.

persCstmCdstring · nullableOptional

Personal Customs Clearance Code

Example: P100000000000

newPersCstmCdstring · nullableOptional

New Customs Clearance No.

Example: P100000000000

900

Business processing error details

*/*

post/v1/delivery/deliveryAmount

POST /api/order/v1/delivery/deliveryAmount HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 2216

{
  "deliMethodCd": "10",
  "dlvpInfo": {
    "dlvpSeq": "1",
    "dlvpNm": "플래티어",
    "mbrDlvpSeq": "1",
    "baseDlvpYn": "Y",
    "zipNoSeq": 1,
    "zipNo": 5836,
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "101동",
    "emailAddr": "mac9692@plateer.com",
    "rcvmnNm": "박진성",
    "cellSctNo": "010",
    "cellTxnoNo": "2023",
    "cellEndNo": "4046",
    "telRgnNo": "031",
    "telTxnoNo": "406",
    "telEndNo": "4129",
    "deliMsgCd": "10",
    "deliMsg": "초인종누르지마세요.",
    "comnFrdrCogoMethodCd": "10",
    "comnFrdrEtcMethod": "조심히 오세요.",
    "comnFrdrPwd": "2321",
    "comnFrdrPwdMask": "****",
    "deliMsgCdNm": "부재 시 경비실에 맡겨주세요",
    "comnFrdrCogoMethodCdNm": "자유출입가능",
    "aplyBsketInfoList": [
      {
        "bsketNum": 1,
        "aplyCnt": 1
      }
    ],
    "pcccSeq": "text",
    "persCstmCd": "text",
    "newPersCstmCd": "text"
  },
  "goodsList": [
    {
      "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"
    }
  ],
  "allClaim": true,
  "allNonReturnable": true
}

[
  {
    "dlvpSeq": "1",
    "mbrDlvpSeq": "1",
    "baseDlvpYn": "Y",
    "dlvpNm": "우리집",
    "zipNo": 5837,
    "zipAddr": "서울 송파구 법원로9길",
    "dtlAddr": "에이치비지니스파크 D동 6층",
    "rcvmnNm": "홍길동",
    "rcvmnEmailAddr": "receiver@plateer.com",
    "rcvmnCellSctNo": "010",
    "rcvmnCellTxnoNo": "0000",
    "rcvmnCellEndNo": "0000",
    "rcvmnTelRgnNo": "02",
    "rcvmnTelTxnoNo": "554",
    "rcvmnTelEndNo": "4583",
    "shopTrafMsg": "포장 안 해주셔도 돼요.",
    "deliMsgCd": "40",
    "deliMsg": "벨X, 노크X",
    "comnFrdrCogoMethodCd": "20",
    "comnFrdrEtcMethod": "뒷문 있어요.",
    "comnFrdrPwd": "123456",
    "pcccSeq": "text",
    "persCstmCd": "P100000000000",
    "newPersCstmCd": "P100000000000",
    "dlvGrpInfoList": [
      {
        "dlvpSeq": "1",
        "deliNo": "1",
        "deliKindCd": "10",
        "deliProcTypCd": "10",
        "deliMethodCd": "10",
        "basketGoodsList": [
          {
            "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"
          }
        ],
        "dlvAmtInfoList": [
          {
            "ordCostGbCd": "10",
            "dlexTypCd": "10",
            "stdAdtnAmt": 20000,
            "dlexAmt": 3500,
            "aplyAdtnAmt": 20000,
            "trdTypCd": "text",
            "entrNo": "1000211",
            "deliPolcNo": "10000431",
            "dlvBenefitInfo": {
              "promoNo": "C1000000",
              "promoNm": "프로모션 명",
              "promoTypCd": "11",
              "ourChrgRate": 100,
              "entrChrgRate": 0,
              "cpnIsuNo": "100000",
              "ordCostGbCd": "10"
            }
          }
        ]
      }
    ]
  }
]

Agent Order Placement

post

Function Description

API that creates an order entered by a customer service agent.

Detailed Description

Creates an order paid with the member's mileage. When the order succeeds, an order completion AlimTalk message and email are sent to the member.

Special Notes

Same logic as the order (Place Order) API.
The difference is that the order is created using the member number (mbrNo) parameter, which is a required parameter.

Revision History

Release v2.00_240530 : Changed API URL and Swagger

Header parameters

AuthorizationanyOptional

Access Token

Body

Place Order Request

Responses

200

Order Successful

No content

900

Business processing error details

application/json

post/v1/counselorOrder

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

{
  "ordBaseInfo": {
    "ordNo": "20230810O008148",
    "siteNo": "1",
    "ordMediaCd": "20",
    "ordGbCd": "10",
    "rfdBankCd": "104",
    "rfdActnNo": "000000000000",
    "rcdActnDepositorNm": "홍길동",
    "rglrDeliNo": "1",
    "chlNo": "1",
    "chlDtlNo": "1",
    "ordererInfo": {
      "mbrNo": "100001311",
      "ordManNm": "홍길동",
      "umemPwd": "password123!",
      "ordManEmailAddr": "nonmember@plateer.com",
      "cellSctNo": "010",
      "cellTxnoNo": "0000",
      "cellEndNo": "0000",
      "telRgnNo": "02",
      "telTxnoNo": "554",
      "telEndNo": "4583",
      "ordLmtYn": "N",
      "brth": "19961212",
      "adlCertiYn": "Y",
      "comGbCd": "P00",
      "stafYn": "Y",
      "nonMemberAge": 19,
      "nonMemberCertiYn": "Y"
    },
    "giftCard": {
      "prstTypCd": "10",
      "prstMsg": "생일 축하해요."
    },
    "ordGoodsGb": "10"
  },
  "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": 800,
          "aplyEndTm": "2359",
          "aeDesc": "사은행사 설명",
          "aeNm": "사은행사 명",
          "aeGoodsList": [
            {
              "aeFvrSeq": "1",
              "aplyMinAmt": 5000,
              "aplyMaxAmt": 10000,
              "aeGoodsNm": "사은품 명",
              "aeGoodsNo": "10000001",
              "aeGoodsItmNo": "001",
              "aeGoodsImgPath": "/path/image001.png"
            }
          ]
        }
      ]
    }
  ],
  "ordDlvInfoList": [
    {
      "dlvpSeq": "1",
      "mbrDlvpSeq": "1",
      "baseDlvpYn": "Y",
      "dlvpNm": "우리집",
      "zipNo": 5837,
      "zipAddr": "서울 송파구 법원로9길",
      "dtlAddr": "에이치비지니스파크 D동 6층",
      "rcvmnNm": "홍길동",
      "rcvmnEmailAddr": "receiver@plateer.com",
      "rcvmnCellSctNo": "010",
      "rcvmnCellTxnoNo": "0000",
      "rcvmnCellEndNo": "0000",
      "rcvmnTelRgnNo": "02",
      "rcvmnTelTxnoNo": "554",
      "rcvmnTelEndNo": "4583",
      "shopTrafMsg": "포장 안 해주셔도 돼요.",
      "deliMsgCd": "40",
      "deliMsg": "벨X, 노크X",
      "comnFrdrCogoMethodCd": "20",
      "comnFrdrEtcMethod": "뒷문 있어요.",
      "comnFrdrPwd": "123456",
      "pcccSeq": "text",
      "persCstmCd": "P100000000000",
      "newPersCstmCd": "P100000000000",
      "dlvGrpInfoList": [
        {
          "dlvpSeq": "1",
          "deliNo": "1",
          "deliKindCd": "10",
          "deliProcTypCd": "10",
          "deliMethodCd": "10",
          "basketGoodsList": [
            {
              "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"
            }
          ],
          "dlvAmtInfoList": [
            {
              "ordCostGbCd": "10",
              "dlexTypCd": "10",
              "stdAdtnAmt": 20000,
              "dlexAmt": 3500,
              "aplyAdtnAmt": 20000,
              "trdTypCd": "text",
              "entrNo": "1000211",
              "deliPolcNo": "10000431",
              "dlvBenefitInfo": {
                "promoNo": "C1000000",
                "promoNm": "프로모션 명",
                "promoTypCd": "11",
                "ourChrgRate": 100,
                "entrChrgRate": 0,
                "cpnIsuNo": "100000",
                "ordCostGbCd": "10"
              }
            }
          ]
        }
      ]
    }
  ],
  "ordBnfInfo": {
    "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
      }
    ]
  },
  "accmInfo": {
    "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
          }
        ]
      }
    ]
  },
  "paymentRequest": {
    "siteNo": "1",
    "orderInfo": {
      "ordNo": "20990101O000001",
      "claimNo": "20990101C000001",
      "goodsNm": "플래티어커피",
      "ordManNm": "김플래티어",
      "ordmnCellNo": 1012345678,
      "ordmnEmailAddr": "kim@plateer.com",
      "crcUnitCd": "KRW",
      "ordMediaCd": "30",
      "mbrNo": "100000001",
      "ordDtlGbCd": "10",
      "clientIp": "127.0.0.1",
      "taxFreeAmt": 1
    },
    "payInfoList": [
      {
        "payNo": "1",
        "payWayCd": "11",
        "payAmt": 1000,
        "mersNo": "1",
        "pgGbCd": "10",
        "trdNo": "INIMX_DBNKINIpayTest20990101090000685510",
        "selectCardCd": "01",
        "termlId": "INIBillTst",
        "billKey": "text",
        "authResultMap": "{P_STATUS:결과코드, P_RMESG1:결과메시지, P_TID:인증거래번호, P_AMT:거래금액, idc_name:IDC센터코드P_REQ_URL:승인요청 URL, P_NOTI:가맹점 임의 데이터}"
      }
    ]
  },
  "proofDocInfo": {
    "ordNo": "text",
    "mbrNo": "text",
    "ordManNm": "홍길동",
    "proofType": "text",
    "payWayCd": "11",
    "orderTaxInvoiceRequest": {
      "entrNo": "text",
      "goodsNm": "text",
      "goodsCount": 1,
      "payAmt": 1,
      "bmanNo": "text",
      "bmanNm": "text",
      "rpstmnNm": "text",
      "zipNo": "text",
      "zipAddr": "text",
      "dtlAddr": "text",
      "aempNm": "text",
      "aempTelRgnNo": "text",
      "aempTelTxnoNo": "text",
      "aempTelEndNo": "text",
      "aempEmailId": "text",
      "aempEmailDomain": "text",
      "aempEmail": "text",
      "validYn": "text"
    },
    "orderCashReceiptRequest": {
      "prsntPurpsCd": "text",
      "idefNo": "text",
      "prchsrNm": "text",
      "prchsrEmail": "text",
      "prchsrCell": "text",
      "smsTrnsYn": "text",
      "faxTrnsYn": "text",
      "valiYn": "text"
    }
  }
}

No content

Issue Order No.

get

Function Description

Issues an order number.

Detailed Description

Called just before payment on the order form to issue the order number.

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Success

*/*

stringOptional

900

Business processing error details

*/*

get/v1/orderSheet/ordNo

GET /api/order/v1/orderSheet/ordNo HTTP/1.1
Host: api-order.x2bee.com/
Accept: */*

text

PreviousPayment Information

NextOrder Lookup

Last updated 1 month ago