콘텐츠로 건너뛰기
ShopentlyLearn

데이터 스키마: CMS 페이지

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

데이터 스키마

응답 메타데이터입니다

AnalyticsPageMeta · 스키마 · 데이터 스키마: CMS 페이지
paginationPagination 필수

커서 기반 페이지 나누기 메타데이터입니다.

예제: {"has_more":false,"limit":20,"next_cursor":null}
periodAnalyticsPeriodData 필수

보고 기간과 시작·종료 경계입니다.

예제: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_id문자열필수

고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.

minLength: 1maxLength: 100
예제: "example"

추가 필드: 아니요

목록 조회 — CMS 페이지 — 응답

ApiResponse_list_PageSummaryData__ · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.
data배열 <PageSummaryData > 필수

응답 예제 · ApiResponse_list_PageSummaryData__.

예제: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_available":true,"market_scope":"all","number":"example","published":false,"slug":"example","title":"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"}

추가 필드: 아니요

조회 — CMS 페이지 — 응답

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

응답 예제 · PageDetailData.

예제: {"body_html":"<p>Example</p>","created_at":"2026-01-01T12:00:00Z","id":"example","is_available":true,"market_scope":"all","meta_description":"example","meta_keywords":["example"],"meta_title":"example","number":"example","published":false,"slug":"example","title":"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"}

추가 필드: 아니요

생성 — CMS 페이지 — 요청 본문

PageCreate · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.
body_html문자열 null선택 사항

페이지의 HTML 본문입니다.

문자열:maxLength: 100000
market_ids배열 <문자열> 선택 사항

선택한 시장의 식별자입니다.

maxItems: 1000
배열:minLength: 1maxLength: 63
market_scope문자열선택 사항

전체 시장에 적용되는지 특정 시장에만 적용되는지 나타냅니다.

제약 조건
enum
["all", "selected"]
meta_description문자열 null선택 사항

선택한 언어의 검색 엔진 설명입니다.

문자열:maxLength: 160
meta_keywords배열 <문자열> null선택 사항

선택한 언어의 검색 엔진 키워드입니다.

배열:maxItems: 20
배열 / 배열:maxLength: 60
meta_title문자열 null선택 사항

선택한 언어의 검색 엔진 제목입니다.

문자열:maxLength: 70
published불리언선택 사항

리소스가 공개되어 있는지 나타냅니다.

기본값: false
slug문자열 null선택 사항

선택한 언어의 URL 경로 조각입니다.

문자열:maxLength: 160
title문자열필수

선택한 언어의 제목입니다.

minLength: 1maxLength: 300
예제: "Example"

추가 필드: 아니요

조회 — CMS 페이지 — 응답

PageDetailData · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.
body_html문자열 null필수

페이지의 HTML 본문입니다.

예제: "<p>Example</p>"
created_at문자열필수

생성 시각입니다.

format: "date-time"
예제: "2026-01-01T12:00:00Z"
id문자열필수

리소스 식별자이며 반환된 값을 그대로 유지해야 합니다. (PageDetailData).

예제: "example"
is_available불리언필수

현재 컨텍스트에서 항목을 사용할 수 있는지 나타냅니다.

예제: true
market_scope문자열필수

전체 시장에 적용되는지 특정 시장에만 적용되는지 나타냅니다.

제약 조건
enum
["all", "selected"]
예제: "all"
meta_description문자열 null필수

선택한 언어의 검색 엔진 설명입니다.

예제: "example"
meta_keywords배열 <문자열> null필수

선택한 언어의 검색 엔진 키워드입니다.

예제: ["example"]
meta_title문자열 null필수

선택한 언어의 검색 엔진 제목입니다.

예제: "example"
number문자열필수

사용자에게 표시하는 주문 또는 요청 번호입니다.

예제: "example"
published불리언필수

리소스가 공개되어 있는지 나타냅니다.

예제: false
slug문자열 null필수

선택한 언어의 URL 경로 조각입니다.

예제: "example"
title문자열 null필수

선택한 언어의 제목입니다.

예제: "example"
updated_at문자열필수

가장 최근 업데이트 시각입니다.

format: "date-time"
예제: "2026-01-01T12:00:00Z"
version정수필수

동시성 제어에 사용하는 리소스 버전입니다.

예제: 1

추가 필드: 아니요

목록 조회 — CMS 페이지 — 응답

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

생성 시각입니다.

format: "date-time"
예제: "2026-01-01T12:00:00Z"
id문자열필수

리소스 식별자이며 반환된 값을 그대로 유지해야 합니다. (PageSummaryData).

예제: "example"
is_available불리언필수

현재 컨텍스트에서 항목을 사용할 수 있는지 나타냅니다.

예제: true
market_scope문자열필수

전체 시장에 적용되는지 특정 시장에만 적용되는지 나타냅니다.

제약 조건
enum
["all", "selected"]
예제: "all"
number문자열필수

사용자에게 표시하는 주문 또는 요청 번호입니다.

예제: "example"
published불리언필수

리소스가 공개되어 있는지 나타냅니다.

예제: false
slug문자열 null필수

선택한 언어의 URL 경로 조각입니다.

예제: "example"
title문자열 null필수

선택한 언어의 제목입니다.

예제: "example"
updated_at문자열필수

가장 최근 업데이트 시각입니다.

format: "date-time"
예제: "2026-01-01T12:00:00Z"
version정수필수

동시성 제어에 사용하는 리소스 버전입니다.

예제: 1

추가 필드: 아니요

수정 — CMS 페이지 — 요청 본문

PageUpdate · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.
body_html문자열 null선택 사항

페이지의 HTML 본문입니다.

문자열:maxLength: 100000
expected_version정수필수

쓰기 전에 읽은 버전이며 일치하지 않으면 업데이트가 거부됩니다.

minimum: 1maximum: 2147483647
예제: 1
market_ids배열 <문자열> 선택 사항

선택한 시장의 식별자입니다.

maxItems: 1000
배열:minLength: 1maxLength: 63
market_scope문자열선택 사항

전체 시장에 적용되는지 특정 시장에만 적용되는지 나타냅니다.

제약 조건
enum
["all", "selected"]
meta_description문자열 null선택 사항

선택한 언어의 검색 엔진 설명입니다.

문자열:maxLength: 160
meta_keywords배열 <문자열> null선택 사항

선택한 언어의 검색 엔진 키워드입니다.

배열:maxItems: 20
배열 / 배열:maxLength: 60
meta_title문자열 null선택 사항

선택한 언어의 검색 엔진 제목입니다.

문자열:maxLength: 70
published불리언선택 사항

리소스가 공개되어 있는지 나타냅니다.

slug문자열 null선택 사항

선택한 언어의 URL 경로 조각입니다.

문자열:maxLength: 160
title문자열 null선택 사항

선택한 언어의 제목입니다.

문자열:maxLength: 300
예제: "Example"

추가 필드: 아니요