Vai al contenuto
ShopentlyLearn

Schemi dei dati: Categorie

Schemi dei dati: Categorie. Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

Schemi dei dati

Recupera — Categorie — Risposta

ApiResponse_CategoryDetailData_ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
dataCategoryDetailData Obbligatorio

Esempio di risposta · CategoryDetailData.

Esempio: {"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 Obbligatorio

Metadati della risposta.

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

Campi aggiuntivi: No

Elenca — Categorie — Risposta

ApiResponse_list_CategorySummaryData__ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
dataArray <CategorySummaryData > Obbligatorio

Esempio di risposta · ApiResponse_list_CategorySummaryData__.

Esempio: [{"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 Obbligatorio

Metadati della risposta.

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

Campi aggiuntivi: No

Crea — Categorie — Corpo della richiesta

CategoryCreate · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
descriptionStringa nullFacoltativo

Descrizione nella lingua selezionata.

Stringa:maxLength: 50000
introductionStringa nullFacoltativo

Testo introduttivo nella lingua selezionata.

Stringa:maxLength: 5000
is_visibleBooleanoFacoltativo

Indica se la risorsa è visibile.

Valore predefinito: false
market_idsArray <Stringa> Facoltativo

Identificativi dei mercati selezionati.

maxItems: 1000
Array:minLength: 1maxLength: 63
meta_descriptionStringa nullFacoltativo

Descrizione per i motori di ricerca nella lingua selezionata.

Stringa:maxLength: 160
meta_keywordsArray <Stringa> nullFacoltativo

Parole chiave per i motori di ricerca nella lingua selezionata.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleStringa nullFacoltativo

Titolo per i motori di ricerca nella lingua selezionata.

Stringa:maxLength: 70
nameStringaObbligatorio

Nome della risorsa nel contesto pertinente.

minLength: 1maxLength: 200
Esempio: "Example"
parent_idStringa nullFacoltativo

Identificativo della categoria genitore.

Stringa:minLength: 1maxLength: 63
slugStringa nullFacoltativo

Segmento del percorso URL nella lingua selezionata.

Stringa:maxLength: 160

Campi aggiuntivi: No

Recupera — Categorie — Risposta

CategoryDetailData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
created_atStringaObbligatorio

Data e ora di creazione.

format: "date-time"
Esempio: "2026-01-01T12:00:00Z"
descriptionStringa nullObbligatorio

Descrizione nella lingua selezionata.

Esempio: "example"
idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito. (CategoryDetailData).

Esempio: "example"
introductionStringa nullObbligatorio

Testo introduttivo nella lingua selezionata.

Esempio: "example"
is_availableBooleanoObbligatorio

Indica se l’elemento è disponibile in questo contesto.

Esempio: true
is_visibleBooleanoObbligatorio

Indica se la risorsa è visibile.

Esempio: false
meta_descriptionStringa nullObbligatorio

Descrizione per i motori di ricerca nella lingua selezionata.

Esempio: "example"
meta_keywordsArray <Stringa> nullObbligatorio

Parole chiave per i motori di ricerca nella lingua selezionata.

Esempio: ["example"]
meta_titleStringa nullObbligatorio

Titolo per i motori di ricerca nella lingua selezionata.

Esempio: "example"
nameStringa nullObbligatorio

Nome della risorsa nel contesto pertinente.

Esempio: "Example"
numberStringaObbligatorio

Numero dell’ordine o della richiesta destinato alle persone.

Esempio: "example"
parent_idStringa nullObbligatorio

Identificativo della categoria genitore.

Esempio: null
slugStringa nullObbligatorio

Segmento del percorso URL nella lingua selezionata.

Esempio: "example"
updated_atStringaObbligatorio

Data e ora dell’aggiornamento più recente.

format: "date-time"
Esempio: "2026-01-01T12:00:00Z"
versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 1

Campi aggiuntivi: No

Elenca — Categorie — Risposta

CategorySummaryData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
created_atStringaObbligatorio

Data e ora di creazione.

format: "date-time"
Esempio: "2026-01-01T12:00:00Z"
idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito. (CategorySummaryData).

Esempio: "example"
is_availableBooleanoObbligatorio

Indica se l’elemento è disponibile in questo contesto.

Esempio: true
is_visibleBooleanoObbligatorio

Indica se la risorsa è visibile.

Esempio: false
nameStringa nullObbligatorio

Nome della risorsa nel contesto pertinente.

Esempio: "Example"
numberStringaObbligatorio

Numero dell’ordine o della richiesta destinato alle persone.

Esempio: "example"
parent_idStringa nullObbligatorio

Identificativo della categoria genitore.

Esempio: null
slugStringa nullObbligatorio

Segmento del percorso URL nella lingua selezionata.

Esempio: "example"
updated_atStringaObbligatorio

Data e ora dell’aggiornamento più recente.

format: "date-time"
Esempio: "2026-01-01T12:00:00Z"
versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 1

Campi aggiuntivi: No

Aggiorna — Categorie — Corpo della richiesta

CategoryUpdate · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
descriptionStringa nullFacoltativo

Descrizione nella lingua selezionata.

Stringa:maxLength: 50000
expected_versionInteroObbligatorio

Versione letta prima della scrittura; una differenza impedisce l’aggiornamento.

minimum: 1maximum: 9223372036854775807
Esempio: 1
introductionStringa nullFacoltativo

Testo introduttivo nella lingua selezionata.

Stringa:maxLength: 5000
is_visibleBooleanoFacoltativo

Indica se la risorsa è visibile.

market_idsArray <Stringa> Facoltativo

Identificativi dei mercati selezionati.

maxItems: 1000
Array:minLength: 1maxLength: 63
meta_descriptionStringa nullFacoltativo

Descrizione per i motori di ricerca nella lingua selezionata.

Stringa:maxLength: 160
meta_keywordsArray <Stringa> nullFacoltativo

Parole chiave per i motori di ricerca nella lingua selezionata.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleStringa nullFacoltativo

Titolo per i motori di ricerca nella lingua selezionata.

Stringa:maxLength: 70
nameStringa nullFacoltativo

Nome della risorsa nel contesto pertinente.

Stringa:maxLength: 200
Esempio: "Example"
parent_idStringa nullFacoltativo

Identificativo della categoria genitore.

Stringa:minLength: 1maxLength: 63
slugStringa nullFacoltativo

Segmento del percorso URL nella lingua selezionata.

Stringa:maxLength: 160

Campi aggiuntivi: No