Schéma ioCanto

Sous le lien suivant, vous pouvez consulter le schéma ioCanto, où toutes les données sont spécifiées : ioCanto Spec à GitLab.

Pour chaque type de données, un exemple est également disponible, montrant à quoi doit ressembler le résultat : Exemples à GitLab.

Structure du schéma ioCanto

Le schéma est divisé en deux domaines principaux : Definitions et Properties. Ces éléments sont expliqués plus en détail ci-dessous.

Definitions

Elles regroupent toutes les définitions valides concernant les types de champs ou les listes de valeurs définies pour certains champs. Quelques exemples :

Structure de la logique de tarification.
Caractères autorisés pour les numéros d'article.
Multiplication des prix et valeurs en pourcentage par un facteur de 100'000.

Parmi les domaines de valeurs, on trouve par exemple :

Codes pays
Formes juridiques
Statut de disponibilité
Unités d’emballage
Unités de mesure

Properties

Les Properties représentent les types de données au sein de Mercanto et décrivent leur structure détaillée : type, descriptions, champs obligatoires, etc.

Structuration des données

Les champs sont attribués à un seul type de données. La structure de base est la suivante :

Niveau 1	Type de données	p. ex. `product_abstract`, `order_deadline_time`
Niveau 2	Objet de données	p. ex. `catalog`, `price_group`
Niveau 3	Champ	p. ex. `base_measurement_code`, `no_public_price`

Les objets de données sont utilisés lorsqu’il existe plusieurs champs liés et/ou dépendants.
Exemple : warehousing. Contient les champs type, environment et shelf_life_days.

À la fin de chaque type de données, les champs obligatoires sont indiqués.

Catégorisation des champs de données

Pour chaque champ, au minimum les éléments suivants sont indiqués :

`key`	Clé unique du champ
`type`	Type du champ : `string`, `integer`, `number`, `object` ou `array`

Des informations supplémentaires peuvent être fournies :

`title`	Titre du champ
`description`	Description (complémentaire) du champ et de son utilisation prévue
`$ref`	Référence aux définitions
`minimum`	Valeur minimale autorisée pour l’input
`maximum`	Valeur maximale autorisée
`maxLength`	Longueur maximale autorisée
`enum`	Valeurs acceptées
`default`	Valeur par défaut si aucun contenu n’est fourni

Contenu des fichiers pour l’identification

Chaque fichier JSON doit contenir, en plus de ses champs spécifiques, les champs globaux suivants au début :

merchant : contient le key défini lors de la création du fournisseur
version : version actuelle du schéma, disponible auprès de l’équipe Mercanto Onboarding

Champs dépendant de la langue

Lors de la création d’un fournisseur dans Mercanto, une langue souhaitée est définie comme langue par défaut.
Lors de l’import de champs dépendant de la langue (définis dans ioCanto via localized_text), la langue par défaut doit toujours être fournie. Il est également défini quelles langues vous, en tant que fournisseur, souhaitez supporter. Pour ces langues supportées, des traductions peuvent être fournies dans le locale correspondant : de_CH, fr_CH, it_CH, en_GB. Remarque : Toutes les langues non fournies seront automatiquement remplacées par le contenu de la langue par défaut.