gper/Gnuboard7
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
Gnuboard7/modules/_bundled/sirsoft-ecommerce/docs/api/cart.md
T
HeuJung 9cf9c3ff8c fix(core,board,ecommerce,payments,basic): KVE-2026 보안 게이트 6묶음 + 자격증명 전송로 정합 
KISA 제보 취약점(KVE-2026-1914/1919/2019/2029/2041/2042/2043/2044)과
그 수정 과정에서 드러난 자격증명 전송로 결함을 함께 해소한다.

globalHeaders 는 데이터소스와 apiCall 핸들러에만 적용되는데, 코어 ApiClient 를
직접 부르는 경로들이 그 사실을 모른 채 게이트된 엔드포인트를 호출하고 있었다.
서버는 정당한 사용자를 거부하고 화면은 이미 버튼을 내준 뒤라, 예외도 로그도 없이
그 자리만 비는 형태로만 드러났다. 전송로 10축을 전수 열거해 6건을 고치고,
같은 실수가 반복되지 않도록 규정과 coverage 에 등재했다.

아웃바운드 프록시가 사이트 자기 자신으로 가는 내부 요청까지 가로채 저장이 수십 초씩
걸리던 문제도 함께 고쳤다. 실패가 폴백으로 삼켜져 화면에는 지연으로만 나타났다.
2026-09-06 00:42:29 +09:00

44 KiB
Raw Permalink Blame History

Cart API 레퍼런스

소유: module sirsoft-ecommerce · 생성: php artisan api:docgen (실측 기반). @generated 블록은 재생성 시 갱신되며, 사람이 작성한 설명은 보존됩니다.

TL;DR (5초 요약)

1. 이 문서는 실제 API 호출로 실측한 Cart 엔드포인트 레퍼런스입니다
2. 각 엔드포인트: 메서드/URI/권한 + 요청 파라미터 표 + 요청 예시(curl) + 실측 응답 필드 표 + 응답 예시(envelope)
3. 응답 필드의 예시값·응답 예시 JSON 은 실제 호출 응답에서 관측된 값입니다
4. 갱신: 코드 변경 후 php artisan api:docgen 재실행
5. 설명(TODO) 칸은 사람이 채웁니다

DELETE /api/modules/sirsoft-ecommerce/cart

  • 라우트명: api.modules.sirsoft-ecommerce.cart.destroy-multiple
  • 컨트롤러: Modules\Sirsoft\Ecommerce\Http\Controllers\Public\CartController@destroyMultiple
  • 인증/권한: optional.sanctum (선택적 인증: 회원/비회원 모두 접근)

요청 파라미터

이름 위치 타입 필수 허용값 용도
ids query array 예 min 1 대상 리소스 식별자 배열 (대량 작업 대상)

이 엔드포인트는 확장이 파라미터를 추가할 수 있습니다 (sirsoft-ecommerce.cart.delete_items_validation_rules).

요청 예시

DELETE /api/modules/sirsoft-ecommerce/cart?ids=%EC%98%88%EC%8B%9C%EA%B0%92 HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}   (optional.sanctum: 비회원은 헤더 생략 가능)

응답 필드 (data 내부)

단건 응답: data 객체의 필드.

필드 타입 실측 예시값 용도/설명
deleted_count integer 2 실제로 삭제된 장바구니 아이템 건수 (CartService::deleteItems() 반환값. 성공 메시지의 :deleted_count 치환값과 동일)

응답 예시

HTTP/1.1 200

{
    "success": true,
    "message": "2개 상품이 삭제되었습니다.",
    "data": {
        "deleted_count": 2
    }
}

에러 응답

상태코드 의미 발생 조건
422 Unprocessable Entity 요청 파라미터가 검증 규칙을 위반한 경우 (ids 누락/빈 배열, 존재하지 않는 장바구니 ID — error.errors 에 필드별 메시지)
500 Internal Server Error 삭제 처리 중 예외 발생 (messages.cart.delete_failed)

설명 장바구니에서 선택한 여러 아이템(ids)을 한 번에 삭제합니다. optional.sanctum으로 회원은 Auth::id(), 비회원은 cart_key(X-Cart-Key)로 소유를 식별하며, CartController@destroyMultiple이 CartService::deleteItems()를 호출해 삭제된 건수(deleted_count)를 반환합니다. 장바구니 화면에서 체크박스로 선택한 항목들을 "선택 삭제"할 때 사용합니다.

GET /api/modules/sirsoft-ecommerce/cart

  • 라우트명: api.modules.sirsoft-ecommerce.cart.index
  • 컨트롤러: Modules\Sirsoft\Ecommerce\Http\Controllers\Public\CartController@index
  • 인증/권한: optional.sanctum (선택적 인증: 회원/비회원 모두 접근)

요청 파라미터

이름 위치 타입 필수 허용값 용도
selected_ids query array 아니오 — selected 식별자 배열

이 엔드포인트는 확장이 파라미터를 추가할 수 있습니다 (sirsoft-ecommerce.cart.get_validation_rules).

요청 예시

GET /api/modules/sirsoft-ecommerce/cart?selected_ids=%EC%98%88%EC%8B%9C%EA%B0%92 HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}   (optional.sanctum: 비회원은 헤더 생략 가능)

