For the complete documentation index, see llms.txt. This page is also available as Markdown.

Order Lookup

Non-member Login

post

Function Description

  • Validates the order and creates non-member cookie information when looking up a non-member order


Detailed Description

  • Checks whether the order exists and whether the non-member password for the order is valid

  • Sets the order number and non-member password cookie information after successful validation

Header parameters
AuthorizationanyOptional

Access Token

Body
ordNostringRequired

Order No.

nonMemberPwdstringRequired

Non-Member Password

systemTypestring · enumRequired

SYSTEM (System Type) * 10 : FO * 20 : BO

Example: 10Possible values:
Responses
200

Non-member Login Processing Success

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

{
  "ordNo": "text",
  "nonMemberPwd": "text",
  "systemType": "10"
}

Look Up Order History

post

Function Description

  • Looks up the order history list.


Detailed Description

  • Looks up the order list corresponding to the member number.

  • Non-members cannot look up the order history list.

  • Only looks up orders included between the lookup start datetime and lookup end datetime.

  • The order status classification code is passed as 'O' when clicking Order/Delivery, and 'C' when clicking Cancel/Exchange/Return, under My Page > Order Status.

    • When passed as Order/Delivery, all orders are listed; when passed as Cancel/Exchange/Return, only orders in Cancel/Exchange/Return status are listed.

  • For each order product, retrieves the codes matching the order history status code (ref_1_val) and order history type code (ref_2_val) of the FO system claim-processable-status (ST007) group code, to display buttons on the screen (orderButtonList).


Revision History

  • release_231220 : Added delivery address column

  • Release v2.00_240401:

    • Added single-product status

    • Added main-product order sequence no. (for matching gifts to the product)

    • Added expected shipment date for reserved products

    • Changed so that when orderClassificationCode is 'O', only Order/Delivery is looked up instead of all

  • Release v2.00_240729 : Added order-cancellation-allowed status (ordCnclPsbYn), added e-coupon product to product type code (goodsTypCd) filtering

Header parameters
AuthorizationanyOptional

Access Token

Body

Search Order List DTO

rowsPerPageinteger · int32Optional

Display Quantity per Screen

Example: 10
pageIdxinteger · int32Optional

Page No.

Example: 1
stdDtstring · dateOptional

Search Start Date

Example: 2023-08-02
endDtstring · dateOptional

Search End Date

Example: 2023-08-09
orderClassificationCodestringOptional

Order Status Classification Code Value (All Orders: O / Claims: C / Gift Box: G)

Example: C
pagingYnstringOptional

Paging Status

Example: Y
Responses
200

Success

