Aller au contenu
ShopentlyLearn

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

ApiResponse_ProductFileListData_

ApiResponse_ProductFileListData_ · Champs, types et contraintes des données acceptées ou renvoyées par l’API. Transmettez les fichiers en multipart/form-data après la création de upload_id, puis associez-les au produit. Le téléchargement exige un jeton Bearer et le droit correspondant à category ; la réponse contient les octets, sans adresse publique ni mot de passe. Pour mode=period, choisissez days (1–3650) ou l’ancien months, jamais les deux. Les conditions sont enregistrées à l’achat ; le remboursement retire uniquement l’accès à la ligne remboursée.
dataProductFileListData Obligatoire

Données d'une réponse réussie.

Exemple: {"files":[{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}],"product_version":2}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoire

Métadonnées de la réponse.

Exemple: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Champs supplémentaires: Non

ApiResponse_ReleaseListData_

ApiResponse_ReleaseListData_ · Champs, types et contraintes des données acceptées ou renvoyées par l’API. Transmettez les fichiers en multipart/form-data après la création de upload_id, puis associez-les au produit. Le téléchargement exige un jeton Bearer et le droit correspondant à category ; la réponse contient les octets, sans adresse publique ni mot de passe. Pour mode=period, choisissez days (1–3650) ou l’ancien months, jamais les deux. Les conditions sont enregistrées à l’achat ; le remboursement retire uniquement l’accès à la ligne remboursée.
dataReleaseListData Obligatoire

Données d'une réponse réussie.

Exemple: {"current_release_id":"00000000-0000-4000-8000-000000000001","product_version":2,"releases":[{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}],"update_days":365,"update_mode":"period","update_months":null}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoire

Métadonnées de la réponse.

Exemple: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Champs supplémentaires: Non

ApiResponse_UploadData_

ApiResponse_UploadData_ · Champs, types et contraintes des données acceptées ou renvoyées par l’API. Transmettez les fichiers en multipart/form-data après la création de upload_id, puis associez-les au produit. Le téléchargement exige un jeton Bearer et le droit correspondant à category ; la réponse contient les octets, sans adresse publique ni mot de passe. Pour mode=period, choisissez days (1–3650) ou l’ancien months, jamais les deux. Les conditions sont enregistrées à l’achat ; le remboursement retire uniquement l’accès à la ligne remboursée.
dataUploadData Obligatoire

Données d'une réponse réussie.