응답 필드 (data 내부)

단건 응답: data 객체의 필드.

필드 타입 실측 예시값 용도/설명
items array [] 장바구니 라인 아이템 목록 (상품·옵션·수량 등 — CartItemResource 파생)
item_ids array [] item 식별자 배열 (연관 리소스 참조)
item_count integer 0 item 개수 (집계)
calculation object {"items":[],"summary":{"subtotal":0,"subtotal_formatted":… 선택 아이템 기준 금액 계산 결과 (상품 소계·할인·배송비 등 — OrderCalculationResult 파생)
has_unshippable_items boolean false unshippable items 여부
selected_shipping_country string KR 배송비 계산에 적용된 배송 국가 코드 (ResolveShippingCountry 해석 결과)

응답 예시

HTTP/1.1 200

{
    "success": true,
    "message": "장바구니 목록을 조회했습니다.",
    "data": {
        "items": [],
        "item_ids": [],
        "item_count": 0,
        "calculation": {
            "items": [],
            "summary": {
                "subtotal": 0,
                "subtotal_formatted": "¥0",
                "product_coupon_discount": 0,
                "product_coupon_discount_formatted": "¥0",
                "code_discount": 0,
                "code_discount_formatted": "¥0",
                "order_coupon_discount": 0,
                "order_coupon_discount_formatted": "¥0",
                "total_coupon_discount": 0,
                "total_coupon_discount_formatted": "¥0",
                "total_discount": 0,
                "discount_formatted": "¥0",
                "base_shipping_total": 0,
                "extra_shipping_total": 0,
                "total_shipping": 0,
                "total_shipping_fee": 0,
                "shipping_fee_formatted": "¥0",
                "shipping_discount": 0,
                "shipping_discount_formatted": "¥0",
                "taxable_amount": 0,
                "tax_free_amount": 0,
                "vat_amount": 0,
                "points_earning": 0,
                "total_mileage": 0,
                "mileage_formatted": "0P",
                "points_used": 0,
                "points_used_formatted": "¥0",
                "payment_amount": 0,
                "payment_amount_formatted": "¥0",
                "final_amount": 0,
                "final_amount_formatted": "¥0",
                "coupon_discount": 0,
                "coupon_discount_formatted": "¥0",
                "order_discount": 0,
                "order_discount_formatted": "¥0"
            },
            "promotions": {
                "coupon_issue_ids": [],
                "item_coupons": [],
                "discount_code": null,
                "product_promotions": {
                    "coupons": [],
                    "discount_codes": [],
                    "events": []
                },
                "order_promotions": {
                    "coupons": [],
                    "discount_codes": [],
                    "events": []
                }
            },
            "validation_errors": []
        },
        "has_unshippable_items": false,
        "selected_shipping_country": "KR"
    }
}

에러 응답

상태코드 의미 발생 조건
422 Unprocessable Entity 요청 파라미터가 검증 규칙을 위반한 경우 (error.errors 에 필드별 메시지)

설명 장바구니 목록과 함께 가격 정보(소계·할인·배송비 등 calculation)를 계산해 반환합니다. optional.sanctum으로 회원은 Auth::id(), 비회원은 cart_key(X-Cart-Key)로 장바구니를 식별하며, CartController@index가 CartService::getCartWithCalculation()을 호출합니다. selected_ids를 전달하면 해당 아이템만 계산에 포함되고(미전달=전체, 빈 배열=계산 생략), 선택된 배송 국가로 배송 불가한 상품이 있으면 has_unshippable_items가 true가 됩니다. 비회원인데 cart_key가 없거나 형식(ck_+32자)이 틀리면 400을 반환합니다.

POST /api/modules/sirsoft-ecommerce/cart

  • 라우트명: api.modules.sirsoft-ecommerce.cart.store
  • 컨트롤러: Modules\Sirsoft\Ecommerce\Http\Controllers\Public\CartController@store
  • 인증/권한: optional.sanctum (선택적 인증: 회원/비회원 모두 접근)

요청 파라미터

이름 위치 타입 필수 허용값 용도
product_id body integer 예 — product 식별자
items body array 예 min 1 처리 대상 항목 배열

이 엔드포인트는 확장이 파라미터를 추가할 수 있습니다 (sirsoft-ecommerce.cart.bulk_add_validation_rules).

요청 예시

POST /api/modules/sirsoft-ecommerce/cart HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}   (optional.sanctum: 비회원은 헤더 생략 가능)
Content-Type: application/json

{
    "product_id": 1,
    "items": [
        "예시값"
    ]
}

응답 필드 (data 내부)

단건 응답: data 객체의 필드.

필드 타입 실측 예시값 용도/설명
items array [{"id":962,"product_id":201,"quantity":1, …}] 이번 요청으로 담긴 장바구니 아이템 목록 (CartItemResource — 아래 "장바구니 아이템 필드" 참조)
cart_count integer 3 담기 후 장바구니에 들어있는 전체 아이템 수 (CartService::bulkAddToCart() 반환값)

추가옵션 추가금(price_adjustment)은 쇼핑몰 기본 통화 기준 값입니다. 기본 통화가 아닌 통화로 표시할 때는 multi_currency_price_adjustment 의 해당 통화 값을 사용하세요 — 통화코드별로 { price, formatted, is_default, exchange_rate } 를 담으며 formatted 에는 부호(+/-)가 붙습니다. 상품가·옵션가의 multi_currency_* 와 같은 형태입니다.

담기 응답의 아이템은 목록 조회(GET /cart)가 돌려주는 아이템과 동일한 필드·동일한 값을 가집니다. 추가옵션을 선택해 담았다면 additional_options·additional_options_total 이 채워지고 그 금액이 subtotal 에 반영되므로, 담기 직후 목록을 다시 조회하지 않고 이 응답만으로 화면을 갱신해도 됩니다.

장바구니 아이템 필드 (items[] — CartItemResource)

필드 타입 실측 예시값 용도/설명
id integer 962 장바구니 아이템 ID (수량/옵션 변경·삭제 시 path 파라미터)
product_id integer 201 담긴 상품 ID
product_option_id integer 1086 선택된 상품 옵션 ID
quantity integer 1 구매 수량
additional_options array [] 선택된 추가옵션 해석 결과 (항목별 additional_option_id, value_id, group_name, name, price_adjustment, price_adjustment_formatted, multi_currency_price_adjustment, custom_text)
additional_options_total integer 0 추가옵션 단위 추가금 합계 (수량 미곱셈, 기본 통화 기준)
created_at string 2026-07-14 10:00:00 담은 일시 (사용자 타임존 포맷)
updated_at string 2026-07-14 10:00:00 최종 수정 일시 (사용자 타임존 포맷)
product object|null {"id":201,"name":"티셔츠", …} 상품 요약 (id, name, product_code, thumbnail_url, sales_status, display_status)
product_option object|null {"id":1086,"selling_price":19000, …} 옵션 요약 (id, option_code, option_name, option_name_localized, option_values, option_values_localized, list_price, list_price_formatted, multi_currency_list_price, selling_price, selling_price_formatted, multi_currency_selling_price, discount_rate, stock_quantity, is_active)
available boolean true 현재 구매 가능 여부 (Product::isPurchasable())
unavailable_reason string|null sold_out 구매 불가 사유 (판매상태 suspended/sold_out/coming_soon 또는 전시상태 hidden. 구매 가능 시 null)
is_shippable_to_selected_country boolean true 선택된 배송 국가로 배송 가능한지 (배송정책 기준)
selected_shipping_country string KR 판정에 사용된 배송 국가 코드
subtotal integer 19000 표시 소계 = (옵션 판매가 + 추가옵션 단위 합계) × 수량 (옵션이 로드된 경우에만 존재)
subtotal_formatted string 19,000원 소계 통화 포맷 문자열
multi_currency_subtotal object {"KRW":19000} 통화별 환산 소계

응답 예시

HTTP/1.1 201

{
    "success": true,
    "message": "장바구니에 상품이 추가되었습니다.",
    "data": {
        "items": [
            {
                "id": 962,
                "product_id": 201,
                "product_option_id": 1086,
                "quantity": 1,
                "additional_options": [],
                "additional_options_total": 0,
                "created_at": "2026-07-14 10:00:00",
                "updated_at": "2026-07-14 10:00:00",
                "product": {
                    "id": 201,
                    "name": "티셔츠",
                    "product_code": "P-201",
                    "thumbnail_url": null,
                    "sales_status": "on_sale",
                    "display_status": "visible"
                },
                "product_option": {
                    "id": 1086,
                    "option_code": "OPT-1086",
                    "option_name": "색상/사이즈",
                    "option_name_localized": "색상/사이즈",
                    "option_values": ["BLACK", "L"],
                    "option_values_localized": ["블랙", "L"],
                    "list_price": 25000,
                    "list_price_formatted": "25,000원",
                    "multi_currency_list_price": {"KRW": 25000},
                    "selling_price": 19000,
                    "selling_price_formatted": "19,000원",
                    "multi_currency_selling_price": {"KRW": 19000},
                    "discount_rate": 24.0,
                    "stock_quantity": 50,
                    "is_active": true
                },
                "available": true,
                "unavailable_reason": null,
                "is_shippable_to_selected_country": true,
                "selected_shipping_country": "KR",
                "subtotal": 19000,
                "subtotal_formatted": "19,000원",
                "multi_currency_subtotal": {"KRW": 19000}
            }
        ],
        "cart_count": 3
    }
}

에러 응답

상태코드 의미 발생 조건
400 Bad Request 비회원인데 X-Cart-Key 헤더가 없거나 형식(ck_+32자 영숫자)이 아닌 경우
403 Forbidden 타인 소유 장바구니 항목 조작 (CartOperationException: access_denied)
404 Not Found 대상 장바구니 항목 없음 (CartOperationException: item_not_found)
422 Unprocessable Entity 요청 파라미터 검증 실패 (error.errors) 또는 재고 부족·판매 중지·구매 대상 제한·구매 수량 한도 위반 (CartUnavailableException — error 에 code: cart_unavailable, unavailable_items, has_stock_issue, has_status_issue, has_restriction_issue, has_min_qty_issue, has_max_qty_issue), 옵션 없음/타상품 옵션 (CartOperationException: option_not_found/invalid_option)
500 Internal Server Error 담기 처리 중 예외 발생 (messages.cart.add_failed)

설명 하나의 상품에 대해 단일 또는 여러 옵션 조합을 items[] 배열로 한 번에 장바구니에 담습니다. optional.sanctum으로 회원/비회원 모두 접근하며, CartController@store가 CartService::bulkAddToCart()를 호출한 뒤 추가된 아이템 목록과 총 담긴 수량(cart_count)을 201로 반환합니다. 재고 부족·판매 중지·구매 대상 제한·구매 수량 한도 위반은 사유별 422(cart_unavailable/purchase_not_allowed), 항목/권한/옵션 문제는 404/403/422로 매핑됩니다. 비회원은 cart_key(X-Cart-Key) 검증을 통과해야 합니다.

DELETE /api/modules/sirsoft-ecommerce/cart/all

  • 라우트명: api.modules.sirsoft-ecommerce.cart.destroy-all
  • 컨트롤러: Modules\Sirsoft\Ecommerce\Http\Controllers\Public\CartController@destroyAll
  • 인증/권한: optional.sanctum (선택적 인증: 회원/비회원 모두 접근)

요청 파라미터

요청 파라미터 없음.

요청 예시

DELETE /api/modules/sirsoft-ecommerce/cart/all HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}   (optional.sanctum: 비회원은 헤더 생략 가능)

