Schémas de données: Catégories

Schémas de données: Catégories. Champs, types et contraintes des données acceptées ou renvoyées par l’API.

Schémas de données

Obtenir — Catégories — Réponse

ApiResponse_CategoryDetailData_ · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

dataCategoryDetailData Obligatoire: Exemple de réponse · CategoryDetailData.

Exemple: {"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 Obligatoire: Métadonnées de la réponse.

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

Champs supplémentaires: Non

Lister — Catégories — Réponse

ApiResponse_list_CategorySummaryData__ · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

dataTableau <CategorySummaryData > Obligatoire: Exemple de réponse · ApiResponse_list_CategorySummaryData__.

Exemple: [{"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 Obligatoire: Métadonnées de la réponse.

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

Champs supplémentaires: Non

Créer — Catégories — Corps de la requête

CategoryCreate · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

descriptionChaîne nullFacultatif: Description dans la langue sélectionnée.

Chaîne:maxLength: 50000
introductionChaîne nullFacultatif: Texte d'introduction dans la langue sélectionnée.

Chaîne:maxLength: 5000
is_visibleBooléenFacultatif: Indique si la ressource est visible.

Valeur par défaut: false
market_idsTableau <Chaîne> Facultatif: Identifiants des marchés sélectionnés.

maxItems: 1000
Tableau:minLength: 1maxLength: 63
meta_descriptionChaîne nullFacultatif: Description pour les moteurs de recherche dans la langue sélectionnée.

Chaîne:maxLength: 160
meta_keywordsTableau <Chaîne> nullFacultatif: Mots-clés pour les moteurs de recherche dans la langue sélectionnée.

Tableau:maxItems: 20
Tableau / Tableau:maxLength: 50
meta_titleChaîne nullFacultatif: Titre pour les moteurs de recherche dans la langue sélectionnée.

Chaîne:maxLength: 70
nameChaîneObligatoire: Nom de la ressource dans le contexte concerné.

minLength: 1maxLength: 200

Exemple: "Example"
parent_idChaîne nullFacultatif: Identifiant de la catégorie parente.

Chaîne:minLength: 1maxLength: 63
slugChaîne nullFacultatif: Segment du chemin URL dans la langue sélectionnée.

Chaîne:maxLength: 160

Champs supplémentaires: Non

Obtenir — Catégories — Réponse

CategoryDetailData · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

created_atChaîneObligatoire: Date et heure de création.

format: "date-time"

Exemple: "2026-01-01T12:00:00Z"
descriptionChaîne nullObligatoire: Description dans la langue sélectionnée.

Exemple: "example"
idChaîneObligatoire: Identifiant de ressource ; conserver la valeur renvoyée. (CategoryDetailData).

Exemple: "example"
introductionChaîne nullObligatoire: Texte d'introduction dans la langue sélectionnée.

Exemple: "example"
is_availableBooléenObligatoire: Indique si l'article est disponible dans ce contexte.

Exemple: true
is_visibleBooléenObligatoire: Indique si la ressource est visible.

Exemple: false
meta_descriptionChaîne nullObligatoire: Description pour les moteurs de recherche dans la langue sélectionnée.

Exemple: "example"
meta_keywordsTableau <Chaîne> nullObligatoire: Mots-clés pour les moteurs de recherche dans la langue sélectionnée.

Exemple: ["example"]
meta_titleChaîne nullObligatoire: Titre pour les moteurs de recherche dans la langue sélectionnée.

Exemple: "example"
nameChaîne nullObligatoire: Nom de la ressource dans le contexte concerné.

Exemple: "Example"
numberChaîneObligatoire: Numéro de commande ou de demande visible par l'utilisateur.

Exemple: "example"
parent_idChaîne nullObligatoire: Identifiant de la catégorie parente.

Exemple: null
slugChaîne nullObligatoire: Segment du chemin URL dans la langue sélectionnée.

Exemple: "example"
updated_atChaîneObligatoire: Date et heure de la dernière modification.

format: "date-time"

Exemple: "2026-01-01T12:00:00Z"
versionEntierObligatoire: Version de ressource utilisée pour le contrôle de concurrence.

Exemple: 1

Champs supplémentaires: Non

Lister — Catégories — Réponse

CategorySummaryData · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

created_atChaîneObligatoire: Date et heure de création.

format: "date-time"

Exemple: "2026-01-01T12:00:00Z"
idChaîneObligatoire: Identifiant de ressource ; conserver la valeur renvoyée. (CategorySummaryData).

Exemple: "example"
is_availableBooléenObligatoire: Indique si l'article est disponible dans ce contexte.

Exemple: true
is_visibleBooléenObligatoire: Indique si la ressource est visible.

Exemple: false
nameChaîne nullObligatoire: Nom de la ressource dans le contexte concerné.

Exemple: "Example"
numberChaîneObligatoire: Numéro de commande ou de demande visible par l'utilisateur.

Exemple: "example"
parent_idChaîne nullObligatoire: Identifiant de la catégorie parente.

Exemple: null
slugChaîne nullObligatoire: Segment du chemin URL dans la langue sélectionnée.

Exemple: "example"
updated_atChaîneObligatoire: Date et heure de la dernière modification.

format: "date-time"

Exemple: "2026-01-01T12:00:00Z"
versionEntierObligatoire: Version de ressource utilisée pour le contrôle de concurrence.

Exemple: 1

Champs supplémentaires: Non

Modifier — Catégories — Corps de la requête

CategoryUpdate · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

descriptionChaîne nullFacultatif: Description dans la langue sélectionnée.

Chaîne:maxLength: 50000
expected_versionEntierObligatoire: Version lue avant l'écriture ; une différence entraîne le rejet de la modification.

minimum: 1maximum: 9223372036854775807

Exemple: 1
introductionChaîne nullFacultatif: Texte d'introduction dans la langue sélectionnée.

Chaîne:maxLength: 5000
is_visibleBooléenFacultatif: Indique si la ressource est visible.
market_idsTableau <Chaîne> Facultatif: Identifiants des marchés sélectionnés.

maxItems: 1000
Tableau:minLength: 1maxLength: 63
meta_descriptionChaîne nullFacultatif: Description pour les moteurs de recherche dans la langue sélectionnée.

Chaîne:maxLength: 160
meta_keywordsTableau <Chaîne> nullFacultatif: Mots-clés pour les moteurs de recherche dans la langue sélectionnée.

Tableau:maxItems: 20
Tableau / Tableau:maxLength: 50
meta_titleChaîne nullFacultatif: Titre pour les moteurs de recherche dans la langue sélectionnée.

Chaîne:maxLength: 70
nameChaîne nullFacultatif: Nom de la ressource dans le contexte concerné.

Chaîne:maxLength: 200

Exemple: "Example"
parent_idChaîne nullFacultatif: Identifiant de la catégorie parente.

Chaîne:minLength: 1maxLength: 63
slugChaîne nullFacultatif: Segment du chemin URL dans la langue sélectionnée.

Chaîne:maxLength: 160

Champs supplémentaires: Non