Ga naar de inhoud
ShopentlyLearn

Gegevensschema’s: Categorieën

Gegevensschema’s: Categorieën. Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

Gegevensschema’s

Ophalen — Categorieën — Antwoord

ApiResponse_CategoryDetailData_ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
dataCategoryDetailData Verplicht

Voorbeeldantwoord · CategoryDetailData.

Voorbeeld: {"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 Verplicht

Metadata van het antwoord.

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

Aanvullende velden: Nee

Lijst ophalen — Categorieën — Antwoord

ApiResponse_list_CategorySummaryData__ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
dataArray <CategorySummaryData > Verplicht

Voorbeeldantwoord · ApiResponse_list_CategorySummaryData__.

Voorbeeld: [{"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 Verplicht

Metadata van het antwoord.

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

Aanvullende velden: Nee

Aanmaken — Categorieën — Verzoekinhoud

CategoryCreate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
descriptionTekenreeks nullOptioneel

Beschrijving in de geselecteerde taal.

Tekenreeks:maxLength: 50000
introductionTekenreeks nullOptioneel

Inleidende tekst in de geselecteerde taal.

Tekenreeks:maxLength: 5000
is_visibleBooleaanse waardeOptioneel

Of de resource zichtbaar is.

Standaard: false
market_idsArray <Tekenreeks> Optioneel

Identificaties van geselecteerde markten.

maxItems: 1000
Array:minLength: 1maxLength: 63
meta_descriptionTekenreeks nullOptioneel

Zoekmachinebeschrijving in de geselecteerde taal.

Tekenreeks:maxLength: 160
meta_keywordsArray <Tekenreeks> nullOptioneel

Zoekmachinetrefwoorden in de geselecteerde taal.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleTekenreeks nullOptioneel

Zoekmachinetitel in de geselecteerde taal.

Tekenreeks:maxLength: 70
nameTekenreeksVerplicht

Resourcenaam in de betreffende context.

minLength: 1maxLength: 200
Voorbeeld: "Example"
parent_idTekenreeks nullOptioneel

Identificatie van de bovenliggende categorie.

Tekenreeks:minLength: 1maxLength: 63
slugTekenreeks nullOptioneel

URL-padsegment in de geselecteerde taal.

Tekenreeks:maxLength: 160

Aanvullende velden: Nee

Ophalen — Categorieën — Antwoord

CategoryDetailData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
created_atTekenreeksVerplicht

Tijdstip van aanmaak.

format: "date-time"
Voorbeeld: "2026-01-01T12:00:00Z"
descriptionTekenreeks nullVerplicht

Beschrijving in de geselecteerde taal.

Voorbeeld: "example"
idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven. (CategoryDetailData).

Voorbeeld: "example"
introductionTekenreeks nullVerplicht

Inleidende tekst in de geselecteerde taal.

Voorbeeld: "example"
is_availableBooleaanse waardeVerplicht

Of het item beschikbaar is in deze context.

Voorbeeld: true
is_visibleBooleaanse waardeVerplicht

Of de resource zichtbaar is.

Voorbeeld: false
meta_descriptionTekenreeks nullVerplicht

Zoekmachinebeschrijving in de geselecteerde taal.

Voorbeeld: "example"
meta_keywordsArray <Tekenreeks> nullVerplicht

Zoekmachinetrefwoorden in de geselecteerde taal.

Voorbeeld: ["example"]
meta_titleTekenreeks nullVerplicht

Zoekmachinetitel in de geselecteerde taal.

Voorbeeld: "example"
nameTekenreeks nullVerplicht

Resourcenaam in de betreffende context.

Voorbeeld: "Example"
numberTekenreeksVerplicht

Bestel- of aanvraagnummer voor menselijk gebruik.

Voorbeeld: "example"
parent_idTekenreeks nullVerplicht

Identificatie van de bovenliggende categorie.

Voorbeeld: null
slugTekenreeks nullVerplicht

URL-padsegment in de geselecteerde taal.

Voorbeeld: "example"
updated_atTekenreeksVerplicht

Tijdstip van de meest recente wijziging.

format: "date-time"
Voorbeeld: "2026-01-01T12:00:00Z"
versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

Aanvullende velden: Nee

Lijst ophalen — Categorieën — Antwoord

CategorySummaryData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
created_atTekenreeksVerplicht

Tijdstip van aanmaak.

format: "date-time"
Voorbeeld: "2026-01-01T12:00:00Z"
idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven. (CategorySummaryData).

Voorbeeld: "example"
is_availableBooleaanse waardeVerplicht

Of het item beschikbaar is in deze context.

Voorbeeld: true
is_visibleBooleaanse waardeVerplicht

Of de resource zichtbaar is.

Voorbeeld: false
nameTekenreeks nullVerplicht

Resourcenaam in de betreffende context.

Voorbeeld: "Example"
numberTekenreeksVerplicht

Bestel- of aanvraagnummer voor menselijk gebruik.

Voorbeeld: "example"
parent_idTekenreeks nullVerplicht

Identificatie van de bovenliggende categorie.

Voorbeeld: null
slugTekenreeks nullVerplicht

URL-padsegment in de geselecteerde taal.

Voorbeeld: "example"
updated_atTekenreeksVerplicht

Tijdstip van de meest recente wijziging.

format: "date-time"
Voorbeeld: "2026-01-01T12:00:00Z"
versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

Aanvullende velden: Nee

Bijwerken — Categorieën — Verzoekinhoud

CategoryUpdate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
descriptionTekenreeks nullOptioneel

Beschrijving in de geselecteerde taal.

Tekenreeks:maxLength: 50000
expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 1maximum: 9223372036854775807
Voorbeeld: 1
introductionTekenreeks nullOptioneel

Inleidende tekst in de geselecteerde taal.

Tekenreeks:maxLength: 5000
is_visibleBooleaanse waardeOptioneel

Of de resource zichtbaar is.

market_idsArray <Tekenreeks> Optioneel

Identificaties van geselecteerde markten.

maxItems: 1000
Array:minLength: 1maxLength: 63
meta_descriptionTekenreeks nullOptioneel

Zoekmachinebeschrijving in de geselecteerde taal.

Tekenreeks:maxLength: 160
meta_keywordsArray <Tekenreeks> nullOptioneel

Zoekmachinetrefwoorden in de geselecteerde taal.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleTekenreeks nullOptioneel

Zoekmachinetitel in de geselecteerde taal.

Tekenreeks:maxLength: 70
nameTekenreeks nullOptioneel

Resourcenaam in de betreffende context.

Tekenreeks:maxLength: 200
Voorbeeld: "Example"
parent_idTekenreeks nullOptioneel

Identificatie van de bovenliggende categorie.

Tekenreeks:minLength: 1maxLength: 63
slugTekenreeks nullOptioneel

URL-padsegment in de geselecteerde taal.

Tekenreeks:maxLength: 160

Aanvullende velden: Nee