*/*

Order List DTO

totCntinteger · int32Optional

Order Count

Example: 10
rowsPerPageinteger · int32Optional

Display Quantity per Screen

Example: 10
pageIdxinteger · int32Optional

Page No.

Example: 1
post/v1/mypage/order/orderInfoList
POST /api/order/v1/mypage/order/orderInfoList HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "rowsPerPage": 10,
  "pageIdx": 1,
  "stdDt": "2023-08-02",
  "endDt": "2023-08-09",
  "orderClassificationCode": "C",
  "pagingYn": "Y"
}
{
  "totCnt": 10,
  "rowsPerPage": 10,
  "pageIdx": 1,
  "ordList": [
    {
      "ordNo": "20230809O007943",
      "ordAccpDtm": "2026-01-01T00:00:00.000Z",
      "deliMethodCd": "10",
      "deliMethodNm": "10",
      "ordManNm": "홍길동",
      "ordManCellNo": "Y",
      "mbrNo": "100001452",
      "ordGbCd": "10",
      "rcvmnNm": "홍길동",
      "rcvmnCellNo": "Y",
      "prdList": [
        {
          "system": "10",
          "dlvpSeq": "1",
          "ordNo": "20230809O007943",
          "ordDtlGbCd": "10",
          "ordDtlGbCdNm": "주문완료",
          "ordGbCd": "10",
          "ordGbCdNm": "일반주문",
          "ordSeq": "1",
          "ordProcSeq": "1",
          "claimNo": "20230725C006642",
          "aeOrdSeq": "1",
          "goodsNo": "10002042",
          "goodsNm": "P직매입20",
          "itmNo": "001",
          "itmNm": "레드>190x190",
          "sngGoodsYn": "Y",
          "goodsTypCd": "10",
          "goodsTypCdNm": "일반상품",
          "brandNo": "100002",
          "brandNm": "멀버리",
          "ordDtlStatCd": "12",
          "ordDtlStatCdNm": "주문완료",
          "prestNm": "증정품",
          "norPrc": 1000,
          "salePrc": 1000,
          "dcAmt": 0,
          "ordQty": 1,
          "cnclQty": 1,
          "rtnQty": 1,
          "ordAmt": 1000,
          "deliNo": "1",
          "deliKindCd": "10",
          "deliKindCdNm": "일반배송",
          "shipWaitCaus": "10",
          "shipWaitCausNm": "재고부족",
          "deliTypCd": "01",
          "deliTypCdNm": "일반상품",
          "deliGbCd": "10",
          "deliPolcNo": "10000431",
          "rcvmnNm": "홍길동",
          "zipNo": 5837,
          "zipAddr": "서울 송파구 법원로9길 26",
          "dtlAddr": "비즈니스파크",
          "deliAddr": "서울 송파구 법원로9길 26 비즈니스파크",
          "deliMethodCd": "10",
          "deliMethodCdNm": "택배배송",
          "ordAccpDtm": "2026-01-01T00:00:00.000Z",
          "ordFnshDtm": "2026-01-01T00:00:00.000Z",
          "goodsRevWrtYn": "N",
          "deliFnshDtm": "2026-01-01T00:00:00.000Z",
          "goodsImg": "/url",
          "rtnPsbYn": "N",
          "prstStatCd": "10",
          "claimMgrpCd": "100",
          "claimCauseFaultType": "10",
          "wthdFnshGbCd": "10",
          "exchPsbYn": "N",
          "ordCnclPsbYn": "Y",
          "wthdYn": "Y",
          "ecpnNo": "ORD0001",
          "etcktNo": "ORD0001",
          "saleMethCd": "20",
          "deliIndiRsvDtm": "2026-01-01T00:00:00.000Z",
          "frgnDirPurGoodsYn": "text",
          "taxGbCd": "text"
        }
      ],
      "aeEvtList": [
        {
          "system": "10",
          "dlvpSeq": "1",
          "ordNo": "20230809O007943",
          "ordDtlGbCd": "10",
          "ordDtlGbCdNm": "주문완료",
          "ordGbCd": "10",
          "ordGbCdNm": "일반주문",
          "ordSeq": "1",
          "ordProcSeq": "1",
          "claimNo": "20230725C006642",
          "aeOrdSeq": "1",
          "goodsNo": "10002042",
          "goodsNm": "P직매입20",
          "itmNo": "001",
          "itmNm": "레드>190x190",
          "sngGoodsYn": "Y",
          "goodsTypCd": "10",
          "goodsTypCdNm": "일반상품",
          "brandNo": "100002",
          "brandNm": "멀버리",
          "ordDtlStatCd": "12",
          "ordDtlStatCdNm": "주문완료",
          "prestNm": "증정품",
          "norPrc": 1000,
          "salePrc": 1000,
          "dcAmt": 0,
          "ordQty": 1,
          "cnclQty": 1,
          "rtnQty": 1,
          "ordAmt": 1000,
          "deliNo": "1",
          "deliKindCd": "10",
          "deliKindCdNm": "일반배송",
          "shipWaitCaus": "10",
          "shipWaitCausNm": "재고부족",
          "deliTypCd": "01",
          "deliTypCdNm": "일반상품",
          "deliGbCd": "10",
          "deliPolcNo": "10000431",
          "rcvmnNm": "홍길동",
          "zipNo": 5837,
          "zipAddr": "서울 송파구 법원로9길 26",
          "dtlAddr": "비즈니스파크",
          "deliAddr": "서울 송파구 법원로9길 26 비즈니스파크",
          "deliMethodCd": "10",
          "deliMethodCdNm": "택배배송",
          "ordAccpDtm": "2026-01-01T00:00:00.000Z",
          "ordFnshDtm": "2026-01-01T00:00:00.000Z",
          "goodsRevWrtYn": "N",
          "deliFnshDtm": "2026-01-01T00:00:00.000Z",
          "goodsImg": "/url",
          "rtnPsbYn": "N",
          "prstStatCd": "10",
          "claimMgrpCd": "100",
          "claimCauseFaultType": "10",
          "wthdFnshGbCd": "10",
          "exchPsbYn": "N",
          "ordCnclPsbYn": "Y",
          "wthdYn": "Y",
          "ecpnNo": "ORD0001",
          "etcktNo": "ORD0001",
          "saleMethCd": "20",
          "deliIndiRsvDtm": "2026-01-01T00:00:00.000Z",
          "frgnDirPurGoodsYn": "text",
          "taxGbCd": "text"
        }
      ],
      "dlvpInfo": [
        {
          "dlvpSeq": "1",
          "rcvmnNm": "홍길동",
          "zipNo": 5837,
          "zipAddr": "서울 송파구 법원로9길",
          "dtlAddr": "에이치비지니스파크 D동 6층23",
          "deliAddr": "서울 송파구 법원로9길 에이치비지니스파크 D동 6층23",
          "rcvmnEmailAddr": "test@plateer.com",
          "rcvmnCellSctNo": "010",
          "rcvmnCellTxnoNo": "1234",
          "rcvmnCellEndNo": "5678",
          "deliMsg": "문 앞에 두고 가주세요.",
          "deliMsgCd": "10",
          "deliMsgCdNm": "배송 전 연락바랍니다.",
          "comnFrdrEtcMethod": "자유출입가능",
          "comnFrdrPwd": "1234",
          "comnFrdrCogoMethodCd": "10",
          "persCstmCd": "text",
          "deliNo": "101016693",
          "deliInfoGroupList": [
            {
              "deliNo": "1",
              "prdList": [
                {
                  "system": "10",
                  "dlvpSeq": "1",
                  "ordNo": "20230809O007943",
                  "ordDtlGbCd": "10",
                  "ordDtlGbCdNm": "주문완료",
                  "ordGbCd": "10",
                  "ordGbCdNm": "일반주문",
                  "ordSeq": "1",
                  "ordProcSeq": "1",
                  "claimNo": "20230725C006642",
                  "aeOrdSeq": "1",
                  "goodsNo": "10002042",
                  "goodsNm": "P직매입20",
                  "itmNo": "001",
                  "itmNm": "레드>190x190",
                  "sngGoodsYn": "Y",
                  "goodsTypCd": "10",
                  "goodsTypCdNm": "일반상품",
                  "brandNo": "100002",
                  "brandNm": "멀버리",
                  "ordDtlStatCd": "12",
                  "ordDtlStatCdNm": "주문완료",
                  "prestNm": "증정품",
                  "norPrc": 1000,
                  "salePrc": 1000,
                  "dcAmt": 0,
                  "ordQty": 1,
                  "cnclQty": 1,
                  "rtnQty": 1,
                  "ordAmt": 1000,
                  "deliNo": "1",
                  "deliKindCd": "10",
                  "deliKindCdNm": "일반배송",
                  "shipWaitCaus": "10",
                  "shipWaitCausNm": "재고부족",
                  "deliTypCd": "01",
                  "deliTypCdNm": "일반상품",
                  "deliGbCd": "10",
                  "deliPolcNo": "10000431",
                  "rcvmnNm": "홍길동",
                  "zipNo": 5837,
                  "zipAddr": "서울 송파구 법원로9길 26",
                  "dtlAddr": "비즈니스파크",
                  "deliAddr": "서울 송파구 법원로9길 26 비즈니스파크",
                  "deliMethodCd": "10",
                  "deliMethodCdNm": "택배배송",
                  "ordAccpDtm": "2026-01-01T00:00:00.000Z",
                  "ordFnshDtm": "2026-01-01T00:00:00.000Z",
                  "goodsRevWrtYn": "N",
                  "deliFnshDtm": "2026-01-01T00:00:00.000Z",
                  "goodsImg": "/url",
                  "rtnPsbYn": "N",
                  "prstStatCd": "10",
                  "claimMgrpCd": "100",
                  "claimCauseFaultType": "10",
                  "wthdFnshGbCd": "10",
                  "exchPsbYn": "N",
                  "ordCnclPsbYn": "Y",
                  "wthdYn": "Y",
                  "ecpnNo": "ORD0001",
                  "etcktNo": "ORD0001",
                  "saleMethCd": "20",
                  "deliIndiRsvDtm": "2026-01-01T00:00:00.000Z",
                  "frgnDirPurGoodsYn": "text",
                  "taxGbCd": "text"
                }
              ],
              "aeEvtList": [
                {
                  "system": "10",
                  "dlvpSeq": "1",
                  "ordNo": "20230809O007943",
                  "ordDtlGbCd": "10",
                  "ordDtlGbCdNm": "주문완료",
                  "ordGbCd": "10",
                  "ordGbCdNm": "일반주문",
                  "ordSeq": "1",
                  "ordProcSeq": "1",
                  "claimNo": "20230725C006642",
                  "aeOrdSeq": "1",
                  "goodsNo": "10002042",
                  "goodsNm": "P직매입20",
                  "itmNo": "001",
                  "itmNm": "레드>190x190",
                  "sngGoodsYn": "Y",
                  "goodsTypCd": "10",
                  "goodsTypCdNm": "일반상품",
                  "brandNo": "100002",
                  "brandNm": "멀버리",
                  "ordDtlStatCd": "12",
                  "ordDtlStatCdNm": "주문완료",
                  "prestNm": "증정품",
                  "norPrc": 1000,
                  "salePrc": 1000,
                  "dcAmt": 0,
                  "ordQty": 1,
                  "cnclQty": 1,
                  "rtnQty": 1,
                  "ordAmt": 1000,
                  "deliNo": "1",
                  "deliKindCd": "10",
                  "deliKindCdNm": "일반배송",
                  "shipWaitCaus": "10",
                  "shipWaitCausNm": "재고부족",
                  "deliTypCd": "01",
                  "deliTypCdNm": "일반상품",
                  "deliGbCd": "10",
                  "deliPolcNo": "10000431",
                  "rcvmnNm": "홍길동",
                  "zipNo": 5837,
                  "zipAddr": "서울 송파구 법원로9길 26",
                  "dtlAddr": "비즈니스파크",
                  "deliAddr": "서울 송파구 법원로9길 26 비즈니스파크",
                  "deliMethodCd": "10",
                  "deliMethodCdNm": "택배배송",
                  "ordAccpDtm": "2026-01-01T00:00:00.000Z",
                  "ordFnshDtm": "2026-01-01T00:00:00.000Z",
                  "goodsRevWrtYn": "N",
                  "deliFnshDtm": "2026-01-01T00:00:00.000Z",
                  "goodsImg": "/url",
                  "rtnPsbYn": "N",
                  "prstStatCd": "10",
                  "claimMgrpCd": "100",
                  "claimCauseFaultType": "10",
                  "wthdFnshGbCd": "10",
                  "exchPsbYn": "N",
                  "ordCnclPsbYn": "Y",
                  "wthdYn": "Y",
                  "ecpnNo": "ORD0001",
                  "etcktNo": "ORD0001",
                  "saleMethCd": "20",
                  "deliIndiRsvDtm": "2026-01-01T00:00:00.000Z",
                  "frgnDirPurGoodsYn": "text",
                  "taxGbCd": "text"
                }
              ]
            }
          ]
        }
      ],
      "payInfo": [
        {
          "type": "R",
          "ordNo": "20230809O007943",
          "totOrdPrc": 1000,
          "totAplyAdtnAmt": 1000,
          "totDcAmt": 1000,
          "saveMileageAmt": 10,
          "addPayAmt": 1000,
          "totPayAmt": 0,
          "mileagePayAmt": 1000,
          "pgGbCd": "1000",
          "payMethodResponses": [
            {
              "payWayCd": "11",
              "payWayCdNm": "신용카드",
              "payReqCardcoCd": "201",
              "payReqCardcoCdNm": "현대카드",
              "acqrCd": "201",
              "acqrCdNm": "현대카드",
              "bankCd": "10",
              "bankCdNm": "우리은행",
              "actnNo": "계좌번호 암호화",
              "dpmnNm": "김플래티어",
              "dptFcstDt": "20990101",
              "dlvMonCnt": 6,
              "nintDivYn": "Y",
              "payAmt": 1000
            }
          ],
          "accumulatedMileageResponses": [
            {
              "type": "FRS",
              "adtnDtlGbCd": "41",
              "adtnDtlGbCdNm": "기본적립",
              "aplyAdtnAmt": 1000
            }
          ]
        }
      ]
    }
  ]
}

Look Up Order History Details

post

Function Description

  • Looks up order history details.


Detailed Description

  • Looks up order details (order product information, initial payment information, initial accrued mileage, final refund information, etc.) corresponding to the order number.

  • For non-members, looks up the order details if an order exists whose non-member password and order number match.

  • For each order product, retrieves the codes matching the order history status code (ref_1_val) and order history type code (ref_2_val) of the FO system claim-processable-status (ST007) group code, to display buttons on the screen (orderButtonList).


Revision History

  • release_231206 : Added delivery group list (deliInfoGroupList) under the Response DTO's delivery address information list (changed UI display structure: delivery address > delivery group > product/gift list)

  • Release v2.00_240425 : Added site number (site_no) for multi-site expansion

  • Release v2.00_240711 : Added lookup of delivery policy number (deli_polc_no) due to additional delivery fee improvements

  • Release v2.00_240729 : Added order-cancellation-allowed status (ordCnclPsbYn), added e-coupon product to product type code (goodsTypCd) filtering

Header parameters
AuthorizationanyOptional

Access Token

Body

Search Order Detail DTO

ordNostringRequired

Order No.

Example: 20230809O007943
systemTypestring · enumOptional

SYSTEM (System Type) * 10 : FO * 20 : BO

Example: 10Possible values:
pagingYnstring · enumOptional

Paging Status

Example: YPossible values:
Responses
200

Success

*/*

