Regular Order

Cancel Subscription Order (FO)

put

Function Description

Cancels the subscription order selected on the FO screen.

Detailed Description

Changes the selected subscription order status (OM009) to cancelled.

Header parameters

AuthorizationanyOptional

Access Token

Body

rglrDeliNostringRequired

Subscription Order No.

Example: 1

rglrDeliSeqListinteger · int32[]Optional

Subscription Order Sequence No. List

Responses

200

Success

No content

900

Business processing error details

*/*

put/v1/regularOrder/terminateRegularOrderFO

PUT /api/order/v1/regularOrder/terminateRegularOrderFO HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "rglrDeliNo": "1",
  "rglrDeliSeqList": [
    1
  ]
}

No content

Cancel Subscription Order (BO)

put

Function Description

Cancels the subscription order selected on the BO screen.

Detailed Description

Changes the selected subscription order status (OM009) to cancelled.

Header parameters

AuthorizationanyOptional

Access Token

Bodystring[]

string[]Optional

Responses

200

Success

No content

900

Business processing error details

*/*

put/v1/regularOrder/terminateRegularOrderBO

PUT /api/order/v1/regularOrder/terminateRegularOrderBO HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]

No content

Skip Subscription Order

put

Function Description

Sets the selected subscription order product's order to be skipped.

Detailed Description

Changes the skip status of the selected subscription order product to Y.

The skip status changed to Y is reset to N at the time the order is created.

Header parameters

AuthorizationanyOptional

Access Token

Body

rglrDeliNostringRequired

Subscription Order No.

Example: 1

rglrDeliSeqListinteger · int32[]Optional

Subscription Order Sequence No. List

Responses

200

Success

No content

900

Business processing error details

*/*

put/v1/regularOrder/skipRegularOrder

PUT /api/order/v1/regularOrder/skipRegularOrder HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "rglrDeliNo": "1",
  "rglrDeliSeqList": [
    1
  ]
}

No content

Look Up Subscription Order Application Form

post

Function Description

Looks up the subscription order application form information.

Detailed Description

Looks up the member's subscription order application form information upon entering the subscription order application form. The subscription order application form information includes payment method, order products, order delivery, and accrual information.

Only members can access it; coupons and discounts are not looked up.
Since subscription orders automatically use the default delivery address and cannot be changed, only the member's default delivery address is looked up for delivery address information.
The payment method is the auto-payment card information registered under My Page > Register/Change Auto-payment Card.

Revision History

Release v2.00_240401 : Removed auto-payment card check upon entering the subscription delivery application form
Release v2.00_240401 : Changed subscription order auto-payment card information object

Header parameters

AuthorizationanyOptional

Access Token

Body

Search Subscription Order Application Form 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:

bsketNoListinteger · int64[]Required

Cart No.

Example: [100009929]

Responses

200

Success

*/*

Search Subscription Order Application Form Response DTO

900

Business processing error details

*/*

post/v1/regularOrderSheet/regularOrderSheet

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

{
  "ordMediaCd": "20",
  "bsketNoList": [
    100009929
  ]
}

{
  "orderSheetInfo": {
    "cardResponse": {
      "cardInfo": {
        "siteNo": "1",
        "mbrNo": "100000001",
        "aplyStrDtm": "2026-01-01T00:00:00.000Z",
        "aplyEndDtm": "2026-01-01T00:00:00.000Z",
        "pgGbCd": "10",
        "pgGbCdNm": "이니시스(INICIS)",
        "acqrCd": "102",
        "acqrCdNm": "삼성카드",
        "cardNo": "123456*********7",
        "bllgKeyNo": "371837374a8dcc1f8a04c15c802dfc40954cf5e7",
        "bllgKeyRegDtm": "2026-01-01T00:00:00.000Z",
        "delYn": "N"
      }
    },
    "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
            }
          ]
        }
      ]
    }
  },
  "orderApplicationRequest": {
    "regularOrderBase": {
      "rglrDeliNo": "1",
      "rglrDeliTermCd": "1",
      "rglrDeliCycleCd": "11",
      "rglrDeliCycleVal": "1,3"
    },
    "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"
                }
              }
            ]
          }
        ]
      }
    ],
    "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"
              }
            ]
          }
        ]
      }
    ],
    "basketRequest": {
      "bsketGbCd": "10",
      "goodsNo": "10212309",
      "itmNo": "001",
      "bsketNoList": [
        1
      ]
    }
  }
}

Validate Before Changing Subscription Order Cycle (FO)

post

Function Description

Validates before changing the subscription order cycle.

Detailed Description

Validates using the subscription order's application period and application date as parameters.
Throws an exception if the change period is shorter than the remaining period.

Revision History

Release v2.00_240401 : Separated cycle-change validation (FO)

Header parameters

AuthorizationanyOptional

Access Token

Body

rglrDeliNostringRequired

Subscription Order No.

rglrDeliTermCdstringRequired

Subscription Order Period Code

rglrDeliCycleCdstringRequired

Subscription Order Cycle Code (OM034)

rglrDeliCycleValstringRequired

Subscription Order Date

Responses

200

Success

*/*

