Documentation API

Intégrez GoAnt comme option de livraison sur votre boutique en ligne.

Référence API

Interface Swagger UI

L’interface Swagger interactive est disponible sur votre instance GoAnt déployée. Elle vous permet de tester les requêtes de l’API.

Ouvrir Swagger UI →

Authentification

Toutes les requêtes nécessitent un jeton Bearer dans l’en-tête Authorization.

Authorization: Bearer <votre_token>

Créer une livraison

POST /api/v1/livraisons
{
  "pickup": {
    "address": "12 rue de Rivoli, 75001 Paris",
    "contact": "Sophie Martin",
    "phone": "+33612345678"
  },
  "delivery": {
    "address": "45 boulevard Voltaire, 75011 Paris",
    "contact": "Jean Dupont",
    "phone": "+33698765432"
  },
  "package": {
    "weight_kg": 1.5,
    "notes": "Fragile"
  }
}

Vérifier une zone

GET /api/v1/zones/check?address=

Vérifiez si une adresse est couverte par GoAnt avant de proposer l’option de livraison au moment de la commande.

Suivre une livraison

GET /api/v1/livraisons/:id/tracking

Retourne la position en temps réel du livreur et le statut de la livraison.

Webhooks

Recevez des notifications automatiques sur les changements de statut de vos livraisons.

// Événements disponibles :
// livraison.creee
// livreur.assigne
// livraison.en_cours
// livraison.livree
// livraison.echouee