Order History Detail Info DTO

ordNostringOptional

Order No.

Example: 20230809O007943
ordAccpDtmstring · date-timeOptional

Order Receipt Date/Time

deliMethodCdstringOptional

Delivery Method Code (LO010)

Example: 10
deliMethodNmstringOptional

Delivery Method Code Name

Example: 10
ordManNmstringOptional

Orderer Name

Example: 홍길동
ordManCellNostringOptional

Orderer Mobile Phone No.

Example: Y
mbrNostringOptional

Member No.

Example: 100001452
ordGbCdstringOptional

Order Classification Code (OM002)

Example: 10
rcvmnNmstringOptional

Recipient Name

Example: 홍길동
rcvmnCellNostringOptional

Recipient Mobile Phone No.

Example: Y
giftAcceptanceDeadlineAndDateinteger · int32Write-onlyOptional
additionalInfointeger · int32Write-onlyOptional
post/v1/mypage/order/orderDetailInfo
POST /api/order/v1/mypage/order/orderDetailInfo HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "ordNo": "20230809O007943",
  "systemType": "10",
  "pagingYn": "Y"
}
{
  "ordNo": "20230809O007943",
  "ordAccpDtm": "2026-01-01T00:00:00.000Z",
  "deliMethodCd": "10",
  "deliMethodNm": "10",
  "ordManNm": "홍길동",
  "ordManCellNo": "Y",
  "mbrNo": "100001452",
  "ordGbCd": "10",
  "rcvmnNm": "홍길동",
  "rcvmnCellNo": "Y",
  "prdList": [
    {
      "system": "10",
      "dlvpSeq": "1",
      "ordNo": "20230809O007943",
      "ordDtlGbCd": "10",
      "ordDtlGbCdNm": "주문완료",
      "ordGbCd": "10",
      "ordGbCdNm": "일반주문",
      "ordSeq": "1",
      "ordProcSeq": "1",
      "claimNo": "20230725C006642",
      "aeOrdSeq": "1",
      "goodsNo": "10002042",
      "goodsNm": "P직매입20",
      "itmNo": "001",
      "itmNm": "레드>190x190",
      "sngGoodsYn": "Y",
      "goodsTypCd": "10",
      "goodsTypCdNm": "일반상품",
      "brandNo": "100002",
      "brandNm": "멀버리",
      "ordDtlStatCd": "12",
      "ordDtlStatCdNm": "주문완료",
      "prestNm": "증정품",
      "norPrc": 1000,
      "salePrc": 1000,
      "dcAmt": 0,
      "ordQty": 1,
      "cnclQty": 1,
      "rtnQty": 1,
      "ordAmt": 1000,
      "deliNo": "1",
      "deliKindCd": "10",
      "deliKindCdNm": "일반배송",
      "shipWaitCaus": "10",
      "shipWaitCausNm": "재고부족",
      "deliTypCd": "01",
      "deliTypCdNm": "일반상품",
      "deliGbCd": "10",
      "deliPolcNo": "10000431",
      "rcvmnNm": "홍길동",
      "zipNo": 5837,
      "zipAddr": "서울 송파구 법원로9길 26",
      "dtlAddr": "비즈니스파크",
      "deliAddr": "서울 송파구 법원로9길 26 비즈니스파크",
      "deliMethodCd": "10",
      "deliMethodCdNm": "택배배송",
      "ordAccpDtm": "2026-01-01T00:00:00.000Z",
      "ordFnshDtm": "2026-01-01T00:00:00.000Z",
      "goodsRevWrtYn": "N",
      "deliFnshDtm": "2026-01-01T00:00:00.000Z",
      "goodsImg": "/url",
      "rtnPsbYn": "N",
      "prstStatCd": "10",
      "claimMgrpCd": "100",
      "claimCauseFaultType": "10",
      "wthdFnshGbCd": "10",
      "exchPsbYn": "N",
      "ordCnclPsbYn": "Y",
      "wthdYn": "Y",
      "ecpnNo": "ORD0001",
      "etcktNo": "ORD0001",
      "saleMethCd": "20",
      "deliIndiRsvDtm": "2026-01-01T00:00:00.000Z",
      "frgnDirPurGoodsYn": "text",
      "taxGbCd": "text"
    }
  ],
  "aeEvtList": [
    {
      "system": "10",
      "dlvpSeq": "1",
      "ordNo": "20230809O007943",
      "ordDtlGbCd": "10",
      "ordDtlGbCdNm": "주문완료",
      "ordGbCd": "10",
      "ordGbCdNm": "일반주문",
      "ordSeq": "1",
      "ordProcSeq": "1",
      "claimNo": "20230725C006642",
      "aeOrdSeq": "1",
      "goodsNo": "10002042",
      "goodsNm": "P직매입20",
      "itmNo": "001",
      "itmNm": "레드>190x190",
      "sngGoodsYn": "Y",
      "goodsTypCd": "10",
      "goodsTypCdNm": "일반상품",
      "brandNo": "100002",
      "brandNm": "멀버리",
      "ordDtlStatCd": "12",
      "ordDtlStatCdNm": "주문완료",
      "prestNm": "증정품",
      "norPrc": 1000,
      "salePrc": 1000,
      "dcAmt": 0,
      "ordQty": 1,
      "cnclQty": 1,
      "rtnQty": 1,
      "ordAmt": 1000,
      "deliNo": "1",
      "deliKindCd": "10",
      "deliKindCdNm": "일반배송",
      "shipWaitCaus": "10",
      "shipWaitCausNm": "재고부족",
      "deliTypCd": "01",
      "deliTypCdNm": "일반상품",
      "deliGbCd": "10",
      "deliPolcNo": "10000431",
      "rcvmnNm": "홍길동",
      "zipNo": 5837,
      "zipAddr": "서울 송파구 법원로9길 26",
      "dtlAddr": "비즈니스파크",
      "deliAddr": "서울 송파구 법원로9길 26 비즈니스파크",
      "deliMethodCd": "10",
      "deliMethodCdNm": "택배배송",
      "ordAccpDtm": "2026-01-01T00:00:00.000Z",
      "ordFnshDtm": "2026-01-01T00:00:00.000Z",
      "goodsRevWrtYn": "N",
      "deliFnshDtm": "2026-01-01T00:00:00.000Z",
      "goodsImg": "/url",
      "rtnPsbYn": "N",
      "prstStatCd": "10",
      "claimMgrpCd": "100",
      "claimCauseFaultType": "10",
      "wthdFnshGbCd": "10",
      "exchPsbYn": "N",
      "ordCnclPsbYn": "Y",
      "wthdYn": "Y",
      "ecpnNo": "ORD0001",
      "etcktNo": "ORD0001",
      "saleMethCd": "20",
      "deliIndiRsvDtm": "2026-01-01T00:00:00.000Z",
      "frgnDirPurGoodsYn": "text",
      "taxGbCd": "text"
    }
  ],
  "dlvpInfo": [
    {
      "dlvpSeq": "1",
      "rcvmnNm": "홍길동",
      "zipNo": 5837,
      "zipAddr": "서울 송파구 법원로9길",
      "dtlAddr": "에이치비지니스파크 D동 6층23",
      "deliAddr": "서울 송파구 법원로9길 에이치비지니스파크 D동 6층23",
      "rcvmnEmailAddr": "test@plateer.com",
      "rcvmnCellSctNo": "010",
      "rcvmnCellTxnoNo": "1234",
      "rcvmnCellEndNo": "5678",
      "deliMsg": "문 앞에 두고 가주세요.",
      "deliMsgCd": "10",
      "deliMsgCdNm": "배송 전 연락바랍니다.",
      "comnFrdrEtcMethod": "자유출입가능",
      "comnFrdrPwd": "1234",
      "comnFrdrCogoMethodCd": "10",
      "persCstmCd": "text",
      "deliNo": "101016693",
      "deliInfoGroupList": [
        {
          "deliNo": "1",
          "prdList": [
            {
              "system": "10",
              "dlvpSeq": "1",
              "ordNo": "20230809O007943",
              "ordDtlGbCd": "10",
              "ordDtlGbCdNm": "주문완료",
              "ordGbCd": "10",
              "ordGbCdNm": "일반주문",
              "ordSeq": "1",
              "ordProcSeq": "1",
              "claimNo": "20230725C006642",
              "aeOrdSeq": "1",
              "goodsNo": "10002042",
              "goodsNm": "P직매입20",
              "itmNo": "001",
              "itmNm": "레드>190x190",
              "sngGoodsYn": "Y",
              "goodsTypCd": "10",
              "goodsTypCdNm": "일반상품",
              "brandNo": "100002",
              "brandNm": "멀버리",
              "ordDtlStatCd": "12",
              "ordDtlStatCdNm": "주문완료",
              "prestNm": "증정품",
              "norPrc": 1000,
              "salePrc": 1000,
              "dcAmt": 0,
              "ordQty": 1,
              "cnclQty": 1,
              "rtnQty": 1,
              "ordAmt": 1000,
              "deliNo": "1",
              "deliKindCd": "10",
              "deliKindCdNm": "일반배송",
              "shipWaitCaus": "10",
              "shipWaitCausNm": "재고부족",
              "deliTypCd": "01",
              "deliTypCdNm": "일반상품",
              "deliGbCd": "10",
              "deliPolcNo": "10000431",
              "rcvmnNm": "홍길동",
              "zipNo": 5837,
              "zipAddr": "서울 송파구 법원로9길 26",
              "dtlAddr": "비즈니스파크",
              "deliAddr": "서울 송파구 법원로9길 26 비즈니스파크",
              "deliMethodCd": "10",
              "deliMethodCdNm": "택배배송",
              "ordAccpDtm": "2026-01-01T00:00:00.000Z",
              "ordFnshDtm": "2026-01-01T00:00:00.000Z",
              "goodsRevWrtYn": "N",
              "deliFnshDtm": "2026-01-01T00:00:00.000Z",
              "goodsImg": "/url",
              "rtnPsbYn": "N",
              "prstStatCd": "10",
              "claimMgrpCd": "100",
              "claimCauseFaultType": "10",
              "wthdFnshGbCd": "10",
              "exchPsbYn": "N",
              "ordCnclPsbYn": "Y",
              "wthdYn": "Y",
              "ecpnNo": "ORD0001",
              "etcktNo": "ORD0001",
              "saleMethCd": "20",
              "deliIndiRsvDtm": "2026-01-01T00:00:00.000Z",
              "frgnDirPurGoodsYn": "text",
              "taxGbCd": "text"
            }
          ],
          "aeEvtList": [
            {
              "system": "10",
              "dlvpSeq": "1",
              "ordNo": "20230809O007943",
              "ordDtlGbCd": "10",
              "ordDtlGbCdNm": "주문완료",
              "ordGbCd": "10",
              "ordGbCdNm": "일반주문",
              "ordSeq": "1",
              "ordProcSeq": "1",
              "claimNo": "20230725C006642",
              "aeOrdSeq": "1",
              "goodsNo": "10002042",
              "goodsNm": "P직매입20",
              "itmNo": "001",
              "itmNm": "레드>190x190",
              "sngGoodsYn": "Y",
              "goodsTypCd": "10",
              "goodsTypCdNm": "일반상품",
              "brandNo": "100002",
              "brandNm": "멀버리",
              "ordDtlStatCd": "12",
              "ordDtlStatCdNm": "주문완료",
              "prestNm": "증정품",
              "norPrc": 1000,
              "salePrc": 1000,
              "dcAmt": 0,
              "ordQty": 1,
              "cnclQty": 1,
              "rtnQty": 1,
              "ordAmt": 1000,
              "deliNo": "1",
              "deliKindCd": "10",
              "deliKindCdNm": "일반배송",
              "shipWaitCaus": "10",
              "shipWaitCausNm": "재고부족",
              "deliTypCd": "01",
              "deliTypCdNm": "일반상품",
              "deliGbCd": "10",
              "deliPolcNo": "10000431",
              "rcvmnNm": "홍길동",
              "zipNo": 5837,
              "zipAddr": "서울 송파구 법원로9길 26",
              "dtlAddr": "비즈니스파크",
              "deliAddr": "서울 송파구 법원로9길 26 비즈니스파크",
              "deliMethodCd": "10",
              "deliMethodCdNm": "택배배송",
              "ordAccpDtm": "2026-01-01T00:00:00.000Z",
              "ordFnshDtm": "2026-01-01T00:00:00.000Z",
              "goodsRevWrtYn": "N",
              "deliFnshDtm": "2026-01-01T00:00:00.000Z",
              "goodsImg": "/url",
              "rtnPsbYn": "N",
              "prstStatCd": "10",
              "claimMgrpCd": "100",
              "claimCauseFaultType": "10",
              "wthdFnshGbCd": "10",
              "exchPsbYn": "N",
              "ordCnclPsbYn": "Y",
              "wthdYn": "Y",
              "ecpnNo": "ORD0001",
              "etcktNo": "ORD0001",
              "saleMethCd": "20",
              "deliIndiRsvDtm": "2026-01-01T00:00:00.000Z",
              "frgnDirPurGoodsYn": "text",
              "taxGbCd": "text"
            }
          ]
        }
      ]
    }
  ],
  "payInfo": [
    {
      "type": "R",
      "ordNo": "20230809O007943",
      "totOrdPrc": 1000,
      "totAplyAdtnAmt": 1000,
      "totDcAmt": 1000,
      "saveMileageAmt": 10,
      "addPayAmt": 1000,
      "totPayAmt": 0,
      "mileagePayAmt": 1000,
      "pgGbCd": "1000",
      "payMethodResponses": [
        {
          "payWayCd": "11",
          "payWayCdNm": "신용카드",
          "payReqCardcoCd": "201",
          "payReqCardcoCdNm": "현대카드",
          "acqrCd": "201",
          "acqrCdNm": "현대카드",
          "bankCd": "10",
          "bankCdNm": "우리은행",
          "actnNo": "계좌번호 암호화",
          "dpmnNm": "김플래티어",
          "dptFcstDt": "20990101",
          "dlvMonCnt": 6,
          "nintDivYn": "Y",
          "payAmt": 1000
        }
      ],
      "accumulatedMileageResponses": [
        {
          "type": "FRS",
          "adtnDtlGbCd": "41",
          "adtnDtlGbCdNm": "기본적립",
          "aplyAdtnAmt": 1000
        }
      ]
    }
  ]
}

