Aller au contenu
Floweet
Accès pro

Prospects

Enregistrer les flottes de vos prospects avec leur surcoût carburant et carbone recalculé sur les prix de la semaine : créer, lire, remplacer, supprimer.

api.floweet.com/v1 · Contrat 1.0.0-beta.1 · Bêta

Sections · Prospects
Sur cette page
  1. À savoir
  2. L'objet Prospect
  3. L'objet ProspectDetail
  4. L'objet FleetInput
  5. L'objet FleetCost
  6. Prospects de l'organisation, avec leur surcoût annuel (200 au plus)
  7. Ajouter un prospect et sa flotte
  8. Un prospect : flotte saisie et coût par type de véhicule
  9. Remplacer un prospect (nom et flotte)
  10. Supprimer un prospect

Les prospects d'une organisation : un nom et une flotte, décrite comme pour le coût d'une flotte. Chaque lecture recalcule le surcoût carburant et carbone sur les prix de la semaine : un prospect enregistré en octobre se lit, en novembre, avec les prix de novembre.

À savoir

  • Les prospects appartiennent à l'organisation de la clé : ils sont les mêmes que ceux de l'espace Commercial de l'application, et l'API agit au nom du membre désigné du compte d'API.
  • Une organisation garde 200 prospects au plus : au-delà, 422 prospect_limit. Supprimez ceux qui ne servent plus.
  • PUT remplace le prospect en entier (nom et flotte) : envoyez toujours la flotte complète. La suppression est définitive et répond { ok: true }.
  • La création accepte Idempotency-Key : en cas de coupure, réessayez avec la même clé, sans créer de doublon (voir idempotence). La réponse 201 porte l'en-tête Location.
  • Dans la liste, overspendPerYear et ets2PerYear sont les totaux en centimes ; le détail par type de véhicule est dans la fiche.

L'objet Prospect

ChampTypeDescription
idtoujours présentstring
nametoujours présentstring
vehiclestoujours présentinteger
overspendPerYeartoujours présentintegerCentimes par an.
ets2PerYeartoujours présentinteger
updatedAttoujours présentstring (date-time)
Prospect
{
  "id": "33e3daba-2998-438d-a05e-1c513009107a",
  "name": "Transports Martin",
  "vehicles": 15,
  "overspendPerYear": 1013800,
  "ets2PerYear": 642800,
  "updatedAt": "2026-10-26T11:46:19.310433+00:00"
}

L'objet ProspectDetail

ChampTypeDescription
idtoujours présentstring
nametoujours présentstring
updatedAttoujours présentstring (date-time)
inputtoujours présentFleetInput
costtoujours présentFleetCost
ProspectDetail
{
  "id": "33e3daba-2998-438d-a05e-1c513009107a",
  "name": "Transports Martin",
  "updatedAt": "2026-10-26T11:46:19.310433+00:00",
  "input": {
    "fuel": "gazole",
    "currentBrand": "Esso",
    "reference": "cheapest",
    "kmPerVehicle": 30000,
    "lines": [
      {
        "type": "lcv",
        "vehicles": 12,
        "consumptionL100": 8.5
      },
      {
        "type": "hgv",
        "vehicles": 3,
        "consumptionL100": 30
      }
    ]
  },
  "cost": {
    "fuel": "gazole",
    "pricesFrom": "2026-10-19T11:35:43.000Z",
    "pricesTo": "2026-10-26T11:00:00.000Z",
    "vehicles": 15,
    "currentBrand": "Esso",
    "currentPrice": 2428,
    "referenceBrand": "Total Access",
    "referencePrice": 2252,
    "lines": [
      {
        "type": "lcv",
        "vehicles": 12,
        "consumptionL100": 8.5,
        "litersPerYear": 30600,
        "overspendPerYear": 538600,
        "overspendPerVehicle": 44900,
        "co2Tonnes": 75.9,
        "ets2PerYear": 341500
      },
      {
        "type": "hgv",
        "vehicles": 3,
        "consumptionL100": 30,
        "litersPerYear": 27000,
        "overspendPerYear": 475200,
        "overspendPerVehicle": 158400,
        "co2Tonnes": 67,
        "ets2PerYear": 301300
      }
    ],
    "total": {
      "litersPerYear": 57600,
      "overspendPerYear": 1013800,
      "co2Tonnes": 142.8,
      "ets2PerYear": 642800
    },
    "replaceFirst": "hgv",
    "ets2": {
      "startYear": 2028,
      "pricePerTonne": 4500,
      "costPerLiter": 112
    }
  }
}

