Mine sisu juurde
ShopentlyLearn

Andmeskeemid: CMS-lehed

Andmeskeemid: CMS-lehed. API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

Andmeskeemid

Vastuse metaandmed

AnalyticsPageMeta · Skeem · Andmeskeemid: CMS-lehed
paginationPagination Kohustuslik

Kursoripõhise lehekülgjaotuse metaandmed.

Näide: {"has_more":false,"limit":20,"next_cursor":null}
periodAnalyticsPeriodData Kohustuslik

Aruandeperiood ja selle piirid.

Näide: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100
Näide: "example"

Lisaväljad: Ei

Loend — CMS-lehed — Vastus

ApiResponse_list_PageSummaryData__ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
dataMassiiv <PageSummaryData > Kohustuslik

Vastuse näide · ApiResponse_list_PageSummaryData__.

Näide: [{"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 Kohustuslik

Vastuse metaandmed.

Näide: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Lisaväljad: Ei

Hangi — CMS-lehed — Vastus

ApiResponse_PageDetailData_ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
dataPageDetailData Kohustuslik

Vastuse näide · PageDetailData.

Näide: {"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 Kohustuslik

Vastuse metaandmed.

Näide: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Lisaväljad: Ei

Loo — CMS-lehed — Päringu sisu

PageCreate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
body_htmlString nullValikuline

Lehe HTML-sisu.

String:maxLength: 100000
market_idsMassiiv <String> Valikuline

Valitud turgude identifikaatorid.

maxItems: 1000
Massiiv:minLength: 1maxLength: 63
market_scopeStringValikuline

Kas ressurss hõlmab kõiki või valitud turge.

Piirangud
enum
["all", "selected"]
meta_descriptionString nullValikuline

Otsingumootori kirjeldus valitud keeles.

String:maxLength: 160
meta_keywordsMassiiv <String> nullValikuline

Otsingumootori märksõnad valitud keeles.

Massiiv:maxItems: 20
Massiiv / Massiiv:maxLength: 60
meta_titleString nullValikuline

Otsingumootori pealkiri valitud keeles.

String:maxLength: 70
publishedTõeväärtusValikuline

Kas ressurss on avaldatud.

Vaikeväärtus: false
slugString nullValikuline

URL-i teesegment valitud keeles.

String:maxLength: 160
titleStringKohustuslik

Pealkiri valitud keeles.

minLength: 1maxLength: 300
Näide: "Example"

Lisaväljad: Ei

Hangi — CMS-lehed — Vastus

PageDetailData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
body_htmlString nullKohustuslik

Lehe HTML-sisu.

Näide: "<p>Example</p>"
created_atStringKohustuslik

Loomise aeg.

format: "date-time"
Näide: "2026-01-01T12:00:00Z"
idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul. (PageDetailData).

Näide: "example"
is_availableTõeväärtusKohustuslik

Kas kirje on selles kontekstis saadaval.

Näide: true
market_scopeStringKohustuslik

Kas ressurss hõlmab kõiki või valitud turge.

Piirangud
enum
["all", "selected"]
Näide: "all"
meta_descriptionString nullKohustuslik

Otsingumootori kirjeldus valitud keeles.

Näide: "example"
meta_keywordsMassiiv <String> nullKohustuslik

Otsingumootori märksõnad valitud keeles.

Näide: ["example"]
meta_titleString nullKohustuslik

Otsingumootori pealkiri valitud keeles.

Näide: "example"
numberStringKohustuslik

Kasutajale mõeldud tellimuse või pöördumise number.

Näide: "example"
publishedTõeväärtusKohustuslik

Kas ressurss on avaldatud.

Näide: false
slugString nullKohustuslik

URL-i teesegment valitud keeles.

Näide: "example"
titleString nullKohustuslik

Pealkiri valitud keeles.

Näide: "example"
updated_atStringKohustuslik

Viimase uuendamise aeg.

format: "date-time"
Näide: "2026-01-01T12:00:00Z"
versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 1

Lisaväljad: Ei

Loend — CMS-lehed — Vastus

PageSummaryData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
created_atStringKohustuslik

Loomise aeg.

format: "date-time"
Näide: "2026-01-01T12:00:00Z"
idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul. (PageSummaryData).

Näide: "example"
is_availableTõeväärtusKohustuslik

Kas kirje on selles kontekstis saadaval.

Näide: true
market_scopeStringKohustuslik

Kas ressurss hõlmab kõiki või valitud turge.

Piirangud
enum
["all", "selected"]
Näide: "all"
numberStringKohustuslik

Kasutajale mõeldud tellimuse või pöördumise number.

Näide: "example"
publishedTõeväärtusKohustuslik

Kas ressurss on avaldatud.

Näide: false
slugString nullKohustuslik

URL-i teesegment valitud keeles.

Näide: "example"
titleString nullKohustuslik

Pealkiri valitud keeles.

Näide: "example"
updated_atStringKohustuslik

Viimase uuendamise aeg.

format: "date-time"
Näide: "2026-01-01T12:00:00Z"
versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 1

Lisaväljad: Ei

Muuda — CMS-lehed — Päringu sisu

PageUpdate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
body_htmlString nullValikuline

Lehe HTML-sisu.

String:maxLength: 100000
expected_versionTäisarvKohustuslik

Enne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.

minimum: 1maximum: 2147483647
Näide: 1
market_idsMassiiv <String> Valikuline

Valitud turgude identifikaatorid.

maxItems: 1000
Massiiv:minLength: 1maxLength: 63
market_scopeStringValikuline

Kas ressurss hõlmab kõiki või valitud turge.

Piirangud
enum
["all", "selected"]
meta_descriptionString nullValikuline

Otsingumootori kirjeldus valitud keeles.

String:maxLength: 160
meta_keywordsMassiiv <String> nullValikuline

Otsingumootori märksõnad valitud keeles.

Massiiv:maxItems: 20
Massiiv / Massiiv:maxLength: 60
meta_titleString nullValikuline

Otsingumootori pealkiri valitud keeles.

String:maxLength: 70
publishedTõeväärtusValikuline

Kas ressurss on avaldatud.

slugString nullValikuline

URL-i teesegment valitud keeles.

String:maxLength: 160
titleString nullValikuline

Pealkiri valitud keeles.

String:maxLength: 300
Näide: "Example"

Lisaväljad: Ei