Passer au contenu principal
POST
Créer un forfait kilométrique

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

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.

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

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

Corps

application/json
name
string
requis

Nom affiché au client.

Required string length: 1 - 100
price
object
requis

Prix HT du forfait pour le client.

tiers
object[]
requis

Kilomètres inclus par jour selon la durée : s’applique le palier de plus grand fromDay atteint par les jours facturés. Le palier du jour 1 est obligatoire, un palier par jour. Remplacés en entier.

Required array length: 1 - 20 elements
description
string | null

Description libre ; null si absente.

Maximum string length: 500
isDefault
boolean

Forfait retenu quand une offre omet mileagePackageId. Au plus un par organisation : en désigner un autre retire ce statut à l’ancien ; un forfait par défaut est toujours actif.

isActive
boolean

false : forfait retiré de la vente. Désactiver le forfait par défaut exige isDefault: false.

displayOrder
integer

Rang d’affichage ; ordre de la liste.

Plage requise: 0 <= x <= 2147483647

Réponse

Créer un forfait kilométrique

data
object
requis
Exemple: