Modele stron CMS

Schematy stron CMS w Shopently API. Poznaj pola listy, szczegółów, tworzenia i edycji stron oraz typy danych treści.

Schematy danych

Metadane odpowiedzi

AnalyticsPageMeta · Schemat · Modele stron CMS

paginationPagination Wymagane: Metadane stronicowania z użyciem kursora.

Przykład: {"has_more":false,"limit":20,"next_cursor":null}
periodAnalyticsPeriodData Wymagane: Okres raportowania i jego granice.

Przykład: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idTekstWymagane: Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100

Przykład: "example"

Dodatkowe pola: Nie

Pobierz listę stron CMS — Odpowiedź

ApiResponse_list_PageSummaryData__ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

dataTablica <PageSummaryData > Wymagane: Przykład odpowiedzi · ApiResponse_list_PageSummaryData__.

Przykład: [{"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 Wymagane: Metadane odpowiedzi.

Przykład: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Dodatkowe pola: Nie

Pobierz stronę CMS — Odpowiedź

ApiResponse_PageDetailData_ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

dataPageDetailData Wymagane: Przykład odpowiedzi · PageDetailData.

Przykład: {"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 Wymagane: Metadane odpowiedzi.

Przykład: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Dodatkowe pola: Nie

Utwórz stronę CMS — Treść żądania

PageCreate · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

body_htmlTekst nullOpcjonalne

Treść strony w HTML.

Tekst:maxLength: 100000

market_idsTablica <Tekst> Opcjonalne

Identyfikatory wybranych rynków.

maxItems: 1000

Tablica:minLength: 1maxLength: 63

market_scopeTekstOpcjonalne

Czy zasób dotyczy wszystkich, czy wybranych rynków.

Ograniczenia

enum: ["all", "selected"]

meta_descriptionTekst nullOpcjonalne

Opis dla wyszukiwarek w wybranym języku.

Tekst:maxLength: 160

meta_keywordsTablica <Tekst> nullOpcjonalne

Słowa kluczowe dla wyszukiwarek w wybranym języku.

Tablica:maxItems: 20

Tablica / Tablica:maxLength: 60

meta_titleTekst nullOpcjonalne

Tytuł dla wyszukiwarek w wybranym języku.

Tekst:maxLength: 70

publishedWartość logicznaOpcjonalne

Czy zasób jest opublikowany.

Wartość domyślna: false

slugTekst nullOpcjonalne

Fragment ścieżki URL w wybranym języku.

Tekst:maxLength: 160

titleTekstWymagane

Tytuł w wybranym języku.

minLength: 1maxLength: 300

Przykład: "Example"

Dodatkowe pola: Nie

Pobierz stronę CMS — Odpowiedź

PageDetailData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

body_htmlTekst nullWymagane

Treść strony w HTML.

Przykład: "<p>Example</p>"

created_atTekstWymagane

Data i czas utworzenia.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"

idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API. (PageDetailData).

Przykład: "example"

is_availableWartość logicznaWymagane

Czy pozycja jest dostępna w tym kontekście.

Przykład: true

market_scopeTekstWymagane

Czy zasób dotyczy wszystkich, czy wybranych rynków.

Ograniczenia

enum: ["all", "selected"]

Przykład: "all"

meta_descriptionTekst nullWymagane

Opis dla wyszukiwarek w wybranym języku.

Przykład: "example"

meta_keywordsTablica <Tekst> nullWymagane

Słowa kluczowe dla wyszukiwarek w wybranym języku.

Przykład: ["example"]

meta_titleTekst nullWymagane

Tytuł dla wyszukiwarek w wybranym języku.

Przykład: "example"

numberTekstWymagane

Numer zamówienia lub zgłoszenia widoczny dla użytkownika.

Przykład: "example"

publishedWartość logicznaWymagane

Czy zasób jest opublikowany.

Przykład: false

slugTekst nullWymagane

Fragment ścieżki URL w wybranym języku.

Przykład: "example"

titleTekst nullWymagane

Tytuł w wybranym języku.

Przykład: "example"

updated_atTekstWymagane

Data i czas ostatniej aktualizacji.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"

versionLiczba całkowitaWymagane

Wersja zasobu używana do kontroli współbieżności.

Przykład: 1

Dodatkowe pola: Nie

Pobierz listę stron CMS — Odpowiedź

PageSummaryData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

created_atTekstWymagane

Data i czas utworzenia.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"

idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API. (PageSummaryData).

Przykład: "example"

is_availableWartość logicznaWymagane

Czy pozycja jest dostępna w tym kontekście.

Przykład: true

market_scopeTekstWymagane

Czy zasób dotyczy wszystkich, czy wybranych rynków.

Ograniczenia

enum: ["all", "selected"]

Przykład: "all"

numberTekstWymagane

Numer zamówienia lub zgłoszenia widoczny dla użytkownika.

Przykład: "example"

publishedWartość logicznaWymagane

Czy zasób jest opublikowany.

Przykład: false

slugTekst nullWymagane

Fragment ścieżki URL w wybranym języku.

Przykład: "example"

titleTekst nullWymagane

Tytuł w wybranym języku.

Przykład: "example"

updated_atTekstWymagane

Data i czas ostatniej aktualizacji.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"

versionLiczba całkowitaWymagane

Wersja zasobu używana do kontroli współbieżności.

Przykład: 1

Dodatkowe pola: Nie

Zmień stronę CMS — Treść żądania

PageUpdate · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

body_htmlTekst nullOpcjonalne

Treść strony w HTML.

Tekst:maxLength: 100000

expected_versionLiczba całkowitaWymagane

Wersja odczytana przed zapisem; niezgodność powoduje odrzucenie zmiany.

minimum: 1maximum: 2147483647

Przykład: 1

market_idsTablica <Tekst> Opcjonalne

Identyfikatory wybranych rynków.

maxItems: 1000

Tablica:minLength: 1maxLength: 63

market_scopeTekstOpcjonalne

Czy zasób dotyczy wszystkich, czy wybranych rynków.

Ograniczenia

enum: ["all", "selected"]

meta_descriptionTekst nullOpcjonalne

Opis dla wyszukiwarek w wybranym języku.

Tekst:maxLength: 160

meta_keywordsTablica <Tekst> nullOpcjonalne

Słowa kluczowe dla wyszukiwarek w wybranym języku.

Tablica:maxItems: 20

Tablica / Tablica:maxLength: 60

meta_titleTekst nullOpcjonalne

Tytuł dla wyszukiwarek w wybranym języku.

Tekst:maxLength: 70

publishedWartość logicznaOpcjonalne

Czy zasób jest opublikowany.

slugTekst nullOpcjonalne

Fragment ścieżki URL w wybranym języku.

Tekst:maxLength: 160

titleTekst nullOpcjonalne

Tytuł w wybranym języku.

Tekst:maxLength: 300

Przykład: "Example"

Dodatkowe pola: Nie