Exemple: {"category":"digital","expires_at":"2026-01-01T12:00:00Z","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","product_id":"example","received_bytes":46,"sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"status":"ready"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoire

Métadonnées de la réponse.

Exemple: {"request_id":"example"}

Champs supplémentaires: Non

ApiResponse[AudienceData]

ApiResponse_AudienceData_ · Consultez la règle d’accès et la version du produit. La date de première publication reste inchangée.
dataAudienceData Obligatoire

Données d'une réponse réussie.

Exemple: {"anchor_at":"2026-11-03T12:00:00Z","effective_at":"2026-11-03T12:00:00Z","file_id":"00000000-0000-4000-8000-000000000007","file_version_id":"00000000-0000-4000-8000-000000000010","historical_access_preserved":true,"id":"00000000-0000-4000-8000-000000000009","lookback_days":null,"mode":"all_purchasers","next_cursor":null,"order_ids":[],"product_version":3,"revision":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoire

Métadonnées de la réponse.

Exemple: {"request_id":"example-request"}

Champs supplémentaires: Non

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

AudienceChange

AudienceChange · Sélectionnez les achats admissibles. Les commandes choisies doivent contenir ce produit payé et non remboursé.
audienceAudienceSelection Obligatoire

Règle d’accès explicite au fichier partagé vendu.

Exemple: {"mode":"all_purchasers"}
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

AudienceData

AudienceData · Consultez la règle d’accès et la version du produit. La date de première publication reste inchangée.
anchor_atChaîneObligatoire

Première publication ; inchangée après modification de la règle.

format: "date-time"
Exemple: "2026-11-03T12:00:00Z"
effective_atChaîneObligatoire

Date de publication de cette règle d’accès.

format: "date-time"
Exemple: "2026-11-03T12:00:00Z"
file_idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée. · file_id

Exemple: "00000000-0000-4000-8000-000000000007"
file_version_idChaîneObligatoire

Identifiant d’une version de fichier immuable.

Exemple: "00000000-0000-4000-8000-000000000010"
historical_access_preservedBooléenFacultatif

Les droits accordés sont conservés si la règle devient plus restrictive.

Valeur par défaut: trueExemple: true
idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée.

Exemple: "00000000-0000-4000-8000-000000000009"
lookback_daysEntier nullObligatoire

1–3650 jours avant la première publication ; seulement recent_and_new.

Exemple: null
modeChaîneObligatoire

Règle d’accès explicite au fichier partagé vendu. new_purchases / recent_and_new / selected / all_purchasers.

Exemple: "all_purchasers"
next_cursorChaîne nullObligatoire

Valeur de continuation pour la page suivante, ou null.

Exemple: null
order_idsTableau <Chaîne> Obligatoire

Commandes payées et non remboursées contenant ce produit.

Exemple: []
product_versionEntierObligatoire

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

Exemple: 3
revisionEntierObligatoire

Révision successive de la règle d’accès.

Exemple: 1

Champs supplémentaires: Non

AudienceSelection

AudienceSelection · Sélectionnez les achats admissibles. Les commandes choisies doivent contenir ce produit payé et non remboursé.
lookback_daysEntier nullFacultatif

1–3650 jours avant la première publication ; seulement recent_and_new.

Entier:minimum: 1maximum: 3650
modeChaîneObligatoire

Règle d’accès explicite au fichier partagé vendu. new_purchases / recent_and_new / selected / all_purchasers.

Contraintes
enum
["new_purchases", "recent_and_new", "selected", "all_purchasers"]
Exemple: "new_purchases"
order_idsTableau <Chaîne> Facultatif

Commandes payées et non remboursées contenant ce produit.

maxItems: 1000
Contraintes · Tableau 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Valeur par défaut: []

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

FileAssign

FileAssign · Champs, types et contraintes des données acceptées ou renvoyées par l’API. Transmettez les fichiers en multipart/form-data après la création de upload_id, puis associez-les au produit. Le téléchargement exige un jeton Bearer et le droit correspondant à category ; la réponse contient les octets, sans adresse publique ni mot de passe. Pour mode=period, choisissez days (1–3650) ou l’ancien months, jamais les deux. Les conditions sont enregistrées à l’achat ; le remboursement retire uniquement l’accès à la ligne remboursée.
audienceAudienceSelection nullFacultatif

Règle d’accès explicite au fichier partagé vendu.

Exemple: {"mode":"new_purchases"}
expected_versionEntierObligatoire

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

minimum: 1maximum: 9223372036854775807
Exemple: 1
labelChaîneFacultatif

Nom de la ressource dans le contexte concerné.

maxLength: 300
Valeur par défaut: ""
upload_idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée. · upload_id

format: "uuid"
Exemple: "00000000-0000-4000-8000-000000000001"

Champs supplémentaires: Non

FileCategory

FileCategory · Champs, types et contraintes des données acceptées ou renvoyées par l’API. Transmettez les fichiers en multipart/form-data après la création de upload_id, puis associez-les au produit. Le téléchargement exige un jeton Bearer et le droit correspondant à category ; la réponse contient les octets, sans adresse publique ni mot de passe. Pour mode=period, choisissez days (1–3650) ou l’ancien months, jamais les deux. Les conditions sont enregistrées à l’achat ; le remboursement retire uniquement l’accès à la ligne remboursée.
Chaîne
Contraintes
enum
["internal", "customer_document", "digital"]

Champs supplémentaires: Oui

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

ProductFileData

ProductFileData · Champs, types et contraintes des données acceptées ou renvoyées par l’API. Transmettez les fichiers en multipart/form-data après la création de upload_id, puis associez-les au produit. Le téléchargement exige un jeton Bearer et le droit correspondant à category ; la réponse contient les octets, sans adresse publique ni mot de passe. Pour mode=period, choisissez days (1–3650) ou l’ancien months, jamais les deux. Les conditions sont enregistrées à l’achat ; le remboursement retire uniquement l’accès à la ligne remboursée.
categoryFileCategory Obligatoire

Catégorie de fichier: internal / customer_document / digital

Exemple: "digital"
created_atChaîneObligatoire

Date et heure de création.

format: "date-time"
Exemple: "2026-01-01T12:00:00Z"
current_version_idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée. · current_version_id

format: "uuid"
Exemple: "00000000-0000-4000-8000-000000000001"
file_idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée. · file_id

format: "uuid"
Exemple: "00000000-0000-4000-8000-000000000001"
filenameChaîneObligatoire

Fichier

Exemple: "manual.pdf"
idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée.

format: "uuid"
Exemple: "00000000-0000-4000-8000-000000000001"
labelChaîneObligatoire

Nom de la ressource dans le contexte concerné.

Exemple: "Manual"
mime_typeChaîneObligatoire

Type de contenu du média.

Exemple: "application/pdf"
sha256ChaîneObligatoire

SHA-256 (hex, 64)

Exemple: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesEntierObligatoire

Taille en octets

Exemple: 46
stateChaîneObligatoire

Statut

Exemple: "active"
version_numberEntierObligatoire

Version

Exemple: 1

Champs supplémentaires: Non

ProductFileListData

ProductFileListData · Champs, types et contraintes des données acceptées ou renvoyées par l’API. Transmettez les fichiers en multipart/form-data après la création de upload_id, puis associez-les au produit. Le téléchargement exige un jeton Bearer et le droit correspondant à category ; la réponse contient les octets, sans adresse publique ni mot de passe. Pour mode=period, choisissez days (1–3650) ou l’ancien months, jamais les deux. Les conditions sont enregistrées à l’achat ; le remboursement retire uniquement l’accès à la ligne remboursée.
filesTableau <ProductFileData > Obligatoire

Fichiers du produit

Exemple: [{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}]
product_versionEntierObligatoire

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

Exemple: 2

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

ProductVersion

ProductVersion · Cette opération est retirée et renvoie 409 sans modifier les données. Définissez l’accès de chaque fichier numérique avec le choix des destinataires.
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

ReleaseData

ReleaseData · Champs, types et contraintes des données acceptées ou renvoyées par l’API. Transmettez les fichiers en multipart/form-data après la création de upload_id, puis associez-les au produit. Le téléchargement exige un jeton Bearer et le droit correspondant à category ; la réponse contient les octets, sans adresse publique ni mot de passe. Pour mode=period, choisissez days (1–3650) ou l’ancien months, jamais les deux. Les conditions sont enregistrées à l’achat ; le remboursement retire uniquement l’accès à la ligne remboursée.
changelogChaîneObligatoire

Description des modifications

Exemple: "Manual update"
filesTableau <ReleaseFileData > Obligatoire

Fichiers du produit

Exemple: [{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}]
idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée.

format: "uuid"
Exemple: "00000000-0000-4000-8000-000000000001"
manifest_sha256Chaîne nullObligatoire

Versions numériques · SHA-256

Exemple: "1111111111111111111111111111111111111111111111111111111111111111"
published_atChaîne nullObligatoire

Publier la version · UTC

Chaîne:format: "date-time"
Exemple: null
release_sequenceEntier nullObligatoire

Versions numériques · Position dans la collection ordonnée.

Exemple: null
stateChaîneObligatoire

Statut

Exemple: "active"
version_labelChaîneObligatoire

Version

Exemple: "1.0"
withdrawn_atChaîne nullObligatoire

Retirer l’offre · UTC

Chaîne:format: "date-time"
Exemple: null

Champs supplémentaires: Non

ReleaseDraft

ReleaseDraft · Cette opération est retirée et renvoie 409 sans modifier les données. Définissez l’accès de chaque fichier numérique avec le choix des destinataires.
changelogChaîneFacultatif

Description des modifications

maxLength: 20000
Valeur par défaut: ""
expected_versionEntierObligatoire

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

minimum: 1maximum: 9223372036854775807
Exemple: 1
version_idsTableau <Chaîne> Obligatoire

Version · UUID[]

minItems: 1maxItems: 20
Tableau:format: "uuid"
Exemple: ["00000000-0000-4000-8000-000000000001"]
version_labelChaîneObligatoire

Version

minLength: 1maxLength: 64
Exemple: "1.0"

Champs supplémentaires: Non

ReleaseFileData

ReleaseFileData · Champs, types et contraintes des données acceptées ou renvoyées par l’API. Transmettez les fichiers en multipart/form-data après la création de upload_id, puis associez-les au produit. Le téléchargement exige un jeton Bearer et le droit correspondant à category ; la réponse contient les octets, sans adresse publique ni mot de passe. Pour mode=period, choisissez days (1–3650) ou l’ancien months, jamais les deux. Les conditions sont enregistrées à l’achat ; le remboursement retire uniquement l’accès à la ligne remboursée.
file_idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée. · file_id

format: "uuid"
Exemple: "00000000-0000-4000-8000-000000000001"
sort_orderEntierObligatoire

Position dans la collection ordonnée.

Exemple: 0
version_idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée. · version_id

format: "uuid"
Exemple: "00000000-0000-4000-8000-000000000001"

Champs supplémentaires: Non

ReleaseListData

ReleaseListData · Champs, types et contraintes des données acceptées ou renvoyées par l’API. Transmettez les fichiers en multipart/form-data après la création de upload_id, puis associez-les au produit. Le téléchargement exige un jeton Bearer et le droit correspondant à category ; la réponse contient les octets, sans adresse publique ni mot de passe. Pour mode=period, choisissez days (1–3650) ou l’ancien months, jamais les deux. Les conditions sont enregistrées à l’achat ; le remboursement retire uniquement l’accès à la ligne remboursée.
current_release_idChaîne nullObligatoire

Identifiant de ressource ; conserver la valeur renvoyée. · current_release_id

Chaîne:format: "uuid"
Exemple: "00000000-0000-4000-8000-000000000001"
product_versionEntierObligatoire

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

Exemple: 2
releasesTableau <ReleaseData > Obligatoire

Versions numériques

Exemple: [{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}]
update_daysEntier nullObligatoire

Nombre de jours (days; null)

Exemple: 365
update_modeChaîneObligatoire

Accès aux futurs fichiers après achat: none / period / unlimited

Exemple: "period"
update_monthsEntier nullObligatoire

Mois (months; null)

Exemple: null

Champs supplémentaires: Non

UpdatePolicy

UpdatePolicy · Cette opération est retirée et renvoie 409 sans modifier les données. Définissez l’accès de chaque fichier numérique avec le choix des destinataires.
daysEntier nullFacultatif

Nombre de jours (1–3650; mode=period; months=null)

Entier:minimum: 1maximum: 3650
Exemple: 365
expected_versionEntierObligatoire

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

minimum: 1maximum: 9223372036854775807
Exemple: 1
modeChaîneObligatoire

Accès aux futurs fichiers après achat: none / period / unlimited

Contraintes
enum
["none", "period", "unlimited"]
Exemple: "period"
monthsEntier nullFacultatif

Mois (1–120; mode=period; days=null)

Entier:minimum: 1maximum: 120
Exemple: null

Champs supplémentaires: Non

UploadCreate

UploadCreate · Champs, types et contraintes des données acceptées ou renvoyées par l’API. Transmettez les fichiers en multipart/form-data après la création de upload_id, puis associez-les au produit. Le téléchargement exige un jeton Bearer et le droit correspondant à category ; la réponse contient les octets, sans adresse publique ni mot de passe. Pour mode=period, choisissez days (1–3650) ou l’ancien months, jamais les deux. Les conditions sont enregistrées à l’achat ; le remboursement retire uniquement l’accès à la ligne remboursée.
filenameChaîneObligatoire

Fichier

minLength: 1maxLength: 255
Exemple: "manual.pdf"
product_idChaîne nullFacultatif

Identifiant du produit.

Contraintes · Chaîne 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Exemple: "example"
sha256ChaîneObligatoire

SHA-256 (hex, 64)

Contraintes
pattern
"^[0-9a-f]{64}$"
Exemple: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesEntierObligatoire

Taille en octets

minimum: 1maximum: 262144000
Exemple: 46

Champs supplémentaires: Non

UploadData

UploadData · Champs, types et contraintes des données acceptées ou renvoyées par l’API. Transmettez les fichiers en multipart/form-data après la création de upload_id, puis associez-les au produit. Le téléchargement exige un jeton Bearer et le droit correspondant à category ; la réponse contient les octets, sans adresse publique ni mot de passe. Pour mode=period, choisissez days (1–3650) ou l’ancien months, jamais les deux. Les conditions sont enregistrées à l’achat ; le remboursement retire uniquement l’accès à la ligne remboursée.
categoryFileCategory Obligatoire

Catégorie de fichier: internal / customer_document / digital

Exemple: "digital"
expires_atChaîneObligatoire

Date et heure d'expiration du jeton.

format: "date-time"
Exemple: "2026-01-01T12:00:00Z"
filenameChaîneObligatoire

Fichier

Exemple: "manual.pdf"
idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée.

format: "uuid"
Exemple: "00000000-0000-4000-8000-000000000001"
product_idChaîne nullObligatoire

Identifiant du produit.

Exemple: "example"
received_bytesEntierObligatoire

Envoi en cours… · Taille en octets

Exemple: 46
sha256ChaîneObligatoire

SHA-256 (hex, 64)

Exemple: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesEntierObligatoire

Taille en octets

Exemple: 46
statusChaîneObligatoire

Statut accepté par cette opération précise.

Exemple: "ready"

Champs supplémentaires: Non