Feeds¶

A feed is a file that contains a list of ads you want to advertise and is a way to handle repetitive asynchronous bulk uploading of ads.

Once a feed is created you can link your HTTP(s) URL through POST /feed/config or the seller console frontend to make our system fetch your file and import your ads. After that, scheduled fetches happen once per day synchronizing the system with any updates you may want to introduce to the ads list. You can stop the feed advertising process using POST /feed/config/, or the console.

Note

If you have a dedicated account manager, they can also support you by ensuring the URL of your feed is properly connected to your account.

In order to let us download your feed and all the relevant linked content, access to our outgoing IPs should be whitelisted as described in section of the Sellside API.

File Format¶

We support feed files in either an TSV or XML format. Feeds are expected to be in UTF-8 encoding. Information on the most actual set of supported data is described below in the Feed Fields section.

Note

Currently, we have introduced a number of new fields for describing the feed ad. It contains a larger subset of what is considered a ‘widely adopted market standard’. The new fields follow specifications stated in manual for Google Merchant Center customers. For more information see FAQ section.

For instructions on how to create your feed in specific formats, please expand the relevant sections.

TSV

Note

Beware that although double quotes are accepted within a field, a leading quote indicates that the complete field is quoted. In that situation, the parser must look for a terminating quote before the next separator (tab).

"First" second third will not be interpreted as a single field

First "second" third is a valid single field

If you need to start a field with quotes then the complete field needs to be enclosed in quotes as well

""First" second third" is a valid single field (notice the complete field is enclosed in quotes)

"\"First\" second third" is a valid single field (you can escape inner quotes, but field also needs to be enclosed in quotes)

TSV format follows specification described on wiki. Some complex fields, like shipping & pick-up or attributes must follow the specified encoding conventions.

download example

XML

The contents of this XML file need to adhere to the XSD available for sellers at GET /feed/xsd. All the values provided should conform to the rules specified for the valid XML document. For the more complex data (that contains, for example HTML tags) we recommend using character data (CDATA). XML escape characters are also supported.

<?xml version="1.0" encoding="UTF-8"?>
<admarkt:ads xmlns:admarkt="http://admarkt.marktplaats.nl/schemas/1.0">
    <admarkt:ad>
        <admarkt:vendorId>42</admarkt:vendorId>
        <admarkt:title>Bally 1992 Adams Family</admarkt:title>
        <admarkt:description>Best pinball machine ever made</admarkt:description>
        <admarkt:categoryId>999</admarkt:categoryId>
        <admarkt:url>https://pinball.com/game/bally-adams-family/</admarkt:url>
        <admarkt:vanityUrl>https://pinball.com</admarkt:vanityUrl>
        <admarkt:price>870000</admarkt:price>
        <admarkt:originalPrice>875000</admarkt:originalPrice>
        <admarkt:priceType>FIXED_PRICE</admarkt:priceType>
        <admarkt:phoneNumber>16123456789</admarkt:phoneNumber>
        <admarkt:emailAdvertiser>true</admarkt:emailAdvertiser>
        <admarkt:sellerName>Pinball King</admarkt:sellerName>
        <admarkt:status>ACTIVE</admarkt:status>
        <admarkt:media>
            <admarkt:image url="https://pinball.com/game/bally-adams-family/1.jpg"/>
            <admarkt:image url="https://pinball.com/game/bally-adams-family/2.jpg"/>
            <admarkt:image url="https://pinball.com/game/bally-adams-family/3.jpg"/>
        </admarkt:media>
        <admarkt:budget>
            <admarkt:cpc/>
            <admarkt:autobid>false</admarkt:autobid>
            <admarkt:totalBudget>10000</admarkt:totalBudget>
            <admarkt:dailyBudget>1000</admarkt:dailyBudget>
        </admarkt:budget>
        <admarkt:shippingOptions>
            <admarkt:shippingOption>
                <admarkt:shippingType>PICKUP</admarkt:shippingType>
                <admarkt:location>1097DN</admarkt:location>
            </admarkt:shippingOption>
            <admarkt:shippingOption>
                <admarkt:shippingType>SHIP</admarkt:shippingType>
                <admarkt:cost>695</admarkt:cost>
                <admarkt:time>2d-5d</admarkt:time>
            </admarkt:shippingOption>
        </admarkt:shippingOptions>
        <admarkt:attributes>
            <admarkt:attribute>
                <admarkt:attributeName>model</admarkt:attributeName>
                <admarkt:attributeValue>Adams Family</admarkt:attributeValue>
            </admarkt:attribute>
            <admarkt:attribute>
                <admarkt:attributeName>multiball</admarkt:attributeName>
                <admarkt:attributeValue>TRUE</admarkt:attributeValue>
            </admarkt:attribute>
            <admarkt:attribute>
                <admarkt:attributeName>screen size</admarkt:attributeName>
                <admarkt:attributeValue>32"</admarkt:attributeValue>
            </admarkt:attribute>
            <admarkt:attribute>
                <admarkt:attributeName>resolutions</admarkt:attributeName>
                <admarkt:attributeValue>1024x768:24dpi</admarkt:attributeValue>
                <admarkt:attributeValue>800x600:18dpi</admarkt:attributeValue>
            </admarkt:attribute>
        </admarkt:attributes>
        <admarkt:gtin>840639124391</admarkt:gtin>
        <admarkt:productType>Hobby &amp; Games &gt; Arcade Games &gt; Pinball Machines</admarkt:productType>
        <admarkt:googleProductCategory>Electronics &gt; Arcade Equipment &gt; Pinball Machines</admarkt:googleProductCategory>
        <admarkt:brand>Bally</admarkt:brand>
        <admarkt:condition>refurbished</admarkt:condition>
        <admarkt:energyEfficiencyClass>E</admarkt:energyEfficiencyClass>
        <admarkt:minEnergyEfficiencyClass>F</admarkt:minEnergyEfficiencyClass>
        <admarkt:maxEnergyEfficiencyClass>D</admarkt:maxEnergyEfficiencyClass>
        <admarkt:color>black/white/green</admarkt:color>
        <admarkt:gender>unisex</admarkt:gender>
        <admarkt:ageGroup>adult</admarkt:ageGroup>
        <admarkt:itemGroupId>BC23456</admarkt:itemGroupId>
    </admarkt:ad>
