Cart

Change Cart Item Option

put

Function Description

Changes the option of the selected product.

Detailed Description

Changes the data corresponding to the cart number passed as a parameter
Updates the item number and quantity
If changed to an item already in the cart, deletes the already-existing item and updates by adding the quantities
Validation is performed at call time; the change is not allowed if it fails
Checks product sale status, purchasable quantity, and whether the cart's maximum item count is exceeded

Revision History

Release v2.00_240711: Checks subscription order and gifting usage settings

Header parameters

AuthorizationanyOptional

Access Token

Body

Cart Registration Request DTO

bsketNointeger · int64Required

Cart No.

Example: 100000001

bsketInfGbCdstring · enumRequired

OM042 (Cart Entry Type Code) 10: BASKET_BUY (Cart Purchase) ,20: NOW_BUY (Buy Now) ,30: WISH_BUY (Wishlist Purchase)

Example: 10Possible values:

bsketGbCdstring · enumRequired

OM001(Cart Type Code) 10: HDEL(Parcel Delivery) 20: STORE_PICK_UP(In-Store Pickup) 30: QUICK_DELIVERY(Quick Delivery) 40: REGULAR_DELIVERY(Subscription Order)

Example: 10Possible values:

chlNostringRequired

Channel No.

Example: 1

chlDtlNostringRequired

Channel Detail No.

Example: 1

infDispCtgNoGbCdstring · enumRequired

OM041(Inflow Display Category No. Type Code) 01: DISPLAY_STORE(Display Store) ,02: EXHIBITIONS(Special Exhibition) ,06: SEARCH_SALES(Search Sales) ,07: SEARCH_AD_BANNER(Search Ad Banner) ,08: FLOATING_BANNER(Floating Banner) ,09: WISHLIST(Wishlist) ,10: NONE(No Inflow Display No.)

Example: 10Possible values:

infDispCtgNostringRequired

Referral Display Category No.

Example: 1

repDispCtgNostringRequired

Main Display Category No.

Example: 1

conrNostringOptional

Corner No.

Example: 1

goodsNostringRequired

Product No.

Example: 100000001

itmNostringRequired

Item No.

Example: 001

bsketQtyinteger · int32 · min: 1Optional

Cart Quantity

Example: 1

ordGbCdstring · enumRequired

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

Example: 10Possible values:

Responses

200

Success

*/*

Cart Registration Response DTO

bsketNointeger · int64Optional

Cart No.

Example: 100000001

900

Business processing error details

*/*

put/v1/basket/optionChange

PUT /api/order/v1/basket/optionChange HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 224

{
  "bsketNo": 100000001,
  "bsketInfGbCd": "10",
  "bsketGbCd": "10",
  "chlNo": "1",
  "chlDtlNo": "1",
  "infDispCtgNoGbCd": "10",
  "infDispCtgNo": "1",
  "repDispCtgNo": "1",
  "conrNo": "1",
  "goodsNo": "100000001",
  "itmNo": "001",
  "bsketQty": 1,
  "ordGbCd": "10"
}

{
  "bsketNo": 100000001
}

Delete Cart Item

put

Function Description

Deletes the selected products from the cart.

Detailed Description

Deletes the data corresponding to the cart number passed as a parameter
Updates the order-completed status to 'Y'

Revision History

Release v2.00_240711: Checks subscription order and gifting usage settings

Header parameters

AuthorizationanyOptional

Access Token

Body

Cart Condition DTO

bsketGbCdstring · enumOptional

OM001(Cart Type Code) 10: HDEL(Parcel Delivery) 20: STORE_PICK_UP(In-Store Pickup) 30: QUICK_DELIVERY(Quick Delivery) 40: REGULAR_DELIVERY(Subscription Order)

Example: 10Possible values:

goodsNostringOptional

Product No.

Example: 10212309

itmNostringOptional

Item No.

Example: 001

bsketNoListinteger · int64[]Required

Cart No. List

Responses

200

Success

No content

900

Business processing error details

