Datascheman: Kategorier

Datascheman: Kategorier. Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

Datascheman

Hämta — Kategorier — Svar

ApiResponse_CategoryDetailData_ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

dataCategoryDetailData Obligatoriskt: Exempel på svar · CategoryDetailData.

Exempel: {"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 Obligatoriskt: Metadata för svaret.

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

Ytterligare fält: Nej

Lista — Kategorier — Svar

ApiResponse_list_CategorySummaryData__ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

dataArray <CategorySummaryData > Obligatoriskt: Exempel på svar · ApiResponse_list_CategorySummaryData__.

Exempel: [{"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 Obligatoriskt: Metadata för svaret.

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

Ytterligare fält: Nej

Skapa — Kategorier — Begärans innehåll

CategoryCreate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

descriptionSträng nullValfritt: Beskrivning på valt språk.

Sträng:maxLength: 50000
introductionSträng nullValfritt: Inledande text på valt språk.

Sträng:maxLength: 5000
is_visibleBooleskt värdeValfritt: Anger om resursen är synlig.

Standardvärde: false
market_idsArray <Sträng> Valfritt: Identifierare för valda marknader.

maxItems: 1000
Array:minLength: 1maxLength: 63
meta_descriptionSträng nullValfritt: Sökmotorbeskrivning på valt språk.

Sträng:maxLength: 160
meta_keywordsArray <Sträng> nullValfritt: Sökord för sökmotorer på valt språk.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleSträng nullValfritt: Sökmotortitel på valt språk.

Sträng:maxLength: 70
nameSträngObligatoriskt: Resursens namn i aktuell kontext.

minLength: 1maxLength: 200

Exempel: "Example"
parent_idSträng nullValfritt: Identifierare för överordnad kategori.

Sträng:minLength: 1maxLength: 63
slugSträng nullValfritt: URL-segment på valt språk.

Sträng:maxLength: 160

Ytterligare fält: Nej

Hämta — Kategorier — Svar

CategoryDetailData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

created_atSträngObligatoriskt: Tidpunkt för skapande.

format: "date-time"

Exempel: "2026-01-01T12:00:00Z"
descriptionSträng nullObligatoriskt: Beskrivning på valt språk.

Exempel: "example"
idSträngObligatoriskt: Resursens identifierare; bevara den som den returneras. (CategoryDetailData).

Exempel: "example"
introductionSträng nullObligatoriskt: Inledande text på valt språk.

Exempel: "example"
is_availableBooleskt värdeObligatoriskt: Anger om artikeln är tillgänglig i denna kontext.

Exempel: true
is_visibleBooleskt värdeObligatoriskt: Anger om resursen är synlig.

Exempel: false
meta_descriptionSträng nullObligatoriskt: Sökmotorbeskrivning på valt språk.

Exempel: "example"
meta_keywordsArray <Sträng> nullObligatoriskt: Sökord för sökmotorer på valt språk.

Exempel: ["example"]
meta_titleSträng nullObligatoriskt: Sökmotortitel på valt språk.

Exempel: "example"
nameSträng nullObligatoriskt: Resursens namn i aktuell kontext.

Exempel: "Example"
numberSträngObligatoriskt: Beställnings- eller ärendenummer som visas för användaren.

Exempel: "example"
parent_idSträng nullObligatoriskt: Identifierare för överordnad kategori.

Exempel: null
slugSträng nullObligatoriskt: URL-segment på valt språk.

Exempel: "example"
updated_atSträngObligatoriskt: Tidpunkt för senaste uppdatering.

format: "date-time"

Exempel: "2026-01-01T12:00:00Z"
versionHeltalObligatoriskt: Resursversion för samtidighetskontroll.

Exempel: 1

Ytterligare fält: Nej

Lista — Kategorier — Svar

CategorySummaryData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

created_atSträngObligatoriskt: Tidpunkt för skapande.

format: "date-time"

Exempel: "2026-01-01T12:00:00Z"
idSträngObligatoriskt: Resursens identifierare; bevara den som den returneras. (CategorySummaryData).

Exempel: "example"
is_availableBooleskt värdeObligatoriskt: Anger om artikeln är tillgänglig i denna kontext.

Exempel: true
is_visibleBooleskt värdeObligatoriskt: Anger om resursen är synlig.

Exempel: false
nameSträng nullObligatoriskt: Resursens namn i aktuell kontext.

Exempel: "Example"
numberSträngObligatoriskt: Beställnings- eller ärendenummer som visas för användaren.

Exempel: "example"
parent_idSträng nullObligatoriskt: Identifierare för överordnad kategori.

Exempel: null
slugSträng nullObligatoriskt: URL-segment på valt språk.

Exempel: "example"
updated_atSträngObligatoriskt: Tidpunkt för senaste uppdatering.

format: "date-time"

Exempel: "2026-01-01T12:00:00Z"
versionHeltalObligatoriskt: Resursversion för samtidighetskontroll.

Exempel: 1

Ytterligare fält: Nej

Uppdatera — Kategorier — Begärans innehåll

CategoryUpdate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

descriptionSträng nullValfritt: Beskrivning på valt språk.

Sträng:maxLength: 50000
expected_versionHeltalObligatoriskt: Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 9223372036854775807

Exempel: 1
introductionSträng nullValfritt: Inledande text på valt språk.

Sträng:maxLength: 5000
is_visibleBooleskt värdeValfritt: Anger om resursen är synlig.
market_idsArray <Sträng> Valfritt: Identifierare för valda marknader.

maxItems: 1000
Array:minLength: 1maxLength: 63
meta_descriptionSträng nullValfritt: Sökmotorbeskrivning på valt språk.

Sträng:maxLength: 160
meta_keywordsArray <Sträng> nullValfritt: Sökord för sökmotorer på valt språk.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleSträng nullValfritt: Sökmotortitel på valt språk.

Sträng:maxLength: 70
nameSträng nullValfritt: Resursens namn i aktuell kontext.

Sträng:maxLength: 200

Exempel: "Example"
parent_idSträng nullValfritt: Identifierare för överordnad kategori.

Sträng:minLength: 1maxLength: 63
slugSträng nullValfritt: URL-segment på valt språk.

Sträng:maxLength: 160

Ytterligare fält: Nej