응답 필드 (data 내부)

단건 응답: data 객체의 필드.

필드 타입 실측 예시값 용도/설명
deleted_count integer 0 deleted 개수 (집계)

응답 예시

HTTP/1.1 200

{
    "success": true,
    "message": "장바구니가 비워졌습니다. 0개 상품이 삭제되었습니다.",
    "data": {
        "deleted_count": 0
    }
}

에러 응답

상태코드 의미 발생 조건
422 Unprocessable Entity 비회원인데 X-Cart-Key 헤더가 없거나 형식(ck_+32자 영숫자)이 아닌 경우 (CartKeyRequest 검증)
500 Internal Server Error 삭제 처리 중 예외 발생 (messages.cart.delete_failed)

설명 현재 회원/비회원 장바구니의 모든 아이템을 삭제해 장바구니를 비웁니다. optional.sanctum으로 회원은 Auth::id(), 비회원은 cart_key로 대상을 식별하며, CartController@destroyAll이 CartService::deleteAll()을 호출해 삭제된 건수(deleted_count)를 반환합니다. 장바구니 화면의 "전체 비우기" 동작에 사용합니다.

GET /api/modules/sirsoft-ecommerce/cart/count

  • 라우트명: api.modules.sirsoft-ecommerce.cart.count
  • 컨트롤러: Modules\Sirsoft\Ecommerce\Http\Controllers\Public\CartController@count
  • 인증/권한: optional.sanctum (선택적 인증: 회원/비회원 모두 접근)