stringOptional

900

Business processing error details

*/*

post/v1/regularOrder/validateChangeRegularOrder

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

{
  "rglrDeliNo": "text",
  "rglrDeliTermCd": "text",
  "rglrDeliCycleCd": "text",
  "rglrDeliCycleVal": "text"
}

text

Change Subscription Order Processing Status, Item, Order Quantity, and Add Product (BO)

post

Function Description

Changes the subscription order processing status, item, and order quantity, adds a product, and saves.

Detailed Description

Changes the skip status of the subscription order.
Changes the item of the subscription order.
Newly adds a product to the subscription order.
Changes the quantity of the subscription order.

Header parameters

AuthorizationanyOptional

Access Token

Body

Responses

200

Success

No content

900

Business processing error details

*/*

post/v1/regularOrder/saveRegularOrder

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

{
  "createList": [
    {
      "rglrDeliNo": "1",
      "rglrDeliSeq": 1,
      "skipYn": "Y",
      "goodsNo": "1",
      "goodsNm": "상품1",
      "itmNo": "1",
      "itmNm": "단품1",
      "afterItmNo": "1",
      "rglrDeliQty": 1,
      "rglrDeliTermCd": "1",
      "rglrDeliCycleVal": "1",
      "rglrDeliStatCd": "10",
      "brandNo": "text",
      "brandNm": "text",
      "goodsNoAndItmNo": "text"
    }
  ],
  "updateList": [
    {
      "rglrDeliNo": "1",
      "rglrDeliSeq": 1,
      "skipYn": "Y",
      "goodsNo": "1",
      "goodsNm": "상품1",
      "itmNo": "1",
      "itmNm": "단품1",
      "afterItmNo": "1",
      "rglrDeliQty": 1,
      "rglrDeliTermCd": "1",
      "rglrDeliCycleVal": "1",
      "rglrDeliStatCd": "10",
      "brandNo": "text",
      "brandNm": "text",
      "goodsNoAndItmNo": "text"
    }
  ]
}

No content

Change Subscription Order Item and Order Quantity (FO)

post

Function Description

Changes the subscription order item and order quantity.

Detailed Description

Changes the item of the subscription order.
Changes the quantity of the subscription order.

Header parameters

AuthorizationanyOptional

Access Token

Body

rglrDeliNostringRequired

Subscription Order No.

Example: 1

rglrDeliSeqinteger · int32Required

Subscription Order Sequence No.

Example: 1

skipYnstringOptional

Skip Status

Example: Y

goodsNostringOptional

Product No.

Example: 1

goodsNmstringOptional

Product Name

Example: 상품1

itmNostringRequired

Item No.

Example: 1

itmNmstringRequired

Item Name

Example: 단품1

afterItmNostringRequired

Item No. to Change

Example: 1

rglrDeliQtyinteger · int32 · min: 1Optional

Subscription Order Quantity

Example: 1

rglrDeliTermCdstringOptional

Subscription Order Period Code (OM008)

Example: 1

rglrDeliCycleValstringOptional

Subscription Order Cycle Value

Example: 1

rglrDeliStatCdstring · enumOptional

OM009(Subscription Order Status Code) 10: In Progress , 20: Suspended , 30: Terminated

Example: 10Possible values:

brandNostringOptional

Brand No.

brandNmstringOptional