L'objet FleetInput

ChampTypeDescription
fuelfacultatif"gazole" | "sp95-e10" | "sp98" | "e85" | "gpl"défaut "gazole"
currentBrandtoujours présentstring1 à 60 caractèresEnseigne où la flotte fait le plein aujourd'hui (un nom d'enseigne de /v1/barometer).
referencefacultatif"cheapest" | "supermarkets"défaut "cheapest"Comparer à l'enseigne la moins chère ou à la moyenne des grandes surfaces.
kmPerVehicletoujours présentintegerde 0 à 500000
linestoujours présentobject[]1 à 3 éléments
lines[].typetoujours présent"car" | "lcv" | "hgv"car (voiture), lcv (véhicule utilitaire léger), hgv (poids lourd).
lines[].vehiclestoujours présentintegerde 0 à 100000
lines[].consumptionL100toujours présentnumberde 0 à 100Litres aux 100 km.
FleetInput
{
  "fuel": "gazole",
  "currentBrand": "Esso",
  "reference": "cheapest",
  "kmPerVehicle": 30000,
  "lines": [
    {
      "type": "lcv",
      "vehicles": 12,
      "consumptionL100": 8.5
    },
    {
      "type": "hgv",
      "vehicles": 3,
      "consumptionL100": 30
    }
  ]
}

L'objet FleetCost

ChampTypeDescription
fueltoujours présent"gazole" | "sp95-e10" | "sp98" | "e85" | "gpl"
pricesFromtoujours présentstring (date-time)
pricesTotoujours présentstring (date-time)
vehiclestoujours présentinteger
currentBrandtoujours présentstring
currentPricetoujours présentinteger | nullPrix moyen de l'enseigne actuelle ; null si elle est inconnue (aucun surcoût calculé).
referenceBrandtoujours présentstring | null
referencePricetoujours présentinteger | nullPrix en millièmes d'euro par litre (2372 = 2,372 €/L).
linestoujours présentobject[]
lines[].typetoujours présent"car" | "lcv" | "hgv"
lines[].vehiclestoujours présentinteger
lines[].consumptionL100toujours présentnumber
lines[].litersPerYeartoujours présentinteger
lines[].overspendPerYeartoujours présentintegerCentimes par an.
lines[].overspendPerVehicletoujours présentintegerCentimes par véhicule et par an.
lines[].co2Tonnestoujours présentnumber
lines[].ets2PerYeartoujours présentintegerCoût carbone ETS2, centimes par an dès 2028.
totaltoujours présentobject
total.litersPerYeartoujours présentinteger
total.overspendPerYeartoujours présentinteger
total.co2Tonnestoujours présentnumber
total.ets2PerYeartoujours présentinteger
replaceFirsttoujours présent"car" | "lcv" | "hgv" | nullType de véhicule qui coûte le plus par véhicule (carburant + ETS2).
ets2toujours présentobject
ets2.startYeartoujours présentinteger
ets2.pricePerTonnetoujours présentintegerCentimes par tonne de CO2 (hypothèse).
ets2.costPerLitertoujours présentintegerMillièmes d'euro par litre.
FleetCost
{
  "fuel": "gazole",
  "pricesFrom": "2026-10-19T11:35:43.000Z",
  "pricesTo": "2026-10-26T11:00:00.000Z",
  "vehicles": 15,
  "currentBrand": "Esso",
  "currentPrice": 2428,
  "referenceBrand": "Total Access",
  "referencePrice": 2252,
  "lines": [
    {
      "type": "lcv",
      "vehicles": 12,
      "consumptionL100": 8.5,
      "litersPerYear": 30600,
      "overspendPerYear": 538600,
      "overspendPerVehicle": 44900,
      "co2Tonnes": 75.9,
      "ets2PerYear": 341500
    },
    {
      "type": "hgv",
      "vehicles": 3,
      "consumptionL100": 30,
      "litersPerYear": 27000,
      "overspendPerYear": 475200,
      "overspendPerVehicle": 158400,
      "co2Tonnes": 67,
      "ets2PerYear": 301300
    }
  ],
  "total": {
    "litersPerYear": 57600,
    "overspendPerYear": 1013800,
    "co2Tonnes": 142.8,
    "ets2PerYear": 642800
  },
  "replaceFirst": "hgv",
  "ets2": {
    "startYear": 2028,
    "pricePerTonne": 4500,
    "costPerLiter": 112
  }
}

