Doc à compléter, cette API est utilisée pour l'application mobile des stats.
Liste des produits provenant de Leo2. Inclut des informations générales sur le produit, son prix, sa classification, son étiquette et quelques préférences clavier.
-
- ID
pilot-get_products
-
- Type de données
- pilot
-
- shop (int)
- Identifiant magasin
-
- (optionnal_parameter)
- id_product (int)
Identifiant produit (si besoin de récupérer uniquement un produit) - id_familly (int)
Identifiant famille - date_create (date)
Date de création (format YYYY-MM-DD) - date_update (date)
Date de mise à jour (format YYYY-MM-DD) - only_in_stock (boolean)
Affiche uniquement les produits en stock - min_date_update (int)
Affiche tous ce qui a été mis à jour depuis un timestamp - ean_list (string)
Filtrage EAN - code barre (séparateur virgule, max 50)
-
- Requête
- /api.php?module=atoo_pilot&type=pilot&method=get_products
Listing des produitsListe des produits provenant de Leo2. Inclut des informations générales sur le produit, son prix, sa classification, son étiquette et quelques préférences clavier.
data (array)
Tableau d'objets
(object)
id (integer)
ID Produit Leo2
id_ext (integer)
Votre ID Produit externe (null si aucun ID associé)
name (string) (maxLength: 60)
Nom long
shortname (string) (maxLength: 30)
Nom court (nom affiché sur la touche en caisse)
identifiers (object)
ref_int (string) (maxLength: 30)
Référence
product_type (integer) (maxLength: 2)
Nature du produit parmi ces choix : ID : 1 - Produit fini | 2 - Composant | 3 - Matière première
barcode (string) (maxLength: 50)
price (object)
ttc (number) (Nombre de decimales: 2)
Prix de base TTC
id_tva (integer)
TVA (ID de la table TVA)
ht (number) (Nombre de decimales: 3)
Prix HT (attention, le prix de référence sur la caisse est le prix TTC, le prix HT affiché ici est indicatif)
ht_purchase (number) (Nombre de decimales: 3)
Prix d'achat HT
sell_min (number) (Nombre de decimales: 2)
Prix de vente Minimum TTC
ecotaxe (number) (Nombre de decimales: 2)
Ecotaxe (Valeur indicative)
options (object)
is_negative (boolean)
Prix négatif
is_weighed_product (boolean)
Produit pesé
tare (number) (Nombre de decimales: 4)
Si Produit pesé, Tare
is_blocked (boolean)
Produit bloqué
with_stock_managment (boolean)
Activer Gestion stock
discount_forbidden (boolean)
Remise interdite
with_lunch_voucher (boolean)
T.R. Autorisé sur ce produit
classification (object)
code_compta (string) (maxLength: 20)
Code comptable (liste disponible avec la méthode get_compta)
id_familly (integer)
ID de la table FAMILLE
id_subfamilly (integer)
ID de la table SOUS_FAMILLE
id_rayon (integer)
ID de la table RAYON
id_categorie (integer)
ID de la table CATEGORIE
id_brand (integer)
ID de la table MARQUE
id_collection (integer)
ID de la table COLLECTION
label (object)
capacity (number) (Nombre de decimales: 3)
Contenance
capacity_unit (integer)
Unité de mesure pour la contenance (ID de la table UNIGEST)
origin (integer)
Origine du produit (ID de la table ORIGINE)
treatments (integer)
Traitements (ID de la table TRAITEMENT)
size (string) (maxLength: 50)
Calibre
keyboard (object)
name (string) (maxLength: 50)
Nom sur Touche caisse
name_on_remote (string) (maxLength: 50)
Nom sur Touche appareil portable
background_color (integer) (Nombre de decimales: 4)
Valeur hexadécimal d'une couleur au format BVR (attention: BVR et non RVB). NB: à la place du code BVR il peux y avoir une valeur comprise entre 0 et 16 qui correspondent à des codes de couleur prédéfinies sur la caisse.
type (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés
-
- ID
pilot-get_products_stock
-
- Type de données
- pilot
-
- shop (int)
- Identifiant magasin
-
- (optionnal_parameter)
- id_product (int)
Identifiant produit (si besoin de récupérer uniquement un produit) - id_familly (int)
Identifiant famille - date_create (date)
Date de création (format YYYY-MM-DD) - date_update (date)
Date de mise à jour (format YYYY-MM-DD) - only_in_stock (boolean)
Affiche uniquement les produits en stock - min_date_update (int)
Affiche tous ce qui a été mis à jour depuis un timestamp - ean_list (string)
Filtrage EAN - code barre (séparateur virgule, max 50)
-
- Requête
- /api.php?module=atoo_pilot&type=pilot&method=get_products_stock
Stock des produitsdata (array)
Tableau d'objets
(object)
id (integer)
ID Produit Leo2
barcode (string) (maxLength: 50)
Code barre (ou code EAN selon usage)
stock (number)
Quantité en stock
type (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés
Récupération des textes informatifs des produitsdata (array)
Tableau d'objets
(object)
infos (array)
Tableau d'objets
(object)
id (integer)
Identifiant info libre
type (string) (maxLength: 50)
Type info (choix parmi les valeurs 'Infos Libres 1' | 'Infos Libres 2' | 'Infos Libres 3')
type (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés Met à jour des textes informations libres et retourne les ID produits mis à jours.
Mise à jour des textes informations libres des produitsMet à jour des textes informations libres et retourne les ID produits mis à jours.
type (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés La remise sur le prix unitaire est soit un montant, soit un pourcentage. On remplira donc uniquement le champs correspondant (amount ou )
Tarifs produits : VentilationLa remise sur le prix unitaire est soit un montant, soit un pourcentage. On remplira donc uniquement le champs correspondant (amount ou )
data (array)
Tableau d'objets
(object)
idProduct (integer)
ID produit
nameProduct (integer)
Nom du produit
prices (array)
Tableau d'objets
(object)
id (integer)
Identifiant unique tarif
amount (number) (Nombre de decimales: 2)
Remise (montant) sur le prix unitaire TTC
percent (number) (Nombre de decimales: 2)
Remise (pourcentage) sur le prix unitaire TTC
id_ventil (integer)
ID Ventilation
type (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés
Mise à jour tarifs produits : Ventilationtype (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés Liste les 100 derniers mouvements de stocks (uniquement ceux fait via l'API) dans la limite des derniers 15 jours
Mouvements de stock (API)Liste les 100 derniers mouvements de stocks (uniquement ceux fait via l'API)
data (array)
Tableau d'objets
(object)
id (integer)
ID LEO2 du mouvement
idProduct (integer)
ID LEO2 produit
nameProduct (integer)
ID LEO2 produit
isAdd (boolean)
1 si entrée de stock, 0 si sortie
quantity (integer)
ID LEO2 du mouvement
extRef (string) (maxLength: 40)
observations (string) (maxLength: 200)
type (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés
Récupération des codes barres des produitsdata (array)
Tableau d'objets
(object)
idProduct (integer)
ID produit
nameProduct (integer)
Nom du produit
mainBarcode (integer)
Code barre principal du produit
altBarcodes (array)
Tableau d'objets
(object)
id (integer)
Identifiant unique code barre
barcode (string)
Code barre
type (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés Met à jour les code barre pour 1 à plusieurs produits et retourne les ID produits mis à jours.
Mise à jour des codes barres des produitsMet à jour les code barre et retourne les ID produits mis à jours.
type (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés
Liste des TVA sur la caissedata (array)
Tableau d'objets
(object)
id (integer)
Identifiant TVA
rate (integer)
Taux de TVA
type (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés Numéro unique identifiant le produit dans le système comptable.
Permet de suivre les mouvements du produit et de générer des rapports comptables.
Classification - Listing numéros Compte comptableNuméro unique identifiant le produit dans le système comptable.
Permet de suivre les mouvements du produit et de générer des rapports comptables.
data (array)
Tableau d'objets
(object)
id (integer)
Identifiant interne LEO2
code_cpt (string)
Identifiant en comptabilité (plan comptable FR)
type (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés
Classification - Listing des groupesdata (array)
Tableau d'objets
(object)
id (integer)
ID LEO2 du groupe
name (string) (maxLength: 30)
Nom du groupe
type (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés
Modification / ajout de groupetype (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés Renseigner un tableau des ID à supprimer
Suppression de groupe(s)Renseigner un tableau des ID à supprimer
type (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés Regroupe les produits en grandes catégories génériques (ex : Alimentaire, Vêtements, Électronique).
Permet une classification large et intuitive des produits.
Classification - Listing des famillesRegroupe les produits en grandes catégories génériques (ex : Alimentaire, Vêtements, Électronique).
Permet une classification large et intuitive des produits.
data (array)
Tableau d'objets
(object)
id (integer)
ID LEO2 de la famille
name (string) (maxLength: 30)
Nom de la famille
group (integer)
Groupe auquel appartient la famille.
sort (integer)
Ordre de tri sur le ticket (valeur entre 1 et 20 ou vide)
printer_prod (string) (maxLength: 400)
Nom de l'imprimante de production à utiliser par défaut
type (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés
Modification / ajout de famillestype (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés Renseigner un tableau des ID à supprimer
Suppression de famille(s)Renseigner un tableau des ID à supprimer
type (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés Subdivision des familles en catégories plus précises.
Offre une classification plus fine des produits.
Classification - Listing des sous-famillesSubdivision des familles en catégories plus précises.
Offre une classification plus fine des produits.
data (array)
Tableau d'objets
(object)
id (integer)
ID LEO2 de la sous-famille
name (string) (maxLength: 50)
Nom de la sous-famille
printer_prod (string) (maxLength: 400)
Nom de l'imprimante de production à utiliser par défaut
type (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés
Modification / ajout de sous famillestype (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés Renseigner un tableau des ID à supprimer
Suppression de sous-famille(s)Renseigner un tableau des ID à supprimer
type (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés Emplacement physique des produits dans le magasin (ex : Fruits et légumes frais, Prêt-à-porter hommes, Téléphonie).
Facilite la localisation des produits.
Classification - Liste des rayonsEmplacement physique des produits dans le magasin (ex : Fruits et légumes frais, Prêt-à-porter hommes, Téléphonie).
Facilite la localisation des produits.
type (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés Classification des produits selon des critères spécifiques (ex : Bio, Éco-responsable).
Permet de répondre aux attentes et aux besoins de clients spécifiques.
Aide à la mise en avant de produits.
Classification - Liste des catégoriesClassification des produits selon des critères spécifiques (ex : Bio, Éco-responsable).
Permet de répondre aux attentes et aux besoins de clients spécifiques.
Aide à la mise en avant de produits.
type (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés Regroupement de produits thématiques ou saisonniers (ex : Collection printemps-été, Collection Noël, ...).
Permet de mettre en avant des produits spécifiques.
Classification - Liste des collectionsRegroupement de produits thématiques ou saisonniers (ex : Collection printemps-été, Collection Noël, ...).
Permet de mettre en avant des produits spécifiques.
type (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés Fabricant ou distributeur des produits.
Permet aux clients de retrouver leurs marques préférées.
Aide à la différenciation des produits et à la fidélisation client.
Classification - Liste des marquesFabricant ou distributeur des produits.
Permet aux clients de retrouver leurs marques préférées.
Aide à la différenciation des produits et à la fidélisation client.
type (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés Pays ou région de provenance des produits (ex : France, Italie, Biologique).
Permet de garantir la traçabilité des produits.
Renseigne les clients sur l'origine et les caractéristiques des produits.
Etiquette - Liste des originesPays ou région de provenance des produits (ex : France, Italie, Biologique).
Permet de garantir la traçabilité des produits.
Renseigne les clients sur l'origine et les caractéristiques des produits.
type (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés Description des traitements spécifiques subis par les produits.
Permet d'informer les clients sur les caractéristiques et les propriétés des produits.
Aide à la sélection des produits pour les clients ayant des besoins spécifiques.
Etiquette - Liste des traitementsDescription des traitements spécifiques subis par les produits.
Permet d'informer les clients sur les caractéristiques et les propriétés des produits.
Aide à la sélection des produits pour les clients ayant des besoins spécifiques.
type (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés Détermine l'unité utilisée pour mesurer la quantité de produit. (Exemple : KG, Litre, Mètre, ...)
Etiquette - Liste des unités de mesure pour la contenance.Détermine l'unité utilisée pour mesurer la quantité de produit. (Exemple : KG, Litre, Mètre, ...)
type (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés
Ventilations - Liste simple des ventilationstype (string)
Type de fluxview (string)
Identifiant de la vuetitle (string)
Titre du fluxowner (string,null)
Propriétairedescription (string)
Description du fluxmethod (string)
Méthode pour générer le fluxgmtDate (string)
Date de génération du fluxplatform (string)
Plateformefilters (string,null)
Filtres utilisés Alertes sur les 7 derniers jours
Nombre de clients par rapport à l'année précédente le même mois.
Moyenne journalière calculée sur les 12 derniers mois
Valeur pour les 12 derniers mois.
Progression de la valeur du panier moyen par rapport à l'année précédente le même mois.
Liste les 10 semaines qui ont la fréquentation la plus faible.
Liste des 20 produits, sur les 30 derniers jours, pour lesquels le bénéfice a été le plus élevé (à droite les bénéfices réalisés)
Liste des 20 produits, sur les 30 derniers jours, pour lesquels il y a eu le plus de ventes (à droite les quantités vendues).
Liste des produits vendus à perte sur les 30 derniers jours.
Répartition du chiffre d'affaires par produit sur les 12 derniers mois.
Répartition du chiffre d'affaires par jour de la semaine sur les 12 derniers mois.
Chiffre d'affaires sur les 12 derniers mois. Les valeurs sont exprimées en TTC.
Chiffre d'affaires sur les 30 derniers jours. Les valeurs sont exprimées en TTC
Bénéfice sur les 12 derniers mois.
Bénéfice sur les 30 derniers jours.
Liste des produits pour lesquels le stock est inférieur aux ventes moyennes journalières (basé sur les ventes moyennes journalières sur les 10 derniers jours)
Liste des produits pour lesquels le stock est inférieur aux ventes sur les 7 derniers jours (basé sur les ventes moyennes journalières sur les 10 derniers jours)
Liste des produits pour lesquels le stock est supérieur aux ventes moyennes mensuelles (basé sur les ventes moyennes journalières sur les 10 derniers jours)