Product Data API
Data Supplier API Documentation
Introduction
Overview
The EuroStocks Product-Data-Supplier-API is an interface to store Product 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 api@eurostocks.com for any questions regarding API. |
The API is available at this base URL:
https://products-data-api.eurostocks.com
Main features
Create a new ad
Update an ad
Deactivate an ad
Activate an ad
Delete an ad
Undelete an ad
Update Stock
Upload images
Change the order of existing images
Delete image
Get location Information
Products by LocationId
Inactive Products by LocationId
Deleted Products by LocationId
Product details by LocationId and EuroStocksAdId
Fitments Makes
Fitments Models
Fitments Types
Prerequisites
Product Data supplier API access can be granted to suppliers who wants to send EuroStocks Product 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-products-data-api.eurostocks.com Note: Test data will be removed time to time.
Working with Ad Data
Overview
Product Supplier API allows you to manage your Product 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 |
imageCount | No. of images supplier will sent for requested new Product |
Product Data
Main categories to add products. Example: Accessoires or Auto onderdelen | |
Sub categories to add products. Example: Audio en toebehoren (universeel) or Bagage en Transport | |
Product types. Example: Afstandsbediening radio or Antenne | |
price | Product price Attributes and Features. |
Additional Ad Information
condition | Provides Product Condition. For example : NEW or USED |
delivery | Provides Product Delivery type. For example : Ophalen or Ophalen of verzenden |
stock | Provides Product stock. |
unlimitedStock | Provides Product unlimitedStock. |
allowOrderForOutOfStock | Provides Product allowOrderForOutOfStock. |
weight | Provides Product weight. |
warehouseLocation | Provides Product warehouseLocation. |
internalNumber | Provides Product internalNumber. |
eanNumber | Provides Product eanNumber. |
Provides all the feature available for selected Product type. For example: MONTAGE_MOGELIJK and SCHADE_OVERIGE_CATEGORIEEN. | |
Provides all the feature values available for selected feature. For example: AVAILABILITY = "RESERVED". | |
Provides all the attribute available for selected Product type. For example: MONTAGE_KOSTEN. | |
productInfo | Provides multilingual attributes which allows to add attribute for different languages. For example: PRODUCT_TITLE and PRODUCT_SPECIFIC_DESCRIPTION. |
priceInfo | Provides price information which will allow to calculate price. For example : PRICE_ON_REQUEST |
ktypes | Using ktypes Products can have its make, model and types. |
oemNumbers | Multiple oemnumbers are allowed. Max length for a oemNumber is 20 characters. alphanumeric characters are allowed. Spaces are allowed. - / \ and + is allowed. |
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
Create a new ad
POST
https://services.eurostocks.com/api/v1/productdatasupplier/productdetails
Markplaats, 2dehands and webshop will take few minutes to reflect changes. Please note, when creating a new product, activating a product or undeleting a product by default it will not get automatically added to Marktplaats.nl and/or 2dehands.be. If you want to change this behavior, please contact Eurostocks.
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 |
---|---|
n/a |
Sample Success Request
Sample Success Response
Sample Error Request
Sample Error Response
Update an ad
PUT
https://services.eurostocks.com/api/v1/productdatasupplier/productdetails
Markplaats, 2dehands and webshop will take few minutes to reflect changes.
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 |
---|---|
n/a |
Sample Success Request
Sample Success Response
Deactivate an ad
PUT
https://services.eurostocks.com/api/v1/productdatasupplier/deactivate/{locationId}/{eurostocksAdId}
To deactivate a product, the current status of product must be active. Markplaats, 2dehands and webshop will take few minutes to reflect changes. When product is deactivated then its status will be changed to deactivated and the product Ad from Marktplaats and 2dehands will be removed if Ad is active.
Headers
Name | Type | Description |
---|---|---|
Header* | 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 Product is added |
eurostocksAdId | Number | Unique Identification number of Product you want to deactivate |
Sample Success Requestc
Sample Success Response
Activate an ad
PUT
https://services.eurostocks.com/api/v1/productdatasupplier/activate/{locationId}/{eurostocksAdId}
To activate a product, the current status of product must be deactivated. Markplaats, 2dehands and webshop will take few minutes to reflect changes. Please note, when creating a new product, activating a product or undeleting a product by default it will not get automatically added to Marktplaats.nl and/or 2dehands.be. If you want to change this behavior, please contact Eurostocks.
Headers
Name | Type | Description |
---|---|---|
UserName | String | Username which EuroStocks provides |
APIKey | String | ApiKey which EuroStocks provides |
Password | String | Password which EuroStocks provides |
Request Body
Name | Type | Description |
---|---|---|
locationId | Number | Unique Identification number of location for which Product is added |
eurostocksAdId | Number | Unique Identification number of Product you want to activate |
Sample Success Request
Sample Success Response
Delete an ad
DELETE
https://services.eurostocks.comapi/v1/productdatasupplier/{locationId}/{eurostocksAdId}
No need to delete images before deleting Product. Markplaats, 2dehands and webshop will take few minutes to reflect changes. When product is deleted then its status will be changed to deleted and the product Ad from Marktplaats and 2dehands will be removed if Ad is active.
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 Product is added |
eurostocksAdId* | Number | Unique Identification number of Product you want to delete |
Sample Success Request
Sample Success Response
Undelete an ad
PUT
https://services.eurostocks.com/api/v1/productdatasupplier/undelete/{locationId}/{eurostocksAdId}
To undelete a product, the current status of product must be deleted. Markplaats, 2dehands and webshop will take few minutes to reflect changes. Please note, when creating a new product, activating a product or undeleting a product by default it will not get automatically added to Marktplaats.nl and/or 2dehands.be. If you want to change this behavior, please contact Eurostocks.
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 Product is added |
eurostocksAdId | Number | Unique Identification number of Product you want to undelted |
Sample Success Request
Sample Success Response
Update Stock
POST
https://services.eurostocks.com/api/v1/productdatasupplier/stock/{eurostocksAdId}/{locationId}/{stock}/{unlimitedStock}/{allowOrderForOutOfStock}
UnlimitedStock and AllowOrderForOutOfStock is Optional Parameters, default value is false. Markplaats, 2dehands and webshop will take few minutes to reflect changes. Stock = 0 won't change the product status and it won't remove the product from Marktplaats and 2dehands if Ad is ac
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 |
---|---|---|
eurostocksAdId* | Number | Unique Identification number of Product you want to undelted |
locationId* | Number | Unique Identification number of location for which Product is added |
stock | Number | stock value can not be greater then 999 it will accept positive and negative number |
unlimitedstock | String | unlimitedstock is optional Parameter default value is false |
allowOrderForOutOfStock | String | allowOrderForOutOfStock is optional Parameter default value is false |
Sample Success Request
Sample Success Response
Upload an image
POST
https://services.eurostocks.com/api/v1/productdatasupplier/images/{locationId}/{eurostocksAdId}/{displaySequence}
Upload new image by binary data. Markplaats, 2dehands and webshop will take few minutes to reflect changes.
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 Product is added |
eurostocksAdId* | Number | Unique Identification number of Product you want to delete |
displaySequence* | Number | Display Sequence is a unique number for each image and, it should start from 1 and it should be incremental. Duplicate display sequence is not allowed. |
Data Types
Request | Success Response |
---|---|
binary image data | Image details in binary format |
Sample Request Template
Example Screen (Right click and select open image in new tab)
Sample Success Response
Example Screen (Right click and select open image in new tab)
Sample DisplaySequence Error Response
Update existing image
PATCH
https://services.eurostocks.com/api/v1/productdatasupplier/images/{locationId}/{eurostocksAdId}/{displaySequence}
Replace existing image with new image. Markplaats, 2dehands and webshop will take few minutes to reflect changes.
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 Product is added |
eurostocksAdId | Number | Unique Identification number of Product you want to replace image |
displaySequence | Number | To patch an image at specific sequence use Display Sequence in the patch request. |
Data Types
Request | Success Response |
---|---|
binary image data | Image details in binary format |
Sample Success Request
Sample Success Response
Example Screen (Right click and select open image in new tab)
Change the order of existing images
PUT
https://services.eurostocks.com/api/v1/productdatasupplier/images/{locationId}/{eurostocksAdId}
Sequence will be set as per provided in the request. Markplaats, 2dehands and webshop will take few minutes to reflect changes.
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 Product is added |
eurostocksAdId | Number | Unique Identification number of Product |
Sample Success Request
Sample Success Response
Delete images
DELETE
https://services.eurostocks.com/api/v1/productdatasupplier/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 |
APIKey* | String | ApiKey which EuroStocks provides |
Request Body
Name | Type | Description |
---|---|---|
locationId* | Number | Unique Identification number of location for which Product is added |
eurostocksAdId* | Number | Unique Identification number of Product |
displaySequence* | Number | To delete an image at specific sequence use Display Sequence in the Delete request. |
Sample Success Request
Sample Success Response
Example Screen (Right click and select open image in new tab)
Get Location Information
GET
https://services.eurostocks.com/api/v1/productdatasupplier/locations
Get all the locations details associated with supplier.
Headers
Name | Type | Description |
---|---|---|
UserName* | String | Username which EuroStocks provides |
APIKey* | String | ApiKey which EuroStocks provides |
UserName* | String | Password which EuroStocks provides |
Sample Success Request
Sample Success Response
Products by LocationId
GET
https://services.eurostocks.com/api/v1/productdatasupplier/productlist/{locationId}
Get product list by locationId, provides EuroStocksAdId and CreatedDate and ModifiedDate having UTC date time format.
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 | LocationId for which you want the all active products list |
Sample Success Request
Sample Success Response
Inactive Products by LocationId
GET
https://services.eurostocks.com/api/v1/productdatasupplier/productlist/deactivated/{locationId}
Get inactive product list by locationId, provides EuroStocksAdId and CreatedDate and ModifiedDate having UTC date time format.
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 | LocationId for which you want the all inactive products list |
Sample Success Request
Sample Success Response
Deleted Products by LocationId
GET
https://services.eurostocks.com/api/v1/productdatasupplier/productlist/deleted/{locationId}
Get deleted product list by locationId, provides EuroStocksAdId and CreatedDate and ModifiedDate having UTC date time format.
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 | LocationId for which you want the all deleted products list |
Sample Success Request
Sample Success Response
Product details by LocationId and EuroStocksAdId
GET
https://services.eurostocks.com/api/v1/productdatasupplier/productDetails/{locationId}/{eurostocksAdId}
Get product list by locationId.
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 | LocationId for which you want the all active products list |
eurostocksAdId | Number | EurostocksAdId for which you want detail overview |
Sample Success Request
Sample Success Response
Fitments Makes
GET
https://services.eurostocks.com/api/v1/fitments/makes
Get all fitments makes information.
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
Fitments Models
GET
https://services.eurostocks.com/api/v1/fitments/{makeId}/models
Get fitments models details by makeId.
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 |
---|---|---|
makeId* | Number | MakeId for which you want all fitments Models |
Sample Success Request
Sample Success Response
Fitments Types
GET
https://services.eurostocks.com/api/v1/fitments/{modelId}/types
Get fitments types details by modelId.
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 |
---|---|---|
modelId* | Number | ModelId for which you want all fitments Types |
Sample Success Request
Sample Success Response
Main Categories
GET
https://services.eurostocks.com/api/v1/productdatasupplier/mainCategories
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
Sub Categories
GET
https://services.eurostocks.com/api/v1/productdatasupplier/subCategories/{maincategoryKey}
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
Product Types
GET
https://services.eurostocks.com/api/v1/productdatasupplier/productType/{subcategoryKey}
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
Features
GET
https://services.eurostocks.com/api/v1/productdatasupplier/features/{productTypeKey}
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
Feature Values
GET
https://services.eurostocks.com/api/v1/productdatasupplier/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* | Number | Feature key to get it's values |
Sample Success Request
Sample Success Response
Attributes
GET
https://services.eurostocks.com/api/v1/productdatasupplier/attributes/{productTypeKey}
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 |
---|---|---|
ProductTypeKey* | Number | Product type key to get attributes |
Sample Success Request
Sample Success Response
Sample Success Request
Sample Success Response
Sample request Body
GET
https://services.eurostocks.com/api/v1/productdatasupplier/productdatasupplierRequestTemplate/{ProductTypeKey}/{mandatoryMode}
Headers
Name | Type | Description |
---|---|---|
UserName* | String | Username which EuroStocks provides |
APIKey* | String | ApiKey which EuroStocks provides |
Password* | String | Password which EuroStocks provides |
Request Body
Name | Type | Description |
---|---|---|
ProductTypeKey* | String | Product type key to get attributes |
mandatoryMode | mandatoryMode=true is when only want mandatory details associated with Product Type in request to create new Ad mandatoryMode=false is to get all details associated with Product Type to create new Ad |
Sample Success Request
Sample Success Response
All Error Codes
Overview
List of possible error codes with each request.
Product Add/Update Product 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} |
{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 |
{ProductType} price can not be 0. |
PRICE_ON_REQUEST is not allowed for Product type {ProductType} |
Extended attribute(s) is mandatory for 'nl' language |
Ktype is not allow for subcategory |
Stock can not be zero |
Invalid characters in OEMNumber |
OEMNumber length should not be more then 20 characters |
Invalid price field |
ErrorCode - 500 |
---|
Something went wrong |
Product 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 Product found |
Product Add/Update image request
ErrorCode - 400 |
---|
Invalid request |
Product does not belongs to the supplier |
Either filename or new image not found |
ErrorCode - 404 |
---|
Product not matched with location |
ErrorCode - 500 |
---|
Internal server error |
Product Delete request
ErrorCode - 400 |
---|
Invalid request |
Product does not belongs to the supplier |
ErrorCode - 404 |
---|
Product not matched with location |
ErrorCode - 500 |
---|
Internal server error |
Get Product request
ErrorCode - 400 |
---|
Invalid request |
Product does not belongs to the supplier |
ErrorCode - 404 |
---|
ErrorCode - 404 |
Product is not found |
Product not matched with location |
ErrorCode - 500 |
---|
Internal server error |
Price Attributes and Features
Price Features can be identified from flag "IsPriceFeature". please refer API : https://products-data-api.eurostocks.com/api/v1/productdatasupplier/features/{productTypeKey} |
Price Attributes can be identified from flag "IsPriceAttribute". please refer API : https://products-data-api.eurostocks.com/api/v1/productdatasupplier/attributes/{productTypeKey} |
Parameter | Description |
---|---|
VAT_NOT_RECLAIMABLE | Vat Not Reclaimable (Marge product), Added as Feature |
PRICE | Price, Added as Attribute |
PRICE_ON_REQUEST | Price On Request, Added as Feature |
DISCOUNTED_PRICE | Discounted price, Added as Attribute |
EXCLUDING_VAT | Price is excluding vat, Added as Feature |
SPECIAL_SHIPPING_RATE | Special shipping rate, Added as Attribute |
Last updated