*/*

put/v1/basket/deleteBasket

PUT /api/order/v1/basket/deleteBasket HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "bsketGbCd": "10",
  "goodsNo": "10212309",
  "itmNo": "001",
  "bsketNoList": [
    1
  ]
}

No content

Check Whether Cart Product Is Orderable

post

Function Description

Checks whether the selected cart product data is orderable, when the user clicks Buy Now in the cart, before proceeding to the order form.

Detailed Description

If validation fails, an error message is displayed in the cart instead of proceeding to the order form.
- Product: product sales status, purchasable quantity, stock, reservation product available date/time, non-member cannot purchase adult products, adult product verification status
- Orderer: purchase-restricted member check, age check

Revision History

Release v2.00_240401 : Removed the auto-payment card check when entering the subscription order application form
Release v2.00_240711: Checks the subscription order and gift settings
Release v2.00_240729: Added validation for ticket products

Header parameters

AuthorizationanyOptional

Access Token

Body

ordGbCdstring · enumRequired

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

Example: 10Possible values:

bsketGbCdstring · enumRequired

OM001(Cart Type Code) 10: HDEL(Parcel Delivery) 20: STORE_PICK_UP(In-Store Pickup) 30: QUICK_DELIVERY(Quick Delivery) 40: REGULAR_DELIVERY(Subscription Order)

Example: 10Possible values:

bsketNoListinteger · int64[]Required

Cart No. List

Responses

200

Success

No content

900

Business processing error details

*/*

post/v1/basket/validateBasket

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

{
  "ordGbCd": "10",
  "bsketGbCd": "10",
  "bsketNoList": [
    1
  ]
}

No content

Add to Cart

post

Function Description

Adds the selected product to the cart.

Detailed Description

For a non-member's first registration, generates a session number and stores it in a cookie.
Called when Buy Now or Add to Cart is performed.
Validation is performed on call, and registration fails if it does not pass.
- Common: product sales status, purchasable quantity
- Buy Now: product stock, reservation product available date/time, non-member cannot purchase adult products, adult product verification status, whether a shipping fee policy exists, orderer purchase-restricted member status/age
- Add to Cart: whether a shipping fee policy exists, checks whether the maximum cart item count is exceeded

Special Notes

When a new product is INSERTed in the Buy Now or Add to Cart case, returns the cart number (BSKET_NO) of the INSERTed row (returns NULL when it is an UPDATE of an existing product quantity)
The maximum quantity that can be added to the cart is Reference Value 1 of common code ST002, code "10".
The retention period of a registered cart is Reference Value 1 of common code ST003, code "10". Once the retention period has passed, it is deleted by batch.

Revision History

Release v2.00_240711: Checks the subscription order and gift settings
Release v2.00_240729: Added validation for ticket products

Header parameters

AuthorizationanyOptional

Access Token

Body

Cart Registration Request DTO

bsketNointeger · int64Required

Cart No.

Example: 100000001

bsketInfGbCdstring · enumRequired

OM042 (Cart Entry Type Code) 10: BASKET_BUY (Cart Purchase) ,20: NOW_BUY (Buy Now) ,30: WISH_BUY (Wishlist Purchase)

Example: 10Possible values:

bsketGbCdstring · enumRequired

OM001(Cart Type Code) 10: HDEL(Parcel Delivery) 20: STORE_PICK_UP(In-Store Pickup) 30: QUICK_DELIVERY(Quick Delivery) 40: REGULAR_DELIVERY(Subscription Order)

Example: 10Possible values:

chlNostringRequired

Channel No.

Example: 1

chlDtlNostringRequired

Channel Detail No.

Example: 1

infDispCtgNoGbCdstring · enumRequired

Example: 10Possible values:

infDispCtgNostringRequired

Referral Display Category No.

Example: 1

repDispCtgNostringRequired

Main Display Category No.

Example: 1

conrNostringOptional

Corner No.

Example: 1

goodsNostringRequired

Product No.

Example: 100000001

itmNostringRequired

