Véhicule v2.6

  1. Documentation API
  2. Véhicule v2.6
Versions
  • v2.2 (Deprecated)
  • v2.3 (Deprecated)
  • v2.4 (Deprecated)
  • v2.5 (Deprecated)
  • v2.6 (Deprecated)
  • v2.7 (Deprecated)
  • v3.0 (Deprecated)
  • v3.1 (Deprecated)
  • v3.2 (Deprecated)
  • v3.3 (Deprecated)
  • v3.4 (Deprecated)
  • v3.5 (Deprecated)
  • v3.6 (Deprecated)
  • v3.7
  • Liste
  • Tables de correspondance

Description

Récupére les véhicules de votre site. Plusieurs filtres sont possibles.

Quota

La méthode est limitée à 100 appels/heure. Si le quota est dépassé, un code erreur 429 sera retourné.

La méthode pour récupérer les miniatures des images est limitée à 10 appels/minute. Si le quota est dépassé, un code erreur 429 sera retourné.

URL

{version}/api-key/{apiKey}/vehicles/

Méthode

GET

Paramètres de l'url

Paramètre Type Obligatoire Description Commentaire
version Alphanumérique Oui Le numéro de la version de l’API que vous souhaitez appeler.

Ce paramètre est obligatoire

Valeur possibles: v2.6
page Numérique Non Le numéro de la page que vous souhaitez récupérer. Une page correspond à une liste de véhicules. (Voir paramètre count).

Ce paramètre est optionnel

Si non défini, la valeur de « page » sera par défaut à 1.
count Numérique Non Le nombre de véhicules désirés sur la page demandée. (Voir paramètre page).

Ce paramètre est optionnel

Si non défini, la valeur de « count » sera par défaut à 10.
Ce paramètre ne peut dépasser 100. Si besoin de récupérer plus d'éléments, utilisez le paramètre page ci-dessus.
dateUpdatedStart Date Non Permet de récupérer les véhicules qui ont été modifiés après cette date (strictement supérieur).

Ce paramètre est optionnel

Exemple : 2015-12-01
dateUpdatedEnd Date Non Permet de récupérer les véhicules qui ont été modifiés avant cette date (strictement inférieur). Exemple : 2015-12-01
orderBy [parameter] Alphabétique Non Permet de récupérer la liste des véhicules dans un certain ordre. Le paramètre « orderBy » doit prendre une clé « parameter » pour savoir sur quelle donnée le tri doit se baser.

Ce paramètre est optionnel

Exemple : orderBy[brand] = DESC

Valeurs possibles pour la clé parameter : dateCreated, state, brand, model, version

Valeurs possibles pour orderBy : ASC, DESC

vo Alphanumérique Non Filtre sur le N°VO d’un véhicules désirés. En passant ce paramètre, vous pouvez récupérer seulement les véhicules d’un N°VO spécifique.

Ce paramètre est optionnel.

state Alphabétique Non Filtre sur les statuts des véhicules désirés. En passant ce paramètre, vous pouvez récupérer seulement les véhicules d’un ou plusieurs statuts spécifiques. Si vous désirez plusieurs états, concaténez les états désirés par une ",".

Ce paramètre est optionnel.

Voir détail
reference Alphanumérique Non Filtre sur le N° de dossier du véhicule désiré. Le N° de dossier est unique par véhicule et par site. En passant ce paramètre, vous pouvez récupérer seulement le véhicule avec le N° de dossier défini.

Ce paramètre est optionnel.

Voir détail
vin Alphanumérique Non Filtre sur le VIN des véhicules désirés. En passant ce paramètre, vous pouvez récupérer seulement les véhicules d’un VIN spécifique.

Ce paramètre est optionnel.

Voir détail
licenseeNumber Alphanumérique Non Filtre sur l'immatriculation des véhicules désirés. En passant ce paramètre, vous pouvez récupérer seulement les véhicules d’une immatriculation spécifique.

