Vehicle Data API

Data Supplier API Documentation

Introduction

Overview

The EuroStocks Data-Supplirer-API is an interface to store vehicle to the EuroStocks-database and make them available on the platform as classified ads. It allows users to do all necessary operations like Get, Add, Update and Delete an ad information.

Documentation can be incomplete and/or outdated, Contact EuroStocks team by sending an email on [email protected] for any questions regarding API.

The API is available at this base URL:

https://vehicles-data-api.eurostocks.com/ - New domain https://hexon.eurostocks.com - will be deprecated from 01-Jan-2021

Main features

  • Create a new ad

  • Update an ad

  • Delete an ad

  • Upload images

  • Change the order of existing images

  • Delete image

  • Get an Ad Information

Prerequisites

Data supplier API access can be granted to suppliers who wants to send EuroStocks vehicle informations, and it required username, password and API Key to access API.

Limited support for the development process and maintenance: Please note that all examples provided in our documentation are considered as guidelines for your development process but EuroStocks for itself is not able to directly assist with any of your preferred programming languages and/or used scripts.

Test Account

A test environment can be provided. Please ask for the test account details and all the information will be used as mention in Prerequisites on test API url https://test-vehicles-data-api.eurostocks.com.

Working with Ad Data

Overview

Data Supplier API allows you to manage your vehicle inventory in a programmatic way and integrate it with other applications. It allows users to do all necessary operations like Get, Add, Update and Delete an ad information.

Generate sample request click here.

Platform Meta Data

eurostocksAdId

The unique identifier for an ad object on EuroStocks platform. Example: 123456

locationId

Reference to the company's location of this ad information. Example: 1234567

dataSupplierAdId

Unique Identification number of datasupplier. Example: 1234567

imageCount

No. of images supplier will sent for requested new vehicle

Vehicle Data

vehicleType

General vehicle types. Example: Car or Motorcycle

VehicleCategory

Different cateogies of vehicle types. Example: Sedan or Small car

make

Make of the vehicle. Example: Mercedes or Toyota

model

Model of the vehicle based on make. Example: X5 or Prius

trimline

Manufacturers identity. (OPTIONAL)

licensePlate

Vehicle identification number. (OPTIONAL)

firstRegistration

Vehicle first registration date Example:20121001 (Format: yyyyMMdd)

price

Vehicle price Price attrbiutes.

modelCode

Vehicle's model code.

Additional Ad Information

make

Provides vehicle make. For example : AUDI

make is default property and can be identify from flag "IsDefaultFeature". please refer API : https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/features/{vehicleTypeKey}

model

Provides vehicle model. For example : A4

model is default property and can be identify from flag "IsDefaultFeature". please refer API : https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/features/{vehicleTypeKey}

trimline

Provides vehicle trimline.

trimline is default property and can be identify from flag "IsDefaultAttribute". please refer API : https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/attributes/{vehicleTypeKey}

licensePlate

Provides vehicle licensePlate.

licensePlate is default property and can be identify from flag "IsDefaultAttribute". please refer API : https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/attributes/{vehicleTypeKey}

firstRegistration

Provides vehicle firstRegistration.

firstRegistration is default property and can be identify from flag "IsDefaultAttribute". please refer API : https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/attributes/{vehicleTypeKey}

modelCode

Provides vehicle modelCode.

modelCode is default property and can be identify from flag "IsDefaultAttribute". please refer API : https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/attributes/{vehicleTypeKey}

features

Provides all the feature available for selected vehicle type. For example: ABS and PARKINGASSISTANTS.

PARKINGASSISTANTS is multiple value allowed feature. However, CAMERA and CAM_360_DEGREES can not be sent together.

features values

Provides all the feature values available for selected feature. For example: ABS = "YES".

attributes

Provides all the attribute available for selected vehicle type. For example: DOOR_COUNT.

vehicleInfo

Provides multilingual attributes which allows to add attribute for different languages. For example: REMARKS and ADDITIONALREMARKS.

LANGUAGEISOCODE is mandatory when you want to send multilingual attributes. On Attributes response you will find flag "IsMultilingualAttribute" to identify if attribute is multilingual or not.

To get multilingual attributes please refer API : https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/attributes/{vehicleTypeKey}

To get all supported languages : https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/languages In case of mandatory multilingual attrbiutes, It is required for 'NL' only. If value is not available for other language then it is not mandatory to send for those languages.

priceInfo

Provides price information which will allow to calculate price. For example : PRICE_ON_REQUEST

