Skip to main content
Qargo

FAQ – API Qargo : options disponibles

Qargo propose des API pour la saisie et le statut des commandes, l'exécution des tournées, la synchronisation des données de référence et la comptabilité, selon 3 rôles : tenant, client et sous-traitant.

Table des matières
  1. Quelles sont les options disponibles ?

Q. Qargo propose-t-il une API ? Si oui, quelles fonctions sont disponibles ?

R. Oui ! Qargo propose des API pour un certain nombre de fonctions de la plateforme. Pour une API, 3 rôles sont à prendre en compte, car ils ont un impact sur la configuration de l’intégration.

  • Tenant : l’intégration est configurée directement entre Qargo et un système tiers.
  • Client : l’intégration est configurée sur un client (du compte Qargo) et implique le transfert de données depuis son système vers Qargo ; par exemple, lorsque le client souhaite créer une connexion au portail client pour soumettre des commandes.
  • Sous-traitant : l’intégration est configurée sur un sous-traitant et implique le transfert de données depuis son système vers Qargo ; par exemple, lorsque le sous-traitant souhaite renvoyer des mises à jour depuis son propre TMS vers Qargo.

Quelles sont les options disponibles ?

Saisie de commande et statut / documents (tenant / client)

  • Créer des commandes depuis un système externe (2 options de flux)

  • Statuts vers le système externe

    • Deux flux :

      • Pull : le système externe récupère le statut de la commande au niveau de la commande (sans les arrêts)
      • Push : Qargo envoie une mise à jour de statut en temps réel au système externe via un webhook

Exécution des tournées – Envoi de tournée / mises à jour. (sous-traitant)

API Qargo TMS – Document de spécification sous-traitant

  • Envoyer l’affectation de la tournée au système externe

    • Créer / mettre à jour / annuler
  • Envoyer des mises à jour (de commande)

    • Date de l’arrêt
    • Détails de la cargaison
    • Annulée (retirée) de la tournée
  • Recevoir des mises à jour (de tournée)

    • Statut d’exécution au niveau de chaque arrêt
    • Mises à jour des documents (POD)

Synchronisation des données de référence (tenant uniquement)

Document de spécification de l’API Qargo TMS

La synchronisation est bidirectionnelle : elle met à jour les données entrantes dans Qargo et renvoie les mises à jour de Qargo vers la plateforme tierce.

  • Synchroniser les données des clients et des sous-traitants depuis un système externe

    • Création, mise à jour, archivage (suppression) des données clients
  • Synchroniser les ressources depuis un système externe

    • Créer, mettre à jour et archiver (supprimer) la disponibilité des ressources de la flotte propre (chauffeurs / véhicules)
    • Exemple : un nouveau véhicule ou un nouveau chauffeur créé dans le système tiers est ajouté aux ressources de Qargo.

Comptabilité (tenant uniquement)

Document de spécification de l’API Qargo TMS

  • Synchroniser les factures et les avoirs de Qargo vers un système externe

    • Mettre à jour les factures depuis le système externe

    • Mettre à jour le statut de paiement des factures / avoirs

    • Les avoirs d’achat sont désormais également pris en charge.

    • Bloquer un client (statut du client – Prospect, etc.)