Mine sisu juurde
ShopentlyLearn

Andmeskeemid: Kategooriad

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

Andmeskeemid

Hangi — Kategooriad — Vastus

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

Vastuse näide · CategoryDetailData.

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

Vastuse metaandmed.

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

Lisaväljad: Ei

Loend — Kategooriad — Vastus

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

Vastuse näide · ApiResponse_list_CategorySummaryData__.

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

Loo — Kategooriad — Päringu sisu

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

Kirjeldus valitud keeles.

String:maxLength: 50000
introductionString nullValikuline

Sissejuhatav tekst valitud keeles.

String:maxLength: 5000
is_visibleTõeväärtusValikuline

Kas ressurss on nähtav.

Vaikeväärtus: false
market_idsMassiiv <String> Valikuline

Valitud turgude identifikaatorid.

maxItems: 1000
Massiiv:minLength: 1maxLength: 63
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: 50
meta_titleString nullValikuline

Otsingumootori pealkiri valitud keeles.

String:maxLength: 70
nameStringKohustuslik

Ressursi nimi vastavas kontekstis.

minLength: 1maxLength: 200
Näide: "Example"
parent_idString nullValikuline

Vanemkategooria identifikaator.

String:minLength: 1maxLength: 63
slugString nullValikuline

URL-i teesegment valitud keeles.

String:maxLength: 160

Lisaväljad: Ei

Hangi — Kategooriad — Vastus

CategoryDetailData · 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"
descriptionString nullKohustuslik

Kirjeldus valitud keeles.

Näide: "example"
idStringKohustuslik

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

Näide: "example"
introductionString nullKohustuslik

Sissejuhatav tekst valitud keeles.

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

Kas kirje on selles kontekstis saadaval.

Näide: true
is_visibleTõeväärtusKohustuslik

Kas ressurss on nähtav.

Näide: false
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"
nameString nullKohustuslik

Ressursi nimi vastavas kontekstis.

Näide: "Example"
numberStringKohustuslik

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

Näide: "example"
parent_idString nullKohustuslik

Vanemkategooria identifikaator.

Näide: null
slugString nullKohustuslik

URL-i teesegment 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 — Kategooriad — Vastus

CategorySummaryData · 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. (CategorySummaryData).

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

Kas kirje on selles kontekstis saadaval.

Näide: true
is_visibleTõeväärtusKohustuslik

Kas ressurss on nähtav.

Näide: false
nameString nullKohustuslik

Ressursi nimi vastavas kontekstis.

Näide: "Example"
numberStringKohustuslik

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

Näide: "example"
parent_idString nullKohustuslik

Vanemkategooria identifikaator.

Näide: null
slugString nullKohustuslik

URL-i teesegment 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 — Kategooriad — Päringu sisu

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

Kirjeldus valitud keeles.

String:maxLength: 50000
expected_versionTäisarvKohustuslik

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

minimum: 1maximum: 9223372036854775807
Näide: 1
introductionString nullValikuline

Sissejuhatav tekst valitud keeles.

String:maxLength: 5000
is_visibleTõeväärtusValikuline

Kas ressurss on nähtav.

market_idsMassiiv <String> Valikuline

Valitud turgude identifikaatorid.

maxItems: 1000
Massiiv:minLength: 1maxLength: 63
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: 50
meta_titleString nullValikuline

Otsingumootori pealkiri valitud keeles.

String:maxLength: 70
nameString nullValikuline

Ressursi nimi vastavas kontekstis.

String:maxLength: 200
Näide: "Example"
parent_idString nullValikuline

Vanemkategooria identifikaator.

String:minLength: 1maxLength: 63
slugString nullValikuline

URL-i teesegment valitud keeles.

String:maxLength: 160

Lisaväljad: Ei