Ce paramètre est optionnel.

Voir détail
brand Alphanumérique Non Filtre sur la marque des véhicules désirés. En passant ce paramètre, vous pouvez récupérer seulement les véhicules d’une marque spécifique.

Ce paramètre est optionnel.

Voir détail
model Alphanumérique Non Filtre sur le modèle des véhicules désirés. En passant ce paramètre, vous pouvez récupérer seulement les véhicules d’un modèle spécifique.

Ce paramètre est optionnel.

Voir détail
version Alphanumérique Non Filtre sur la version des véhicules désirés. En passant ce paramètre, vous pouvez récupérer seulement les véhicules d’une version spécifique.

Ce paramètre est optionnel.

Voir détail
siret Numérique Non Filtre sur la société dont les véhicules appartiennent. En passant ce paramètre, vous pouvez récupérer seulement les véhicules d’une société spécifique.

Ce paramètre est optionnel.

Voir détail
sharedVehicle Booléen Non Filtre sur les véhicules issus d'un partage. En passant ce paramètre, vous pouvez récupérer seulement les véhicules issus d'un partage.

Ce paramètre est optionnel.

Données de la requête

Aucune

Réponse

Statut code : 200
Contenu :

Renvoie un tableau de Véhicules

Variable Type Description Commentaire
totalResult Numérique Nombre de résultats
nbPageList Numérique Nombre d'éléments par page
createdAt Date Date de création du véhicule
updatedAt Date Date de modification du véhicule
reference Alphanumérique N° dossier du véhicule (Clé unique du véhicule)
internalReference Alphanumérique N° dossier interne du véhicule
state Alphabétique Cycle de vie du véhicule (PARC, VENDU, SORTI, etc…) Voir détail
typeVoVn Alphabétique Type du véhicule
(Véhicule d’occasions, véhicules neufs, 0 KM)
Valeurs possibles de base :
0KM|VN|VO
vehicleType Alphabétique Type du véhicule
(Véhicule particulier, Véhicule utilitaire, Véhicule 4 roues motrices)
Valeurs possibles de base :
4WD|PL|VP|VU
vin Alphanumérique Numéro de série du véhicule
vo Numérique Numéro de vo du véhicule
licenseNumber Alphanumérique Immatriculation du véhicule
brand: {name} Alphanumérique Marque du véhicule
model: {name} Alphanumérique Modèle du véhicule
country Alphabétique Pays du véhicule Voir détail
version : {name} Alphanumérique Version du véhicule
energy : {name} Alphanumérique Energie du véhicule Valeurs possibles de base :
Courant électrique|Diesel|Diesel / Courant électrique|Diesel ou gaz|Electric|Ess+g.p.l.|Essence|Essence / Courant électrique|Essence / Ethanol|Essence / Ethanol / Courant electrique|Essence ou gaz|Essence plomb|Essence sans plomb|GNV|Hydrogène
firstHand Booléen Première main
bodywork : {name} Alphanumérique Carrosserie du véhicule Valeurs possibles de base :
4X4|Autres|Benne|Benne-Double-Cabine|Berline|Break|Cabine|Cabriolet|Camion|Camionette|Châssis|Châssis cabine|Châssis cabine double|Chassis-Double Cabine|Chassis-nu|Combi I|Combin|Combiné|Combispace|Coup|Coupé|Crossover-suv|Fourgon|Fourgon sureleve|Fourgon vitré|Fourgonnette|Hard-Top|Limousine|Ludospace|Mini Bus|Minispace|Monospace|Monospace compact|Multispace|Pick-Up|Pick-Up (VP)|Pick-Up acier|Pick-up cabine double|Pick-Up Hardtop|Pick-Up long|Pick-Up-Double-Cabine|Plancher-Cabine|Plateau|Plateau cabine|Plateau ridelle|Plateau-Double Cabine|Plateau-Ridelles-Double-C|Roadster|Spider|Targa|Tout-Terrain|Tout-Terrain Cabrio|Tout-Terrain Long|Ts terrains/chemins|Utilitaire|Utilitaires
gearbox : {name} Alphanumérique Boîte Valeurs possibles de base :
Automate à fonct. Continu|Automate à fonct.continu,sequ.|Automate sequentiel|B.v.a.|Bo|Boîte automatique|Boîte automatisée|Boîte avec groupe(s)|Boîte manuelle|Boîte séquentielle|Mecanique|Sans boite de vitesse
reportNumber : {name} Numérique Nombre de rapports
color : {name} Alphanumérique Couleur Valeurs possibles de base :
Beige|Beige Clair|Beige Foncé|Blanc|Blanc fonce|Bleu|Bordeaux|Gris|Gris-argent|Inc.|Inconnu|Jaune|Jaune Clair|Jaune Foncé|Marron|Marron Foncé|Noir|Noir clair|Orange|Orange clair|Rouge|Rouge Clair|Vert|Vert Clair|Violet
colorAccuracy : {name} Alphanumérique Précision couleur Voir détail
insideColor : {name} Alphanumérique Couleur intérieure Valeurs possibles de base :
Beige|Gris|Noir
pricePublicWithoutTax Numérique Prix grand public HT
pricePublic Numérique Prix grand public TTC
priceSeller Numérique Prix négociant TTC
priceSellerWithoutTax Numérique Prix négociant HT
priceWeb Numérique Prix promo TTC
estimateCost Numérique Frais estimés HT
company: {siretNumber, phoneNumber, cellPhoneNumber} Alphanumérique Informations de la société : (SIRET, N° de téléphone, N° de téléphone portable)
warrantyType Alphanumérique Type de garantie Voir détail
warrantyOrganization: {reference, name} Alphanumérique Organisme de garantie
warrantyLabel Alphanumérique Libellé de garantie
warrantyKilometric Numérique Km compris
warrantyDuration Numérique Durée de la garantie (en mois)
warrantyEndDate Date Date de fin de la garantie
purchaseZone Numérique Zone à l'achat Voir détail
purchaseTax Numérique TVA à l'achat Voir détail
supplier Supplier Fournisseur du véhicule
expertise Expertise Expertise du véhicule
dateOfDistribution Date Date de mise en circulation du véhicule
year Date (format année) Année du véhicule
distanceTraveled Numérique Kms du véhicule
distanceTraveledWarranty Booléen Garantie Kms du véhicule
gallery Tableau de Media Photos des véhicules (url des images)
availableDate Date Date de disponibilité du véhicule
entryStockDate Date Date d'entrée en arrivage du véhicule
entryFleetDate Date Date d'entrée parc du véhicule
origin Alphanumérique Provenance du véhicule
fleet Alphanumérique Parc du véhicule
coteDate Date Date de la côte
valueAverage Numérique Cours Moyen
valueMec Numérique Répercussion de la MEC
valueKm Numérique Répercussion du Kilométrage
valueCote Numérique Côte du véhicule
valueOption Numérique Répercussion des Options
valueNew Numérique Valeur à neuf sans option
valueNewOption Numérique Valeur à neuf avec option
note: Alphanumérique Remarques sur le véhicule
gender: {name} Alphanumérique Genre du véhicule Valeurs possibles de base :
4WD|CAM|CTTE|PL|VP|VU
seatMaterial: {name} Alphanumérique Sellerie du véhicule Valeurs possibles de base :
Alcantara|Cuir|Semi cuir|Tissu|Velours
segment: {name} Alphanumérique Segment du véhicule Valeurs possibles de base :
4X4|4x4, SUV et Crossover|Breaks|Cabriolets|Citadines|Coupés|Grandes berlines|Monospaces|Moyennes berlines|Utilitaires
taxHorsepower Numérique Puissance fiscale du véhicule
horsePower Numérique Puissance DIN du véhicule
carEngine Numérique Cylindrée
doors Numérique Nombre de portes du véhicule
seats Numérique Nombre de places du véhicule
urbanConsumption Numérique Conso. urbaine du véhicule
extraUrbanConsumption Numérique Conso. extra-urbaine du véhicule
mixteConsumption Numérique Conso. mixte du véhicule
extraUrbanKmConsumption Numérique Conso CO2 du véhicule
isWorkshop Booléen Véhicule en atelier ?
isRental Booléen Véhicule en location ?
isRecoverableVat Booléen TVA récupérable ?
equipmentStandard Tableau d'Equipment Equipements de série du véhicule
equipmentOptional Tableau d'Equipment Equipements en option du véhicule
location Alphanumérique Emplacement du véhicule
situation Alphanumérique Situation du véhicule
groupFleet Alphanumérique Point de vente du véhicule