</admarkt:ads>

download example

Feed Fields¶

A set of required and optional fields defined by a feed for XML and TSV file formats are listed below.

TSV

Field	Description	Restrictions	Mandatory
vendor id	unique ad identifier	max. 64 chars	yes
campaign vendor id	Identifier for the campaign	max. 64 chars	no
seller name	your company name	max. 60 chars	no
title	item title	title	yes
description	item description	description	yes
category id	category identifier	numeric, positive	yes
status	desired status (default ACTIVE)	ACTIVE,PAUSED	no
url	item URL	max. 2048 chars	no
vanity url	displayed URL	max. 256 chars	no
price type	sales model for item	enum	yes
price	item price in cents if applicable	positive integer	yes/no
original price	original price before discount	positive integer	no
image link	primary image	item images	no
additional image link	additional images	item images	no
attributes	collection of item attributes	attributes	no
autobid	budget details	budget details	no
cpc	budget details	budget details	no
total budget	budget details	budget details	no
daily budget	budget details	budget details	no
shipping	shipping options	shipping & pick-up	no
pickup location	pickup location	shipping & pick-up	no
phone number	phone number	max. 32 chars	no
email advertiser	allow emails to the seller	true,false	no
micro tip	tiny item highlight	max. 18 chars	no
MPN	Manufacturer Part Number (MPN)	2-70 chars	no
google product category	google category for your item	string	no
product type	item product type	max. 750 chars	no
brand	item brand name	max. 70 chars	no
GTIN	Global Trade Identification Number	max. 50 chars	no
item group id	groups item variants	max. 50 chars	no
condition	condition of item	enum	no
material	main item fabrics or materials	max. 200 chars	no
energy efficiency class	energy efficiency class	enum	no
min energy efficiency class	minimal energy efficiency class	enum	no
max energy efficiency class	maximal energy efficiency class	enum	no
color	item colors	max. 100 chars	no
gender	gender item is designed for	enum	no
age group	age group item is intended for	enum	no
size	size information	enum	no
unit pricing base measure	denominator for item unit price	string	no
unit pricing measure	measure and dimension of item	string	no

XML

Field	Description	Restrictions	Mandatory
vendor id	unique ad identifier	max. 64 chars	yes
campaign vendor id	Identifier for the campaign	max. 64 chars	no
external id	deprecated	–	–
seller name	your company name	max. 60 chars	no
title	item title	title	yes
description	item description	description	yes
category id	category identifier	numeric, positive	yes
status	desired status (default ACTIVE)	ACTIVE,PAUSED	no
url	item URL	max. 2048 chars	no
vanity url	displayed URL	max. 256 chars	no
price type	sales model for item	enum	yes
price	item price in cents if applicable	positive integer	yes/no
original price	original price before discount	positive integer	no
media	item images	item images	no
attributes	collection of item attributes	attributes	no
budget	budget details	budget details	no
shipping options	shipping options	shipping & pick-up	no
phone number	phone number	max. 32 chars	no
email advertiser	allow emails to the seller	true,false	no
micro tip	tiny item highlight	max. 18 chars	no
MPN	Manufacturer Part Number (MPN)	2-70 chars	no
google product category	google category for your item	string	no
product type	item product type	max. 750 chars	no
brand	item brand name	max. 70 chars	no
GTIN	Global Trade Identification Number	max. 50 chars	no
item group id	groups item variants	max. 50 chars	no
condition	condition of item	enum	no
material	main item fabrics or materials	max. 200 chars	no
energy efficiency class	energy efficiency class	enum	no
min energy efficiency class	minimal energy efficiency class	enum	no
max energy efficiency class	maximal energy efficiency class	enum	no
color	item colors	max. 100 chars	no
gender	gender item is designed for	enum	no
age group	age group item is intended for	enum	no
size	size information	enum	no
unit pricing base measure	denominator for item unit price	string	no
unit pricing measure	measure and dimension of item	string	no

vendor id¶

The vendor id field is the unique identifier of the ad. It is there to let us know, for consecutive imports, which ads are the same. This results is allowing us to track and update an existing ad with the same vendor id instead of creating a new ad.

The vendor id is mandatory and must be unique for each ad in the feed. Duplicate vendor ids are not allowed and will invalidate the entire feed, preventing further processing.

Note

If an ad in the feed remains unchanged (compared to previous import, including image urls), we will skip over this ad and leave it unchanged in our system. This also means we will not attempt to download the images and process them again. This is an optimization that allows us to speed up processing significantly and cut down on calls to your image server. Any change in the ad (including it re-appearing in the feed if it wasn’t present the previous time) will update the ad and trigger image re-processing.

TSV

Stored in vendor id column.

Example

15839942

XML

Example:

<admarkt:vendorId>15839942</admarkt:vendorId>

Restrictions: Non-empty unique-per-ad string with a maximum of 64 characters.

campaign vendor id¶

The campaign vendor id field is the unique identifier of a campaign to which the ad belongs. It is optional and only needs to be provided if the seller uses multiple campaigns. Otherwise the ad will be placed in the default campaign automatically. Changing the campaign vendor id will move the ad to the campaign identified by that vendor id. If one does not exist, a new campaign with that vendor id will be created.

TSV

Stored in campaign vendor id column.

Example

my-christmas-campaign-2020

XML

Example:

<admarkt:campaignVendorId>my-christmas-campaign-2020</admarkt:campaignVendorId>

Restrictions: Any non-empty latin-1 characters string with a maximum of 64 characters.

external id¶

Deprecated, replaced by vendorId

XML

Warning

There is still an external id field in the XSD, this field is replaced by vendor id. Please update your XML to reflect this change. This makes naming consistent between feeds and sellside API. The ref:feed_vendorId field in the feeds has the same meaning and constraints as the vendor id field in the sellside API.

seller name¶

Use the seller name field to communicate your company name to be displayed.

TSV

Stored in seller name column.

Example

Cups, Caps & Craps

XML

Example

<admarkt:sellerName>Cups, Caps &amp; Craps</admarkt:sellerName>

Restrictions: Maximum of 60 characters.

title¶

Use the title title field to clearly identify the item you are selling. The title is one of the most prominent parts of your ad or free listing. A specific and accurate title will help us show your item to the right buyers.

TSV

Stored in title column.

Example

Goedkope A-merk herenfietsen

XML

Example

<admarkt:title>Goedkope A-merk herenfietsen</admarkt:title>

Restrictions: Minimum and maximum length determined by category, with a maximum of 1024 characters. See Categories. URLs are not allowed as part of the title.

description¶

Use the description field to tell buyers about the details of the item you are selling.

TSV

Stored in description column. Multiline descriptions must be quoted, or ending line characters, and tabulators escaped with \n, \t.

Example

"<p><strong><u>De goedkoopste webshop</u></strong>
        <strong>voor tweedehands fietsen met garantie!
        Gratis en rijklaar thuisbezorgd!</strong>
    </p>
    <p><strong><br></strong>
    </p>
    <ul>
        <li><strong>Laagste prijsgarantie</strong></li>
        <li>Fietsen <strong>100% rijklaar</strong>
        gratis thuisbezorgd</li>
        <li><strong>Ruime voorraad</strong>, voor ieder wat wils</li>
        <li>Snelle <strong>customer service</strong>
        via Whatsapp, bellen en e-mail</li>
        <li>1 <strong>maand garantie</strong></li>
        <li>Aangesloten bij <strong>Webwinkelkeur</strong></li>
    </ul>
    <strong><br></strong>
    <p>Check dus snel onze website en vind de fiets die bij je past!<br>
    </p>
    <strong><br></strong>
    <p>WhatsApp, bel of mail ons voor verdere vragen.
    </p>"

