POST
Créer une mission

Autorisations

X-Api-Key
string
header
requis

Clé API liée à un groupe (med_live_… en production, med_test_… en test). Fournie en clair une seule fois à la création depuis le profil client.

En-têtes

Idempotency-Key
string

Clé d'idempotence fournie par le client (un UUID v4 par opération), conservée 24 h. Recommandée sur toutes les créations. Rejouer la même clé avec un corps identique sur la même route renvoie la réponse en cache (Idempotent-Replayed: true). L'empreinte couvre la méthode, le chemin (donc la mission visée) et le corps : la même clé pour une autre requête renvoie 409 idempotency_key_reused. Requête identique encore en traitement : 409 request_in_progress avec Retry-After.

Les réponses 5xx, 404 et 422 documents_failed ne sont pas mémorisées : un nouvel essai avec la même clé et le même corps est retraité.

Après un 502 (code: relay_timeout), une erreur réseau ou un 5xx, réessayez avec la même clé et le même corps : la requête est relancée, et une mission créée malgré l'erreur vous est renvoyée (201, Idempotent-Replayed: true) au lieu d'être créée une seconde fois. Exception : si la réponse porte outcome_unknown: true, ne réessayez pas, vérifiez d'abord (GET /transports). Seuls la création de mission et le dépôt de documents sont dédoublonnés ainsi ; sans clé, un nouvel essai peut créer un doublon.

Exemple:

"1f3c2b7a-9d4e-4a1b-8c2f-0e6d5a4b3c2d"

Corps

application/json

Requête de création d'une mission. Requis : le véhicule (vehicle ou son alias car) avec son immatriculation (registration) ; pickup et delivery, chacun avec address, date (ISO 8601 UTC avec millisecondes), contact (name, phone, mail) et le créneau start_time / end_time sauf need_appointment: true ; billing avec company_name, address et email.

pickup
object
requis

Point d'enlèvement — objet requis avec address, date, contact (name, phone, mail) et le créneau start_time / end_time (sauf need_appointment: true). L'adresse RÉSOLUE est renvoyée dans la réponse.

delivery
object
requis

Point de livraison — mêmes exigences que pickup.

billing
object
requis

Facturation. company_name, address et email sont toujours requis, même quand vous désignez l'entité par entity_id. S'il en manque un, la création est refusée en 422 et errors[] nomme chaque champ manquant (billing.company_name, billing.address, billing.email — ce dernier doit aussi être une adresse e-mail valide).

L'entité de facturation MED est résolue côté serveur et posée sur la mission, dans cet ordre : entity_id explicite → siret (parmi vos entités) → email (présent dans les e-mails d'une de vos entités) → entité par défaut du donneur d'ordre. Si rien ne correspond, la création est refusée : 422 avec code: billing_entity_required. Une entity_id inconnue, archivée ou n'appartenant pas à votre compte / groupe renvoie 422 avec code: billing_entity_not_allowed. L'entité retenue est renvoyée dans billing.entity_id de la réponse.

type
string

Type de transport.

vehicle
object

Caractéristiques du véhicule (alias car) — requis, avec registration. electric vaut false par défaut.

car
object

Alias de vehicle.

options
string[]
description
string
fuel_refunded
boolean
défaut:false

Carburant remboursé sur l'aller. S'ajoute au réglage de votre compte (un compte déjà en « carburant remboursé » le reste).

order_reference
string

Votre référence de commande (bon de commande, dossier…), reprise sur la mission et ses documents.

return_trip

Trajet retour (optionnel). Le départ du retour est AUTOMATIQUEMENT le lieu de LIVRAISON de l'aller (le convoyeur repart de là où il a livré) : ne renseignez donc QUE la destination du retour, jamais un point de départ. Formes acceptées :

  • true = A→B→A (retour au point d'enlèvement de l'aller) ; - une chaîne = A→B→C (adresse de destination du retour) ; - un objet = forme complète (CreateReturnTripInput). En forme courte (true / chaîne), le retour reprend le véhicule de l'aller, la date de livraison de l'aller et le contact de livraison de l'aller (à défaut, celui d'enlèvement), sans créneau : il est créé en attente de rendez-vous. En forme objet, delivery.address et delivery.date sont requis (et le créneau, sauf need_appointment: true) ; véhicule et contact omis héritent de l'aller.
plateau
boolean
wgarage
boolean

Réponse

Mission créée. Un nouvel essai avec le même Idempotency-Key et le même corps renvoie cette même réponse.

id
string | null
requis

Identifiant de la mission (offer_id). À conserver : il sert à tous les appels suivants.

transport_id
string | null
requis

Référence métier (M-xxxxx). Vaut null dans cette réponse : elle est attribuée juste après la création et se lit ensuite via GET /transports/{id}.

Exemple:

null

status
string
défaut:scheduled
requis
Exemple:

"scheduled"

price
string | null
requis

Prix HT facturé pour l'aller, sous forme de chaîne décimale (ex. "407.44", ou "180" sans décimales), majorations comprises. Convertissez-la en nombre côté client. Le prix détaillé (price { amount_ht, surcharge_ht, currency }) et celui du retour (return_trip.price) se lisent via GET /transports/{id}.

Exemple:

"407.44"

pickup
object
requis

Adresse d'enlèvement RÉSOLUE effectivement utilisée pour la mission.

delivery
object
requis

Adresse de livraison RÉSOLUE effectivement utilisée pour la mission.

return_trip
object | null
requis

Adresses résolues du retour si présent, sinon null.

billing
object | null

Entité(s) de facturation MED posée(s) sur la mission.