Look Up Claim-Processable Buttons (BO)

post

Function Description

  • [BO-only] Looks up only the button list to display for order product entries in BO order claim processing.


Detailed Description

  • In BO, looks up the order product list corresponding to a single order and passes it as a parameter.

  • Looks up the codes matching the order history status code (ref_1_val) and order history type code (ref_2_val) of the BO system claim-processable-status (ST008) group code, to display buttons on the screen.


Revision History

  • Release v2.00_240729 : Added order-cancellation-allowed status (ordCnclPsbYn), collection status (wthdYn), e-coupon number (ecpnNo), e-ticket number (etcktNo) / added button filtering by product type

Header parameters
AuthorizationanyOptional

Access Token

Bodyobject · OrderDetailGoodsInfoResponse[]

Order Product Info List DTO

systemstring · enumOptional

SYSTEM (System Type) * 10 : FO * 20 : BO

Example: 10Possible values:
dlvpSeqstringOptional

Delivery Sequence No.

Example: 1
ordNostringOptional

Order No.

Example: 20230809O007943
ordDtlGbCdstringOptional

Order Detail Classification Code (OM003)

Example: 10
ordDtlGbCdNmstringOptional

Order Detail Classification Code Name

Example: 주문완료
ordGbCdstringOptional

Order Classification Code (OM002)