Prospects de l'organisation, avec leur surcoût annuel (200 au plus)

GET/v1/prospectsScope prospects:read

Paramètres

ChampOùTypeDescription
limitfacultatifrequêteintegerde 1 à 100 · défaut 20Nombre d'éléments par page (1 à 100, 20 par défaut).
cursorfacultatifrequêtestringau plus 400 caractèresCurseur opaque : la valeur nextCursor de la page précédente.

Réponse 200

Succès — Une page de Prospect { data, nextCursor, hasMore }

Erreurs

HTTPSignification
400Requête invalide
401Clé d'API absente, invalide ou révoquée
403Accès refusé (scope, plan ou statut du compte)
404Ressource introuvable
429Trop de requêtes
500Erreur interne
Requête
curl "https://api.floweet.com/v1/prospects" \
  -H "Authorization: Bearer $FLOWEET_API_KEY"
Réponse 200
{
  "data": [
    {
      "id": "33e3daba-2998-438d-a05e-1c513009107a",
      "name": "Transports Martin",
      "vehicles": 15,
      "overspendPerYear": 1013800,
      "ets2PerYear": 642800,
      "updatedAt": "2026-10-26T11:46:19.310433+00:00"
    }
  ],
  "nextCursor": null,
  "hasMore": false
}

Ajouter un prospect et sa flotte

POST/v1/prospectsScope prospects:write

Paramètres

ChampOùTypeDescription
Idempotency-Keyfacultatifen-têtestringau plus 255 caractèresClé unique de cette requête (un UUID v4 neuf, gardé pour ses nouvelles tentatives) : la première réponse est rejouée pendant 24 heures.

Corps de la requête ProspectInput

ChampTypeDescription
nameobligatoirestring1 à 200 caractères
fleetobligatoireFleetInput

Réponse 201

Prospect créé — Un objet ProspectDetail

Erreurs

