Files
Gnuboard7/modules/_bundled/sirsoft-ecommerce/docs/api/product-common-infos.md
T
HeuJung b5c0ec1178 fix(core,ecommerce,board,page,admin_basic,basic): 목록 응답의 하위 컬렉션 전량 직렬화 해소
관리자 상품목록을 한 페이지 여는 것만으로 그 페이지 모든 상품의 옵션이 응답에 실렸다.
같은 패턴을 저장소 전역에서 찾아 14개 목록 엔드포인트를 함께 정리했다.

근본 원인은 둘이다. Resource 가 whenLoaded 로 방어하는데 Repository 가 목록 쿼리에서
관계를 무조건 로드해 가드가 항상 참이 되는 가짜 가드, 그리고 toListArray 경량 표현을
정의해 두고도 컬렉션이 toArray 를 부르는 목록/상세 미분리다. 둘 다 응답만 보면
정상이라 오류도 경고도 없이 페이로드만 불어난다.

목록은 화면이 실제로 그리는 것만 싣는다. 개수·합계는 PHP 컬렉션 연산이 아니라 DB
집계로, 대표 1건이 필요한 곳은 관계 자체를 oldestOfMany 로 좁힌다. eager load 의
limit(1) 은 부모별이 아니라 배치 쿼리 전체에 걸려 첫 행만 값을 갖게 되므로 쓸 수 없다.

뺀 값에는 대체 경로를 먼저 만들었다. 상품 옵션은 행을 펼칠 때 배치로 불러오고(상품 수와
무관하게 쿼리 상수), 종전 동작이 필요한 호출자를 위해 ?with_options=1 등 opt-in 을 남겼다.
배송정책 국가설정과 리뷰 첨부 이미지는 소비처를 실측한 결과 화면이 실제로 그리고 있어
제거하지 않았다 — 그 소비 사실을 회귀 테스트로 고정했다.

재발 방지로 정적 검사 룰 4종과 규정 문서 항목을 함께 넣었다.
2026-08-05 21:20:05 +09:00

21 KiB

Product Common Infos API 레퍼런스

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


TL;DR (5초 요약)

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

GET /api/modules/sirsoft-ecommerce/admin/product-common-infos

  • 라우트명: api.modules.sirsoft-ecommerce.admin.product-common-infos.index
  • 컨트롤러: Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ProductCommonInfoController@index
  • 인증/권한: auth:sanctum + permission:sirsoft-ecommerce.product-common-infos.read

요청 파라미터

이름 위치 타입 필수 허용값 용도
search query string 아니오 max 255 검색어 (지정한 검색 대상 필드에서 부분 일치)
active_only query boolean 아니오 —
default_only query boolean 아니오 —
per_page query string 아니오 — 페이지당 항목 수

요청 예시

GET /api/modules/sirsoft-ecommerce/admin/product-common-infos?search=%EC%98%88%EC%8B%9C%EA%B0%92&active_only=1&default_only=1&per_page=%EC%98%88%EC%8B%9C%EA%B0%92 HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}

응답 필드 (data 내부)

목록 응답: data.data[] 배열 항목의 필드 + data.pagination.