Brand Name

goodsNoAndItmNostringOptional

Responses

200

Success

No content

900

Business processing error details

*/*

post/v1/regularOrder/regularOrderOptionChange

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

{
  "rglrDeliNo": "1",
  "rglrDeliSeq": 1,
  "skipYn": "Y",
  "goodsNo": "1",
  "goodsNm": "상품1",
  "itmNo": "1",
  "itmNm": "단품1",
  "afterItmNo": "1",
  "rglrDeliQty": 1,
  "rglrDeliTermCd": "1",
  "rglrDeliCycleVal": "1",
  "rglrDeliStatCd": "10",
  "brandNo": "text",
  "brandNm": "text",
  "goodsNoAndItmNo": "text"
}

No content

Subscription Order Creation Batch

post

Function Description

Creates orders based on subscription order application data whose next order creation date is today.

Detailed Description

Once the order is created, resets the skip status of the corresponding subscription order products.
Calculates and updates the next order creation date; if it is after the subscription order end date, the subscription order is cancelled.
Updates the most recent order creation date.

Revision History

Release v2.00_240401 : Fixed next scheduled order date calculation when creating a subscription order
Release v2.00_240401 : Fixed skip logic
Release v2.00_240627 : Added Toss subscription order payment

Notes

This API is a BATCH-only API.

Header parameters

AuthorizationanyOptional

Access Token

Bodystring[]

string[]Optional

Responses

200

Success

No content

900

Business processing error details

*/*

post/v1/regularOrder/registerRegularOrderBatch

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

[
  "text"
]

No content

Validate Before Changing Subscription Order Cycle (BO)

post

Function Description

Validates before changing the subscription order cycle.

Detailed Description

Validates using the subscription order's application period and application date as parameters.
Throws an exception if the change period is shorter than the remaining period.

Header parameters

AuthorizationanyOptional

Access Token

Body

rglrDeliNostringRequired

Subscription Order No.

rglrDeliTermCdstringRequired

Subscription Order Period Code

rglrDeliCycleCdstringRequired

Subscription Order Cycle Code (OM034)

rglrDeliCycleValstringRequired

Subscription Order Date

Responses

200

Success

*/*

stringOptional

900

Business processing error details

*/*

post/v1/regularOrder/isPossibleChangeRegularOrderDeliTerm

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

{
  "rglrDeliNo": "text",
  "rglrDeliTermCd": "text",
  "rglrDeliCycleCd": "text",
  "rglrDeliCycleVal": "text"
}

text

Whether the Next Scheduled Order Date Changes When Skipping a Subscription Order (FO)

post

Function Description

Returns whether (true/false) the next scheduled order date for the subscription order will change when a skip is requested.

Detailed Description

Based on the skip request parameters, responds true if, once the request is processed, the skip status of all products in the subscription order will be Y.
Otherwise, responds false.
FO-only; assumes the sequence number in the parameter is always a skip=Y request. (skip -> no scheduled order)

Header parameters

AuthorizationanyOptional

Access Token

Body

rglrDeliNostringRequired

Subscription Order No.

Example: 1

rglrDeliSeqListinteger · int32[]Optional

Subscription Order Sequence No. List

Responses

200

Success

*/*

willBeChangedbooleanOptional

nxtOrdGenDtstringOptional

900

Business processing error details

*/*

post/v1/regularOrder/isNextOrderDateWillBeChanged

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

{
  "rglrDeliNo": "1",
  "rglrDeliSeqList": [
    1
  ]
}

{
  "willBeChanged": true,
  "nxtOrdGenDt": "text"
}

Whether the Next Scheduled Order Date Changes When Skipping a Subscription Order (BO)

post

Function Description

Returns whether (true/false) the next scheduled order date for the subscription order will change when a skip is requested.

Detailed Description

Based on the skip request parameters, responds true if, once the request is processed, the skip status of all products in the subscription order will be Y.
Otherwise, responds false.
BO-only; assumes the skip request value in the parameter can be either Y or N, and responds with the predicted result after the change.

Header parameters

AuthorizationanyOptional

Access Token

Bodyobject · RegularOrderGoodsRequest[]

rglrDeliNostringRequired

Subscription Order No.

Example: 1