XML

Example

<admarkt:description><![CDATA[
    <p><strong><u>De goedkoopste webshop</u></strong>
        <strong>voor tweedehands fietsen met garantie!
        Gratis en rijklaar thuisbezorgd!</strong>
    </p>
    <p><strong><br></strong>
    </p>
    <ul>
        <li><strong>Laagste prijsgarantie</strong></li>
        <li>Fietsen <strong>100% rijklaar</strong>
        gratis thuisbezorgd</li>
        <li><strong>Ruime voorraad</strong>, voor ieder wat wils</li>
        <li>Snelle <strong>customer service</strong>
        via Whatsapp, bellen en e-mail</li>
        <li>1 <strong>maand garantie</strong></li>
        <li>Aangesloten bij <strong>Webwinkelkeur</strong></li>
    </ul>
    <strong><br></strong>
    <p>Check dus snel onze website en vind de fiets die bij je past!<br>
    </p>
    <strong><br></strong>
    <p>WhatsApp, bel of mail ons voor verdere vragen.
    </p>]]>
<admarkt:description/>

Restrictions: Minimum and maximum length determined by the category. See Categories. URLs are not allowed as part of the description. All HTML elements except for the ones below will be removed:

<u> <em> <ul> <li> <p> <strong> <br>

category id¶

Use category id to place your item in the Categories tree.

Each item belongs to one and only one category.

TSV

Stored in category id column.

Example

PAUSED

XML

Example

<admarkt:categoryId>945</admarkt:categoryId>

Restrictions: An integer value from the category list. Must be an id of a leaf category with a non-zero parent id.

status¶

Use status to change the state of your ad.

Must be one of the following:

Name	Description
ACTIVE	The ad will be active (as long as there is budget for it) and it can be found on the marketplace.
PAUSED	The ad will be paused, effectively not found on the marketplace.

The provided (desired) status may differ from the resulting one, depending on the other conditions. For instance, budget may be depleted, or you may have too many active ads already in the category.

TSV

Stored in status column.

Example

PAUSED

XML

Example

<admarkt:status>PAUSED</admarkt:status>

Restrictions: Allowed values are ACTIVE, PAUSED

url¶

Utilize the url to establish a connection to your item page from the advertisement. This represents an external URL, which will be displayed on the ad detail page or search result page.

TSV

Stored in url column.

Example

https://www.bmw.de

XML

Example

<admarkt:url>https://www.bmw.de</admarkt:url>

Restrictions: Must be a valid http(s) url.

vanity url¶

Use vanity url to provide the text for the url link.

TSV

Stored in vanity url column.

Example

BMW

XML

Example

<admarkt:vanityUrl>BMW</admarkt:vanityUrl>

price type¶

Use price type to define pricing model for your item.

TSV

Stored in price type column.

Example

FIXED_PRICE

XML

Example

<admarkt:priceType>FIXED_PRICE</admarkt:priceType>

Restrictions: Allowed Values are BIDDING, BIDDING_FROM, FIXED_PRICE, FREE, SEE_DESCRIPTION, CREDIBLE_BID

price¶

Use price to tell buyers the price of the item you are selling. The meaning of the value depends on the price type.

If price type is FIXED_PRICE or BIDDING_FROM then price is mandatory and needs to be greater than 0.

TSV

Stored in price column.

Example

XML

Example

<admarkt:price>1500</admarkt:price>

Restrictions: The maximum allowed price value is 10000000000 given in cents of the local market currency. (100.000.000,00 EUR / CAD / … ).

original price¶

Use original price to tell your item price before discount. Ignored if a seller does not have a discount feature enabled.

TSV

Stored in original price column.

Example

XML

Example

<admarkt:originalPrice>1500</admarkt:originalPrice>

Restrictions: Must be greater than price. The maximum allowed item price value is 10000000000 given in cents of the local market currency (100.000.000,00 EUR / CAD / … ).

item images¶

You can provide multiple images for your item.

All images will be resized if necessary to a size of maximum 1024px height and 1024px width (preserving the aspect ratio) The system will download the images and, if they meet the requirements, store them on our servers in several sizes.

The main image is shown in search results and acts as the first image on the item page. Additional images will be presented in the provided order in the item page.

TSV

Use image link column to provide the link to the main image of your item.

Example

https://images.pexels.com/photos/62289.jpeg

Use additional image link for more images of your item. Multiple values should be separate with commas.

Example

