Schémas de données: Produits

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

Schémas de données

Lister — Produits — Réponse

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

dataTableau <ProductSummaryData > Obligatoire: Exemple de réponse · ApiResponse_list_ProductSummaryData__.

Exemple: [{"availability":{"available_from":null,"available_until":null,"is_available":true},"brand_id":null,"condition":"new","created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"price_version":1,"primary_category_id":"example","primary_media_id":"example","published":false,"sku":"example","slug":"example","tax_category_id":"example","updated_at":"2026-01-01T12:00:00Z","variants_enabled":false,"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

Obtenir — Produits — Réponse

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

dataProductDetailData Obligatoire: Exemple de réponse · ProductDetailData.

Exemple: {"availability":{"available_from":null,"available_until":null,"is_available":true},"brand_id":null,"condition":"new","created_at":"2026-01-01T12:00:00Z","description":"example","features":[{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}],"id":"example","identifiers":{},"media":[{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}],"meta_description":"example","meta_keywords":["example"],"meta_title":"example","name":"Example","number":"example","price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"price_version":1,"primary_category_id":"example","primary_media_id":"example","published":false,"sku":"example","slug":"example","tax_category_id":"example","updated_at":"2026-01-01T12:00:00Z","variants_enabled":false,"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

Informations de disponibilité dans le contexte sélectionné

AvailabilityData · Schéma · Schémas de données: Produits

available_fromChaîne nullObligatoire: Début de la disponibilité.

Chaîne:format: "date-time"

Exemple: null
available_untilChaîne nullObligatoire: Fin de la disponibilité.

Chaîne:format: "date-time"

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

Exemple: true

Champs supplémentaires: Non

Informations de prix dans le contexte sélectionné

PriceData · Schéma · Schémas de données: Produits

amountChaîneObligatoire

Montant décimal sous forme de chaîne JSON ; null uniquement lorsque cela est autorisé.

Exemple: "0.00"

currencyChaîneObligatoire

Code de la devise du montant.

Contraintes

pattern: "^[A-Z]{3}$"

Exemple: "PLN"

minor_unitsEntierObligatoire

Nombre de décimales utilisées par la devise.

minimum: 0maximum: 4

Exemple: 2

tax_includedBooléenObligatoire

Indique si le prix envoyé comprend les taxes.

Exemple: true

Champs supplémentaires: Non

Informations sur la liste de prix

PriceListData · Schéma · Schémas de données: Produits

currencyChaîneObligatoire: Code de la devise du montant.
idChaîneObligatoire: Identifiant de ressource ; conserver la valeur renvoyée. (PriceListData).
tax_includedBooléenObligatoire: Indique si le prix envoyé comprend les taxes.
versionEntierObligatoire: Version de ressource utilisée pour le contrôle de concurrence.

Champs supplémentaires: Non

Créer — Produits — Corps de la requête

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

brand_idChaîne nullFacultatif

Identifiant de la marque.

Chaîne:minLength: 1maxLength: 63

conditionChaîneFacultatif

État du produit.

Contraintes

enum: ["new", "refurbished", "used", "returned", "display", "damaged"]

Valeur par défaut: "new"

descriptionChaîne nullFacultatif

Description dans la langue sélectionnée.

Chaîne:maxLength: 100000

feature_value_idsTableau <Chaîne> Facultatif

Identifiants des valeurs de caractéristiques sélectionnées.

maxItems: 1000

Tableau:minLength: 1maxLength: 63

identifiersProductIdentifiers nullFacultatif

Codes d'identification du produit.

market_idsTableau <Chaîne> Facultatif

Identifiants des marchés sélectionnés.

maxItems: 1000

Tableau:minLength: 1maxLength: 63

media_idsTableau <Chaîne> Facultatif

Identifiants de médias déjà existants.

maxItems: 20

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: 300

Exemple: "Example"

pricingProductPrice Facultatif

Configuration du prix et versions nécessaires au contrôle de concurrence.

primary_category_idChaîne nullFacultatif

Identifiant de la catégorie principale.

Chaîne:minLength: 1maxLength: 63

publishedBooléenFacultatif

Indique si la ressource est publiée.

Valeur par défaut: false

skuChaîneObligatoire

Code de l'unité de gestion des stocks.

minLength: 1maxLength: 100

Contraintes

pattern: "^\\S+$"

Exemple: "example"

slugChaîne nullFacultatif

Segment du chemin URL dans la langue sélectionnée.

Chaîne:maxLength: 160

tax_category_idChaîne nullFacultatif

Identifiant de la catégorie fiscale.

Chaîne:minLength: 1maxLength: 63

variant_value_idsTableau <Chaîne> Facultatif

Identifiants des valeurs de variante sélectionnées.

maxItems: 250

Tableau:minLength: 1maxLength: 63

variants_enabledBooléenFacultatif

Indique si le produit utilise des variantes.

Valeur par défaut: false

Champs supplémentaires: Non

Obtenir — Produits — Réponse

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

availabilityAvailabilityData Obligatoire

Informations de disponibilité dans le contexte sélectionné.

Exemple: {"available_from":null,"available_until":null,"is_available":true}

brand_idChaîne nullObligatoire

Identifiant de la marque.

Exemple: null

conditionChaîneObligatoire

État du produit.

Contraintes

enum: ["new", "refurbished", "used", "returned", "display", "damaged"]

Exemple: "new"

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"

featuresTableau <FeatureSelectionData > Obligatoire

Caractéristiques du produit.

Exemple: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]

idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée. (ProductDetailData).

Exemple: "example"

identifiersObjetChamps supplémentaires: ChaîneObligatoire

Codes d'identification du produit.

Exemple: {}

mediaTableau <ProductMediaData > Obligatoire

Informations sur les médias associés.

Exemple:

[{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}]

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"

pricePriceData nullObligatoire

Informations de prix dans le contexte sélectionné.

Exemple: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}

price_versionEntierObligatoire

Version actuelle du prix pour le contrôle de concurrence.

Exemple: 1

primary_category_idChaîne nullObligatoire

Identifiant de la catégorie principale.

Exemple: "example"

primary_media_idChaîne nullObligatoire

Identifiant du média principal.

Exemple: "example"

publishedBooléenObligatoire

Indique si la ressource est publiée.

Exemple: false

skuChaîneObligatoire

Code de l'unité de gestion des stocks.

Exemple: "example"

slugChaîne nullObligatoire

Segment du chemin URL dans la langue sélectionnée.

Exemple: "example"

tax_category_idChaîneObligatoire

Identifiant de la catégorie fiscale.

Exemple: "example"

updated_atChaîneObligatoire

Date et heure de la dernière modification.

format: "date-time"

Exemple: "2026-01-01T12:00:00Z"

variants_enabledBooléenObligatoire

Indique si le produit utilise des variantes.

Exemple: false

versionEntierObligatoire

Version de ressource utilisée pour le contrôle de concurrence.

Exemple: 1

Champs supplémentaires: Non

Codes d'identification du produit

ProductIdentifiers · Schéma · Schémas de données: Produits

eanChaîne nullFacultatif: Identifiant EAN du produit.

Chaîne:minLength: 1maxLength: 100
isbnChaîne nullFacultatif: Identifiant ISBN.

Chaîne:minLength: 1maxLength: 100
mpnChaîne nullFacultatif: Référence du fabricant.

Chaîne:minLength: 1maxLength: 100
upcChaîne nullFacultatif: Identifiant UPC du produit.

Chaîne:minLength: 1maxLength: 100

Champs supplémentaires: Non

Informations sur les médias associés

ProductMediaData · Schéma · Schémas de données: Produits

alt_textChaîne nullObligatoire

Texte alternatif de l'image.

Exemple: "example"

idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée. (ProductMediaData).

Exemple: "example"

is_primaryBooléenObligatoire

Indique s'il s'agit de l'élément principal.

Exemple: true

kindChaîneObligatoire

Variante de la structure de données définie par les valeurs autorisées.

Contraintes

enum: ["image", "video", "model_3d"]

Exemple: "image"

mime_typeChaîneObligatoire

Type de contenu du média.

Exemple: "image/jpeg"

positionEntierObligatoire

Position dans la collection ordonnée.

Exemple: 1

urlChaîne nullObligatoire

URL de la ressource.

Exemple: "https://example.invalid/product.jpg"

Champs supplémentaires: Non

Configuration du prix et versions nécessaires au contrôle de concurrence

ProductPrice · Schéma · Schémas de données: Produits

amountChaîne nullObligatoire

Montant décimal sous forme de chaîne JSON ; null uniquement lorsque cela est autorisé.

Chaîne:maxLength: 19

Contraintes · Chaîne 1

pattern: "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

Exemple: "0.00"

currencyChaîneObligatoire

Code de la devise du montant.

Contraintes

pattern: "^[A-Z]{3}$"

Exemple: "PLN"

expected_price_list_versionEntierObligatoire

Version de la liste de prix lue avant cette écriture.

minimum: 1maximum: 9223372036854775807

Exemple: 1

expected_versionEntierObligatoire

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

minimum: 0maximum: 9223372036854775807

Exemple: 0

kindChaîneObligatoire

Variante de la structure de données définie par les valeurs autorisées.

Contraintes

enum: ["base", "market_fixed"]

Exemple: "base"

price_list_idChaîneObligatoire

Identifiant de la liste de prix.

minLength: 1maxLength: 63

Exemple: "example"

tax_includedBooléenObligatoire

Indique si le prix envoyé comprend les taxes.

Exemple: true

Champs supplémentaires: Non

Lister — Produits — Réponse

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

availabilityAvailabilityData Obligatoire

Informations de disponibilité dans le contexte sélectionné.

Exemple: {"available_from":null,"available_until":null,"is_available":true}

brand_idChaîne nullObligatoire

Identifiant de la marque.

Exemple: null

conditionChaîneObligatoire

État du produit.

Contraintes

enum: ["new", "refurbished", "used", "returned", "display", "damaged"]

Exemple: "new"

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. (ProductSummaryData).

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"

pricePriceData nullObligatoire

Informations de prix dans le contexte sélectionné.

Exemple: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}