Item No.

Example: 001

bsketQtyinteger · int32 · min: 1Optional

Cart Quantity

Example: 1

ordGbCdstring · enumRequired

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

Example: 10Possible values:

Responses

200

Success

*/*

Cart Registration Response DTO

bsketNointeger · int64Optional

Cart No.

Example: 100000001

900

Business processing error details

*/*

post/v1/basket/registerBasket

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

{
  "bsketNo": 100000001,
  "bsketInfGbCd": "10",
  "bsketGbCd": "10",
  "chlNo": "1",
  "chlDtlNo": "1",
  "infDispCtgNoGbCd": "10",
  "infDispCtgNo": "1",
  "repDispCtgNo": "1",
  "conrNo": "1",
  "goodsNo": "100000001",
  "itmNo": "001",
  "bsketQty": 1,
  "ordGbCd": "10"
}

{
  "bsketNo": 100000001
}

Merge Cart

post

Function Description

When logging in, merges the cart products that were added while not logged in into the logged-in member's cart.

Detailed Description

Retrieves the non-member cart products using the session number stored in the cookie
Data whose cart entry type code (OM042) is Buy Now is updated with the logged-in member number
Data whose cart entry type code (OM042) is Add to Cart or Wishlist has the existing data deleted and is newly created with the logged-in member's data

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Success

No content

900

Business processing error details

*/*

post/v1/basket/combineBasket

POST /api/order/v1/basket/combineBasket HTTP/1.1
Host: api-order.x2bee.com/
Accept: */*

No content

Search Total Cart Quantity

get

Function Description

Retrieves the total quantity in the cart for a non-member or the currently logged-in member.

Detailed Description

For members, retrieved by member number
For non-members, retrieved by the session number stored in the cookie

Revision History

Release v2.00_240425: Added site number to the total cart quantity search condition

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Success

*/*

integer · int32Optional

900

Business processing error details

*/*

get/v1/basket/totBsketCnt

GET /api/order/v1/basket/totBsketCnt HTTP/1.1
Host: api-order.x2bee.com/
Accept: */*

Search Most Recently Added Cart Type (OM001)

get

Function Description

Retrieves the most recently added cart type (OM001).

Detailed Description

Does not apply to non-members since their carts are not categorized; for members, retrieved by member number
Cart data where the order completion status is 'N' and the cart entry type code (OM042) is [Add to Cart, Wishlist]

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Success

*/*

stringOptional

900

Business processing error details

*/*

get/v1/basket/getRecentBasketType

GET /api/order/v1/basket/getRecentBasketType HTTP/1.1
Host: api-order.x2bee.com/
Accept: */*

text

Search Cart

get

Function Description

Retrieves the products in the cart.

Detailed Description

For members, retrieved by member number
For non-members, retrieved by the session number stored in the cookie
Cart data where the order completion status is 'N' and the cart entry type code (OM042) is [Add to Cart, Wishlist]
Retrieved grouped by delivery group
Products are sorted with priority given to 1. Center Delivery as the delivery method, 2. Most recently added to cart, and delivery groups are sorted by the group containing the highest-priority product
For products with the same shipping fee policy number, the shipping fee amount (dlexAmt) is not processed, in order to calculate the conditional free shipping fee based on selection status

Revision History

Release v2.00_240425: Added site number to the cart search condition
Release v2.00_241025: Modified so that the shipping fee is not calculated when a conditional free-shipping product meets the condition

Query parameters

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Success

*/*

Search Cart Response DTO

900

Business processing error details

*/*

get/v1/basket/getBasket

GET /api/order/v1/basket/getBasket?request=[object+Object] HTTP/1.1
Host: api-order.x2bee.com/
Accept: */*

{
  "groupList": [
    {
      "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"
          }
        }
      ]
    }
  ],
  "countList": [
    {
      "bsketGbCd": "text",
      "count": 1
    }
  ]
}

PreviousNotice FAQ

NextAuto Payment Card Management

Last updated 1 month ago