https://images.pexels.com/photos/62290.jpeg,https://images.pexels.com/photos/62291.jpeg

XML

Use <media> tag for grouping your item images. <media> should contain from 0 to N <image> ordered elements.

The first element is considered the main image

Example

<admarkt:media>
    <admarkt:image url="https://images.pexels.com/photos/62289/62289.jpeg"/>
    <admarkt:image url="https://images.pexels.com/photos/47547/47547.jpeg"/>
<admarkt:media/>

Restrictions: Image number limit depends on the category in the tenant taxonomy

All URLs links must be complete, and pointing to an image on a publicly available web server.

Allowed image formats: JPEG, JPG, PNG, GIF*, BMP.

* Please note that GIFs are not recommended format as they are only 256 colors or less. Also, animated GIFs and PNGs are not supported.

attributes¶

Use attributes field to provide additional information on your item in a structured way, by providing a list of item User-Defined Attributes that can be used to influence the ad relevance. You can provide an arbitrary number of attributes sharing the same structure. When attributes are processed we check if there are is a match to any attribute defined at category level. User-defined attributes that match a category’s predefined key and value are automatically recognized as Category Attributes.

TSV

Note

In TSV format there is no way to directly specify the attribute locale. If the attribute is a Category Attributes (attributes that match category defined attributes), then the attribute locale defined at category level will be used.

Use attributes column to provide a list of item attributes using the the format: name:value.

Example

model:GXS32

You can provide multiple attributes in a comma- separated list.

Example

model:GXS32,screen size:32",touch:FALSE

If the value represents a list, each list entry should be split by a comma, and the value needs to be enclosed in quotes.

Example

model:GXS32,touch:FALSE,screen size:32",resolutions:"1024x768:24dpi,800x600:18dpi",type:"Slim,Pro"

XML

Example

<admarkt:attributes>
    <admarkt:attribute>
        <admarkt:attributeName>model</admarkt:attributeName>
        <admarkt:attributeLocale>nl</admarkt:attributeLocale>
        <admarkt:attributeLabel>model</admarkt:attributeLabel>
        <admarkt:attributeValue>GXS32</admarkt:attributeValue>
    </admarkt:attribute>
    <admarkt:attribute>
        <admarkt:attributeName>screen size</admarkt:attributeName>
        <admarkt:attributeLocale>nl</admarkt:attributeLocale>
        <admarkt:attributeLabel>screen size</admarkt:attributeLabel>
        <admarkt:attributeValue>32"</admarkt:attributeValue>
    </admarkt:attribute>
    <admarkt:attribute>
        <admarkt:attributeName>touch screen</admarkt:attributeName>
        <admarkt:attributeLocale>nl</admarkt:attributeLocale>
        <admarkt:attributeLabel>touch screen</admarkt:attributeLabel>
        <admarkt:attributeValue>FALSE"</admarkt:attributeValue>
    </admarkt:attribute>
    <admarkt:attribute>
        <admarkt:attributeName>resolutions</admarkt:attributeName>
        <admarkt:attributeLabel>resolutions</admarkt:attributeLabel>
        <admarkt:attributeValue>1024x768:24dpi</admarkt:attributeValue>
        <admarkt:attributeValue>800x600:18dpi</admarkt:attributeValue>
    </admarkt:attribute>
    <admarkt:attribute>
        <admarkt:attributeName>type</admarkt:attributeName>
        <admarkt:attributeValue>Slim</admarkt:attributeValue>
        <admarkt:attributeValue>Pro</admarkt:attributeValue>
    </admarkt:attribute>
</admarkt:attributes>

budget details¶

Use budget details to tell us what is your preferred model for budgeting your ad. Use the following values to describe your model:

Name	Description	Mandatory
autobid	use auto bidding option true/false	No
cpc	CPC for the given ad in cents	No
total budget	total budget for the given ad in cents	No
daily budget	daily budget for the given ad in cents	No

TSV

Use autobid column for your choice on that option.

Example

true

Use cpc to provide your cost per click in cents.

Example

Use total budget column to determine total budget for your ad.

Example

Use daily budget column to determine daily budget for your ad.

Example

XML

Example

<admarkt:budget>
    <admarkt:totalBudget>5000</admarkt:totalBudget>
    <admarkt:dailyBudget>1000</admarkt:dailyBudget>
    <admarkt:cpc>2</admarkt:cpc>
</admarkt:budget>

Restrictions: The minimum and maximum values for the total budget depend on the category.

If the total budget provided in the ad is lower than the total amount already spent, the ad will automatically be paused.

When this value of the daily budget is reached the ad will be offline for the rest of the day, and re-activated at the beginning of the following day, unless more money is added during the same day. The minimum value depends on the category.

