Schémas de données: Variantes et options

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

Schémas de données

Lister · Variantes du produit — Variantes et options — Réponse

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

dataTableau <ProductVariantData > Obligatoire: Exemple de réponse · ApiResponse_list_ProductVariantData__.

Exemple: [{"active":true,"created_at":"2026-01-01T12:00:00Z","id":"example","is_default":true,"media_ids":["example"],"position":1,"pricing":{"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1},"primary_media_id":"example","product_id":"example","sku":"example","updated_at":"2026-01-01T12:00:00Z","values":[{"option_id":"example","option_name":"example","value":"example","value_id":"example"}],"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

Lister · Options — Variantes et options — Réponse

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

dataTableau <shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData > Obligatoire: Exemple de réponse · ApiResponse_list_VariantOptionData__.

Exemple: [{"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"selection_type":"button","updated_at":"2026-01-01T12:00:00Z","value_presentation_type":"text","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

Lister · Valeurs des options — Variantes et options — Réponse

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

dataTableau <VariantValueData > Obligatoire: Exemple de réponse · ApiResponse_list_VariantValueData__.

Exemple: [{"color_hex":"#008855","created_at":"2026-01-01T12:00:00Z","id":"example","image_media_id":null,"number":"example","option_id":"example","position":1,"sku_code":"example","updated_at":"2026-01-01T12:00:00Z","value":"example","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 · Variantes du produit — Variantes et options — Réponse

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

dataProductVariantData Obligatoire: Exemple de réponse · ProductVariantData.

Exemple: {"active":true,"created_at":"2026-01-01T12:00:00Z","id":"example","is_default":true,"media_ids":["example"],"position":1,"pricing":{"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1},"primary_media_id":"example","product_id":"example","sku":"example","updated_at":"2026-01-01T12:00:00Z","values":[{"option_id":"example","option_name":"example","value":"example","value_id":"example"}],"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

Obtenir · Options — Variantes et options — Réponse

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

datashopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData Obligatoire: Exemple de réponse · shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData.

Exemple: {"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"selection_type":"button","updated_at":"2026-01-01T12:00:00Z","value_presentation_type":"text","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

Obtenir · Valeurs des options — Variantes et options — Réponse

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

dataVariantValueData Obligatoire: Exemple de réponse · VariantValueData.

Exemple: {"color_hex":"#008855","created_at":"2026-01-01T12:00:00Z","id":"example","image_media_id":null,"number":"example","option_id":"example","position":1,"sku_code":"example","updated_at":"2026-01-01T12:00:00Z","value":"example","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

Obtenir · Options — Variantes et options — Réponse

shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData · 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. (shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData).

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"

positionEntierObligatoire

Position dans la collection ordonnée.

Exemple: 1

selection_typeChaîneObligatoire

Mode de sélection autorisé pour les valeurs de caractéristique.

Contraintes

enum: ["button", "dropdown"]

Exemple: "button"

updated_atChaîneObligatoire

Date et heure de la dernière modification.

format: "date-time"

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

value_presentation_typeChaîneObligatoire

Mode de présentation des valeurs du répertoire.

Contraintes

enum: ["text", "color", "image"]

Exemple: "text"

versionEntierObligatoire

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

Exemple: 1

Champs supplémentaires: Non

Obtenir · Variantes du produit — Variantes et options — Réponse

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

activeBooléenObligatoire: Indique si la ressource est active.

Exemple: true
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. (ProductVariantData).

Exemple: "example"
is_defaultBooléenObligatoire: Indique s'il s'agit du choix par défaut.

Exemple: true
media_idsTableau <Chaîne> Obligatoire: Identifiants de médias déjà existants.

Exemple: ["example"]
positionEntierObligatoire: Position dans la collection ordonnée.

Exemple: 1
pricingVariantPricingData Obligatoire: Configuration du prix et versions nécessaires au contrôle de concurrence.

Exemple: {"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1}
primary_media_idChaîne nullObligatoire: Identifiant du média principal.

Exemple: "example"
product_idChaîneObligatoire: Identifiant du produit.

Exemple: "example"
skuChaîneObligatoire: Code de l'unité de gestion des stocks.

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

format: "date-time"

Exemple: "2026-01-01T12:00:00Z"
valuesTableau <VariantChoiceData > Obligatoire: Valeurs du répertoire.

Exemple: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]
versionEntierObligatoire: Version de ressource utilisée pour le contrôle de concurrence.

Exemple: 1

Champs supplémentaires: Non

Valeurs du répertoire

VariantChoiceData · Schéma · Schémas de données: Variantes et options

option_idChaîneObligatoire: Identifiant de l'option de variante.

Exemple: "example"
option_nameChaîne nullObligatoire: Nom de l'option de variante.

Exemple: "example"
valueChaîne nullObligatoire: Valeur décrite par le schéma environnant.

Exemple: "example"
value_idChaîneObligatoire: Identifiant d'une valeur du répertoire.

Exemple: "example"

Champs supplémentaires: Non

Créer · Variantes du produit — Variantes et options — Corps de la requête

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

activeBooléenFacultatif

Indique si la ressource est active.

Valeur par défaut: true

expected_versionEntierObligatoire

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

minimum: 1maximum: 9223372036854775807

Exemple: 1

is_defaultBooléenFacultatif

Indique s'il s'agit du choix par défaut.

media_idsTableau <Chaîne> Facultatif

Identifiants de médias déjà existants.

maxItems: 20

Tableau:minLength: 1maxLength: 63

pricingVariantPrice Facultatif

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

skuChaîneFacultatif

Code de l'unité de gestion des stocks.

minLength: 1maxLength: 100

Contraintes

pattern: "^\\S+$"

value_idsTableau <Chaîne> Obligatoire

Identifiants des valeurs du répertoire.

minItems: 1maxItems: 250

Tableau:minLength: 1maxLength: 63

Exemple: ["example"]

Champs supplémentaires: Non

Créer · Options — Variantes et options — Corps de la requête

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

nameChaîneObligatoire

Nom de la ressource dans le contexte concerné.

minLength: 1maxLength: 120

Contraintes

pattern: "^[^\\x00]*$"

Exemple: "Example"

selection_typeChaîneFacultatif

Mode de sélection autorisé pour les valeurs de caractéristique.

Contraintes

enum: ["button", "dropdown"]

Valeur par défaut: "button"

value_presentation_typeChaîneFacultatif

Mode de présentation des valeurs du répertoire.

Contraintes

enum: ["text", "color", "image"]

Valeur par défaut: "text"

Champs supplémentaires: Non

Modifier · Options — Variantes et options — Corps de la requête

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

expected_versionEntierObligatoire

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

minimum: 1maximum: 9223372036854775807

Exemple: 1

nameChaîne nullFacultatif

Nom de la ressource dans le contexte concerné.

Chaîne:minLength: 1maxLength: 120

Contraintes · Chaîne 1

pattern: "^[^\\x00]*$"

Exemple: "Example"

selection_typeChaîneFacultatif

Mode de sélection autorisé pour les valeurs de caractéristique.

Contraintes

enum: ["button", "dropdown"]

value_presentation_typeChaîneFacultatif

Mode de présentation des valeurs du répertoire.

Contraintes

enum: ["text", "color", "image"]

Champs supplémentaires: Non

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

VariantPrice · Schéma · Schémas de données: Variantes et options

amountChaîne nullObligatoire

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

Chaîne:maxLength: 20

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_product_versionEntierObligatoire

Version du produit lue avant cette écriture.

minimum: 0maximum: 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_adjustment", "market_fixed"]

Exemple: "base_adjustment"

price_list_idChaîneObligatoire

Identifiant de la liste de prix.

minLength: 1maxLength: 63

Exemple: "example"

Champs supplémentaires: Non

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

VariantPricingData · Schéma · Schémas de données: Variantes et options

base_adjustmentMoneyData Obligatoire: Ajustement par rapport au prix de base.

Exemple: {"amount":"0.00","currency":"PLN","minor_units":2}
market_priceMoneyData nullObligatoire: Prix pour le marché sélectionné.

Exemple: null
pricePriceData nullObligatoire: Informations de prix dans le contexte sélectionné.

Exemple: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
product_versionEntierObligatoire: Version actuelle du produit pour le contrôle de concurrence.

Exemple: 1
versionEntierObligatoire: Version de ressource utilisée pour le contrôle de concurrence.

Exemple: 1

Champs supplémentaires: Non

Modifier · Variantes du produit — Variantes et options — Corps de la requête

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

activeBooléenFacultatif

Indique si la ressource est active.

expected_versionEntierObligatoire

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

minimum: 1maximum: 9223372036854775807

Exemple: 1

is_defaultBooléenFacultatif

Indique s'il s'agit du choix par défaut.

media_idsTableau <Chaîne> Facultatif

Identifiants de médias déjà existants.

maxItems: 20

Tableau:minLength: 1maxLength: 63

pricingVariantPrice 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_product_version":1,"expected_version":0,"kind":"base_adjustment","price_list_id":"example"}

skuChaîneFacultatif

Code de l'unité de gestion des stocks.

minLength: 1maxLength: 100

Contraintes

pattern: "^\\S+$"

Exemple: "example"

Champs supplémentaires: Non

Créer · Valeurs des options — Variantes et options — Corps de la requête

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

color_hexChaîne nullFacultatif

Couleur représentée par un code hexadécimal.

Contraintes · Chaîne 1

pattern: "^#[0-9A-Fa-f]{6}$"

expected_versionEntierObligatoire

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

minimum: 1maximum: 9223372036854775807

Exemple: 1

valueChaîneObligatoire

Valeur décrite par le schéma environnant.

minLength: 1maxLength: 180

Contraintes

pattern: "^[^\\x00]*$"

Exemple: "Example"

Champs supplémentaires: Non

Obtenir · Valeurs des options — Variantes et options — Réponse

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

color_hexChaîne nullObligatoire: Couleur représentée par un code hexadécimal.

Exemple: "#008855"
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. (VariantValueData).

Exemple: "example"
image_media_idChaîne nullObligatoire: Identifiant du fichier image sélectionné.

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

Exemple: "example"
option_idChaîneObligatoire: Identifiant de l'option de variante.

Exemple: "example"
positionEntierObligatoire: Position dans la collection ordonnée.

Exemple: 1
sku_codeChaîneObligatoire: Code de l'unité de gestion des stocks.

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

format: "date-time"

Exemple: "2026-01-01T12:00:00Z"
valueChaîne nullObligatoire: Valeur décrite par le schéma environnant.

Exemple: "example"
versionEntierObligatoire: Version de ressource utilisée pour le contrôle de concurrence.

Exemple: 1

Champs supplémentaires: Non

Modifier · Valeurs des options — Variantes et options — Corps de la requête

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

color_hexChaîne nullFacultatif

Couleur représentée par un code hexadécimal.

Contraintes · Chaîne 1

pattern: "^#[0-9A-Fa-f]{6}$"

expected_versionEntierObligatoire

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

minimum: 1maximum: 9223372036854775807

Exemple: 1

valueChaîne nullFacultatif

Valeur décrite par le schéma environnant.

Chaîne:minLength: 1maxLength: 180

Contraintes · Chaîne 1

pattern: "^[^\\x00]*$"

Exemple: "Example"

Champs supplémentaires: Non