요청 파라미터

이름 위치 타입 필수 허용값 용도
selected_ids query array 아니오 — selected 식별자 배열

이 엔드포인트는 확장이 파라미터를 추가할 수 있습니다 (sirsoft-ecommerce.cart.get_validation_rules).

요청 예시

GET /api/modules/sirsoft-ecommerce/cart/count?selected_ids=%EC%98%88%EC%8B%9C%EA%B0%92 HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}   (optional.sanctum: 비회원은 헤더 생략 가능)

응답 필드 (data 내부)

단건 응답: data 객체의 필드.

필드 타입 실측 예시값 용도/설명
count integer 0 장바구니에 담긴 아이템 개수 (selected_ids 지정 시 해당 항목만 집계)

응답 예시

HTTP/1.1 200

{
    "success": true,
    "message": "장바구니 수량을 조회했습니다.",
    "data": {
        "count": 0
    }
}

에러 응답

상태코드 의미 발생 조건
422 Unprocessable Entity 요청 파라미터가 검증 규칙을 위반한 경우 (error.errors 에 필드별 메시지)

설명 장바구니에 담긴 아이템 개수(count)만 가볍게 조회합니다. optional.sanctum으로 회원/비회원 모두 접근하며, CartController@count가 CartService::getItemCount()를 호출합니다. 전체 목록·계산 결과가 필요 없는 헤더의 장바구니 배지 카운트 갱신 등에 사용하며, selected_ids로 특정 아이템만 집계할 수도 있습니다.

POST /api/modules/sirsoft-ecommerce/cart/key

  • 라우트명: api.modules.sirsoft-ecommerce.cart.key
  • 컨트롤러: Modules\Sirsoft\Ecommerce\Http\Controllers\Public\CartController@issueCartKey
  • 인증/권한: optional.sanctum (선택적 인증: 회원/비회원 모두 접근)

요청 파라미터

요청 파라미터 없음.

요청 예시

POST /api/modules/sirsoft-ecommerce/cart/key HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}   (optional.sanctum: 비회원은 헤더 생략 가능)

응답 필드 (data 내부)

단건 응답: data 객체의 필드.

필드 타입 실측 예시값 용도/설명
cart_key string ck_F2M15LD5Wu9UQsOwvOVrfp1UeECn3q6f 비회원 장바구니 식별 키 (ck_ + 32자 영숫자. 이후 요청의 X-Cart-Key 헤더에 실어 자신의 장바구니를 식별)

