Passer au contenu principal
POST
Créer une location

Autorisations

Authorization
string
header
requis

Clé API lck_… créée dans Lexio (Paramètres → Développeur), envoyée en Authorization: Bearer. Voir Authentification.

En-têtes

Idempotency-Key
string
requis

Clé unique de l’opération, réutilisée à chaque nouvel essai : un rejeu avec la même clé et le même corps renvoie la réponse initiale sans rien réécrire. Voir Idempotence. Facultative avec ?dryRun=true sur les opérations qui l’acceptent.

Required string length: 1 - 255
Pattern: ^[\x20-\x7E]+$
Exemple:

"8b3e1d2c-4a5f-4c6b-9e7d-1f2a3b4c5d6e"

Corps

application/json
quoteId
string<uuid>

Devis de POST /quotes, consommé une fois : seule source du véhicule, de la période et des entrées de prix, alors absents du corps.

Exemple:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

vehicleId
string<uuid>

Sans quoteId, obligatoire : véhicule à louer.

Exemple:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

startAt
string

Sans quoteId, obligatoire : départ, heure murale de l’agence sans décalage.

Exemple:

"2026-11-10T10:00"

endAt
string

Sans quoteId, obligatoire : retour, heure murale de l’agence sans décalage.

Exemple:

"2026-11-10T10:00"

mileagePackageId
string<uuid> | null

Forfait kilométrique. Omis : forfait par défaut de l’organisation ; null : kilométrage illimité.

Exemple:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

deductibleId
string<uuid> | null

Franchise. Omis : franchise par défaut de la catégorie du véhicule, sinon de l’organisation ; null : sans franchise.

Exemple:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

depositId
string<uuid> | null

Caution. Omis : caution liée à la franchise retenue si elle est active, sinon caution par défaut de la catégorie, sinon de l’organisation, y compris avec deductibleId: null ; null : sans caution.

Exemple:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

options
object[]

Sans quoteId : options et quantités, règles de POST /quotes.

Maximum array length: 50
charges
object[]

Sans quoteId, clé interne seulement : frais ou remises libres.

Maximum array length: 20
promoCode
string | null

Code promo, sans distinction de casse ; refusé → 422 PROMO_CODE_REJECTED (reason).

Required string length: 1 - 50
isVatReverseCharge
boolean

Sans quoteId, clé interne seulement : autoliquidation de la TVA, possible si isVatReverseChargeAvailable de GET /organization est vrai.

customerId
string<uuid>

Client existant (GET /customers), clé interne seulement.

Exemple:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

customer
object

Titulaire particulier : repris par email parmi les fiches de votre code partenaire, sinon créé (effects.customerResolution).

partnerReference
string | null

Votre numéro de commande, unique par code partenaire (doublon → 409 ALREADY_EXISTS).

Required string length: 1 - 255
source
enum<string>

Canal de vente, ONLINE par défaut. Une clé partenaire ne peut envoyer que PARTNER, que porte toujours sa location.

Options disponibles:
ONLINE,
PHONE,
WALKIN,
PARTNER,
OTHER
pickupLocation
object | null

Lieu de départ ; omis ou null : aucun.

returnLocation
object | null

Lieu de retour ; omis ou null : aucun.

notes
string | null

Note libre.

Required string length: 1 - 2000
internalNotes
string | null

Note interne (clé interne seulement) : visible de l’équipe dans Lexio, jamais sur un document client ; clé partenaire → 400 not_applicable.

Required string length: 1 - 2000

Réponse

Créer une location

data
object
requis

Location, dans la même représentation pour la lecture, la liste et chaque écriture. Montants dans currency, voir Montants et TVA.

Exemple:
effects
object
requis