VAT_RECLAIMABLE is mandatory when any price fields is added. On Attributes and Features response you will find flag "IsPriceAttribute" and "IsPriceFeature" respectively to identify attribute and feature is part of price info or not.

To get "IsPriceAttribute" and "IsPriceFeature" please refer API : https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/attributes/{vehicleTypeKey} and https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/features/{vehicleTypeKey}.

How Ad Data Are Rendered

Representation as JSON data in Supplier API

This is an ad fragment in JSON format for demonstration purposes only, some fields are not included.

Create a new Ad

POST

https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/vehicledetails

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Data Types

Request
Success Response

Ad

n/a

Sample Success Request

Sample Success Response

Sample Error Response

Update an Ad

PUT

https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/vehicledetails

Headers

Name
Type
Description

UserName

String

Username which EuroStocks provides

Password

String

Password which EuroStocks provides

APIKey

String

ApiKey which EuroStocks provides

Data Types

Request
Success Response

Ad

n/a

Sample Success Request

Sample Success Response

Patch an Ad

PATCH

https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/vehicledetails/{locationId}/{eurostocksAdId}

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Request parameters

Name
Type
Description

locationId*

Number

Unique Identification number of location for which Vehicle is added

eurostocksAdId*

Number

Unique Identification number of Vehicle you want to patch

Sample Success Request

Update Behavior for Attributes, Features, and Multilingual Vehicle Information

When using the PATCH Vehicle endpoint to update an existing ad, the API processes the sections Attributes, Features, and VehicleInfo (language-wise) according to the following logic:

  1. Update Existing Values

    • If a value for a given Attribute, Feature, or Multilingual field already exists for the vehicle being patched, the new value provided in the JSON body will first be validated.

    • Upon successful validation, the existing value will be replaced/updated with the new one.

  2. Add New Values

    • If the specified Attribute, Feature, or Multilingual field does not exist for the vehicle, the provided value will be inserted/added to that vehicle record.

  3. Remove Existing Values

    • If a key is included in the request but its value is left empty (for example, "WEIGHT": ""), the corresponding entry for that Attribute, Feature, or Multilingual field will be deleted/removed from the vehicle record.

Note: The PATCH request only applies to the fields explicitly sent in the JSON body. Any omitted fields remain unchanged.

Sample Success Request

Delete an Ad

DELETE

https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/{locationId}/{eurostocksAdId}

No need to delete images before deleting vehicle.

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Request Body

Name
Type
Description

locationId*

Number

Unique Identification number of location for which vehicle is added

eurostocksAdId*

Number

Unique Identification number of vehicle you want to delete

Sample Success Request

Sample Success Response

Upload an image

POST

https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/images/{locationId}/{eurostocksAdId}/{displaySequence}

Upload new image by binary data.

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Request Body

Name
Type
Description

locationId

Number

Unique Identification number of location for which vehicle is added

eurostocksAdId

Number

Unique Identification number of vehicle you want to delete

displaySequence

Number

Sequence no. of the new image to show on the EuroStocks website

Data Types

Request
Success Response

binary image data

Image details in binary format

Sample Success Request

Sample Success Response

Replace existing image with new image.

Update existing image

PATCH

https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/images/{locationId}/{eurostocksAdId}/{displaySequence}

Replace existing image with new image.

Headers

Name
Type
Description

UserName

String

Username which EuroStocks provides

Password

String

Password which EuroStocks provides

APIKey

String

ApiKey which EuroStocks provides

Request Body

Name
Type
Description

locationId*

Number

Unique Identification number of location for which vehicle is added

eurostocksAdId*

Number

Unique Identification number of vehicle you want to replace image

displaySequence

Number

Sequence no. of the new image want to patch

Data Types

Request
Success Response

binary image data

Image details in binary format

Sample Success Request

Sample Success Response

Change the order of existing images

Change the order of existing images

PUT

https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/images/{locationId}/{eurostocksAdId}

Sequence will be set as per provided in the request.

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Request Body

Name
Type
Description

locationId*

Number

Unique Identification number of location for which vehicle is added

eurostocksAdId

Number

Unique Identification number of vehicle

Sample Success Request

Sample Success Response

Delete images

DELETE

https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/image/{locationId}/{eurostocksAdId}/{displaySequence}

Delete image from the Ad using eurostocksAdId.

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKe*

String

ApiKey which EuroStocks provides

Request Body

Name
Type
Description

locationId*

Number

Unique Identification number of location for which vehicle is added

eurostocksAdId*

Number

Unique Identification number of vehicle