응답 예시

HTTP/1.1 200

{
    "success": true,
    "message": "장바구니 키가 발급되었습니다.",
    "data": {
        "cart_key": "ck_F2M15LD5Wu9UQsOwvOVrfp1UeECn3q6f"
    }
}

에러 응답

상태코드 의미 발생 조건
500 Internal Server Error 키 발급 처리 중 예외 발생 (messages.cart.key_issue_failed — "장바구니 키 발급에 실패했습니다.")

설명 비회원 장바구니를 식별하기 위한 cart_key(ck_+32자 영숫자)를 발급합니다. 인증이 필요 없으며(optional.sanctum), CartController@issueCartKey가 CartService::issueCartKey()로 키를 생성해 반환합니다. 비회원은 이 키를 X-Cart-Key 헤더에 실어 이후 장바구니 담기·조회·수정 요청에서 자신의 장바구니를 식별합니다. 비회원 쇼핑 시작 시점(첫 장바구니 담기 전)에 한 번 호출해 클라이언트에 저장해 둡니다.

POST /api/modules/sirsoft-ecommerce/cart/merge

  • 라우트명: api.modules.sirsoft-ecommerce.cart.merge
  • 컨트롤러: Modules\Sirsoft\Ecommerce\Http\Controllers\Public\CartController@merge
  • 인증/권한: optional.sanctum (선택적 인증: 회원/비회원 모두 접근)

요청 파라미터

요청 파라미터 없음.

요청 예시

POST /api/modules/sirsoft-ecommerce/cart/merge HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}   (optional.sanctum: 비회원은 헤더 생략 가능)

응답 필드 (data 내부)

단건 응답: data 객체의 필드.

필드 타입 실측 예시값 용도/설명
merged_count integer 2 비회원 장바구니에서 회원 계정으로 옮겨진 아이템 건수 (CartService::mergeGuestCartToUser() 반환값)

응답 예시

HTTP/1.1 200

{
    "success": true,
    "message": ":count개 상품이 장바구니로 병합되었습니다.",
    "data": {
        "merged_count": 2
    }
}

messages.cart.merged 는 :count 플레이스홀더를 갖지만 컨트롤러가 messageParams 를 전달하지 않으므로 응답 메시지에는 치환되지 않은 원문이 그대로 실립니다. 화면 표기는 data.merged_count 를 사용하십시오.

에러 응답

상태코드 의미 발생 조건
422 Unprocessable Entity 비로그인 상태로 호출(auth 오류 — "로그인이 필요합니다."), X-Cart-Key 헤더 누락 또는 형식(ck_+32자 영숫자) 불일치 (MergeGuestCartRequest 검증)
500 Internal Server Error 병합 처리 중 예외 발생 (messages.cart.merge_failed)

설명 비회원 상태에서 담아 둔 장바구니를 로그인한 회원 계정으로 병합합니다. 로그인 직후 클라이언트가 보유한 cart_key(X-Cart-Key)를 실어 호출하면, CartController@merge가 CartService::mergeGuestCartToUser()로 해당 cart_key의 비회원 아이템을 회원 장바구니로 옮기고 병합된 건수(merged_count)를 반환합니다. 비회원으로 담던 상품이 로그인 후 사라지지 않도록 인증 성공 시점에 1회 호출합니다.

POST /api/modules/sirsoft-ecommerce/cart/query

  • 라우트명: api.modules.sirsoft-ecommerce.cart.query
  • 컨트롤러: Modules\Sirsoft\Ecommerce\Http\Controllers\Public\CartController@index
  • 인증/권한: optional.sanctum (선택적 인증: 회원/비회원 모두 접근)

요청 파라미터

이름 위치 타입 필수 허용값 용도
selected_ids body array 아니오 — selected 식별자 배열

이 엔드포인트는 확장이 파라미터를 추가할 수 있습니다 (sirsoft-ecommerce.cart.get_validation_rules).

요청 예시

POST /api/modules/sirsoft-ecommerce/cart/query HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}   (optional.sanctum: 비회원은 헤더 생략 가능)
Content-Type: application/json

{
    "selected_ids": [
        "예시값"
    ]
}

응답 필드 (data 내부)

단건 응답: data 객체의 필드.