price_versionEntierObligatoire

Version actuelle du prix pour le contrôle de concurrence.

Exemple: 1

primary_category_idChaîne nullObligatoire

Identifiant de la catégorie principale.

Exemple: "example"

primary_media_idChaîne nullObligatoire

Identifiant du média principal.

Exemple: "example"

publishedBooléenObligatoire

Indique si la ressource est publiée.

Exemple: false

skuChaîneObligatoire

Code de l'unité de gestion des stocks.

Exemple: "example"

slugChaîne nullObligatoire

Segment du chemin URL dans la langue sélectionnée.

Exemple: "example"

tax_category_idChaîneObligatoire

Identifiant de la catégorie fiscale.

Exemple: "example"

updated_atChaîneObligatoire

Date et heure de la dernière modification.

format: "date-time"

Exemple: "2026-01-01T12:00:00Z"

variants_enabledBooléenObligatoire

Indique si le produit utilise des variantes.

Exemple: false

versionEntierObligatoire

Version de ressource utilisée pour le contrôle de concurrence.

Exemple: 1

Champs supplémentaires: Non

Modifier — Produits — Corps de la requête

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

brand_idChaîne nullFacultatif

Identifiant de la marque.

Chaîne:minLength: 1maxLength: 63

conditionChaîneFacultatif