필드 타입 실측 예시값 용도/설명
id integer 1 기본 키 (내부 식별자)
name object {"ko":"일반 배송 안내","en":"Standard Shipping"} 대상의 이름/명칭 (다국어 필드는 로케일별 값 객체)
localized_name string 일반 배송 안내 name 의 현재 로케일 해석 값 (다국어 필드를 표시용 문자열로 해석)
content object {"ko":"• 배송 기간: 결제 완료 후 1~3일 이내 출고 (영업일 기준)\n• 배송 업체: CJ대… 본문 내용
localized_content string • 배송 기간: 결제 완료 후 1~3일 이내 출고 (영업일 기준) … content 의 현재 로케일 해석 값 (다국어 필드를 표시용 문자열로 해석)
content_mode string text 내용 표시 모드 (text 일반 텍스트 / html HTML, 기본값 text)
is_default boolean true default 여부
is_active boolean true active 여부
sort_order integer 0 표시 정렬 순서 값 (작을수록 우선)
icon string info-circle 아이콘 식별자 (아이콘 클래스/이름)
created_at string 2026-07-30 23:35:46 생성 일시
updated_at string 2026-07-30 23:35:46 최종 수정 일시
products_count integer 85 products 개수 (집계)
language_count integer 2 language 개수 (집계)
abilities object {"can_create":true,"can_update":true,"can_delete":true} 현재 사용자가 이 리소스에 수행 가능한 작업 불리언 맵 (can_update, can_delete 등 — 권한 맵 기반)

응답 예시

HTTP/1.1 200
{
    "success": true,
    "message": "공통정보 목록을 불러왔습니다.",
    "data": {
        "data": [
            {
                "id": 1,
                "name": {
                    "ko": "일반 배송 안내",
                    "en": "Standard Shipping"
                },
                "localized_name": "일반 배송 안내",
                "content": {
                    "ko": "• 배송 기간: 결제 완료 후 1~3일 이내 출고 (영업일 기준)\n• 배송 업체: CJ대한통운, 한진택배, 롯데택배\n• 배송 지역: 전국 배송 가능 (일부 도서산간 지역 제외)\n• 배송 조회: 마이페이지 > 주문내역에서 실시간 조회 가능\n• 배송비: 3만원 이상 구매 시 무료, 미만 시 3,000원",
                    "en": "• Delivery Time: Ships within 1-3 business days after payment\n• Carriers: CJ Logistics, Hanjin, Lotte\n• Coverage: Nationwide (some remote areas excluded)\n• Tracking: Available in My Page > Order History\n• Shipping Fee: Free for orders over 30,000 KRW, otherwise 3,000 KRW"
                },
                "localized_content": "• 배송 기간: 결제 완료 후 1~3일 이내 출고 (영업일 기준)\n• 배송 업체: CJ대한통운, 한진택배, 롯데택배\n• 배송 지역: 전국 배송 가능 (일부 도서산간 지역 제외)\n• 배송 조회: 마이페이지 > 주문내역에서 실시간 조회 가능\n• 배송비: 3만원 이상 구매 시 무료, 미만 시 3,000원",
                "content_mode": "text",
                "is_default": true,
                "is_active": true,
                "sort_order": 0,
                "icon": "info-circle",
                "created_at": "2026-07-30 23:35:46",
                "updated_at": "2026-07-30 23:35:46",
                "products_count": 85,
                "language_count": 2,
                "abilities": {
                    "can_create": true,
                    "can_update": true,
                    "can_delete": true
                }
            },
            {
                "id": 2,
                "name": {
                    "ko": "당일 배송 안내",
                    "en": "Same-Day Delivery"
                },
                "localized_name": "당일 배송 안내",
                "content": {
                    "ko": "• 주문 마감: 오전 11시까지 결제 완료 시 당일 출고\n• 배송 지역: 서울, 경기, 인천 일부 지역\n• 배송비: 7만원 이상 무료, 미만 시 4,000원\n• 수령 시간: 오후 6시~9시 사이 도착\n• 주의: 재고 상황에 따라 익일 배송으로 변경될 수 있습니다",
                    "en": "• Order Deadline: Complete payment by 11 AM for same-day shipping\n• Coverage: Parts of Seoul, Gyeonggi, Incheon\n• Fee: Free for orders over 70,000 KRW, otherwise 4,000 KRW\n• Arrival: Between 6 PM - 9 PM\n• Note: May change to next-day delivery based on stock availability"
                },
                "localized_content": "• 주문 마감: 오전 11시까지 결제 완료 시 당일 출고\n• 배송 지역: 서울, 경기, 인천 일부 지역\n• 배송비: 7만원 이상 무료, 미만 시 4,000원\n• 수령 시간: 오후 6시~9시 사이 도착\n• 주의: 재고 상황에 따라 익일 배송으로 변경될 수 있습니다",
                "content_mode": "text",
                "is_default": false,
                "is_active": true,
                "sort_order": 1,
                "icon": "info-circle",
                "created_at": "2026-07-30 23:35:46",
                "updated_at": "2026-07-30 23:35:46",
                "products_count": 0,
                "language_count": 2,
                "abilities": {
                    "can_create": true,
                    "can_update": true,
                    "can_delete": true
                }
            },
            "... (총 25건 중 2건 표시)"
        ],
        "abilities": {
            "can_create": true,
            "can_update": true,
            "can_delete": true
        },
        "pagination": {
            "current_page": 1,
            "last_page": 5,
            "per_page": 25,
            "total": 103,
            "from": 1,
            "to": 25,
            "has_more_pages": true
        }
    }
}

에러 응답

상태코드 의미 발생 조건
401 Unauthenticated 유효한 Bearer 토큰이 없거나 만료된 경우
403 Forbidden 요구 권한(sirsoft-ecommerce.product-common-infos.read)이 없는 경우
422 Unprocessable Entity 요청 파라미터가 검증 규칙을 위반한 경우 (error.errors 에 필드별 메시지)

설명 관리자가 상품 공통정보(배송·교환·반품 안내 등 여러 상품에 재사용되는 안내문) 목록을 조회합니다. auth:sanctum + admin + sirsoft-ecommerce.product-common-infos.read 권한이 필요하며, ProductCommonInfoController@index가 search·active_only·default_only 필터를 조립합니다. per_page가 0 이하이거나 all이면 ProductCommonInfoService::getAllCommonInfos()로 전체를 조회하고, 그 외에는 getPaginatedCommonInfos()로 페이지네이션 조회(data.pagination 포함)합니다. localized_name·localized_content는 현재 로케일로 해석된 값, products_count는 이 공통정보를 사용하는 상품 수입니다.

POST /api/modules/sirsoft-ecommerce/admin/product-common-infos

  • 라우트명: api.modules.sirsoft-ecommerce.admin.product-common-infos.store
  • 컨트롤러: Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ProductCommonInfoController@store
  • 인증/권한: auth:sanctum + permission:sirsoft-ecommerce.product-common-infos.create

요청 파라미터

이름 위치 타입 필수 허용값 용도
name body array 예 — 대상의 이름/명칭
content body array 아니오 — 본문 내용
content_mode body string 아니오 text, html 내용 표시 모드 (text 일반 텍스트 / html HTML, 미지정 시 text)
is_default body boolean 아니오 — 기본값 지정 여부
is_active body boolean 아니오 — 활성 여부 (true 활성 / false 비활성)
sort_order body integer 아니오 min 0 표시 정렬 순서 값 (작을수록 우선)

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

요청 예시

POST /api/modules/sirsoft-ecommerce/admin/product-common-infos HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}
Content-Type: application/json