필드 타입 실측 예시값 용도/설명
items array [] 장바구니 라인 아이템 목록 (상품·옵션·수량 등 — CartItemResource 파생)
item_ids array [] item 식별자 배열 (연관 리소스 참조)
item_count integer 0 item 개수 (집계)
calculation object {"items":[],"summary":{"subtotal":0,"subtotal_formatted":… 선택 아이템 기준 금액 계산 결과 (상품 소계·할인·배송비 등 — OrderCalculationResult 파생)
has_unshippable_items boolean false unshippable items 여부
selected_shipping_country string KR 배송비 계산에 적용된 배송 국가 코드 (ResolveShippingCountry 해석 결과)

응답 예시

HTTP/1.1 200

{
    "success": true,
    "message": "장바구니 목록을 조회했습니다.",
    "data": {
        "items": [],
        "item_ids": [],
        "item_count": 0,
        "calculation": {
            "items": [],
            "summary": {
                "subtotal": 0,
                "subtotal_formatted": "¥0",
                "product_coupon_discount": 0,
                "product_coupon_discount_formatted": "¥0",
                "code_discount": 0,
                "code_discount_formatted": "¥0",
                "order_coupon_discount": 0,
                "order_coupon_discount_formatted": "¥0",
                "total_coupon_discount": 0,
                "total_coupon_discount_formatted": "¥0",
                "total_discount": 0,
                "discount_formatted": "¥0",
                "base_shipping_total": 0,
                "extra_shipping_total": 0,
                "total_shipping": 0,
                "total_shipping_fee": 0,
                "shipping_fee_formatted": "¥0",
                "shipping_discount": 0,
                "shipping_discount_formatted": "¥0",
                "taxable_amount": 0,
                "tax_free_amount": 0,
                "vat_amount": 0,
                "points_earning": 0,
                "total_mileage": 0,
                "mileage_formatted": "0P",
                "points_used": 0,
                "points_used_formatted": "¥0",
                "payment_amount": 0,
                "payment_amount_formatted": "¥0",
                "final_amount": 0,
                "final_amount_formatted": "¥0",
                "coupon_discount": 0,
                "coupon_discount_formatted": "¥0",
                "order_discount": 0,
                "order_discount_formatted": "¥0"
            },
            "promotions": {
                "coupon_issue_ids": [],
                "item_coupons": [],
                "discount_code": null,
                "product_promotions": {
                    "coupons": [],
                    "discount_codes": [],
                    "events": []
                },
                "order_promotions": {
                    "coupons": [],
                    "discount_codes": [],
                    "events": []
                }
            },
            "validation_errors": []
        },
        "has_unshippable_items": false,
        "selected_shipping_country": "KR"
    }
}

에러 응답

상태코드 의미 발생 조건
422 Unprocessable Entity 요청 파라미터가 검증 규칙을 위반한 경우 (error.errors 에 필드별 메시지)

설명 GET /cart와 동일하게 장바구니 목록과 가격 계산 결과를 반환하되, selected_ids를 GET 쿼리 대신 POST 본문으로 전달하는 변형 엔드포인트입니다(같은 CartController@index 처리). 선택 아이템 배열이 커서 URL 길이 제한이 우려되는 경우에 사용합니다. optional.sanctum으로 회원/비회원 모두 접근하며, 응답 구조(items·calculation·has_unshippable_items 등)는 GET 조회와 동일합니다.

DELETE /api/modules/sirsoft-ecommerce/cart/{id}

  • 라우트명: api.modules.sirsoft-ecommerce.cart.destroy
  • 컨트롤러: Modules\Sirsoft\Ecommerce\Http\Controllers\Public\CartController@destroy
  • 인증/권한: optional.sanctum (선택적 인증: 회원/비회원 모두 접근)

요청 파라미터

이름 위치 타입 필수 허용값 용도
id path string 예 — 대상 리소스의 식별자

요청 예시

DELETE /api/modules/sirsoft-ecommerce/cart/{id} HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}   (optional.sanctum: 비회원은 헤더 생략 가능)

응답 필드 (data 내부)

이 엔드포인트는 data 를 반환하지 않습니다 (성공 메시지만 — data 는 null).

응답 예시

HTTP/1.1 200

{
    "success": true,
    "message": "장바구니에서 상품이 삭제되었습니다.",
    "data": null
}

에러 응답

상태코드 의미 발생 조건
403 Forbidden 타인 소유 장바구니 항목 삭제 시도 (CartOperationException: access_denied)
404 Not Found id 에 해당하는 장바구니 항목이 없는 경우 (CartOperationException: item_not_found)
422 Unprocessable Entity 비회원인데 X-Cart-Key 헤더가 없거나 형식(ck_+32자 영숫자)이 아닌 경우 (DeleteCartItemRequest 검증)
500 Internal Server Error 삭제 처리 중 예외 발생 (messages.cart.delete_failed)

설명 장바구니에서 단일 아이템(id)을 삭제합니다. optional.sanctum으로 회원은 Auth::id(), 비회원은 cart_key(X-Cart-Key)로 소유를 식별하며, CartController@destroy가 CartService::deleteItem()을 호출합니다. 존재하지 않는 항목은 404, 타인 소유 항목 삭제 시도는 403(사유별 CartOperationException 매핑)으로 반환합니다. 장바구니 각 행의 개별 삭제 버튼에 사용합니다.

PUT /api/modules/sirsoft-ecommerce/cart/{id}/option

  • 라우트명: api.modules.sirsoft-ecommerce.cart.change-option
  • 컨트롤러: Modules\Sirsoft\Ecommerce\Http\Controllers\Public\CartController@changeOption
  • 인증/권한: optional.sanctum (선택적 인증: 회원/비회원 모두 접근)

요청 파라미터

이름 위치 타입 필수 허용값 용도
id path string 예 — 대상 리소스의 식별자
product_option_id body integer 예 — product option 식별자
quantity body integer 예 min 1, max 99 변경할 구매 수량 (1 ~ 관리자 설정 상한, 기본 99)
additional_option_selections body array 아니오 — 추가 옵션 재선택 목록 (항목별 additional_option_id/value_id, 직접입력 custom_text — 미전달 시 기존 선택 유지)

이 엔드포인트는 확장이 파라미터를 추가할 수 있습니다 (sirsoft-ecommerce.cart.change_option_validation_rules).

요청 예시

PUT /api/modules/sirsoft-ecommerce/cart/{id}/option HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}   (optional.sanctum: 비회원은 헤더 생략 가능)
Content-Type: application/json