displaySequence

Number

Sequence no. of the image you want to delete

Sample Success Request

Sample Success Response

Upload interior 360d images

POST

https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/interior360dimages/{locationId}/{eurostocksAdId}/{displaySequence}

Upload new 360d image by binary data..

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Request Body

Name
Type
Description

locationId*

Number

Unique Identification number of location for which vehicle is added

eurostocksAdId*

Number

Unique Identification number of vehicle you want to replace image

displaySequence

Number

Sequence no. of the new image

Data Types

Request
Success Response

fileName

Name of the image to update

binary image data

Image details in binary format

Sample Success Request

Sample Success Response

Update 360d existing image

PATCH

https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/interior360dimages/{locationId}/{eurostocksAdId}

Replace existing image with new image.

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey

String

ApiKey which EuroStocks provides

Request Body

Name
Type
Description

locationId

Number

Unique Identification number of location for which vehicle is added

eurostocksAdId

Number

Unique Identification number of vehicle you want to replace image

Data Types

Request
Success Response

fileName

Name of the image to update

binary image data

Image details in binary format

Sample Success Request

Sample Success Response

Change the order of existing interior 360d images

PUT

https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/interior360dimages/{locationId}/{eurostocksAdId}

Sequence will be set as per provided in the request.

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Request Body

Name
Type
Description

locationId*

Number

Unique Identification number of location for which vehicle is added

eurostocksAdId

String

Unique Identification number of vehicle

Sample Success Request

Sample Success Response

Delete 360d interior image

DELETE

https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/interior360dimages/{locationId}/{eurostocksAdId}/{displaySequence}

Delete image from the Ad using eurostocksAdId.

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Request Body

Name
Type
Description

locationId*

Number

Unique Identification number of location for which vehicle is added

eurostocksAdId*

Number

Unique Identification number of vehicle

displaySequence

Number

Sequence no. of the image you want to delete

Sample Success Request

Sample Success Response

Get an Ad Information

GET

vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/vehicleDetails/{locationId}/{eurostocksAdId}

This endpoint returns comprehensive data for the specified advertisement, including its features, attributes, and portalInfo object. See the example responses below for more details.

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Request Body

Name
Type
Description

locationId*

Number

Unique Identification number of location for which vehicle is added

eurostocksAdId

Number

Unique Identification number of vehicle

Sample Success Request

Sample Success Response

Get Location Information

GET

https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/locations

Get all the locations details associated with supplier.

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Sample Success Request

Sample Success Response

Get an Ad Information From Location

GET

https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/vehicleDetails/{locationId}/

Get all vehicles added for specific location and location must be associated with supplier.

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Request Body

Name
Type
Description

locationId*

Number

Unique Identification number of location for which vehicle is added

Sample Success Request

Sample Success Response

Vehicle Types

GET

https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/vehicletypes

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Sample Success Request

Sample Success Response

Vehicle Category

GET

https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/vehiclecategories/{vehicleTypeKey}

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Request Body

Name
Type
Description

vehicleTypeKey*

String

Vehicle type key to get it's categories

Sample Success Request

Sample Success Response

Makes

GET

https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/makes/{vehicleTypeKey}

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Request Body

Name
Type
Description

vehicleTypeKey*

String

Vehicle type key to get it's makes

Sample Success Request

Sample Success Response

Models

GET

https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/models/{vehicleTypeKey}/{makeKey}

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Request Body

Name
Type
Description

vehicleTypeKey*

String

Vehicle type key to get it's model based on selected make

makeKey*

String

Make key to get related models

Sample Success Request

Sample Success Response

Features

GET

https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/features/{vehicleTypeKey}

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Request Body

Name
Type
Description

vehicleTypeKey*

String

Vehicle type key to get features

Sample Success Request

Sample Success Response

Feature Values

GET

https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/featurevalues/{featureKey}

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Request Body

Name
Type
Description

featureKey*

String

Feature key to get it's values

Sample Success Request

Sample Success Response

Attributes

GET

https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/attributes/{vehicleTypeKey}

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Request Body

Name
Type
Description

vehicleTypeKey*

String

Vehicle type key to get attributes

Sample Success Request

Sample Success Response

Languages

GET

https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/languages

List of all supported languages for vehicle info.

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Sample Success Request

Sample Success Response

Sample request Body

GET

https://vehicles-data-api.eurostocks.com/api/v2/vehicledatasupplier/VehicleDataSupplierRequestTemplate/{vehicleTypeKey}/{mandatoryMode}

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Request Body

Name
Type
Description

vehicleTypeKey*

String

Vehicle type key to get attributes

mandatoryMode

String

mandatoryMode=true is when only want mandatory details associated with Vehicle Type in request to create new Ad

mandatoryMode=false is to get all details associated with Vehicle Type to create new Ad

Sample Success Request

Sample Success Response

All Error Codes

Overview

List of possible error codes with each request.

Vehicle Add/Update vehicle request

ErrorCode - 400

{attributeValue} is invalid value of attribute {attributekey}

{attributeValue} is required

Attribute not mapped with this product type

AttributeValue already exists for {attributekey}

{attributes} are not valid attributes

{features} are not valid features

No Features mapped with this product type

{features} is not exist for this category

{featureValue} invalid for feature {featureKey}

CAMERA and CAM_360_DEGREES can not select together for feature

{attributes} are mandatory attributes

{features} are mandatory features

{featuresValue} already exist for {featureKey}

Invalid Features Value for feature {featureKey}

LANGUAGE_ISO_CODE Language is not supported

LANGUAGE_ISO_CODE is required to add multilingual attribute

{VehicleType} price can not be 0.

OTHER make not allowed

OTHER model not allowed

MILEAGE should not more then 500 for new vehicle

PRICE_ON_REQUEST is not allowed for vehicle type {vehicleType}

Extended attribute(s) is mandatory for 'nl' language

ErrorCode - 500

Something went wrong

Vehicle not added

ErrorCode - 404

sub category does not exist

product type in not match with this subcategory

location is not exists

Supplier not linked with this location

No vehicle found

Vehicle Add/Update image request

ErrorCode - 400

Invalid request

Vehicle does not belongs to the supplier

Either filename or new image not found

ErrorCode - 404

Vehicle not matched with location

ErrorCode - 500

Internal server error

Vehicle Delete request

ErrorCode - 400

Invalid request

Vehicle does not belongs to the supplier

ErrorCode - 404

Vehicle not matched with location

ErrorCode - 500

Internal server error

Get Vehicle request

ErrorCode - 400

Invalid request

Vehicle does not belongs to the supplier

ErrorCode - 404

vehicle is not found

Vehicle not matched with location

ErrorCode - 500

Internal server error

Price attributes

Parameter
Description

Parameter

Description

VAT_RECLAIMABLE

Vat Reclaimable

PRICE_NL

Price NL customer

EX_VAT_NL

EX_VAT_NL customer

EX_BPM_NL

EX_BPM_NL Customer

PRICE_EXPORT

PRICE_EXPORT Customer

EX_VAT_EXPORT

EX_VAT_EXPORT Customer

EX_BPM_EXPORT

EX_BPM_EXPORT Customer

PRICE_PORTAL_NL

PRICE_PORTAL_NL Customer

EX_VAT_PORTAL_NL

EX_VAT_PORTAL_NL Customer

EX_BPM_PORTAL_NL

EX_BPM_PORTAL_NL Customer

PRICE_PORTAL_EXPORT

PRICE_PORTAL_EXPORT Customer

EX_VAT_PORTAL_EXPORT

EX_VAT_PORTAL_EXPORT Customer

EX_BPM_PORTAL_EXPORT

EX_BPM_PORTAL_EXPORT Customer

PRICE_NL_B2B

PRICE_NL_B2B Dealer

EX_VAT_NL_B2B

EX_VAT_NL_B2B Dealer

EX_BPM_NL_B2B

EX_BPM_NL_B2B Dealer

PRICE_EXPORT_B2B

PRICE_EXPORT_B2B Dealer

EX_VAT_EXPORT_B2B

EX_VAT_EXPORT_B2B Dealer

EX_BPM_EXPORT_B2B

EX_BPM_EXPORT_B2B Dealer

PRICE_PORTAL_NL_B2B

PRICE_PORTAL_NL_B2B Dealer

EX_VAT_PORTAL_NL_B2B

EX_VAT_PORTAL_NL_B2B Dealer

EX_BPM_PORTAL_NL_B2B

EX_BPM_PORTAL_NL_B2B Dealer

PRICE_PORTAL_EXPORT_B2B

PRICE_PORTAL_EXPORT_B2B Dealer

EX_VAT_PORTAL_EXPORT_B2B

EX_VAT_PORTAL_EXPORT_B2B Dealer

EX_BPM_PORTAL_EXPORT_B2B

EX_BPM_PORTAL_EXPORT_B2B Dealer

PreviousProduct Data APINextData API

Last updated