État du produit.

Contraintes

enum: ["new", "refurbished", "used", "returned", "display", "damaged"]

descriptionChaîne nullFacultatif

Description dans la langue sélectionnée.

Chaîne:maxLength: 100000

Exemple: null

expected_variant_price_versionsObjetChamps supplémentaires: Entier

minimum: 0maximum: 9223372036854775807

Facultatif

Versions des prix lues précédemment, indexées par identifiant de variante.

maxProperties: 250

Contraintes

propertyNames: {"maxLength": 63, "minLength": 1}

expected_versionEntierObligatoire

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

minimum: 1maximum: 9223372036854775807

Exemple: 1

feature_value_idsTableau <Chaîne> Facultatif

Identifiants des valeurs de caractéristiques sélectionnées.

maxItems: 1000

Tableau:minLength: 1maxLength: 63

identifiersProductIdentifiers nullFacultatif

Codes d'identification du produit.

market_idsTableau <Chaîne> Facultatif

Identifiants des marchés sélectionnés.

maxItems: 1000

Tableau:minLength: 1maxLength: 63

media_idsTableau <Chaîne> Facultatif

Identifiants de médias déjà existants.

maxItems: 20

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: 300

Exemple: null

pricingProductPrice Facultatif

Configuration du prix et versions nécessaires au contrôle de concurrence.

Exemple:

{"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}

primary_category_idChaîne nullFacultatif

Identifiant de la catégorie principale.

Chaîne:minLength: 1maxLength: 63

publishedBooléenFacultatif

Indique si la ressource est publiée.

skuChaîneFacultatif

Code de l'unité de gestion des stocks.

minLength: 1maxLength: 100

Contraintes

pattern: "^\\S+$"

Exemple: "example"

slugChaîne nullFacultatif

Segment du chemin URL dans la langue sélectionnée.

Chaîne:maxLength: 160

tax_category_idChaîne nullFacultatif

Identifiant de la catégorie fiscale.

Chaîne:minLength: 1maxLength: 63

variant_value_idsTableau <Chaîne> Facultatif

Identifiants des valeurs de variante sélectionnées.

maxItems: 250

Tableau:minLength: 1maxLength: 63

variants_enabledBooléenFacultatif

Indique si le produit utilise des variantes.

Champs supplémentaires: Non