Schémas de données · Réductions

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

Schémas de données

ApiResponse[CampaignData]

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

dataCampaignData Obligatoire: Données d'une réponse réussie.

Exemple: {"created_at":"2026-10-07T10:00:00Z","created_by":{"kind":"admin","label":"Editorial integration","reference":"learn-api-key"},"enabled":false,"id":"example-campaign","kind":"coupon","markets":[{"currency":"PLN","market_id":"poland","minor_units":0}],"name":"Autumn guide offer","updated_at":"2026-10-07T10:00:00Z","used_count":0,"version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoire: Métadonnées de la réponse.

Exemple: {"locale":"example","market_code":"example","market_id":"poland","pagination":{"has_more":false,"limit":1,"next_cursor":null},"request_id":"learn-example-request"}

Champs supplémentaires: Non

ApiResponse[list[CampaignData]]

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

dataTableau <CampaignData > Obligatoire: Données d'une réponse réussie.

Exemple: []
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoire: Métadonnées de la réponse.

Exemple: {"locale":"example","market_code":"example","market_id":"poland","pagination":{"has_more":false,"limit":1,"next_cursor":null},"request_id":"learn-example-request"}

Champs supplémentaires: Non

CampaignCreate

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

audienceChaîneFacultatif

Clients

Contraintes

enum: ["all", "guest", "customer", "selected"]

Valeur par défaut: "all"

benefit_typeChaîneFacultatif

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

Contraintes

enum: ["percentage", "fixed", "none"]

Valeur par défaut: "percentage"

category_idsTableau <Chaîne> Facultatif

Identifiants des catégories associées.

maxItems: 1000

Contraintes · Tableau 1

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

codeChaîne nullFacultatif

Code stable lisible par une machine.

Contraintes · Chaîne 1

pattern: "^[A-Za-z0-9]{6,16}$"

Exemple: "LEARN10"

combine_couponsBooléenFacultatif

Cumuler avec d’autres codes

Valeur par défaut: false

combine_promotionsBooléenFacultatif

Autoriser ce code sur les produits bénéficiant de promotions automatiques

Valeur par défaut: false

customer_idsTableau <Chaîne> Facultatif

Données du client enregistrées pour cette ressource.

maxItems: 1000

Contraintes · Tableau 1

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

ends_atChaîne nullFacultatif

Actif jusqu'au

Chaîne:format: "date-time"

free_shippingBooléenFacultatif

Livraison gratuite

Valeur par défaut: false

marketsTableau <MarketData-Input > Obligatoire

Marchés disponibles dans le contexte de la boutique.

minItems: 1maxItems: 1000

Exemple: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantityEntierFacultatif

Nombre minimum d'articles dans le panier

minimum: 1maximum: 2147483647

Valeur par défaut: 1

nameChaîneObligatoire

Nom de la ressource dans le contexte concerné.

minLength: 1maxLength: 160

Exemple: "Autumn guide offer"

per_customer_limitEntierFacultatif

Limite d'utilisations par client

minimum: -1maximum: 2147483647

Valeur par défaut: -1

percentageChaîneFacultatif

Pourcentage

maxLength: 19

Contraintes

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

Valeur par défaut: "10"

product_idsTableau <Chaîne> Facultatif

Identifiants des produits associés.

maxItems: 1000

Contraintes · Tableau 1

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

product_scopeChaîneFacultatif

Produits

Contraintes

enum: ["all", "selected"]

Valeur par défaut: "all"

show_accountBooléenFacultatif

Dans le compte client

Valeur par défaut: false

show_cartBooléenFacultatif

Dans le panier

Valeur par défaut: false

show_productBooléenFacultatif

Sur les pages produit

Valeur par défaut: false

starts_atChaîne nullFacultatif

Actif à partir du

Chaîne:format: "date-time"

usage_limitEntierFacultatif

Limite d'utilisations

minimum: -1maximum: 2147483647

Valeur par défaut: -1

Champs supplémentaires: Non

CampaignData

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

audienceChaîneFacultatif

Clients

Contraintes

enum: ["all", "guest", "customer", "selected"]

Valeur par défaut: "all"

benefit_typeChaîneFacultatif

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

Contraintes

enum: ["percentage", "fixed", "none"]

Valeur par défaut: "percentage"

category_idsTableau <Chaîne> Facultatif

Identifiants des catégories associées.

maxItems: 1000

Contraintes · Tableau 1

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

codeChaîne nullFacultatif

Code stable lisible par une machine.

Contraintes · Chaîne 1

pattern: "^[A-Za-z0-9]{6,16}$"

combine_couponsBooléenFacultatif

Cumuler avec d’autres codes

Valeur par défaut: false

combine_promotionsBooléenFacultatif

Autoriser ce code sur les produits bénéficiant de promotions automatiques

Valeur par défaut: false

created_atChaîneObligatoire

Date et heure de création.

format: "date-time"

Exemple: "2026-10-07T10:00:00Z"

created_byCreatorData Obligatoire

Créé par

Exemple: {"kind":"admin","label":"Editorial integration","reference":"learn-api-key"}

customer_idsTableau <Chaîne> Facultatif

Données du client enregistrées pour cette ressource.

maxItems: 1000

Contraintes · Tableau 1

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

enabledBooléenObligatoire

Indique si ce paramètre est activé.

Exemple: false

ends_atChaîne nullFacultatif

Actif jusqu'au

Chaîne:format: "date-time"

free_shippingBooléenFacultatif

Livraison gratuite

Valeur par défaut: false

idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée.

Exemple: "example-campaign"

kindChaîneObligatoire

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

Contraintes

enum: ["coupon", "promotion"]

Exemple: "coupon"

marketsTableau <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Obligatoire

Marchés disponibles dans le contexte de la boutique.

minItems: 1maxItems: 1000

Exemple: [{"currency":"PLN","market_id":"poland","minor_units":0}]

minimum_quantityEntierFacultatif

Nombre minimum d'articles dans le panier

minimum: 1maximum: 2147483647

Valeur par défaut: 1

nameChaîneObligatoire

Nom de la ressource dans le contexte concerné.

minLength: 1maxLength: 160

Exemple: "Autumn guide offer"

per_customer_limitEntierFacultatif

Limite d'utilisations par client

minimum: -1maximum: 2147483647

Valeur par défaut: -1

percentageChaîneFacultatif

Pourcentage

maxLength: 19

Contraintes

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

Valeur par défaut: "10"

product_idsTableau <Chaîne> Facultatif

Identifiants des produits associés.

maxItems: 1000

Contraintes · Tableau 1

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

product_scopeChaîneFacultatif

Produits

Contraintes

enum: ["all", "selected"]

Valeur par défaut: "all"

show_accountBooléenFacultatif

Dans le compte client

Valeur par défaut: false

show_cartBooléenFacultatif

Dans le panier

Valeur par défaut: false

show_productBooléenFacultatif

Sur les pages produit

Valeur par défaut: false

starts_atChaîne nullFacultatif

Actif à partir du

Chaîne:format: "date-time"

updated_atChaîneObligatoire

Date et heure de la dernière modification.

format: "date-time"

Exemple: "2026-10-07T10:00:00Z"

usage_limitEntierFacultatif

Limite d'utilisations

minimum: -1maximum: 2147483647

Valeur par défaut: -1

used_countEntierObligatoire

Utilisations effectuées

Exemple: 0

versionEntierObligatoire

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

Exemple: 1

Champs supplémentaires: Non

CampaignStatus

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

enabledBooléenObligatoire: Indique si ce paramètre est activé.

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

minimum: 1maximum: 9223372036854775807

Exemple: 1

Champs supplémentaires: Non

CampaignUpdate

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

audienceChaîneFacultatif

Clients

Contraintes

enum: ["all", "guest", "customer", "selected"]

Valeur par défaut: "all"

benefit_typeChaîneFacultatif

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

Contraintes

enum: ["percentage", "fixed", "none"]

Valeur par défaut: "percentage"

category_idsTableau <Chaîne> Facultatif

Identifiants des catégories associées.

maxItems: 1000

Contraintes · Tableau 1

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

codeChaîne nullFacultatif

Code stable lisible par une machine.

Contraintes · Chaîne 1

pattern: "^[A-Za-z0-9]{6,16}$"

Exemple: "LEARN10"

combine_couponsBooléenFacultatif

Cumuler avec d’autres codes

Valeur par défaut: false

combine_promotionsBooléenFacultatif

Autoriser ce code sur les produits bénéficiant de promotions automatiques

Valeur par défaut: false

customer_idsTableau <Chaîne> Facultatif

Données du client enregistrées pour cette ressource.

maxItems: 1000

Contraintes · Tableau 1

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

ends_atChaîne nullFacultatif

Actif jusqu'au

Chaîne:format: "date-time"

expected_versionEntierObligatoire

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

minimum: 1maximum: 9223372036854775807

Exemple: 1

free_shippingBooléenFacultatif

Livraison gratuite

Valeur par défaut: false

marketsTableau <MarketData-Input > Obligatoire

Marchés disponibles dans le contexte de la boutique.

minItems: 1maxItems: 1000

Exemple: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantityEntierFacultatif

Nombre minimum d'articles dans le panier

minimum: 1maximum: 2147483647

Valeur par défaut: 1

nameChaîneObligatoire

Nom de la ressource dans le contexte concerné.

minLength: 1maxLength: 160

Exemple: "Autumn guide offer"

per_customer_limitEntierFacultatif

Limite d'utilisations par client

minimum: -1maximum: 2147483647

Valeur par défaut: -1

percentageChaîneFacultatif

Pourcentage

maxLength: 19

Contraintes

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

Valeur par défaut: "10"

product_idsTableau <Chaîne> Facultatif

Identifiants des produits associés.

maxItems: 1000

Contraintes · Tableau 1

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

product_scopeChaîneFacultatif

Produits

Contraintes

enum: ["all", "selected"]

Valeur par défaut: "all"

show_accountBooléenFacultatif

Dans le compte client

Valeur par défaut: false

show_cartBooléenFacultatif

Dans le panier

Valeur par défaut: false

show_productBooléenFacultatif

Sur les pages produit

Valeur par défaut: false

starts_atChaîne nullFacultatif

Actif à partir du

Chaîne:format: "date-time"

usage_limitEntierFacultatif

Limite d'utilisations

minimum: -1maximum: 2147483647

Valeur par défaut: -1

Champs supplémentaires: Non

CreatorData

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

kindChaîneObligatoire

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

Contraintes

enum: ["admin", "api"]

Exemple: "admin"

labelChaîneObligatoire

Nom de la ressource dans le contexte concerné.

Exemple: "Editorial integration"

referenceChaîneObligatoire

Identifiant de l'entité référencée.

Exemple: "learn-api-key"

Champs supplémentaires: Non

MarketData

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

currencyChaîneObligatoire

Code de la devise du montant.

Contraintes

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

Exemple: "PLN"

fixed_amountChaîneFacultatif

Montant de la réduction

maxLength: 19

Contraintes

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

Valeur par défaut: "0"

market_idChaîneObligatoire

Identifiant de marché renvoyé par le point d'accès au contexte.

Contraintes

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Exemple: "poland"

maximum_priceChaîne nullFacultatif

Prix maximum du produit

Chaîne:maxLength: 19

Contraintes · Chaîne 1

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

minimum_priceChaîne nullFacultatif

Prix minimum du produit

Chaîne:maxLength: 19

Contraintes · Chaîne 1

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

minimum_subtotalChaîneFacultatif

Montant minimum du panier

maxLength: 19

Contraintes

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

Valeur par défaut: "0"

minor_unitsEntierObligatoire

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

minimum: 0maximum: 4

Exemple: 2

Champs supplémentaires: Non

MarketData

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

currencyChaîneObligatoire

Code de la devise du montant.

Contraintes

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

Exemple: "PLN"

fixed_amountChaîneFacultatif

Montant de la réduction

maxLength: 19

Contraintes

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

Valeur par défaut: "0"

market_idChaîneObligatoire

Identifiant de marché renvoyé par le point d'accès au contexte.

Contraintes

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Exemple: "poland"

maximum_priceChaîne nullFacultatif

Prix maximum du produit

Chaîne:maxLength: 19

Contraintes · Chaîne 1

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

minimum_priceChaîne nullFacultatif

Prix minimum du produit

Chaîne:maxLength: 19

Contraintes · Chaîne 1

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

minimum_subtotalChaîneFacultatif

Montant minimum du panier

maxLength: 19

Contraintes

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

Valeur par défaut: "0"

minor_unitsEntierObligatoire

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

minimum: 0maximum: 4

Exemple: 0

Champs supplémentaires: Non