데이터 스키마: 카테고리

데이터 스키마: 카테고리. API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

데이터 스키마

조회 — 카테고리 — 응답

ApiResponse_CategoryDetailData_ · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

dataCategoryDetailData 필수: 응답 예제 · CategoryDetailData.

예제: {"created_at":"2026-01-01T12:00:00Z","description":"example","id":"example","introduction":"example","is_available":true,"is_visible":false,"meta_description":"example","meta_keywords":["example"],"meta_title":"example","name":"Example","number":"example","parent_id":null,"slug":"example","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta 필수: 응답 메타데이터입니다.

예제: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

추가 필드: 아니요

목록 조회 — 카테고리 — 응답

ApiResponse_list_CategorySummaryData__ · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

data배열 <CategorySummaryData > 필수: 응답 예제 · ApiResponse_list_CategorySummaryData__.

예제: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_available":true,"is_visible":false,"name":"Example","number":"example","parent_id":null,"slug":"example","updated_at":"2026-01-01T12:00:00Z","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta 필수: 응답 메타데이터입니다.

예제: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

추가 필드: 아니요

생성 — 카테고리 — 요청 본문

CategoryCreate · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

description문자열 null선택 사항: 선택한 언어의 설명입니다.

문자열:maxLength: 50000
introduction문자열 null선택 사항: 선택한 언어의 소개 문구입니다.

문자열:maxLength: 5000
is_visible불리언선택 사항: 리소스가 표시되는지 나타냅니다.

기본값: false
market_ids배열 <문자열> 선택 사항: 선택한 시장의 식별자입니다.

maxItems: 1000
배열:minLength: 1maxLength: 63
meta_description문자열 null선택 사항: 선택한 언어의 검색 엔진 설명입니다.

문자열:maxLength: 160
meta_keywords배열 <문자열> null선택 사항: 선택한 언어의 검색 엔진 키워드입니다.

배열:maxItems: 20
배열 / 배열:maxLength: 50
meta_title문자열 null선택 사항: 선택한 언어의 검색 엔진 제목입니다.

문자열:maxLength: 70
name문자열필수: 해당 컨텍스트의 리소스 이름입니다.

minLength: 1maxLength: 200

예제: "Example"
parent_id문자열 null선택 사항: 상위 카테고리 식별자입니다.

문자열:minLength: 1maxLength: 63
slug문자열 null선택 사항: 선택한 언어의 URL 경로 조각입니다.

문자열:maxLength: 160

추가 필드: 아니요

조회 — 카테고리 — 응답

CategoryDetailData · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

created_at문자열필수: 생성 시각입니다.

format: "date-time"

예제: "2026-01-01T12:00:00Z"
description문자열 null필수: 선택한 언어의 설명입니다.

예제: "example"
id문자열필수: 리소스 식별자이며 반환된 값을 그대로 유지해야 합니다. (CategoryDetailData).

예제: "example"
introduction문자열 null필수: 선택한 언어의 소개 문구입니다.

예제: "example"
is_available불리언필수: 현재 컨텍스트에서 항목을 사용할 수 있는지 나타냅니다.

예제: true
is_visible불리언필수: 리소스가 표시되는지 나타냅니다.

예제: false
meta_description문자열 null필수: 선택한 언어의 검색 엔진 설명입니다.

예제: "example"
meta_keywords배열 <문자열> null필수: 선택한 언어의 검색 엔진 키워드입니다.

예제: ["example"]
meta_title문자열 null필수: 선택한 언어의 검색 엔진 제목입니다.

예제: "example"
name문자열 null필수: 해당 컨텍스트의 리소스 이름입니다.

예제: "Example"
number문자열필수: 사용자에게 표시하는 주문 또는 요청 번호입니다.

예제: "example"
parent_id문자열 null필수: 상위 카테고리 식별자입니다.

예제: null
slug문자열 null필수: 선택한 언어의 URL 경로 조각입니다.

예제: "example"
updated_at문자열필수: 가장 최근 업데이트 시각입니다.

format: "date-time"

예제: "2026-01-01T12:00:00Z"
version정수필수: 동시성 제어에 사용하는 리소스 버전입니다.

예제: 1

추가 필드: 아니요

목록 조회 — 카테고리 — 응답

CategorySummaryData · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

created_at문자열필수: 생성 시각입니다.

format: "date-time"

예제: "2026-01-01T12:00:00Z"
id문자열필수: 리소스 식별자이며 반환된 값을 그대로 유지해야 합니다. (CategorySummaryData).

예제: "example"
is_available불리언필수: 현재 컨텍스트에서 항목을 사용할 수 있는지 나타냅니다.

예제: true
is_visible불리언필수: 리소스가 표시되는지 나타냅니다.

예제: false
name문자열 null필수: 해당 컨텍스트의 리소스 이름입니다.

예제: "Example"
number문자열필수: 사용자에게 표시하는 주문 또는 요청 번호입니다.

예제: "example"
parent_id문자열 null필수: 상위 카테고리 식별자입니다.

예제: null
slug문자열 null필수: 선택한 언어의 URL 경로 조각입니다.

예제: "example"
updated_at문자열필수: 가장 최근 업데이트 시각입니다.

format: "date-time"

예제: "2026-01-01T12:00:00Z"
version정수필수: 동시성 제어에 사용하는 리소스 버전입니다.

예제: 1

추가 필드: 아니요

수정 — 카테고리 — 요청 본문

CategoryUpdate · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

description문자열 null선택 사항: 선택한 언어의 설명입니다.

문자열:maxLength: 50000
expected_version정수필수: 쓰기 전에 읽은 버전이며 일치하지 않으면 업데이트가 거부됩니다.

minimum: 1maximum: 9223372036854775807

예제: 1
introduction문자열 null선택 사항: 선택한 언어의 소개 문구입니다.

문자열:maxLength: 5000
is_visible불리언선택 사항: 리소스가 표시되는지 나타냅니다.
market_ids배열 <문자열> 선택 사항: 선택한 시장의 식별자입니다.

maxItems: 1000
배열:minLength: 1maxLength: 63
meta_description문자열 null선택 사항: 선택한 언어의 검색 엔진 설명입니다.

문자열:maxLength: 160
meta_keywords배열 <문자열> null선택 사항: 선택한 언어의 검색 엔진 키워드입니다.

배열:maxItems: 20
배열 / 배열:maxLength: 50
meta_title문자열 null선택 사항: 선택한 언어의 검색 엔진 제목입니다.

문자열:maxLength: 70
name문자열 null선택 사항: 해당 컨텍스트의 리소스 이름입니다.

문자열:maxLength: 200

예제: "Example"
parent_id문자열 null선택 사항: 상위 카테고리 식별자입니다.

문자열:minLength: 1maxLength: 63
slug문자열 null선택 사항: 선택한 언어의 URL 경로 조각입니다.

문자열:maxLength: 160

추가 필드: 아니요