{
    "name": [
        "예시 이름"
    ],
    "content": [
        "예시 내용입니다."
    ],
    "content_mode": "text",
    "is_default": true,
    "is_active": true,
    "sort_order": 1
}

응답 필드 (data 내부)

응답 예시

에러 응답

상태코드 의미 발생 조건
401 Unauthenticated 유효한 Bearer 토큰이 없거나 만료된 경우
403 Forbidden 요구 권한(sirsoft-ecommerce.product-common-infos.create)이 없는 경우
422 Unprocessable Entity 요청 파라미터가 검증 규칙을 위반한 경우 (error.errors 에 필드별 메시지)

설명 관리자가 새 상품 공통정보를 생성합니다. auth:sanctum + admin + sirsoft-ecommerce.product-common-infos.create 권한이 필요하며, ProductCommonInfoController@store가 ProductCommonInfoService::createCommonInfo()에 검증된 데이터를 전달해 저장합니다. name은 다국어 배열(필수), content는 다국어 안내 내용, content_mode는 text/html 중 하나이며, is_default·is_active·sort_order로 기본 사용 여부·활성 여부·정렬을 지정합니다. 확장이 sirsoft-ecommerce.product-common-info.create_validation_rules 필터로 추가 파라미터를 붙일 수 있고, 성공 시 HTTP 201을, 처리 실패 시 400 에러 응답을 반환합니다.

DELETE /api/modules/sirsoft-ecommerce/admin/product-common-infos/{id}

  • 라우트명: api.modules.sirsoft-ecommerce.admin.product-common-infos.destroy
  • 컨트롤러: Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ProductCommonInfoController@destroy
  • 인증/권한: auth:sanctum + permission:sirsoft-ecommerce.product-common-infos.delete

요청 파라미터

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

요청 예시

DELETE /api/modules/sirsoft-ecommerce/admin/product-common-infos/{id} HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}

응답 필드 (data 내부)

응답 예시

에러 응답

상태코드 의미 발생 조건
401 Unauthenticated 유효한 Bearer 토큰이 없거나 만료된 경우
403 Forbidden 요구 권한(sirsoft-ecommerce.product-common-infos.delete)이 없는 경우
404 Not Found path 파라미터에 해당하는 리소스가 없는 경우

설명 관리자가 상품 공통정보 1건을 삭제합니다. auth:sanctum + admin + sirsoft-ecommerce.product-common-infos.delete 권한이 필요하며, ProductCommonInfoController@destroy가 ProductCommonInfoService::deleteCommonInfo()를 호출해 삭제합니다. path의 id에 해당하는 공통정보가 없거나 삭제 처리 중 오류가 발생하면 각각 404/400 에러 응답을 반환합니다. 여러 상품에서 참조 중인 공통정보를 삭제할 경우 노출에 영향을 줄 수 있으므로 products_count를 먼저 확인하는 것이 좋습니다.

GET /api/modules/sirsoft-ecommerce/admin/product-common-infos/{id}

  • 라우트명: api.modules.sirsoft-ecommerce.admin.product-common-infos.show
  • 컨트롤러: Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ProductCommonInfoController@show
  • 인증/권한: auth:sanctum + permission:sirsoft-ecommerce.product-common-infos.read

요청 파라미터

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

요청 예시

GET /api/modules/sirsoft-ecommerce/admin/product-common-infos/{id} HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}

응답 필드 (data 내부)

응답 예시

에러 응답