Example: 10
ordGbCdNmstringOptional

Order Classification Code Name

Example: 일반주문
ordSeqstringOptional

Order Sequence No.

Example: 1
ordProcSeqstringOptional

Order Processing Sequence No.

Example: 1
claimNostringOptional

Claim No.

Example: 20230725C006642
aeOrdSeqstringOptional

Main Item Order Sequence No.

Example: 1
goodsNostringOptional

Product No.

Example: 10002042
goodsNmstringOptional

Product Name

Example: P직매입20
itmNostringOptional

Item No.

Example: 001
itmNmstringOptional

Item Name

Example: 레드>190x190
sngGoodsYnstringOptional

Single Product Status

Example: Y
goodsTypCdstringOptional

Product Type Code (PR002)

Example: 10
goodsTypCdNmstringOptional

Product Type Code Name

Example: 일반상품
brandNostringOptional

Brand No.

Example: 100002
brandNmstringOptional

Brand Name

Example: 멀버리
ordDtlStatCdstringOptional

Order Detail Sub-Type Code (OM005)

Example: 12
ordDtlStatCdNmstringOptional

Order Detail Sub-Type Code Name

Example: 주문완료
prestNmstringOptional

Gift Item Name

Example: 증정품
norPrcinteger · int32Optional

Regular Price

