Gå til indhold
ShopentlyLearn

Dataskemaer: Kategorier

Dataskemaer: Kategorier. Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

Dataskemaer

Hent — Kategorier — Svar

ApiResponse_CategoryDetailData_ · Felter, typer og begrænsninger for data, som API'et modtager 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"}

Yderligere felter: Nej

Vis liste — Kategorier — Svar

ApiResponse_list_CategorySummaryData__ · Felter, typer og begrænsninger for data, som API'et modtager 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"}

Yderligere felter: Nej

Opret — Kategorier — Forespørgselsindhold

CategoryCreate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
descriptionStreng nullValgfrit

Beskrivelse på det valgte sprog.

Streng:maxLength: 50000
introductionStreng nullValgfrit

Indledningstekst på det valgte sprog.

Streng:maxLength: 5000
is_visibleBoolesk værdiValgfrit

Om ressourcen er synlig.

Standard: false
market_idsArray <Streng> Valgfrit

Identifikatorer for valgte markeder.

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

Beskrivelse til søgemaskiner på det valgte sprog.

Streng:maxLength: 160
meta_keywordsArray <Streng> nullValgfrit

Nøgleord til søgemaskiner på det valgte sprog.

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

Titel til søgemaskiner på det valgte sprog.

Streng:maxLength: 70
nameStrengObligatorisk

Ressourcens navn i den relevante kontekst.

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

Identifikator for overordnet kategori.

Streng:minLength: 1maxLength: 63
slugStreng nullValgfrit

URL-stisegment på det valgte sprog.

Streng:maxLength: 160

Yderligere felter: Nej

Hent — Kategorier — Svar

CategoryDetailData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
created_atStrengObligatorisk

Oprettelsestidspunkt.

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

Beskrivelse på det valgte sprog.

Eksempel: "example"
idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. (CategoryDetailData).

Eksempel: "example"
introductionStreng nullObligatorisk

Indledningstekst på det valgte sprog.

Eksempel: "example"
is_availableBoolesk værdiObligatorisk

Om varen er tilgængelig i denne kontekst.

Eksempel: true
is_visibleBoolesk værdiObligatorisk

Om ressourcen er synlig.

Eksempel: false
meta_descriptionStreng nullObligatorisk

Beskrivelse til søgemaskiner på det valgte sprog.

Eksempel: "example"
meta_keywordsArray <Streng> nullObligatorisk

Nøgleord til søgemaskiner på det valgte sprog.

Eksempel: ["example"]
meta_titleStreng nullObligatorisk

Titel til søgemaskiner på det valgte sprog.

Eksempel: "example"
nameStreng nullObligatorisk

Ressourcens navn i den relevante kontekst.

Eksempel: "Example"
numberStrengObligatorisk

Ordre- eller sagsnummer beregnet til mennesker.

Eksempel: "example"
parent_idStreng nullObligatorisk

Identifikator for overordnet kategori.

Eksempel: null
slugStreng nullObligatorisk

URL-stisegment på det valgte sprog.

Eksempel: "example"
updated_atStrengObligatorisk

Tidspunkt for seneste opdatering.

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

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

Yderligere felter: Nej

Vis liste — Kategorier — Svar

CategorySummaryData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
created_atStrengObligatorisk

Oprettelsestidspunkt.

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

Ressourceidentifikator; bevar den som returneret. (CategorySummaryData).

Eksempel: "example"
is_availableBoolesk værdiObligatorisk

Om varen er tilgængelig i denne kontekst.

Eksempel: true
is_visibleBoolesk værdiObligatorisk

Om ressourcen er synlig.

Eksempel: false
nameStreng nullObligatorisk

Ressourcens navn i den relevante kontekst.

Eksempel: "Example"
numberStrengObligatorisk

Ordre- eller sagsnummer beregnet til mennesker.

Eksempel: "example"
parent_idStreng nullObligatorisk

Identifikator for overordnet kategori.

Eksempel: null
slugStreng nullObligatorisk

URL-stisegment på det valgte sprog.

Eksempel: "example"
updated_atStrengObligatorisk

Tidspunkt for seneste opdatering.

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

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

Yderligere felter: Nej

Opdater — Kategorier — Forespørgselsindhold

CategoryUpdate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
descriptionStreng nullValgfrit

Beskrivelse på det valgte sprog.

Streng:maxLength: 50000
expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 1maximum: 9223372036854775807
Eksempel: 1
introductionStreng nullValgfrit

Indledningstekst på det valgte sprog.

Streng:maxLength: 5000
is_visibleBoolesk værdiValgfrit

Om ressourcen er synlig.

market_idsArray <Streng> Valgfrit

Identifikatorer for valgte markeder.

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

Beskrivelse til søgemaskiner på det valgte sprog.

Streng:maxLength: 160
meta_keywordsArray <Streng> nullValgfrit

Nøgleord til søgemaskiner på det valgte sprog.

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

Titel til søgemaskiner på det valgte sprog.

Streng:maxLength: 70
nameStreng nullValgfrit

Ressourcens navn i den relevante kontekst.

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

Identifikator for overordnet kategori.

Streng:minLength: 1maxLength: 63
slugStreng nullValgfrit

URL-stisegment på det valgte sprog.

Streng:maxLength: 160

Yderligere felter: Nej