상태코드 의미 발생 조건
401 Unauthenticated 유효한 Bearer 토큰이 없거나 만료된 경우
403 Forbidden 요구 권한(sirsoft-ecommerce.product-common-infos.read)이 없는 경우
404 Not Found path 파라미터에 해당하는 리소스가 없는 경우

설명 관리자가 상품 공통정보 1건의 상세를 조회합니다. auth:sanctum + admin + sirsoft-ecommerce.product-common-infos.read 권한이 필요하며, ProductCommonInfoController@show가 ProductCommonInfoService::getCommonInfo()로 단건을 조회합니다. 다국어 원본(name, content)과 현재 로케일 해석값(localized_name, localized_content), content_mode, 기본/활성 여부를 함께 반환하며, 해당 id의 공통정보가 없으면 404를 반환합니다. 주로 수정 화면 진입 시 기존 값을 불러오는 데 사용됩니다.

PUT /api/modules/sirsoft-ecommerce/admin/product-common-infos/{id}

  • 라우트명: api.modules.sirsoft-ecommerce.admin.product-common-infos.update
  • 컨트롤러: Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ProductCommonInfoController@update
  • 인증/권한: auth:sanctum + permission:sirsoft-ecommerce.product-common-infos.update

요청 파라미터

이름 위치 타입 필수 허용값 용도
id path string 예 — 대상 리소스의 식별자
name body array 예 — 대상의 이름/명칭
content body array 아니오 — 본문 내용
content_mode body string 아니오 text, html 내용 표시 모드 (text 일반 텍스트 / html HTML, 미지정 시 text)
is_default body boolean 아니오 — 기본값 지정 여부
is_active body boolean 아니오 — 활성 여부 (true 활성 / false 비활성)
sort_order body integer 아니오 min 0 표시 정렬 순서 값 (작을수록 우선)

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

요청 예시

PUT /api/modules/sirsoft-ecommerce/admin/product-common-infos/{id} HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}
Content-Type: application/json

{
    "name": [
        "예시 이름"
    ],
    "content": [
        "예시 내용입니다."
    ],
    "content_mode": "text",
    "is_default": true,
    "is_active": true,
    "sort_order": 1
}

응답 필드 (data 내부)

응답 예시

에러 응답

상태코드 의미 발생 조건
401 Unauthenticated 유효한 Bearer 토큰이 없거나 만료된 경우
403 Forbidden 요구 권한(sirsoft-ecommerce.product-common-infos.update)이 없는 경우
422 Unprocessable Entity 요청 파라미터가 검증 규칙을 위반한 경우 (error.errors 에 필드별 메시지)
404 Not Found path 파라미터에 해당하는 리소스가 없는 경우

설명 관리자가 상품 공통정보 1건을 수정합니다. auth:sanctum + admin + sirsoft-ecommerce.product-common-infos.update 권한이 필요하며, ProductCommonInfoController@update가 ProductCommonInfoService::updateCommonInfo()에 검증된 데이터를 전달해 갱신합니다. name(다국어 배열)은 필수이고 content·content_mode·is_default·is_active·sort_order를 함께 변경할 수 있습니다. 확장이 sirsoft-ecommerce.product-common-info.update_validation_rules 필터로 파라미터를 추가할 수 있으며, 대상이 없거나 처리 실패 시 각각 404/400 에러 응답을 반환합니다.

PATCH /api/modules/sirsoft-ecommerce/admin/product-common-infos/{id}/toggle-active

  • 라우트명: api.modules.sirsoft-ecommerce.admin.product-common-infos.toggle-active
  • 컨트롤러: Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ProductCommonInfoController@toggleActive
  • 인증/권한: auth:sanctum + permission:sirsoft-ecommerce.product-common-infos.update

요청 파라미터

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

요청 예시

PATCH /api/modules/sirsoft-ecommerce/admin/product-common-infos/{id}/toggle-active HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}

응답 필드 (data 내부)

응답 예시

에러 응답

상태코드 의미 발생 조건
401 Unauthenticated 유효한 Bearer 토큰이 없거나 만료된 경우
403 Forbidden 요구 권한(sirsoft-ecommerce.product-common-infos.update)이 없는 경우
404 Not Found path 파라미터에 해당하는 리소스가 없는 경우

설명 관리자가 상품 공통정보의 활성/비활성 상태를 한 번의 요청으로 토글합니다. auth:sanctum + admin + sirsoft-ecommerce.product-common-infos.update 권한이 필요하며, ProductCommonInfoController@toggleActive가 ProductCommonInfoService::toggleActive()를 호출해 현재 is_active 값을 반전시킵니다. 반전 결과에 따라 활성화/비활성화 메시지를 구분해 응답하므로 목록 화면의 스위치 조작에 적합합니다. 대상이 없거나 처리 실패 시 각각 404/400 에러 응답을 반환합니다.