{
    "product_option_id": 1,
    "quantity": 1,
    "additional_option_selections": [
        "예시값"
    ]
}

응답 필드 (data 내부)

단건 응답: data 객체의 필드.

필드 타입 실측 예시값 용도/설명
item object {"id":962,"product_option_id":1090, …} 옵션·수량이 반영된 장바구니 아이템 1건 (CartItemResource — 필드 구성은 POST /cart 의 "장바구니 아이템 필드" 표와 동일)

값도 목록 조회와 동일합니다. 재선택한 추가옵션이 additional_options 에 실리고 그 금액이 subtotal 에 반영되므로, 이 응답만으로 해당 행을 갱신해도 금액이 어긋나지 않습니다.

응답 예시

HTTP/1.1 200

{
    "success": true,
    "message": "옵션이 변경되었습니다.",
    "data": {
        "item": {
            "id": 962,
            "product_id": 201,
            "product_option_id": 1090,
            "quantity": 2,
            "additional_options": [],
            "additional_options_total": 0,
            "created_at": "2026-07-14 10:00:00",
            "updated_at": "2026-07-14 10:12:00",
            "product": {
                "id": 201,
                "name": "티셔츠",
                "product_code": "P-201",
                "thumbnail_url": null,
                "sales_status": "on_sale",
                "display_status": "visible"
            },
            "product_option": {
                "id": 1090,
                "option_code": "OPT-1090",
                "option_name": "색상/사이즈",
                "option_name_localized": "색상/사이즈",
                "option_values": ["WHITE", "M"],
                "option_values_localized": ["화이트", "M"],
                "list_price": 25000,
                "list_price_formatted": "25,000원",
                "multi_currency_list_price": {"KRW": 25000},
                "selling_price": 19000,
                "selling_price_formatted": "19,000원",
                "multi_currency_selling_price": {"KRW": 19000},
                "discount_rate": 24.0,
                "stock_quantity": 40,
                "is_active": true
            },
            "available": true,
            "unavailable_reason": null,
            "is_shippable_to_selected_country": true,
            "selected_shipping_country": "KR",
            "subtotal": 38000,
            "subtotal_formatted": "38,000원",
            "multi_currency_subtotal": {"KRW": 38000}
        }
    }
}

에러 응답

상태코드 의미 발생 조건
403 Forbidden 타인 소유 장바구니 항목 조작 (CartOperationException: access_denied)
404 Not Found id 에 해당하는 장바구니 항목이 없는 경우 (CartOperationException: item_not_found)
422 Unprocessable Entity 요청 파라미터 검증 실패(error.errors), 옵션 없음/타상품 옵션 지정 (CartOperationException: option_not_found/invalid_option), 재고 부족·판매 중지·구매 대상 제한·구매 수량 한도 위반 (CartUnavailableException — error.code = cart_unavailable, unavailable_items, has_stock_issue, has_status_issue, has_restriction_issue, has_min_qty_issue, has_max_qty_issue)
500 Internal Server Error 옵션 변경 처리 중 예외 발생 (messages.cart.update_failed)

설명 장바구니 아이템(id)의 선택 옵션과 수량을 변경합니다. optional.sanctum으로 회원/비회원 모두 접근하며, CartController@changeOption이 CartService::changeOption()으로 product_option_id·quantity(및 추가 옵션 선택)를 반영한 뒤 수정된 아이템을 반환합니다. 다른 상품의 옵션으로 바꾸려 하거나 옵션이 없는 경우, 재고/판매상태/구매수량 한도 위반은 사유별 422/404/403으로 매핑됩니다. 장바구니에서 옵션(예: 색상/사이즈)을 바꿀 때 사용합니다.

PATCH /api/modules/sirsoft-ecommerce/cart/{id}/quantity

  • 라우트명: api.modules.sirsoft-ecommerce.cart.update-quantity
  • 컨트롤러: Modules\Sirsoft\Ecommerce\Http\Controllers\Public\CartController@updateQuantity
  • 인증/권한: optional.sanctum (선택적 인증: 회원/비회원 모두 접근)

요청 파라미터

이름 위치 타입 필수 허용값 용도
id path string 예 — 대상 리소스의 식별자
quantity body integer 예 min 1, max 99 변경할 구매 수량 (1 ~ 관리자 설정 상한, 기본 99)

이 엔드포인트는 확장이 파라미터를 추가할 수 있습니다 (sirsoft-ecommerce.cart.update_quantity_validation_rules).

요청 예시

PATCH /api/modules/sirsoft-ecommerce/cart/{id}/quantity HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}   (optional.sanctum: 비회원은 헤더 생략 가능)
Content-Type: application/json

{
    "quantity": 1
}

응답 필드 (data 내부)

단건 응답: data 객체의 필드.

