L'appel des API se fait via l'url https://partner.motelservices.fr/api/v1
Chaque établissement possède un ou plusieurs points de vente. Dans M-System, les points de ventes s'appellent des caisses.
Les paramètres sont à passer en POST
Exemple d'appel en cURL
/etablissement
Récupère la liste des points de vente du compte, ainsi que quelques informations générales.
Champ | Type | Description |
---|---|---|
id_etablissement | String | Obligatoire. Le numéro de compte du client. Il se trouve en bas de la page 'Profil' du back office. |
token | String | Obligatoire. Le token du client. Une chaîne de caractères que que client demande à M-System. |
Un objet JSON avec la structure suivante :
Champ | Type | Description |
---|---|---|
message | String | Des informations sur l'éxecution de l'appel. "OK" en cas de succès, un message d'erreur sinon |
nom | String | Le nom de l'établissement |
caisses | JSON Array | Un tableau JSON contenant la liste des points de vente de l'établissement |
→id_caisse | String | L'identifiant de la caisse |
→libelle | String | Le libellé de la caisse |
types_paiement | JSON Array | Un tableau contenant les libellés des types de paiement |
→libelle | String | Le libellé du type de paiement |
/produits
Récupère la liste des produits du compte. Tous les produits actifs sont renvoyés.
Champ | Type | Description |
---|---|---|
id_etablissement | String | Obligatoire. Le numéro de compte du client. Il se trouve en bas de la page 'Profil' du back office. |
token | String | Obligatoire. Le token du client. Une chaîne de caractères que que client demande à M-System. |
Un objet JSON avec la structure suivante :
Champ | Type | Description |
---|---|---|
message | String | Des informations sur l'éxecution de l'appel. "OK" en cas de succès, un message d'erreur sinon |
data | JSON Array | Un tableau JSON contenant la liste des produits |
→id_produit | String | L'identifiant du produit |
→id_categorie | String | L'identifiant de la catégorie du produit |
→categorie | String | La catégorie du produit |
→libelle | String | Le libellé du produit |
→taux_tva | String | Le taux de TVA du produit. 0.1 = TVA 10% |
/ventes
Récupère la liste des ventes sur une période donnée. Les résultats sont renvoyés de la table du journal par rowid croissant. Les résultats sont paginés par paquets de 500.
Champ | Type | Description |
---|---|---|
id_etablissement | String | Obligatoire. Le numéro de compte du client. Il se trouve en bas de la page 'Profil' du back office. |
token | String | Obligatoire. Le token du client. Une chaîne de caractères que que client demande à M-System. |
date_debut | String | Obligatoire. La date de début de la période des ventes à récupérer. Format à saisir : YYYY-MM-DD |
date_fin | String | Obligatoire. La date de fin de la période des ventes à récupérer. Format à saisir : YYYY-MM-DD |
current_page | String | Optionnel. Le numéro de page du journal à récupérer. Si il n'est pas spécifié, la page 1 est renvoyée. |
id_caisse | String | Optionnel. Filtre pour ne récupérer les ventes que sur certaines caisses. Séparateur : virgule |
Un objet JSON avec la structure suivante :
Champ | Type | Description |
---|---|---|
message | String | Des informations sur l'éxecution de l'appel. "OK" en cas de succès, un message d'erreur sinon |
total_pages | Int | Le nombre total de pages qui correspond à l'intervalle demandé |
current_page | Int | Le numéro de la page courante |
data | JSON Array | Un tableau JSON contenant la liste des ventes |
→id | String | Le numéro de la ligne dans la table du journal |
→id_transaction | String | L'identifiant de la transaction. Une transaction comporte un ou plusieurs produits. |
→id_produit | String | L'identifiant du produit |
→produit | String | Le libellé du produit |
→taux_tva | String | Le taux de TVA du produit. 0.1 = TVA 10% |
→id_caisse | String | L'identifiant de la caisse où a eu lieu la transaction |
→caisse | String | Le libellé de la caisse où a eu lieu la transaction |
→type_paiement | String | Le libellé du type de paiement de la transaction |
→quantite | String | La quantité du produit dans la transaction |
→montant_ttc | String | Le montant ttc du produit dans la transaction (est égal au prix unitaire x la quantité) |
→montant_ht | String | Le montant ht du produit dans la transaction (est égal au prix unitaire ht x la quantité) |
/ventes2
Récupère la liste des ventes sur une période donnée. Les résultats sont renvoyés de la table du journal par id_transaction croissant. Les résultats sont paginés par paquets de 500. Les données sont présentées sous une autre forme que dans /ventes
Champ | Type | Description |
---|---|---|
id_etablissement | String | Obligatoire. Le numéro de compte du client. Il se trouve en bas de la page 'Profil' du back office. |
token | String | Obligatoire. Le token du client. Une chaîne de caractères que que client demande à M-System. |
date_debut | String | Obligatoire. La date de début de la période des ventes à récupérer. Format à saisir : YYYY-MM-DD |
date_fin | String | Obligatoire. La date de fin de la période des ventes à récupérer. Format à saisir : YYYY-MM-DD |
current_page | String | Optionnel. Le numéro de page du journal à récupérer. Si il n'est pas spécifié, la page 1 est renvoyée. |
id_caisse | String | Optionnel. Filtre pour ne récupérer les ventes que sur certaines caisses. Séparateur : virgule |
Un objet JSON avec la structure suivante :
Champ | Type | Description |
---|---|---|
message | String | Des informations sur l'éxecution de l'appel. "OK" en cas de succès, un message d'erreur sinon |
total_pages | Int | Le nombre total de pages qui correspond à l'intervalle demandé |
current_page | Int | Le numéro de la page courante |
data | JSON Array | Un tableau JSON contenant la liste des ventes |
→id_transaction | String | L'identifiant de la transaction. Une transaction comporte un ou plusieurs produits. |
→total_ttc | Float | Le moontant total TTC de la transaction |
→total_ht | Float | Le moontant total HT de la transaction |
→produits | JSON Array | Un tableau JSON avec la liste des produits de la transaction |
→→produit | String | Le libellé du produit |
→→id_produit | String | L'identifiant du produit |
→→taux_tva | String | Le taux de TVA du produit. 0.1 = TVA 10% |
→→quantite | String | La quantité du produit dans la transaction |
→→montant_ttc | Float | Le montant ttc du produit dans la transaction (est égal au prix unitaire x la quantité) |
→→montant_ht | Float | Le montant ht du produit dans la transaction (est égal au prix unitaire ht x la quantité) |
→paiements | JSON Array | La liste des paiements de la transaction |
→→type | String | Le type de paiement |
→→montant | Float | Le montant de la transaction encaissé avec ce type de paiement |
/insert_commande
Insert une commande dans M-System. Cette commande apparait sous forme de note dans l'application.
Champ | Type | Description |
---|---|---|
id_etablissement | String | Obligatoire. Le numéro de compte du client. Il se trouve en bas de la page 'Profil' du back office. |
token | String | Obligatoire. Le token du client. Une chaîne de caractères que que client demande à M-System. |
libelle | String | Obligatoire. Le libellé de la note qui sera affichée dans M-System. |
date_commande | String | Facultatif. La date à laquelle la commande est passée. Si non spécifiée, l'heure d'appel à la page est utilisée. Format : YYYY-MM-DD HH:MM:SS |
id_type_paiement | String | Facultatif. L'identifiant du type de paiement avec lequel cette commande sera encaissée. Si non spécifié, la commande pourra être encaissée avec un type de paiement choisi par l'utilisateur M-System |
id_externe | String | Facultatif. L'identifiant dde la commande dans le système appelant. |
etat_commande | String | Facultatif. L'état de la commande dans le système appelant. |
contenu_commande | Json Array | Obligatoire. Le contenu de la commande |
→id_produit | String | Obligatoire. L'identifiant du produit de la commande |
→quantite | String | Obligatoire. La quantité du produit de la commande |
→prix_unitaire | String | Obligatoire. Le prix unitaire du produit |
Exemple d'appel de la page
Un objet JSON avec la structure suivante :
Champ | Type | Description |
---|---|---|
message | String | Des informations sur l'éxecution de l'appel. "OK" en cas de succès, un message d'erreur sinon |
id_note | String | L'identifiant de la note nouvellement insérée dans M-System |
nb_produits | Float | Le nombre de produits de la note |
montant_commande | Float | Le montant total de la note |