rglrDeliSeqinteger · int32Required

Subscription Order Sequence No.

Example: 1

skipYnstringOptional

Skip Status

Example: Y

goodsNostringOptional

Product No.

Example: 1

goodsNmstringOptional

Product Name

Example: 상품1

itmNostringRequired

Item No.

Example: 1

itmNmstringRequired

Item Name

Example: 단품1

afterItmNostringRequired

Item No. to Change

Example: 1

rglrDeliQtyinteger · int32 · min: 1Optional

Subscription Order Quantity

Example: 1

rglrDeliTermCdstringOptional

Subscription Order Period Code (OM008)

Example: 1

rglrDeliCycleValstringOptional

Subscription Order Cycle Value

Example: 1

rglrDeliStatCdstring · enumOptional

OM009(Subscription Order Status Code) 10: In Progress , 20: Suspended , 30: Terminated

Example: 10Possible values:

brandNostringOptional

Brand No.

brandNmstringOptional

Brand Name

goodsNoAndItmNostringOptional

Responses

200

Success

*/*

willBeChangedbooleanOptional

nxtOrdGenDtstringOptional

900

Business processing error details

*/*

post/v1/regularOrder/isNextOrderDateWillBeChangedBO

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

[
  {
    "rglrDeliNo": "1",
    "rglrDeliSeq": 1,
    "skipYn": "Y",
    "goodsNo": "1",
    "goodsNm": "상품1",
    "itmNo": "1",
    "itmNm": "단품1",
    "afterItmNo": "1",
    "rglrDeliQty": 1,
    "rglrDeliTermCd": "1",
    "rglrDeliCycleVal": "1",
    "rglrDeliStatCd": "10",
    "brandNo": "text",
    "brandNm": "text",
    "goodsNoAndItmNo": "text"
  }
]

{
  "willBeChanged": true,
  "nxtOrdGenDt": "text"
}

Look Up Next Scheduled Subscription Order Date After Cycle Change (FO)

post

Function Description

Looks up the next scheduled subscription order date after a cycle change.

Detailed Description

Returns the date in the format 2023.03.11(Mon).
Calculates the date starting after the order's cycle has elapsed from the change date.

Revision History

Release v2.00_240401 : Fixed next scheduled order date calculation upon subscription order cycle change

Header parameters

AuthorizationanyOptional

Access Token

Body

rglrDeliNostringOptional

rglrDeliTermCdstringOptional

rglrDeliStrDtstringOptional

rglrDeliEndDtstringOptional

rglrDeliCycleCdstringOptional

rglrDeliCycleValstringOptional

nxtOrdGenDtstringOptional

accpDtmstring · date-timeOptional

rglrDeliStatCdstringOptional

rglrDeliStatCdNmstringOptional

lastRglrDeliSeqinteger · int32Optional

Responses

200

Success

*/*

stringOptional

900

Business processing error details

*/*

post/v1/regularOrder/getNextRegularOrderDate

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

{
  "rglrDeliNo": "text",
  "rglrDeliTermCd": "text",
  "rglrDeliStrDt": "text",
  "rglrDeliEndDt": "text",
  "rglrDeliCycleCd": "text",
  "rglrDeliCycleVal": "text",
  "nxtOrdGenDt": "text",
  "accpDtm": "2026-01-01T00:00:00.000Z",
  "rglrDeliStatCd": "text",
  "rglrDeliStatCdNm": "text",
  "lastRglrDeliSeq": 1,
  "goodsList": [
    {
      "goodsNo": "10001861",
      "deliProcTypCd": "10",
      "deliPolcNo": "10000151",
      "deliNo": "100000021",
      "entrNo": "1000002",
      "ordQty": 1,
      "salePrc": 1000,
      "dcAmt": 3000,
      "sysModDtm": "2026-01-01T00:00:00.000Z",
      "rglrDeliSeq": 1,
      "goodsNm": "테스트상품",
      "itmNo": "001",
      "itmNm": "화이트>95",
      "rglrDeliQty": 1,
      "goodsImgUrl": "text",
      "bpckPsbYn": "Y",
      "skipYn": "Y",
      "brandNo": "Y",
      "brandNm": "Y",
      "goodsCount": 1,
      "chlNo": "1",
      "chlDtlNo": "1",
      "stdCtgNo": "1",
      "infDispCtgNoGbCd": "10",
      "infDispCtgNo": "1",
      "repDispCtgNo": "1",
      "conrNo": "1",
      "marketingDisplayNo": "1"
    }
  ]
}