The minimum and maximum values of the cost per click (CPC) depend on the category.

shipping & pick-up¶

Use shipping options to inform buyers about item delivery details Each option can be described with the following information:

Name	Description	Mandatory
shippingType	SHIP, PICKUP	Yes
cost	cost of shipping in cents	No
time	time it takes to deliver the item	No
location	pick up location of the item	Yes if PICKUP

SHIP means the item can be delivered to the buyer in the provided time and for the provided cost. PICKUP means the item can be picked up by the buyer in the provided location. For SHIP provide ‘cost’ in cents and ‘time’ in days, ‘location’ is ignored. For PICKUP provide ‘location’, ‘cost’ and ‘time’ are ignored.

The ‘time’ field must be represented through the following formats, applicable for both TSV and XML:

literal values: 2d-5d and 6d-10d. These default values represent [minimum transit time in days]-[maximum transit time in days] options.

format: <number (not starting with 0)>d. The format represents [transit time in days] only (without minimum/maximum components).

TSV

Use shipping field to tell buyers about the different cost vs. time options for your item delivery.

Each option should be formatted as follows:

[cost in cents]:[<time>]

Example

2d-5d
6d-10d
1d
12d
123d

Use pickup location field to tell buyers the location your item can be picked up at. Location is given as a postal code.

Example

1097DN

XML

Example

<admarkt:shippingOptions>
    <admarkt:shippingOption>
        <admarkt:shippingType>SHIP</admarkt:shippingType>
        <admarkt:cost>695</admarkt:cost>
        <admarkt:time>6d-10d</admarkt:time>
    </admarkt:shippingOption>
</admarkt:shippingOptions>

<admarkt:shippingOptions>
    <admarkt:shippingOption>
        <admarkt:shippingType>PICKUP</admarkt:shippingType>
        <admarkt:location>1097DN</admarkt:location>
    </admarkt:shippingOption>
</admarkt:shippingOptions>

Restrictions: Shipping options can be disabled/optional/mandatory for an item. An item can contain a maximum one shipping option per shipping option type (SHIP/PICKUP). The available shipping options are configured per category, see the config field of the response in GET /categories.

phone number¶

Use the phone number field to allow buyers to call you and ask about the item.

TSV

Stored in phone number column.

Example

+31207894561

XML

Example

<admarkt:phoneNumber>+31207894561</admarkt:phoneNumber>

Restrictions: The number should be given as an international phone number format, e.g. +31207894561 or as a local phone number, e.g. 06789456612.

email advertiser¶

Use the email advertiser flag to allow buyers to contact you via email (or the other platform defined form of contact), and ask about the item. The default value is false.

TSV

Stored in email advertiser column.

Example

true

XML

Example

<admarkt:emailAdvertiser>true</admarkt:emailAdvertiser>

Restrictions: Allowed values true and false

micro tip¶

Micro tip is a short freeform text, that can be shown as a highlight on your ad image. It is a feature enabled as part of a package that sellers can purchase (currently available only for Marktplaats tenant). It provides extra attention on the ad in the search results.

If micro tip feature is not enabled for the seller, the field will be ignored.

TSV

Stored in micro tip column.

Example

TODAY 15% SALE

XML

Example

<admarkt:microTip>TODAY 15% SALE</admarkt:microTip>

Restrictions: Maximum of 18 characters. The characters .,/@#<> are not allowed.

MPN¶

Manufacturer Part Number (MPN), definition follows Google Merchant Center guidelines.

TSV

Stored in mpn column.

Example

AB12345R89TN6E

XML

Example

<admarkt:mpn>AB12345R89TN6E</admarkt:mpn>

Restrictions: Maximum of 70 characters.

google product category¶

Use this field to describe your item category in Google’s product taxonomy. See Google Merchant Center

TSV

Stored in google product category column.

Example	Apparel > Accessories > Clothing > Dresses
Example	2271

XML

Example	<admarkt:googleProductCategory> Apparel & Accessories > Clothing > Dresses </admarkt:googleProductCategory>
Example	<admarkt:googleProductCategory>2271</admarkt:googleProductCategory>

Restrictions: Should be a valid category. You can provide it using the identifier, or the full category path.

product type¶

The product type field allows you to incorporate your item unique product type classification system into the dataset. Definition follows Google Merchant Center guidelines.

TSV

Stored in product type column.

Example

Home > Women > Dresses > Maxi Dresses

XML

Example

 <admarkt:productType>
    Home &gt; Women &gt; Dresses &gt; Maxi Dresses
</admarkt:productType>

Restrictions: Maximum of 750 characters.