필드 타입 실측 예시값 용도/설명
items array [{"id":962,"quantity":2, …}] 수량 반영 후의 장바구니 전체 아이템 목록 (CartItemResource — 필드 구성은 POST /cart 의 "장바구니 아이템 필드" 표와 동일. 프론트가 refetch 없이 화면을 갱신하도록 전체를 함께 반환)
item_count integer 1 장바구니 아이템 개수
calculation object {"items":[…],"summary":{…},"promotions":{…},"validation_errors":[]} 선택 아이템 기준 금액 계산 결과 (GET /cart 의 calculation 과 동일 구조 — 소계·할인·배송비·적립·최종 결제금액 등)
item_ids array [962] 장바구니 아이템 ID 목록
has_unshippable_items boolean false 선택된 배송 국가로 보낼 수 없는 상품이 1건이라도 있으면 true (주문 전체 차단 플래그)
selected_shipping_country string KR 현재 선택된 배송 국가 코드

이 응답은 GET /cart 와 같은 키 집합입니다. 화면이 이 응답으로 장바구니 데이터를 통째로 교체하므로(refetch 제거), 한쪽에만 있는 키가 생기면 수량을 바꾸는 순간 그 값이 사라집니다 — 특히 has_unshippable_items 가 빠지면 주문 차단이 조용히 풀립니다.

응답 예시

HTTP/1.1 200

{
    "success": true,
    "message": "수량이 변경되었습니다.",
    "data": {
        "items": [
            {
                "id": 962,
                "product_id": 201,
                "product_option_id": 1086,
                "quantity": 2,
                "additional_options": [],
                "additional_options_total": 0,
                "created_at": "2026-07-14 10:00:00",
                "updated_at": "2026-07-14 10:15:00",
                "product": {
                    "id": 201,
                    "name": "티셔츠",
                    "product_code": "P-201",
                    "thumbnail_url": null,
                    "sales_status": "on_sale",
                    "display_status": "visible"
                },
                "product_option": {
                    "id": 1086,
                    "option_code": "OPT-1086",
                    "option_name": "색상/사이즈",
                    "option_name_localized": "색상/사이즈",
                    "option_values": ["BLACK", "L"],
                    "option_values_localized": ["블랙", "L"],
                    "list_price": 25000,
                    "list_price_formatted": "25,000원",
                    "multi_currency_list_price": {"KRW": 25000},
                    "selling_price": 19000,
                    "selling_price_formatted": "19,000원",
                    "multi_currency_selling_price": {"KRW": 19000},
                    "discount_rate": 24.0,
                    "stock_quantity": 50,
                    "is_active": true
                },
                "available": true,
                "unavailable_reason": null,
                "is_shippable_to_selected_country": true,
                "selected_shipping_country": "KR",
                "subtotal": 38000,
                "subtotal_formatted": "38,000원",
                "multi_currency_subtotal": {"KRW": 38000}
            }
        ],
        "item_count": 1,
        "calculation": {
            "items": [],
            "summary": {
                "subtotal": 38000,
                "subtotal_formatted": "38,000원",
                "total_discount": 0,
                "discount_formatted": "0원",
                "total_shipping_fee": 0,
                "shipping_fee_formatted": "0원",
                "payment_amount": 38000,
                "payment_amount_formatted": "38,000원",
                "final_amount": 38000,
                "final_amount_formatted": "38,000원"
            },
            "promotions": {
                "coupon_issue_ids": [],
                "item_coupons": [],
                "discount_code": null,
                "product_promotions": {"coupons": [], "discount_codes": [], "events": []},
                "order_promotions": {"coupons": [], "discount_codes": [], "events": []}
            },
            "validation_errors": []
        }
    }
}

calculation.summary 는 GET /cart 응답과 동일한 전체 키 집합(product_coupon_discount, code_discount, taxable_amount, points_earning 등)을 포함합니다. 위 예시는 대표 키만 발췌한 것입니다.

에러 응답

상태코드 의미 발생 조건
403 Forbidden 타인 소유 장바구니 항목 조작 (CartOperationException: access_denied)
404 Not Found id 에 해당하는 장바구니 항목이 없는 경우 (CartOperationException: item_not_found)
422 Unprocessable Entity 요청 파라미터 검증 실패(quantity 누락/범위 초과 — error.errors) 또는 재고 부족·판매 중지·구매 수량 한도 위반 (CartUnavailableException — error.code = cart_unavailable, unavailable_items, has_stock_issue, has_status_issue, has_restriction_issue, has_min_qty_issue, has_max_qty_issue)
500 Internal Server Error 수량 변경 처리 중 예외 발생 (messages.cart.update_failed)

설명 장바구니 아이템(id)의 수량만 변경합니다. optional.sanctum으로 회원/비회원 모두 접근하며, CartController@updateQuantity가 CartService::updateQuantity()로 수량을 반영한 뒤 프론트가 별도 refetch 없이 화면을 갱신할 수 있도록 index와 동일한 전체 목록·계산 결과(items·calculation)를 함께 반환합니다. 수량 상한은 관리자 환경설정의 장바구니 수량 상한(기본 99)을 따르며, 재고 부족·판매 중지·구매수량 한도 위반은 사유별 422, 항목/권한 문제는 404/403으로 매핑됩니다. 장바구니의 수량 증감(+/-) 컨트롤에 사용합니다.

Reference in new issue View Git Blame Copy Permalink