text

Delete Subscription Order Product (BO)

post

Function Description

Deletes a product registered in a subscription order.

Detailed Description

Deletes the product matching the subscription order number and subscription order sequence number.
Deleting all products is not allowed.

Header parameters

AuthorizationanyOptional

Access Token

Body

rglrDeliNostringRequired

rglrDeliSeqListinteger · int32[]Required

Responses

200

Success

No content

900

Business processing error details

*/*

post/v1/regularOrder/deleteRegularOrderGoods

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

{
  "rglrDeliNo": "text",
  "rglrDeliSeqList": [
    1
  ]
}

No content

Change Subscription Order Cycle (BO)

post

Function Description

Changes the subscription order cycle.

Detailed Description

Changes the application period and application date of the subscription order.
Throws an exception if the change period is shorter than the remaining period.
Updates the next scheduled order date corresponding to the changed application period and application date of the subscription order.

Header parameters

AuthorizationanyOptional

Access Token

Body

rglrDeliNostringRequired

Subscription Order No.

rglrDeliTermCdstringRequired

Subscription Order Period Code

rglrDeliCycleCdstringRequired

Subscription Order Cycle Code (OM034)

rglrDeliCycleValstringRequired

Subscription Order Date

Responses

200

Success

No content

900

Business processing error details

*/*

post/v1/regularOrder/changeDeliTermRegularOrder

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

{
  "rglrDeliNo": "text",
  "rglrDeliTermCd": "text",
  "rglrDeliCycleCd": "text",
  "rglrDeliCycleVal": "text"
}

No content

Change Subscription Order Cycle (FO)

post

Function Description

Changes the subscription order cycle.

Detailed Description

Changes the application period and application date of the subscription order.
Throws an exception if the change period is shorter than the remaining period.
Updates the next scheduled order date corresponding to the changed application period and application date of the subscription order.

Revision History

Release v2.00_240509: Applied monthly subscription order cycle change
Release v2.00_240523: Common next-order-date calculation work

Header parameters

AuthorizationanyOptional

Access Token

Body

rglrDeliNostringRequired

Subscription Order No.

rglrDeliTermCdstringRequired

Subscription Order Period Code

rglrDeliCycleCdstringRequired

Subscription Order Cycle Code (OM034)

rglrDeliCycleValstringRequired

Subscription Order Date

Responses

200

Success

No content

900

Business processing error details

*/*

post/v1/regularOrder/changeDeliTermRegularOrderFO

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

{
  "rglrDeliNo": "text",
  "rglrDeliTermCd": "text",
  "rglrDeliCycleCd": "text",
  "rglrDeliCycleVal": "text"
}

No content

Apply for Subscription Order

post

Function Description

Applies for a subscription order.

Detailed Description

Creates subscription order application data (basic, delivery address, product) from the content entered in the subscription order application form.

Revision History

Release v2.00_240401 : Fixed subscription order application form history error

Header parameters

AuthorizationanyOptional

Access Token

Body

Subscription Order Creation Info

Responses

200

Success

No content

900

Business processing error details

*/*

post/v1/regularOrder/applyForRegularOrder

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

{
  "regularOrderBase": {
    "rglrDeliNo": "1",
    "rglrDeliTermCd": "1",
    "rglrDeliCycleCd": "11",
    "rglrDeliCycleVal": "1,3"
  },
  "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"
              }
            }
          ]
        }
      ]
    }
  ],
  "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"
            }
          ]
        }
      ]
    }
  ],
  "basketRequest": {
    "bsketGbCd": "10",
    "goodsNo": "10212309",
    "itmNo": "001",
    "bsketNoList": [
      1
    ]
  }
}

No content

Issue Subscription Order Number

get

Function Description

Issues a subscription order number.

Detailed Description

Called just before submission completion on the subscription order application form to issue the subscription order number.

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Success

*/*

stringOptional

900

Business processing error details

*/*

get/v1/regularOrderSheet/getRglrDeliNo