Variable Type Description Commentaire
phoneNumber Alphanumérique N° téléphone du fournisseur
cellPhoneNumber Alphanumérique N° téléphone portable du fournisseur
faxNumber Alphanumérique N° fax du fournisseur
address Address Addresse du fournisseur
legalFormContact Alphanumérique Forme légale du fournisseur Professionnel/société uniquement
corporateNameContact Alphanumérique Raison Sociale du fournisseur Professionnel/société uniquement
commonName Alphanumérique Nom de l'enseigne du fournisseur Professionnel/société uniquement
groupName Alphanumérique Nom du groupe du fournisseur Professionnel/société uniquement
siret Alphanumérique Siret du fournisseur Professionnel/société uniquement
tvaIntracom Alphanumérique TVA intracommunautaire du fournisseur Professionnel/société uniquement
firstname Alphanumérique Prénom du fournisseur Particulier uniquement
lastname Alphanumérique Nom du fournisseur Particulier uniquement

Variable Type Description Commentaire
address Alphanumérique Addresse
addressBis Alphanumérique Complément d'addresse
postalCode Alphanumérique Code postal
city Alphanumérique Ville
country Alphanumérique Pays

Variable Type Description Commentaire
generalState Alphanumérique Etat général du véhicule
comment Alphanumérique Remarques sur l'expertise du véhicule
frontLeft Alphanumérique Etat roue avant gauche du véhicule
frontRight Alphanumérique Etat roue avant droite du véhicule
rearLeft Alphanumérique Etat roue arrière gauche du véhicule
rearRight Alphanumérique Etat roue arrière droite du véhicule
frontCosting numérique Prix estimés roues avants du véhicule
rearCosting numérique Prix estimés roues arrières du véhicule
spare Alphanumérique Roue de secours du véhicule
spareType Alphanumérique Options de la roue de secours du véhicule
spareCosting numérique Prix estimés roue de secours du véhicule
tireType Alphanumérique Type de pneu du véhicule
tireBrand Alphanumérique Marque de pneu du véhicule
tireSize Alphanumérique Taille de pneu du véhicule
elementList Tableau d'ElementList Liste des éléments

