Gå til innhold
ShopentlyLearn

Dataskjemaer: Kategorier

Dataskjemaer: Kategorier. Felter, typer og begrensninger for data som API-et mottar eller returnerer.

Dataskjemaer

Hent — Kategorier — Svar

ApiResponse_CategoryDetailData_ · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
dataCategoryDetailData Obligatorisk

Eksempel på svar · CategoryDetailData.

Eksempel: {"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 Obligatorisk

Svarmetadata.

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

Ytterligere felt: Nei

Vis liste — Kategorier — Svar

ApiResponse_list_CategorySummaryData__ · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
dataArray <CategorySummaryData > Obligatorisk

Eksempel på svar · ApiResponse_list_CategorySummaryData__.

Eksempel: [{"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 Obligatorisk

Svarmetadata.

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

Ytterligere felt: Nei

Opprett — Kategorier — Forespørselsinnhold

CategoryCreate · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
descriptionStreng nullValgfritt

Beskrivelse på valgt språk.

Streng:maxLength: 50000
introductionStreng nullValgfritt

Innledningstekst på valgt språk.

Streng:maxLength: 5000
is_visibleBoolsk verdiValgfritt

Om ressursen er synlig.

Standard: false
market_idsArray <Streng> Valgfritt

Identifikatorer for valgte markeder.

maxItems: 1000
Array:minLength: 1maxLength: 63
meta_descriptionStreng nullValgfritt

Søkemotorbeskrivelse på valgt språk.

Streng:maxLength: 160
meta_keywordsArray <Streng> nullValgfritt

Søkemotornøkkelord på valgt språk.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleStreng nullValgfritt

Søkemotortittel på valgt språk.

Streng:maxLength: 70
nameStrengObligatorisk

Ressursens navn i den relevante konteksten.

minLength: 1maxLength: 200
Eksempel: "Example"
parent_idStreng nullValgfritt

Identifikator for overordnet kategori.

Streng:minLength: 1maxLength: 63
slugStreng nullValgfritt

URL-stisegment på valgt språk.

Streng:maxLength: 160

Ytterligere felt: Nei

Hent — Kategorier — Svar

CategoryDetailData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
created_atStrengObligatorisk

Opprettelsestidspunkt.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
descriptionStreng nullObligatorisk

Beskrivelse på valgt språk.

Eksempel: "example"
idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres. (CategoryDetailData).

Eksempel: "example"
introductionStreng nullObligatorisk

Innledningstekst på valgt språk.

Eksempel: "example"
is_availableBoolsk verdiObligatorisk

Om varen er tilgjengelig i denne konteksten.

Eksempel: true
is_visibleBoolsk verdiObligatorisk

Om ressursen er synlig.

Eksempel: false
meta_descriptionStreng nullObligatorisk

Søkemotorbeskrivelse på valgt språk.

Eksempel: "example"
meta_keywordsArray <Streng> nullObligatorisk

Søkemotornøkkelord på valgt språk.

Eksempel: ["example"]
meta_titleStreng nullObligatorisk

Søkemotortittel på valgt språk.

Eksempel: "example"
nameStreng nullObligatorisk

Ressursens navn i den relevante konteksten.

Eksempel: "Example"
numberStrengObligatorisk

Ordre- eller saksnummer beregnet på mennesker.

Eksempel: "example"
parent_idStreng nullObligatorisk

Identifikator for overordnet kategori.

Eksempel: null
slugStreng nullObligatorisk

URL-stisegment på valgt språk.

Eksempel: "example"
updated_atStrengObligatorisk

Tidspunkt for siste oppdatering.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

Ytterligere felt: Nei

Vis liste — Kategorier — Svar

CategorySummaryData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
created_atStrengObligatorisk

Opprettelsestidspunkt.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres. (CategorySummaryData).

Eksempel: "example"
is_availableBoolsk verdiObligatorisk

Om varen er tilgjengelig i denne konteksten.

Eksempel: true
is_visibleBoolsk verdiObligatorisk

Om ressursen er synlig.

Eksempel: false
nameStreng nullObligatorisk

Ressursens navn i den relevante konteksten.

Eksempel: "Example"
numberStrengObligatorisk

Ordre- eller saksnummer beregnet på mennesker.

Eksempel: "example"
parent_idStreng nullObligatorisk

Identifikator for overordnet kategori.

Eksempel: null
slugStreng nullObligatorisk

URL-stisegment på valgt språk.

Eksempel: "example"
updated_atStrengObligatorisk

Tidspunkt for siste oppdatering.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

Ytterligere felt: Nei

Oppdater — Kategorier — Forespørselsinnhold

CategoryUpdate · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
descriptionStreng nullValgfritt

Beskrivelse på valgt språk.

Streng:maxLength: 50000
expected_versionHeltallObligatorisk

Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 1maximum: 9223372036854775807
Eksempel: 1
introductionStreng nullValgfritt

Innledningstekst på valgt språk.

Streng:maxLength: 5000
is_visibleBoolsk verdiValgfritt

Om ressursen er synlig.

market_idsArray <Streng> Valgfritt

Identifikatorer for valgte markeder.

maxItems: 1000
Array:minLength: 1maxLength: 63
meta_descriptionStreng nullValgfritt

Søkemotorbeskrivelse på valgt språk.

Streng:maxLength: 160
meta_keywordsArray <Streng> nullValgfritt

Søkemotornøkkelord på valgt språk.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleStreng nullValgfritt

Søkemotortittel på valgt språk.

Streng:maxLength: 70
nameStreng nullValgfritt

Ressursens navn i den relevante konteksten.

Streng:maxLength: 200
Eksempel: "Example"
parent_idStreng nullValgfritt

Identifikator for overordnet kategori.

Streng:minLength: 1maxLength: 63
slugStreng nullValgfritt

URL-stisegment på valgt språk.

Streng:maxLength: 160

Ytterligere felt: Nei