Example: 1000
salePrcinteger · int32Optional

Selling Price

Example: 1000
dcAmtinteger · int32Optional

Discount Amount

Example: 0
ordQtyinteger · int32Optional

Order Quantity

Example: 1
cnclQtyinteger · int32Optional

Cancellation Quantity

Example: 1
rtnQtyinteger · int32Optional

Return Quantity

Example: 1
ordAmtinteger · int32Optional

Order Amount

Example: 1000
deliNostringOptional

Delivery No.

Example: 1
deliKindCdstringOptional

Delivery Type Code (LO009)

Example: 10
deliKindCdNmstringOptional

Delivery Type Code Name

Example: 일반배송
shipWaitCausstringOptional

Shipping Hold Reason Code (LO007)

Example: 10
shipWaitCausNmstringOptional

Shipping Hold Reason Code Name

Example: 재고부족
deliTypCdstringOptional

Delivery Product Classification Code (PR010)

Example: 01
deliTypCdNmstringOptional

Delivery Product Classification Code Name

Example: 일반상품
deliGbCdstringOptional

Delivery Type Code (LO001)

Example: 10
deliPolcNostringOptional

Delivery Policy No.

Example: 10000431
rcvmnNmstringOptional

Recipient Name

Example: 홍길동
zipNostringOptional