GET /api/order/v1/regularOrderSheet/getRglrDeliNo HTTP/1.1
Host: api-order.x2bee.com/
Accept: */*

text

Search Subscription Order Application Completion Info

get

Function Description

API that retrieves the subscription order application information after a successful subscription order application.

Detailed Description

The subscription order number and order media code value are required.
Retrieves the subscription order completion information corresponding to the subscription order number.

Revision History

Release v2.00_240401 : Added retrieval information (subscription order status, subscription order period, subscription order cycle)

Query parameters

rglrDeliNoStringOptional

Subscription Order No.

ordMediaCdStringOptional

Order Channel Code

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Order Completion Retrieved Successfully

application/json

Subscription Order Application Completed

900

Business processing error details

application/json

get/v1/regularOrder/getRegularOrderCompleteInfo

GET /api/order/v1/regularOrder/getRegularOrderCompleteInfo?completeRequest=[object+Object] HTTP/1.1
Host: api-order.x2bee.com/
Accept: */*

{
  "regularOrderDetail": {
    "rglrDeliNo": "1",
    "rglrDeliStatCd": "10",
    "rglrDeliStatCdNm": "10",
    "nxtOrdGenDt": "20231201",
    "rglrDeliTermCd": "1",
    "rglrDeliTermCdNm": "1",
    "rglrDeliCycleCd": "11",
    "rglrDeliCycleCdNm": "11",
    "rglrDeliCycleVal": "1,15",
    "accpDtm": "2026-01-01T00:00:00.000Z",
    "acqrCdNm": "신한카드",
    "cardNo": "1234121*********4",
    "goodsAmount": 10000,
    "deliveryFee": 3000,
    "ordManNm": "홍길동",
    "goodsList": [
      {
        "goodsNo": "10001861",
        "deliProcTypCd": "10",
        "deliPolcNo": "10000151",
        "deliNo": "100000021",
        "entrNo": "1000002",
        "ordQty": 1,
        "salePrc": 1000,
        "dcAmt": 3000,
        "sysModDtm": "2026-01-01T00:00:00.000Z",
        "rglrDeliSeq": 1,
        "goodsNm": "테스트상품",
        "itmNo": "001",
        "itmNm": "화이트>95",
        "rglrDeliQty": 1,
        "goodsImgUrl": "text",
        "bpckPsbYn": "Y",
        "skipYn": "Y",
        "brandNo": "Y",
        "brandNm": "Y",
        "goodsCount": 1,
        "chlNo": "1",
        "chlDtlNo": "1",
        "stdCtgNo": "1",
        "infDispCtgNoGbCd": "10",
        "infDispCtgNo": "1",
        "repDispCtgNo": "1",
        "conrNo": "1",
        "marketingDisplayNo": "1"
      }
    ],
    "deliveryPlace": {
      "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"
            }
          ]
        }
      ]
    }
  },
  "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
          }
        ]
      }
    ]
  },
  "cardInfo": {
    "siteNo": "1",
    "mbrNo": "100000001",
    "aplyStrDtm": "2026-01-01T00:00:00.000Z",
    "aplyEndDtm": "2026-01-01T00:00:00.000Z",
    "pgGbCd": "10",
    "pgGbCdNm": "이니시스(INICIS)",
    "acqrCd": "102",
    "acqrCdNm": "삼성카드",
    "cardNo": "123456*********7",
    "bllgKeyNo": "371837374a8dcc1f8a04c15c802dfc40954cf5e7",
    "bllgKeyRegDtm": "2026-01-01T00:00:00.000Z",
    "delYn": "N"
  }
}

Search Next Order Application Date After Skip

get

Function Description

Retrieves the next order application date after a skip.

Detailed Description

Retrieves the next order application date after a skip.

Query parameters

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Success

*/*

stringOptional

900

Business processing error details

*/*

get/v1/regularOrder/getAfterSkipNxtOrdGenDt

GET /api/order/v1/regularOrder/getAfterSkipNxtOrdGenDt?afterSkipNxtOrdGenDtRequest=[object+Object] HTTP/1.1
Host: api-order.x2bee.com/
Accept: */*

text

PreviousOrder API

NextGift Box

Last updated 22 days ago