Variable Type Description Commentaire
isProvided Booléen Est présent ?
name Alphanumérique Nom de l'élément

Variable Type Description Commentaire
photo Alphanumérique Url de l’image en format original
large Alphanumérique Url de l’image en format large
big Alphanumérique Url de l’image en grand format
thumb Alphanumérique Url de l’image en format miniature
updatedAt Alphanumérique Date de mise à jour de l'image
reference Alphanumérique Clé unique de l'image
position Numérique Position de l'image, la valeur la plus basse correspond à l'image principale
stamp Alphanumérique URL de l'image avec filigranes (si une configuration est activée sur le site/point de vente)
category Alphanumérique Catégorie de l'image

Variable Type Description Commentaire
reference Référence unique de l'équipement Alphanumérique
name Nom de l'équipement Alphanumérique
price Prix de l'équipement Numérique Optionnel
toDisplay Valeur à afficher Booléen

Erreurs

Statut code Contenu
401 Invalid authentication token
500 Une erreur est survenue lors de l'affichage des véhicules.

Vous trouverez la liste des correspondances des champs ci-dessous :

Variable « state »

Code Etat Commentaires Publier ? (Recommandation)
vehicle.state.pending En cours Véhicule en cours de saisie Non
vehicle.state.on_arrival En arrivage Véhicule neuf (VN) ou VO pas encore sur le PARC Oui
vehicle.state.parc Parc Véhicule physiquement sur PARC avec n° de VO Oui
vehicle.state.sold Vendu Véhicule avec Bon de commande (BC) validé Non (ou Oui en précisant "vehicule VENDU")
vehicle.state.sold_ar Vendu AR Véhicule En Arrivage avec Bon de commande (BC) validé Non (ou Oui en précisant "vehicule VENDU")
vehicle.state.out Sorti Véhicule vendu et sorti du parc Non
vehicle.state.out_ar Sorti AR Véhicule vendu sans passer par le parc Non
vehicle.state.canceled Annulé Véhicule restitué Non
vehicle.state.workshop TOUT-VENANT ATELIER Véhicule tout-venant pour l'atelier non destiné à la vente Non