brand¶

Use the brand field to help buyers identify your item. Brand definition follows Google Merchant Center guidelines.

TSV

Stored in brand column.

Example

iPhone

XML

Example

<admarkt:brand>iPhone</admarkt:brand>

Restrictions: Maximum of 70 characters.

GTIN¶

GTIN (Your item’s Global Trade Item Number), definition follows Google Merchant Center guidelines.

TSV

Stored in gtin column.

Example

44320194113475

XML

Example

<admarkt:gtin>44320194113475</admarkt:gtin>

Restrictions: Maximum of 50 characters.

item group id¶

Use this field to group item variants in your item data. Item group id definition follows Google Merchant Center guidelines.

TSV

Stored in conditionitem group id column.

Example

BC23456

XML

Example

<admarkt:itemGroupId>BC23456</admarkt:itemGroupId>

Restrictions: Maximum of 50 characters.

condition¶

Use this field to inform buyers about the condition of your item. Condition definition follows Google Merchant Center guidelines.

TSV

Stored in condition column.

Example

used

XML

Example

<admarkt:condition>used</admarkt:condition>

Restrictions: Accepted values are new, refurbished, used

material¶

Material field describes the main fabric or material that your item is made of. Material definition follows Google Merchant Center guidelines.

TSV

Stored in material column.

Example

Cotton/Silk

XML

Example

<admarkt:material>Cotton/Silk</admarkt:material>

Restrictions: Use human readable material names. Provide up to 3 materials. When providing multiple materials separate each entry with a slash (“/”). Maximum of 70 characters.

energy efficiency class¶

Use this field to tell buyers how your item rates on a given energy efficiency range. See Google Merchant Center

TSV

Stored in energy efficiency class column.

Example

A+

XML

Example

<admarkt:energyEfficiencyClass>A+</admarkt:energyEfficiencyClass>

Allowed values: A+++, A++, A+, A, B, C, B, E, F, G

min energy efficiency class¶

Used in combination with max energy efficiency class to describe the item energy efficiency label. Possible values defined in energy efficiency class

TSV

Stored in min energy efficiency class column.

Example

XML

Example

<admarkt:minEnergyEfficiencyClass>G</admarkt:minEnergyEfficiencyClass>

max energy efficiency class¶

Used in combination with min energy efficiency class to describe the item energy efficiency label. Possible values defined in energy efficiency class

TSV

Stored in max energy efficiency class column.

Example

XML

Example

<admarkt:maxEnergyEfficiencyClass>B</admarkt:maxEnergyEfficiencyClass>

color¶

Use color field to tell buyers about the dominant colors of your item. Color definition follows Google Merchant Center guidelines.

TSV

Stored in color column.

Example

Black/Grey

XML

Example

<admarkt:color>Black/Grey</admarkt:color>

Restrictions: Use human readable color names. Provide up to 3 colors. When providing multiple colors separate each entry with a slash (“/”). Maximum of 100 characters.

gender¶

Use gender field to describe the gender your item is designed for. Gender definition follows Google Merchant Center guidelines.

TSV

Stored in gender column.

Example

unisex

XML

Example

<admarkt:gender>unisex</admarkt:gender>

Restrictions: Allowed values are male, female, unisex

age group¶

Use age group field to describe the age group your item is targeted at. Definition follows Google Merchant Center guidelines.

TSV

Stored in age group column.

Example

adult

XML

Example

<admarkt:ageGroup>adult</admarkt:ageGroup>

Allowed values: newborn, infant, toddler, kids, adult

size¶

Use size field to describe standardized size of your item. Size definition follows Google Merchant Center guidelines.

TSV

Stored in size column.

Example

XXL

XML

Example

<admarkt:size>S</admarkt:size>

Restrictions: Non-empty string with a maximum of 100 characters.

unit pricing base measure¶

The denominator for item unit price. See Google Merchant Center. This field attribute tells the buyers how the price of your item translates per unit.

TSV

Stored in unit pricing base measure column.

Example

1kg

XML

Example

<admarkt:unitPricingBaseMeasure>1kg</admarkt:unitPricingBaseMeasure>

Restrictions: Value should be an integer number with unit.

Supported unit values:

Weight: oz, lb, mg, g, kg
Volume: floz, pt, qt, gal, ml, cl, l, cbm
Length: in, ft, yd, cm, m
Area: sqft, sqm
Per unit: ct

unit pricing measure¶

Defines the measure and dimension of the item. That value helps buyers to understand the exact price per unit for your item. Example 125ml, 100g. See Google Merchant Center.

TSV

Stored in unit pricing measure column.

Example

15kg

XML