Postal Code

Example: 5837
zipAddrstringOptional

Postal Address

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

Detailed Address

Example: 비즈니스파크
deliAddrstringOptional

Delivery Address

Example: 서울 송파구 법원로9길 26 비즈니스파크
deliMethodCdstringOptional

Delivery Method Code (LO010)

Example: 10
deliMethodCdNmstringOptional

Delivery Method Code Name

Example: 택배배송
ordAccpDtmstring · date-timeOptional

Order Reception Date

ordFnshDtmstring · date-timeOptional

Order Completion Date

goodsRevWrtYnstringOptional

Product Review Written Status

Example: N
deliFnshDtmstring · date-timeOptional

Delivery Completion Date/Time

goodsImgstringOptional

Product Image

Example: /url
rtnPsbYnstringOptional

Return Availability Status

Example: N
prstStatCdstringOptional

Gift Status Code (OM044)

Example: 10
claimMgrpCdstringOptional

Claim Subcategory Code (OM006)

Example: 100
claimCauseFaultTypestringOptional

Claim Responsibility Type (10: Customer Responsibility / 20: Company Responsibility)

Example: 10
wthdFnshGbCdstringOptional

Collection Completion Classification Code (LO011)

Example: 10
exchPsbYnstringOptional

Exchange Availability Status