Variable « colorAccuracy »

Code Valeur
vehicle.color_accuracy.glossy Laqué
vehicle.color_accuracy.matte Mat
vehicle.color_accuracy.metallic Métallisé
vehicle.color_accuracy.pearl Nacré
vehicle.color_accuracy.varnish Verni

Variable « warrantyType »

Code Valeur
vehicle.warranty.type.with Garantie
vehicle.warranty.type.manufacturer Garantie constructeur
vehicle.warranty.type.without Sans garantie

Liste des Zones

Code Valeur
0 France
1 UE
2 Hors UE
3 Luxembourg
4 Import / Export
5 Martinique
6 Guadeloupe
7 La Réunion
8 Monaco
9 Espagne
10 Belgique
11 Côte d'Ivoire
12 Allemagne

Liste des TVA

Code Valeur
0 TVA 20
1 TVA Exo
2 TVA/Marge
3 TVA 5,5
4 Sans TVA
5 Franchise de TVA
6 TVA 17
7 TVA 8,5
8 TVA 21
9 TVA 18
10 TVA 19
11 TVA 7

Liste des Pays

Code Pays Code Pays Code Pays Code Pays Code Pays Code Pays
AF Afghanistan ZA Afrique du Sud AL Albanie DZ Algérie DE Allemagne AD Andorre
AO Angola AI Anguilla AQ Antarctique AG Antigua-et-Barbuda SA Arabie saoudite AR Argentine
AM Arménie AW Aruba AU Australie AT Autriche AZ Azerbaïdjan BS Bahamas
BH Bahreïn BD Bangladesh BB Barbade BE Belgique BZ Belize BJ Bénin
BM Bermudes BT Bhoutan BY Biélorussie BO Bolivie BA Bosnie-Herzégovine BW Botswana
BR Brésil BN Brunéi Darussalam BG Bulgarie BF Burkina Faso BI Burundi KH Cambodge
CM Cameroun CA Canada CV Cap-Vert EA Ceuta et Melilla CL Chili CN Chine
CY Chypre CO Colombie KM Comores CG Congo-Brazzaville CD Congo-Kinshasa KP Corée du Nord
KR Corée du Sud CR Costa Rica CI Côte d’Ivoire HR Croatie CU Cuba CW Curaçao
DK Danemark DG Diego Garcia DJ Djibouti DM Dominique EG Égypte AE Émirats arabes unis
EC Équateur ER Érythrée ES Espagne EE Estonie VA État de la Cité du Vatican FM États fédérés de Micronésie
US États-Unis ET Éthiopie FJ Fidji FI Finlande FR France GA Gabon
GM Gambie GE Géorgie GS Géorgie du Sud et îles Sandwich du Sud GH Ghana GI Gibraltar GR Grèce
GD Grenade GL Groenland GP Guadeloupe GU Guam GT Guatemala GG Guernesey
GN Guinée GQ Guinée équatoriale GW Guinée-Bissau GY Guyana GF Guyane française HT Haïti
HN Honduras HU Hongrie CX Île Christmas AC Île de l’Ascension IM Île de Man NF Île Norfolk
AX Îles Åland KY Îles Caïmans IC Îles Canaries CC Îles Cocos CK Îles Cook FO Îles Féroé
FK Îles Malouines MP Îles Mariannes du Nord MH Îles Marshall UM Îles mineures éloignées des États-Unis PN Îles Pitcairn SB Îles Salomon
TC Îles Turques-et-Caïques VG Îles Vierges britanniques VI Îles Vierges des États-Unis IN Inde ID Indonésie IQ Irak
IR Iran IE Irlande IS Islande IL Israël IT Italie JM Jamaïque
JP Japon JE Jersey JO Jordanie KZ Kazakhstan KE Kenya KG Kirghizistan
KI Kiribati XK Kosovo KW Koweït RE La Réunion LA Laos LS Lesotho
LV Lettonie LB Liban LR Libéria LY Libye LI Liechtenstein LT Lituanie
LU Luxembourg MK Macédoine MG Madagascar MY Malaisie MW Malawi MV Maldives
ML Mali MT Malte MA Maroc MQ Martinique MU Maurice MR Mauritanie
YT Mayotte MX Mexique MD Moldavie MC Monaco MN Mongolie ME Monténégro
MS Montserrat MZ Mozambique MM Myanmar (Birmanie) NA Namibie UN Nations Unies NR Nauru
NP Népal NI Nicaragua NE Niger NG Nigéria NU Niue NO Norvège
NC Nouvelle-Calédonie NZ Nouvelle-Zélande OM Oman UG Ouganda UZ Ouzbékistan PK Pakistan
PW Palaos PA Panama PG Papouasie-Nouvelle-Guinée PY Paraguay NL Pays-Bas BQ Pays-Bas caribéens
PE Pérou PH Philippines PL Pologne PF Polynésie française PR Porto Rico PT Portugal
QA Qatar HK R.A.S. chinoise de Hong Kong MO R.A.S. chinoise de Macao CF République centrafricaine DO République dominicaine RO Roumanie
GB Royaume-Uni RU Russie RW Rwanda EH Sahara occidental BL Saint-Barthélemy KN Saint-Christophe-et-Niévès
SM Saint-Marin MF Saint-Martin SX Saint-Martin (partie néerlandaise) PM Saint-Pierre-et-Miquelon VC Saint-Vincent-et-les-Grenadines SH Sainte-Hélène
LC Sainte-Lucie SV Salvador WS Samoa AS Samoa américaines ST Sao Tomé-et-Principe SN Sénégal
RS Serbie SC Seychelles SL Sierra Leone SG Singapour SK Slovaquie SI Slovénie
SO Somalie SD Soudan SS Soudan du Sud LK Sri Lanka SE Suède CH Suisse
SR Suriname SJ Svalbard et Jan Mayen SZ Swaziland SY Syrie TJ Tadjikistan TW Taïwan
TZ Tanzanie TD Tchad CZ Tchéquie TF Terres australes françaises IO Territoire britannique de l’océan Indien PS Territoires palestiniens
TH Thaïlande TL Timor oriental TG Togo TK Tokélaou TO Tonga TT Trinité-et-Tobago
TA Tristan da Cunha TN Tunisie TM Turkménistan TR Turquie TV Tuvalu UA Ukraine
UY Uruguay VU Vanuatu VE Venezuela VN Vietnam WF Wallis-et-Futuna YE Yémen
ZM Zambie ZW Zimbabwe EZ zone euro