Example

<admarkt:unitPricingMeasure>15kg</admarkt:unitPricingMeasure>

Restrictions: Value should be an integer number with a unit.

Supported unit values:

Weight: oz, lb, mg, g, kg
Volume: floz, pt, qt, gal, ml, cl, l, cbm
Length: in, ft, yd, cm, m
Area: sqft, sqm
Per unit: ct

Errors¶

GET /feed/import shows the overview of imported feeds of the user, and GET /feed/import/{id}/detail can be a good source of information on possible errors or warnings on ads, such as missing mandatory attributes or too low CPC etc.

Frequently Asked Questions¶

Below are some common scenarios and questions with their explanations/answers.

How to use TSV format?

We introduced the TSV format in our system, to simplify the integration path. Our customers commonly use spreadsheets to store and manipulate the data, and “TSV export” is a standard option for the majority of spreadsheet programs.

The three important things to remember for successful integration:

There are some column names that we will look for, and expect to find in your TSV feed.
Multiline fields need to be escaped with double quotes, or all the line breaks changed to \n.
Some complex fields, like shipping & pick-up or attributes must follow the specified encoding conventions.

What are the newly added fields?

Those fields are considered a ‘widely adopted market standard’, required, or recommended for advertising on many other channels: MPN, google product category, product type, brand, GTIN, item group id, condition, material, energy efficiency class, min energy efficiency class, max energy efficiency class, color, gender, age group, size, unit pricing base measure, unit pricing measure.

What happens if my feed file cannot be fetched?

When a feed file cannot be fetched, nothing will change on the user’s ads. It’s as if the import didn’t happen. Since the file represents the desired list of ads to be live, we won’t do anything if we can’t get the file - we cannot read a change in the desired situation.

What happens when my feed file is empty?

When a feed file is empty, all ads of the user will be paused. An empty file means the desired list of ads to be live is empty, so all active ads are paused. Note that this also means that all ads which are in statuses BUDGET_REACHED or DAILY_BUDGET_REACHED are also paused. If you want to pause your entire ad inventory, you can download and use the file below.

My feed file contains only new ads. What happens to those I have previously created via frontend / API?

In the spirit of the feed file being the desired set of ads to be live for a user, all currently active ads (including ads in BUDGET_REACHED or DAILY_BUDGET_REACHED) will be paused and the supplied ads will be created (with status ACTIVE).

Can I modify my feed ads via frontend / API?

The feed file is considered “the desired set of ads to be live for a user”. With every daily import, all the ads will be (re)set to their representing feed values. This means you can see changes made through API or web interface undone after a successful feed import.

I have updated my feed images, and after the successful import there is no change.

If you’re changing the images without changing the URLs, the changes may not be picked up, in case the rest of the ad is also unchanged. We suggest adding a bogus parameter to the image URL to force a re-processing of the ad and its images. Make sure to not change this for every feed import, but only when you require images to be re-processed.

What happens when my XML does not validate against XSD?

If the fetched XML file does not validate against the XSD there will be no changes to your ads. Existing ads will remain unchanged and no new ads will be created.

How to validate XML against XSD?

Next to various online capabilities where you can provide both your XML and XSD files, a way to check quickly and locally is to use a tool called xmllint. With this tool you can use our XSD downloaded from GET /feed/xsd to test whether your feed is working before you let our system fetch it using the following command:

xmllint --debug --noout --schema /path/to/admarkt1.0.xsd /path/to/yourfeed.xml

For small chunks of XML you can use online validators as well, such as http://www.utilities-online.info/xsdvalidation/ or https://www.freeformatter.com/xml-validator-xsd.html. Note that these have a limit on the size of the XML you can check, but it should be more than enough to be able to test the correctness of your structure.

When I create an XML feed, do I need to use 'admarkt' prefix for all the tags, as shown in the examples?

The prefix (or more precisely the namespace) is something invented by XML creators, with some intention to differentiate domain concepts, that can have the same name, but a different meaning.

Look at the very first lines of yours (or example) xml:

<?xml version="1.0" encoding="UTF-8"?>
<admarkt:ads xmlns:admarkt="http://admarkt.marktplaats.nl/schemas/1.0">
    <admarkt:ad>
...

xmlns:admarkt there can be changed to any word:

<?xml version="1.0" encoding="UTF-8"?>
<xyz:ads xmlns:xyz="http://admarkt.marktplaats.nl/schemas/1.0">
    <xyz:ad>
...

or even skipped:

<?xml version="1.0" encoding="UTF-8"?>
<ads xmlns="http://admarkt.marktplaats.nl/schemas/1.0">
    <ad>
...

It is up to you!