Preskoči na vsebino
ShopentlyLearn

Podatkovne sheme: Kategorije

Podatkovne sheme: Kategorije. Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

Podatkovne sheme

Pridobi — Kategorije — Odgovor

ApiResponse_CategoryDetailData_ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
dataCategoryDetailData Obvezno

Primer odgovora · CategoryDetailData.

Primer: {"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 Obvezno

Metapodatki odgovora.

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

Dodatna polja: Ne

Prikaži seznam — Kategorije — Odgovor

ApiResponse_list_CategorySummaryData__ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
dataPolje elementov <CategorySummaryData > Obvezno

Primer odgovora · ApiResponse_list_CategorySummaryData__.

Primer: [{"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 Obvezno

Metapodatki odgovora.

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

Dodatna polja: Ne

Ustvari — Kategorije — Telo zahteve

CategoryCreate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
descriptionNiz nullIzbirno

Opis v izbranem jeziku.

Niz:maxLength: 50000
introductionNiz nullIzbirno

Uvodno besedilo v izbranem jeziku.

Niz:maxLength: 5000
is_visibleLogična vrednostIzbirno

Ali je vir viden.

Privzeto: false
market_idsPolje elementov <Niz> Izbirno

Identifikatorji izbranih trgov.

maxItems: 1000
Polje elementov:minLength: 1maxLength: 63
meta_descriptionNiz nullIzbirno

Opis za iskalnike v izbranem jeziku.

Niz:maxLength: 160
meta_keywordsPolje elementov <Niz> nullIzbirno

Ključne besede za iskalnike v izbranem jeziku.

Polje elementov:maxItems: 20
Polje elementov / Polje elementov:maxLength: 50
meta_titleNiz nullIzbirno

Naslov za iskalnike v izbranem jeziku.

Niz:maxLength: 70
nameNizObvezno

Ime vira v ustreznem kontekstu.

minLength: 1maxLength: 200
Primer: "Example"
parent_idNiz nullIzbirno

Identifikator nadrejene kategorije.

Niz:minLength: 1maxLength: 63
slugNiz nullIzbirno

Del poti URL v izbranem jeziku.

Niz:maxLength: 160

Dodatna polja: Ne

Pridobi — Kategorije — Odgovor

CategoryDetailData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
created_atNizObvezno

Čas nastanka.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
descriptionNiz nullObvezno

Opis v izbranem jeziku.

Primer: "example"
idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki. (CategoryDetailData).

Primer: "example"
introductionNiz nullObvezno

Uvodno besedilo v izbranem jeziku.

Primer: "example"
is_availableLogična vrednostObvezno

Ali je element na voljo v tem kontekstu.

Primer: true
is_visibleLogična vrednostObvezno

Ali je vir viden.

Primer: false
meta_descriptionNiz nullObvezno

Opis za iskalnike v izbranem jeziku.

Primer: "example"
meta_keywordsPolje elementov <Niz> nullObvezno

Ključne besede za iskalnike v izbranem jeziku.

Primer: ["example"]
meta_titleNiz nullObvezno

Naslov za iskalnike v izbranem jeziku.

Primer: "example"
nameNiz nullObvezno

Ime vira v ustreznem kontekstu.

Primer: "Example"
numberNizObvezno

Uporabniku prikazana številka naročila ali zahtevka.

Primer: "example"
parent_idNiz nullObvezno

Identifikator nadrejene kategorije.

Primer: null
slugNiz nullObvezno

Del poti URL v izbranem jeziku.

Primer: "example"
updated_atNizObvezno

Čas zadnje posodobitve.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

Primer: 1

Dodatna polja: Ne

Prikaži seznam — Kategorije — Odgovor

CategorySummaryData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
created_atNizObvezno

Čas nastanka.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki. (CategorySummaryData).

Primer: "example"
is_availableLogična vrednostObvezno

Ali je element na voljo v tem kontekstu.

Primer: true
is_visibleLogična vrednostObvezno

Ali je vir viden.

Primer: false
nameNiz nullObvezno

Ime vira v ustreznem kontekstu.

Primer: "Example"
numberNizObvezno

Uporabniku prikazana številka naročila ali zahtevka.

Primer: "example"
parent_idNiz nullObvezno

Identifikator nadrejene kategorije.

Primer: null
slugNiz nullObvezno

Del poti URL v izbranem jeziku.

Primer: "example"
updated_atNizObvezno

Čas zadnje posodobitve.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

Primer: 1

Dodatna polja: Ne

Posodobi — Kategorije — Telo zahteve

CategoryUpdate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
descriptionNiz nullIzbirno

Opis v izbranem jeziku.

Niz:maxLength: 50000
expected_versionCelo številoObvezno

Različica, prebrana pred zapisom; neujemanje zavrne posodobitev.

minimum: 1maximum: 9223372036854775807
Primer: 1
introductionNiz nullIzbirno

Uvodno besedilo v izbranem jeziku.

Niz:maxLength: 5000
is_visibleLogična vrednostIzbirno

Ali je vir viden.

market_idsPolje elementov <Niz> Izbirno

Identifikatorji izbranih trgov.

maxItems: 1000
Polje elementov:minLength: 1maxLength: 63
meta_descriptionNiz nullIzbirno

Opis za iskalnike v izbranem jeziku.

Niz:maxLength: 160
meta_keywordsPolje elementov <Niz> nullIzbirno

Ključne besede za iskalnike v izbranem jeziku.

Polje elementov:maxItems: 20
Polje elementov / Polje elementov:maxLength: 50
meta_titleNiz nullIzbirno

Naslov za iskalnike v izbranem jeziku.

Niz:maxLength: 70
nameNiz nullIzbirno

Ime vira v ustreznem kontekstu.

Niz:maxLength: 200
Primer: "Example"
parent_idNiz nullIzbirno

Identifikator nadrejene kategorije.

Niz:minLength: 1maxLength: 63
slugNiz nullIzbirno

Del poti URL v izbranem jeziku.

Niz:maxLength: 160

Dodatna polja: Ne