Expéditions

Nécessite une clé API — voir Authentification. Les deux points de terminaison sont en lecture seule (GET).

Lister les expéditions

GET /v1/shipments

Paramètres de requête

Paramètre	Type	Défaut	Notes
`limit`	integer	`50`	Max `200`.
`offset`	integer	`0`
`status`	string	—	Correspondance exacte sur le statut de l’expédition (p. ex. `in_transit`). Omettez-le pour renvoyer les expéditions quel que soit leur statut.

Les résultats sont triés par createdAt décroissant.

Exemple de requête

curl -H "Authorization: Bearer lk_YOUR_KEY" \
  "https://tenant.logistall.cloud/api/v1/shipments?limit=2&status=in_transit"

Exemple de réponse

[
  {
    "id": "3f1c9c2a-6b3e-4b3a-9b2d-1a2b3c4d5e6f",
    "shipmentNumber": "SHP-00482",
    "status": "in_transit",
    "mode": "ftl",
    "originCity": "Casablanca",
    "destCity": "Tanger",
    "pickupScheduledAt": "2026-07-10T08:00:00.000Z",
    "deliveryScheduledAt": "2026-07-12T17:00:00.000Z",
    "createdAt": "2026-07-08T14:22:03.000Z"
  },
  {
    "id": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
    "shipmentNumber": "SHP-00479",
    "status": "in_transit",
    "mode": "ocean",
    "originCity": "Casablanca",
    "destCity": "Marrakech",
    "pickupScheduledAt": "2026-07-09T09:30:00.000Z",
    "deliveryScheduledAt": "2026-07-14T00:00:00.000Z",
    "createdAt": "2026-07-07T11:05:47.000Z"
  }
]

mode vaut l’une des valeurs ftl, ltl, parcel, air, ocean, rail, intermodal. originCity/destCity peuvent être null si l’expédition n’a pas d’emplacement d’origine ou de destination enregistré.

Récupérer une expédition

GET /v1/shipments/:id

Mêmes champs que le point de terminaison de liste, plus un tableau tracking — la chronologie de suivi complète de l’expédition, événement le plus récent en premier.

Exemple de requête

curl -H "Authorization: Bearer lk_YOUR_KEY" \
  https://tenant.logistall.cloud/api/v1/shipments/3f1c9c2a-6b3e-4b3a-9b2d-1a2b3c4d5e6f

Exemple de réponse

{
  "id": "3f1c9c2a-6b3e-4b3a-9b2d-1a2b3c4d5e6f",
  "shipmentNumber": "SHP-00482",
  "status": "in_transit",
  "mode": "ftl",
  "originCity": "Casablanca",
  "destCity": "Tanger",
  "pickupScheduledAt": "2026-07-10T08:00:00.000Z",
  "deliveryScheduledAt": "2026-07-12T17:00:00.000Z",
  "createdAt": "2026-07-08T14:22:03.000Z",
  "tracking": [
    {
      "eventType": "departure",
      "status": "in_transit",
      "city": "Casablanca",
      "eventAt": "2026-07-10T09:15:00.000Z"
    },
    {
      "eventType": "pickup",
      "status": "pickup_scheduled",
      "city": "Casablanca",
      "eventAt": "2026-07-10T08:05:00.000Z"
    }
  ]
}

tracking[].eventType vaut l’une des valeurs pickup, departure, arrival, in_transit, out_for_delivery, delivered, exception, customs_hold, attempt_failed, returned. tracking[].status est le statut de l’expédition au moment de cet événement.

Erreurs

Statut	Corps	Quand
`404`	`{ "error": "Not found" }`	Aucune expédition avec cet `id`.
`401`	voir Authentification	Clé manquante/invalide.
`500`	`{ "error": "Database error" }`	Erreur serveur inattendue.

C’est la même chronologie de suivi que celle visible dans l’application sur la page Expéditions, et les mêmes données qu’un lien de suivi public expose au destinataire d’une expédition sans authentification. Voir la page Expéditions du Guide utilisateur pour l’ajout des événements de suivi.