Example: N
ordCnclPsbYnstringOptional

Cancellation Availability Status

Example: Y
wthdYnstringOptional

Collection Status

Example: Y
ecpnNostringOptional

E-Coupon No.

Example: ORD0001
etcktNostringOptional

E-Ticket No.

Example: ORD0001
saleMethCdstringOptional

Sales Method Code (PR003)

Example: 20
deliIndiRsvDtmstring · date-timeOptional

Delivery Instruction Reservation Date/Time

frgnDirPurGoodsYnstringOptional

Overseas Direct Purchase Product Status

taxGbCdstringOptional

Tax/Duty-Free Classification Code (PR007)

Responses
200

Success

*/*
string[]Optional
post/v1/mypage/order/getAvailableBOButtonList
POST /api/order/v1/mypage/order/getAvailableBOButtonList HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 1453

[
  {
    "system": "10",
    "dlvpSeq": "1",
    "ordNo": "20230809O007943",
    "ordDtlGbCd": "10",
    "ordDtlGbCdNm": "주문완료",
    "ordGbCd": "10",
    "ordGbCdNm": "일반주문",
    "ordSeq": "1",
    "ordProcSeq": "1",
    "claimNo": "20230725C006642",
    "aeOrdSeq": "1",
    "goodsNo": "10002042",
    "goodsNm": "P직매입20",
    "itmNo": "001",
    "itmNm": "레드>190x190",
    "sngGoodsYn": "Y",
    "goodsTypCd": "10",
    "goodsTypCdNm": "일반상품",
    "brandNo": "100002",
    "brandNm": "멀버리",
    "ordDtlStatCd": "12",
    "ordDtlStatCdNm": "주문완료",
    "prestNm": "증정품",
    "norPrc": 1000,
    "salePrc": 1000,
    "dcAmt": 0,
    "ordQty": 1,
    "cnclQty": 1,
    "rtnQty": 1,
    "ordAmt": 1000,
    "deliNo": "1",
    "deliKindCd": "10",
    "deliKindCdNm": "일반배송",
    "shipWaitCaus": "10",
    "shipWaitCausNm": "재고부족",
    "deliTypCd": "01",
    "deliTypCdNm": "일반상품",
    "deliGbCd": "10",
    "deliPolcNo": "10000431",
    "rcvmnNm": "홍길동",
    "zipNo": 5837,
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "비즈니스파크",
    "deliAddr": "서울 송파구 법원로9길 26 비즈니스파크",
    "deliMethodCd": "10",
    "deliMethodCdNm": "택배배송",
    "ordAccpDtm": "2026-01-01T00:00:00.000Z",
    "ordFnshDtm": "2026-01-01T00:00:00.000Z",
    "goodsRevWrtYn": "N",
    "deliFnshDtm": "2026-01-01T00:00:00.000Z",
    "goodsImg": "/url",
    "rtnPsbYn": "N",
    "prstStatCd": "10",
    "claimMgrpCd": "100",
    "claimCauseFaultType": "10",
    "wthdFnshGbCd": "10",
    "exchPsbYn": "N",
    "ordCnclPsbYn": "Y",
    "wthdYn": "Y",
    "ecpnNo": "ORD0001",
    "etcktNo": "ORD0001",
    "saleMethCd": "20",
    "deliIndiRsvDtm": "2026-01-01T00:00:00.000Z",
    "frgnDirPurGoodsYn": "text",
    "taxGbCd": "text"
  }
]
[
  "text"
]

Last updated