HTTPSignification
400Requête invalide
401Clé d'API absente, invalide ou révoquée
403Accès refusé (scope, plan ou statut du compte)
404Ressource introuvable
409Conflit
422Requête impossible à traiter
429Trop de requêtes
500Erreur interne
Requête
curl -X POST "https://api.floweet.com/v1/prospects" \
  -H "Authorization: Bearer $FLOWEET_API_KEY" \
  -H "Idempotency-Key: 6f1c2b0e-8d4a-4f7e-9a51-3c2d1e0f9b87" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Transports Martin",
  "fleet": {
    "fuel": "gazole",
    "currentBrand": "Esso",
    "reference": "cheapest",
    "kmPerVehicle": 30000,
    "lines": [
      {
        "type": "lcv",
        "vehicles": 12,
        "consumptionL100": 8.5
      },
      {
        "type": "hgv",
        "vehicles": 3,
        "consumptionL100": 30
      }
    ]
  }
}'
Réponse 201
{
  "id": "33e3daba-2998-438d-a05e-1c513009107a",
  "name": "Transports Martin",
  "updatedAt": "2026-10-26T11:46:19.310433+00:00",
  "input": {
    "fuel": "gazole",
    "currentBrand": "Esso",
    "reference": "cheapest",
    "kmPerVehicle": 30000,
    "lines": [
      {
        "type": "lcv",
        "vehicles": 12,
        "consumptionL100": 8.5
      },
      {
        "type": "hgv",
        "vehicles": 3,
        "consumptionL100": 30
      }
    ]
  },
  "cost": {
    "fuel": "gazole",
    "pricesFrom": "2026-10-19T11:35:43.000Z",
    "pricesTo": "2026-10-26T11:00:00.000Z",
    "vehicles": 15,
    "currentBrand": "Esso",
    "currentPrice": 2428,
    "referenceBrand": "Total Access",
    "referencePrice": 2252,
    "lines": [
      {
        "type": "lcv",
        "vehicles": 12,
        "consumptionL100": 8.5,
        "litersPerYear": 30600,
        "overspendPerYear": 538600,
        "overspendPerVehicle": 44900,
        "co2Tonnes": 75.9,
        "ets2PerYear": 341500
      },
      {
        "type": "hgv",
        "vehicles": 3,
        "consumptionL100": 30,
        "litersPerYear": 27000,
        "overspendPerYear": 475200,
        "overspendPerVehicle": 158400,
        "co2Tonnes": 67,
        "ets2PerYear": 301300
      }
    ],
    "total": {
      "litersPerYear": 57600,
      "overspendPerYear": 1013800,
      "co2Tonnes": 142.8,
      "ets2PerYear": 642800
    },
    "replaceFirst": "hgv",
    "ets2": {
      "startYear": 2028,
      "pricePerTonne": 4500,
      "costPerLiter": 112
    }
  }
}

Un prospect : flotte saisie et coût par type de véhicule

GET/v1/prospects/{id}Scope prospects:read

Paramètres

ChampOùTypeDescription
idobligatoirecheminstring (uuid)

Réponse 200

Succès — Un objet ProspectDetail

Erreurs

HTTPSignification
400Requête invalide
401Clé d'API absente, invalide ou révoquée
403Accès refusé (scope, plan ou statut du compte)
404Ressource introuvable
429Trop de requêtes
500Erreur interne
Requête
curl "https://api.floweet.com/v1/prospects/7d0c1f8e-2a4b-4c6d-9e8f-0a1b2c3d4e5f" \
  -H "Authorization: Bearer $FLOWEET_API_KEY"
Réponse 200
{
  "id": "33e3daba-2998-438d-a05e-1c513009107a",
  "name": "Transports Martin",
  "updatedAt": "2026-10-26T11:46:19.310433+00:00",
  "input": {
    "fuel": "gazole",
    "currentBrand": "Esso",
    "reference": "cheapest",
    "kmPerVehicle": 30000,
    "lines": [
      {
        "type": "lcv",
        "vehicles": 12,
        "consumptionL100": 8.5
      },
      {
        "type": "hgv",
        "vehicles": 3,
        "consumptionL100": 30
      }
    ]
  },
  "cost": {
    "fuel": "gazole",
    "pricesFrom": "2026-10-19T11:35:43.000Z",
    "pricesTo": "2026-10-26T11:00:00.000Z",
    "vehicles": 15,
    "currentBrand": "Esso",
    "currentPrice": 2428,
    "referenceBrand": "Total Access",
    "referencePrice": 2252,
    "lines": [
      {
        "type": "lcv",
        "vehicles": 12,
        "consumptionL100": 8.5,
        "litersPerYear": 30600,
        "overspendPerYear": 538600,
        "overspendPerVehicle": 44900,
        "co2Tonnes": 75.9,
        "ets2PerYear": 341500
      },
      {
        "type": "hgv",
        "vehicles": 3,
        "consumptionL100": 30,
        "litersPerYear": 27000,
        "overspendPerYear": 475200,
        "overspendPerVehicle": 158400,
        "co2Tonnes": 67,
        "ets2PerYear": 301300
      }
    ],
    "total": {
      "litersPerYear": 57600,
      "overspendPerYear": 1013800,
      "co2Tonnes": 142.8,
      "ets2PerYear": 642800
    },
    "replaceFirst": "hgv",
    "ets2": {
      "startYear": 2028,
      "pricePerTonne": 4500,
      "costPerLiter": 112
    }
  }
}

