Url de l'API
Il est disponible sur /api/ecommerce/listing-public
L'Api retourne un JSON avec 4 sections
Section Magasin
Si vous avez plus d'un magasin visible en ligne, la section "Stores" sera visible
La liste des magasins inclue le "Id", le nom "Name" et optionnellement "Info" qui représente le même texte qui est imprimé dans l'en-tête des factures en magasin et le logo du magasin si spécifié.
Section Catégories
Ensuite la section des catégories affiche l'ensemble des catégories principales et secondaires de vos produits. Les données sont en hiérarchies comme pour la boutique en ligne.
"Categories": [
{
"Id": 281,
"Title": "Épicerie",
"Url": "/fr/Epicerie-c281",
"UrlImage": "https://images.comelin.com/67/1454/w300/farine-250g-def.webp"
}
{
"Id": 75,
"Title": "Divestissement",
"Url": "/fr/Divestissement-c75",
"UrlImage": "https://images.comelin.com/67/1355/w350/Divestissement-def.webp",
"SubCategories": [
{
"Id": 190,
"Title": "Auto téléguider",
"Url": "/fr/Divestissement-Auto-teleguider-c190",
"UrlImage": "https://images.comelin.com/67/259/w300/UC6-TRUCK-CRAWLER-KIT-1-10-SCALE-6X6-def.webp"
},
{
"Id": 125,
"Title": "Casse-tête",
"Url": "/fr/Divestissement-Casse-tete-c125",
"UrlImage": "https://images.comelin.com/67/73/w300/Casse-tete-La-mere-et-l-enfant-Basmati-def.webp"
},
{
"Id": 126,
"Title": "Jeux sociétés",
"Url": "/fr/Divestissement-Jeux-societes-c126",
"UrlImage": "https://images.comelin.com/67/66/w300/Serpents-et-Echelles-def.webp"
},
{
"Id": 127,
"Title": "Légo",
"Url": "/fr/Divestissement-Lego-c127",
"UrlImage": "https://images.comelin.com/67/185/w300/Ninjago-Le-temple-de-la-lumiere-Vert-def.webp"
}
]
}
]
Les catégories permettent de créer le menu de navigation et aussi les fils d'Ariane pour les produits. Ex: si le produit est dans la catégorie 126. On peut alors afficher Divertissement > Jeux de société

Un produit peut être associé à plus d'une catégorie. La première étant sa catégorie principale.

Si une catégorie est vide (sans produit) elle ne sera pas exportée.
Section Marques
La section marques affiches la liste des marques associées au produits. Les propriétés sont les mêmes que les catégories (Id, Title, Url et UrlImage)

Les produits sont associés à une seule marque
Section Produits
Pour que le produit se retrouve dans l'API il doit avoir:
- Un titre
- Un prix de vente
- Une photo
- Une catégorie
- Une description
- Marqué pour être exportable
{
"Id": 45,
"Title": "Monopoly",
"IdCategories": [
126,
211
],
"Url": "/fr/Produit-45-Hasbro-Monopoly-Monopoly",
"UrlImage": "/fr/Produit-45-Hasbro-Monopoly-Monopoly",
"BarCode": "073000000097",
"Price": 42.0,
"PriceDiscount": 39.90,
"Promotion": "20% de rabais",
"IdBrand": 80,
"Description": "Bien qu'il soit satisfaisant de provoquer la faillite d'un autre joueur, être loyal est également payant, car notre fortune peut changer du tout au tout en un lancer de dés! Un joueur ingrat peut bien voir tous les autres joueurs se rallier contre lui. Ce Monopoly classique fait vivre aux joueurs les hauts et les bas des échanges de propriétés. Il suffit de compléter des ensembles de couleur pour construire des maisons et les améliorer pour même y construire des hôtels. Plus on possède de propriétés, plus on peut réclamer de loyers. Les cartes Chance peuvent rapporter gros ou mener les joueurs en prison! Les joueurs voyagent autour de la planchette jusqu'à ce qu'un joueur l'emporte.",
"InStock": 6,
},
Matrice et Variants
Si le produit fait partie d'une matrice (produit avec des variantes) vous aurez les variants comme "Sous-produits".
Dans l'exemple si dessous, le produit "Jus" à une variante "Vert" et "Rouge". La valeur dans "Matrix" permet de faire le menu pour sélectionner la Couleur.
{
"Variants": [{
"Matrix": [{
"Id": 17,
"Title": "Couleur",
"Value": "vert"
"IdsVal": [3],
}
],
"Id": 4196,
"Title": "Jus vert",
"Url": "/fr/Produit-4196-Jus-vert",
"UrlImage": "/fr/Produit-4196-Jus-vert",
"Price": 3.0,
"Description": "Super jus pas bon pour la santé",
}, {
"Matrix": [{
"Id": 17,
"Title": "Couleur",
"Value": "Rouge"
"IdsVal": [4],
}
],
"Id": 4197,
"Title": "Jus chimique Rouge",
"Url": "/fr/Produit-4197-Jus-chimique-Rouge",
"UrlImage": "/fr/Produit-4197-Jus-chimique-Rouge",
"Price": 3.0,
"Description": "Super jus pas bon pour la santé",
"InStock": 1,
}
],
"Id": -4195,
"Title": "Jus",
"IdCategories": [187],
"Price": 3.0,
"Description": "Super jus pas bon pour la santé"
},
Une matrice peut avoir plus d'une valeur, par exemple grandeur et longueur.
Champs personnalisés
Si le produit a des champs personnalisé autres que ceux de la matrice, ceux-ci seront exportés sous la section "Attributes"
"Attributes": [
{
"Id": 8,
"Title": "Fait au Québec",
"IdsVal": [
1
],
"Value": "oui"
}
Inventaire par magasin
Si vous avez plus d'un magasin, l'inventaire par magasin sera visible, le premier chiffre correspond au Id du magasin, le 2e la quantité en inventaire dans ce magasin.
- "InStockPerStore": {
"1": 2,
"2": 4
}

Si le produit n'est pas en inventaire la valeur "InStock" ne sera pas exportée (assumer 0).