S'inscrire
Documentation Dashboard Connexion

Documentation API ColiXpress

Intégrez la livraison à la demande dans votre application avec l'API ColiXpress. Cette documentation couvre les endpoints disponibles pour les développeurs tiers.

Introduction

L'API ColiXpress permet de :

  • Créer des commandes de livraison point-à-point ou depuis une boutique.
  • Suivre l'état des commandes en temps réel.
  • Obtenir une estimation tarifaire.
  • Consulter les boutiques et produits partenaires.
  • Gérer des clés API et recevoir des webhooks.

Authentification

Tous les appels à l'API développeur nécessitent deux headers :

GET /api/v1/orders
X-Api-Key: clx_live_votre_cle_ici
X-Api-Secret: votre_secret_ici

Le secret n'est affiché qu'une seule fois lors de la création de la clé. Il est ensuite stocké de manière irréversible.

URL de base

https://api.colixpress.com

Codes d'erreur

  • 200 — Succès
  • 201 — Ressource créée
  • 401 — Clé API ou secret manquant/invalide
  • 403 — Clé désactivée ou IP non autorisée
  • 404 — Ressource introuvable
  • 422 — Données invalides
  • 429 — Trop de requêtes
  • 500 — Erreur serveur

Commandes

POST /api/v1/orders

Créer une nouvelle commande de livraison.

{
  "order_type": "direct",
  "pickup_address": "Akwa, Douala",
  "pickup_lat": 4.0511,
  "pickup_lng": 9.7679,
  "pickup_contact_name": "Jean Kamga",
  "pickup_contact_phone": "+237691234567",
  "dropoff_address": "Bonaberi, Douala",
  "dropoff_lat": 4.0611,
  "dropoff_lng": 9.7879,
  "dropoff_contact_name": "Marie Ngo",
  "dropoff_contact_phone": "+237699887766",
  "package_description": "Documents",
  "package_size": "petit",
  "package_weight_kg": 0.5,
  "package_value": 5000,
  "payment_method": "cash",
  "external_reference": "ORDER-12345"
}

Paramètres requis : pickup_address, dropoff_address (ou shop_id pour order_type=shop).

GET /api/v1/orders

Lister les commandes créées via votre clé API.

Query params : page, per_page, status.

GET /api/v1/orders/{reference}

Détail d'une commande par sa référence ColiXpress.

GET /api/v1/orders/by-reference/{external_reference}

Rechercher une commande par votre référence externe.

PUT /api/v1/orders/{reference}/cancel

Annuler une commande (uniquement si son statut est pending ou accepted).

{
  "cancellation_reason": "Annulation client"
}

GET /api/v1/orders/{reference}/tracking

Historique des statuts d'une commande.

Estimation

GET /api/v1/estimate

Obtenir une estimation de prix avant de créer une commande.

Query params :

  • pickup_lat / pickup_lng — Coordonnées départ
  • dropoff_lat / dropoff_lng — Coordonnées arrivée
  • city — Ville (défaut: Douala)
  • package_size — petit, moyen ou grand
  • package_weight_kg — Poids en kg
  • package_value — Valeur déclarée en XAF
{
  "success": true,
  "data": {
    "distance_km": 2.48,
    "price": 1000,
    "currency": "XAF",
    "city": "Douala"
  }
}

Boutiques

GET /api/v1/shops

Lister les boutiques approuvées.

Query params : category_id, city, page, per_page.

GET /api/v1/shops/{id}

Détail d'une boutique incluant ses produits.

Données de référence

GET /api/v1/countries

Liste des pays supportés (indicatifs, devises, longueurs de numéro).

GET /api/v1/pricing

Règles de tarification actives par ville.

Gestion des clés API

Ces endpoints nécessitent une authentification Bearer (compte développeur connecté).

POST /api/developer/api-keys

Créer une nouvelle paire de clés API.

{
  "name": "Mon application",
  "webhook_url": "https://monapp.com/webhook",
  "allowed_ips": "1.2.3.4,5.6.7.8"
}

GET /api/developer/api-keys

Lister vos clés API.

PUT /api/developer/api-keys/{id}

Mettre à jour une clé (nom, webhook, IP autorisées, statut, mode test).

POST /api/developer/api-keys/{id}/regenerate-secret

Régénérer le secret d'une clé. L'ancien secret est immédiatement invalidé.

Webhooks

Les webhooks sont envoyés à l'URL configurée sur votre clé API lors des changements de statut des commandes. Le payload inclut :

{
  "event": "order.status_updated",
  "order_reference": "COL-2026-XXXXXX",
  "external_reference": "ORDER-12345",
  "status": "in_transit",
  "timestamp": "2026-09-20T12:34:56Z"
}

Vérifiez la signature via le secret webhook partagé lors de l'ouverture du compte.

Besoin d'aide ?

Contactez l'équipe technique à support@colixpress.com ou sur WhatsApp.