Remplacer un prospect (nom et flotte)

PUT/v1/prospects/{id}Scope prospects:write

Paramètres

ChampOùTypeDescription
idobligatoirecheminstring (uuid)

Corps de la requête ProspectInput

ChampTypeDescription
nameobligatoirestring1 à 200 caractères
fleetobligatoireFleetInput

Réponse 200

Succès — Un objet ProspectDetail

Erreurs

HTTPSignification
400Requête invalide
401Clé d'API absente, invalide ou révoquée
403Accès refusé (scope, plan ou statut du compte)
404Ressource introuvable
429Trop de requêtes
500Erreur interne
Requête
curl -X PUT "https://api.floweet.com/v1/prospects/7d0c1f8e-2a4b-4c6d-9e8f-0a1b2c3d4e5f" \
  -H "Authorization: Bearer $FLOWEET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Transports Martin",
  "fleet": {
    "fuel": "gazole",
    "currentBrand": "Esso",
    "reference": "cheapest",
    "kmPerVehicle": 30000,
    "lines": [
      {
        "type": "lcv",
        "vehicles": 12,
        "consumptionL100": 8.5
      },
      {
        "type": "hgv",
        "vehicles": 3,
        "consumptionL100": 30
      }
    ]
  }
}'
Réponse 200
{
  "id": "33e3daba-2998-438d-a05e-1c513009107a",
  "name": "Transports Martin",
  "updatedAt": "2026-10-26T11:46:19.310433+00:00",
  "input": {
    "fuel": "gazole",
    "currentBrand": "Esso",
    "reference": "cheapest",
    "kmPerVehicle": 30000,
    "lines": [
      {
        "type": "lcv",
        "vehicles": 12,
        "consumptionL100": 8.5
      },
      {
        "type": "hgv",
        "vehicles": 3,
        "consumptionL100": 30
      }
    ]
  },
  "cost": {
    "fuel": "gazole",
    "pricesFrom": "2026-10-19T11:35:43.000Z",
    "pricesTo": "2026-10-26T11:00:00.000Z",
    "vehicles": 15,
    "currentBrand": "Esso",
    "currentPrice": 2428,
    "referenceBrand": "Total Access",
    "referencePrice": 2252,
    "lines": [
      {
        "type": "lcv",
        "vehicles": 12,
        "consumptionL100": 8.5,
        "litersPerYear": 30600,
        "overspendPerYear": 538600,
        "overspendPerVehicle": 44900,
        "co2Tonnes": 75.9,
        "ets2PerYear": 341500
      },
      {
        "type": "hgv",
        "vehicles": 3,
        "consumptionL100": 30,
        "litersPerYear": 27000,
        "overspendPerYear": 475200,
        "overspendPerVehicle": 158400,
        "co2Tonnes": 67,
        "ets2PerYear": 301300
      }
    ],
    "total": {
      "litersPerYear": 57600,
      "overspendPerYear": 1013800,
      "co2Tonnes": 142.8,
      "ets2PerYear": 642800
    },
    "replaceFirst": "hgv",
    "ets2": {
      "startYear": 2028,
      "pricePerTonne": 4500,
      "costPerLiter": 112
    }
  }
}

Supprimer un prospect

DELETE/v1/prospects/{id}Scope prospects:write

Paramètres

ChampOùTypeDescription
idobligatoirecheminstring (uuid)

Réponse 200

Succès — { ok: true }

Erreurs

HTTPSignification
400Requête invalide
401Clé d'API absente, invalide ou révoquée
403Accès refusé (scope, plan ou statut du compte)
404Ressource introuvable
429Trop de requêtes
500Erreur interne
Requête
curl -X DELETE "https://api.floweet.com/v1/prospects/7d0c1f8e-2a4b-4c6d-9e8f-0a1b2c3d4e5f" \
  -H "Authorization: Bearer $FLOWEET_API_KEY"
Réponse 200
{
  "ok": true
}