Setting up a vtwonen API
UI update: There is a new channel selection page and overview for Feeds and Marketplaces (previously called APIs)! Some visuals and instructions may not be up-to-date.
Step 1: Create a new connection
Navigate to [Your project] > Channels.
Click +Add new API. This will redirect you to your company's connections page.
On the connections page, select +Add a new connection.
Search for the "vtwonen" connection by clicking through the pages and select it by clicking on it.
Add a label.
Click Create. You will be redirected to vtwonen for the next step.
Once redirected, log in using your vtwonen credentials.
After successfully logging in, the connection with vtwonen is ready. Next, you will be navigated back to the API setup.
Step 2: Create the API
Once you have created your connection, you need to select your new vtwonen connection and configure your API settings:
In the Name field, enter a name for your API.
Choose the Unique ID per item from the dropdown. We recommend the 'id' field.
Select the Language for your API.
Click Continue to create your vtwonen API.
Step 3: Create your product listings
Follow these steps to set up your channel.
Categorize your products
To set up your product data, assign categories to your products.
AI product categorization: Automatically assigns product categories through our algorithm.
Manual Categorization: Manually assign product categories with custom rules. You can create detailed filters to map each product to the correct category.
Uncategorized Items: Products that still need to be reviewed and categorized
Set up rules
Rules help you quickly optimize your product data for the marketplace you want to sell on.
Rule templates: Commonly used rules you can adjust for your use case.
Rules setup: Set up rules to refine your product data. This can include filtering, modifying, or enhancing data fields to meet marketplace requirements.
Build your listings
The Build step is where you configure your product listings to match marketplace requirements. It’s an essential step for getting your products live and avoiding errors.
Mandatory and optional fields:
Mandatory fields : Required to list your products on this marketplace
Recommended : Recommended to avoid errors
Optional : Not required to list
Shared attributes
Shared attributes are the common fields that apply across your products, such as EAN, prices, and titles. This step ensures uniformity in basic product information across your listings.
Use static or dynamic values:
Static values: Fixed values that don’t change (e.g. brand name, manufacturer)
Dynamic values: Fields that automatically change based on the linked data (e.g. stock, prices)
Category-specific attributes
Category-specific attributes are fields that specifically apply to the category for your products. This step helps fine-tune your listings to meet category requirements for your marketplace.
Fill in attributes that are specific to the selected category (e.g. size for clothing or dimensions for furniture.)
Tip: Click Auto-map fields to automatically map using information using information from your other channels or other similar setups. Learn more.
Check the quality of your set up
The Quality step provides feedback on your channel before you activate it. It highlights mandatory and optional errors to ensure your product data meets requirements to list on the marketplace.
Solve errors, prioritizing mandatory errors first.
Actions:
View items: See products with specific issues.
View in build: Redirects to the Build step to map missing information.
Set categories: Directs to the Categories step to categorize items.
Show source: Available for ID fields. Directs to the Settings step.
Preview before activating
The Preview step displays the attributes you mapped in the Build step, helping you check if everything is configured correctly by providing an overview of your products and potential errors.
Filtering:
Filter by error: Click the All dropdown and select if you would like to filter to display only products with errors, or products with a specific error.
Filter by category: Click the All categories dropdown and select the category you want to filter by.
Before you continue:
Review Shared attributes: Ensure all mandatory shared attributes are filled.
Review Category-specific attributes: Ensure all mandatory category-specific attributes are filled.
Check for errors: Correct any red-marked fields.
Additional requirements for vtwonen
These attribute requirements are specific to vtwonen and apply to the attributes in the Build step.
Shared attributes tab
Shipping class (logistic class): The logistic classes determine the respective shipping costs for your items. Enter the logistic class of your product.
Lead time to ship: The shipping lead time indicates the time required until the package is handed over to the shipping. Indicate the shipping time in days.
Title requirements
Product titles should consist of the following:
Brand
The brand name as it is registered
Product type
The product category, for example, "sofa". This must be written in lower case
Series/product name
The series or product name that helps to identify the variant of the product. Each word must be written with a capital letter
Attributes
The distinguishing features of the product, for example, color, dimensions or material
Structure: Brand Product type Name - Attributes
Example: vtwonen pendant lamp Titan - black.
Product description
The product descriptions for your vtwonen API should:
address the customer (“you” and “your”)
be written in a friendly, helpful and respectful tone
avoid jargon or technical terms, if relevant to the target group
describe the product features and the benefits and experience
use relevant keywords
not contain abbreviations
Product descriptions should consist of the following:
Short description
An overview of the product to highlight the most important features. HTML is not allowed
Bullet points
The key features and benefits of the product. Minimum 3 and maximum 5 points
Long description
Detailed information about the product's features, specifications, materials and usage. Also, styling and maintenance tips. HTML is allowed (bold and lists)
Image requirements
Minimum resolution
800 x 800 px
Maximum resolution
4472 x 4472 px
Supported formats
JPEG, PNG, WebP, GIF
Style
No watermarks, logos or text components
Video requirements
Duration
Between 30 sec. and 2 min
Resolution
1080p or higher
Supported formats
.mp4, .mov, .avi, .flv
Style
No borders, sketches, watermarks, logos, labels or prices
Best practices
Adding multiple attribute values: When adding multiple values in an attribute field for Mirakl Marketplaces, separate each value with a pipe symbol "|" to ensure proper detection and processing.
Seller's Product ID for Single/simple products: There are two attributes named 'SellerArticleId' and 'SellerProductId,' respectively. 'SellerProductId' refers to the Parent ID, while 'SellerArticleId' refers to the variant items. For single products, both attributes must be filled with the same value.
For more information on Mirakl Marketplace errors, how-to's, and best practices, check out our dedicated guide.
Step 4: Send your product listings to vtwonen
Once your product listings are ready, you need to send them to vtwonen:
If you have not activated your project, go to [Your project] > Settings and click Activate project.
In [Your project] > APIs, go to [Your vtwonenAPI] > Settings.
Click Activate API.
Once you have activated the API, navigate back to APIs.
Click on the Run now button in the 'Status' column to send your product listings to vtwonen.
Last updated
Was this helpful?