.. _feed-details: Feed Fields =========== A set of required and optional fields defined by a feed for XML and TSV file formats are listed below. .. collapse:: TSV ========================================= ==================================== =================== =========== Field Description Restrictions Mandatory ========================================= ==================================== =================== =========== :ref:`feed_vendorId` **unique** ad identifier max. 64 chars yes :ref:`feed_sellerName` your company name max. 60 chars no :ref:`feed_t` product title see :ref:`feed_t` yes :ref:`feed_descr` product description :ref:`feed_descr` yes :ref:`feed_categoryId` category identifier numeric, positive yes :ref:`feed_status` desired status (default ACTIVE) ACTIVE,PAUSED no :ref:`feed_url` product URL max. 2048 chars no :ref:`feed_vanityUrl` displayed URL max. 256 chars no :ref:`feed_priceType` sales model for product enum yes :ref:`feed_price` product price in cents if applicable positive integer yes/no :ref:`feed_originalPrice` original price before discount positive integer no :ref:`image link ` primary image :ref:`feed_media` no :ref:`additional image link ` additional images :ref:`feed_media` no :ref:`feed_attr` collection of product attributes :ref:`feed_attr` no :ref:`autobid ` budget details :ref:`feed_budget` no :ref:`cpc ` budget details :ref:`feed_budget` no :ref:`total budget ` budget details :ref:`feed_budget` no :ref:`daily budget ` budget details :ref:`feed_budget` no :ref:`shipping ` shipping options :ref:`feed_ship` no :ref:`pickup location ` pickup location :ref:`feed_ship` no :ref:`feed_phoneNumber` phone number max. 32 chars no :ref:`feed_emailAdvertiser` allow emails to the seller true,false no :ref:`feed_regionId` only applicable for Kijiji Canada numeric no :ref:`feed_microTip` tiny product highlight max. 18 chars no :ref:`feed_mpn` Manufacturer Part Number (MPN) 2-70 chars no :ref:`feed_googleProductCategory` google category for your product string no :ref:`feed_productType` customer product type max. 750 chars no :ref:`feed_brand` product brand name max. 70 chars no :ref:`feed_gtin` Global Trade Identification Number max. 50 chars no :ref:`feed_itemGroupId` groups product variants in your max. 50 chars no :ref:`feed_condition` condition of product enum no :ref:`feed_material` main product fabrics or materials max. 200 chars no :ref:`feed_energyEfficiencyClass` energy efficiency class enum no :ref:`feed_minEnergyEfficiencyClass` minimal energy efficiency class enum no :ref:`feed_maxEnergyEfficiencyClass` maximal energy efficiency class enum no :ref:`feed_color` product colors max. 100 chars no :ref:`feed_gender` gender product is designed for enum no :ref:`feed_ageGroup` age group product is intended for enum no :ref:`feed_size` size information enum no :ref:`feed_unitPricingBaseMeasure` denominator for product unit price string no :ref:`feed_unitPricingMeasure` measure and dimension of product string no ========================================= ==================================== =================== =========== .. collapse:: XML ====================================== ==================================== =================== =========== Field Description Restrictions Mandatory ====================================== ==================================== =================== =========== :ref:`feed_vendorId` **unique** ad identifier max. 64 chars yes :ref:`feed_externalId` **deprecated** -- -- :ref:`feed_sellerName` your company name max. 60 chars no :ref:`feed_t` product title see :ref:`feed_t` yes :ref:`feed_descr` product description :ref:`feed_descr` yes :ref:`feed_categoryId` category identifier numeric, positive yes :ref:`feed_status` desired status (default ACTIVE) ACTIVE,PAUSED no :ref:`feed_url` product URL max. 2048 chars no :ref:`feed_vanityUrl` displayed URL max. 256 chars no :ref:`feed_priceType` sales model for product enum yes :ref:`feed_price` product price in cents if applicable positive integer yes/no :ref:`feed_originalPrice` original price before discount positive integer no :ref:`media ` product images :ref:`feed_media` no :ref:`feed_attr` collection of product attributes :ref:`feed_attr` no :ref:`budget ` budget details :ref:`feed_budget` no :ref:`shipping options ` shipping options :ref:`feed_ship` no :ref:`feed_phoneNumber` phone number max. 32 chars no :ref:`feed_emailAdvertiser` allow emails to the seller true,false no :ref:`feed_regionId` only applicable for Kijiji Canada numeric no :ref:`feed_microTip` tiny product highlight max. 18 chars no :ref:`feed_mpn` Manufacturer Part Number (MPN) 2-70 chars no :ref:`feed_googleProductCategory` google category for your product string no :ref:`feed_productType` customer product type max. 750 chars no :ref:`feed_brand` product brand name max. 70 chars no :ref:`feed_gtin` Global Trade Identification Number max. 50 chars no :ref:`feed_itemGroupId` groups product variants in your max. 50 chars no :ref:`feed_condition` condition of product enum no :ref:`feed_material` main product fabrics or materials max. 200 chars no :ref:`feed_energyEfficiencyClass` energy efficiency class enum no :ref:`feed_minEnergyEfficiencyClass` minimal energy efficiency class enum no :ref:`feed_maxEnergyEfficiencyClass` maximal energy efficiency class enum no :ref:`feed_color` product colors max. 100 chars no :ref:`feed_gender` gender product is designed for enum no :ref:`feed_ageGroup` age group product is intended for enum no :ref:`feed_size` size information enum no :ref:`feed_unitPricingBaseMeasure` denominator for product unit price string no :ref:`feed_unitPricingMeasure` measure and dimension of product string no ====================================== ==================================== =================== =========== | .. index:: vendorId .. _feed_vendorId: 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. **vendor id** is mandatory and, unique for each ad in the feed. .. 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. .. collapse:: TSV Stored in **vendor id** column. ========= ================================================ Example .. code-block:: text 15839942 ========= ================================================ .. collapse:: XML Use **vendorId** tag name to encapsulate **vendor id**. ========= ================================================ Example: .. code-block:: html 15839942 ========= ================================================ | Restrictions: Any non-empty string with a maximum length of 64 characters. .. index:: externalId .. _feed_externalId: external id """"""""""" Deprecated, replaced by vendorId .. collapse:: 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. | .. index:: sellerName .. _feed_sellerName: seller name """"""""""" Use the **seller name** field to communicate your company name to be displayed. .. collapse:: TSV Stored in **seller name** column. ========= ================================================ Example .. code-block:: text Cups, Caps & Craps ========= ================================================ .. collapse:: XML ======= ====================================================== Example .. code-block:: html Cups, Caps & Craps ======= ====================================================== | Restrictions: max. 60 characters .. index:: title .. _feed_t: title """"" Use the title **title** field to clearly identify the product 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 product to the right customers. .. collapse:: TSV Stored in **title** column. ======= ==================================================== Example .. code-block:: text Goedkope A-merk herenfietsen ======= ==================================================== .. collapse:: XML ======= ==================================================== Example .. code-block:: html Goedkope A-merk herenfietsen ======= ==================================================== | Restrictions: Any string, with minimum and maximum length determined by the category, with a maximum cap of 1024 characters. See :ref:`categories`. URLs are not allowed as part of the title. .. index:: description .. _feed_descr: description """"""""""" Use the **description** field to tell customers about the details of the product you are selling. .. collapse:: TSV Stored in **description** column. Multiline descriptions must be quoted, or ending line characters, and tabulators escaped with \\n, \\t. ======= ==================================================== Example .. code-block:: text "

De goedkoopste webshop voor tweedehands fietsen met garantie! Gratis en rijklaar thuisbezorgd!


  • Laagste prijsgarantie
  • Fietsen 100% rijklaar gratis thuisbezorgd
  • Ruime voorraad, voor ieder wat wils
  • Snelle customer service via Whatsapp, bellen en e-mail
  • 1 maand garantie
  • Aangesloten bij Webwinkelkeur

Check dus snel onze website en vind de fiets die bij je past!

WhatsApp, bel of mail ons voor verdere vragen.

" ======= ==================================================== .. collapse:: XML ======= ================================================================================= Example .. code-block:: html De goedkoopste webshop voor tweedehands fietsen met garantie! Gratis en rijklaar thuisbezorgd!


  • Laagste prijsgarantie
  • Fietsen 100% rijklaar gratis thuisbezorgd
  • Ruime voorraad, voor ieder wat wils
  • Snelle customer service via Whatsapp, bellen en e-mail
  • 1 maand garantie
  • Aangesloten bij Webwinkelkeur

Check dus snel onze website en vind de fiets die bij je past!

WhatsApp, bel of mail ons voor verdere vragen.

]]> ======= ================================================================================= | Restrictions: Any string, with minimum and maximum length determined by the category. See :ref:`categories`. URLs are not allowed as part of the description. All HTML elements except for the ones below will be removed: .. code-block:: html


  • .. index:: categoryId .. _feed_categoryId: category id """"""""""" Use **category id** to place your product in the :ref:`categories` tree. Each product belongs to one and only one category. .. collapse:: TSV Stored in **category id** column. ========= ======================== Example .. code-block:: text PAUSED ========= ======================== .. collapse:: XML ======= =========================================================== Example .. code-block:: html 945 ======= =========================================================== | Restrictions: An integer value from the category list. Must be an id of a leaf category with a non-zero parent id. .. index:: status .. _feed_status: 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. .. collapse:: TSV Stored in **status** column. ========= ======================== Example .. code-block:: text PAUSED ========= ======================== .. collapse:: XML ======= =========================================================== Example .. code-block:: html PAUSED ======= =========================================================== | Allowed values: *ACTIVE*, *PAUSED* .. index:: url .. _feed_url: url """ Utilize the **url** to establish a connection to your product page from the advertisement. This represents an external URL, which will be displayed on the ad detail page or search result page. .. collapse:: TSV Stored in **url** column. ========= ======================== Example .. code-block:: text https://www.bmw.de ========= ======================== .. collapse:: XML ======= =========================================================== Example .. code-block:: html https://www.bmw.de ======= =========================================================== | Restrictions: Must be a valid http(s) url. .. index:: vanityUrl .. _feed_vanityUrl: vanity url """"""""""" Use **vanity url** to provide the text for the :ref:`feed_url` link. .. collapse:: TSV Stored in **vanity url** column. ========= ======================== Example .. code-block:: text BMW ========= ======================== .. collapse:: XML ======= =========================================================== Example .. code-block:: html BMW ======= =========================================================== | .. index:: priceType .. _feed_priceType: price type """""""""" Use **price type** to define :ref:`pricing model` for your product. .. collapse:: TSV Stored in **price type** column. ========= ======================== Example .. code-block:: text FIXED_PRICE ========= ======================== .. collapse:: XML ======= =========================================================== Example .. code-block:: html FIXED_PRICE ======= =========================================================== | Allowed Values: BIDDING, BIDDING_FROM, FIXED_PRICE, FREE, NEGOTIABLE, SEE_DESCRIPTION, SWAP, CREDIBLE_BID, ON_DEMAND, NOT_APPLICABLE, RESERVED .. index:: price .. _feed_price: price """"" Use **price** to tell customers the price of the product you are selling. The meaning of the value depends on the :ref:`feed_priceType`. If it is `FIXED_PRICE` or `BIDDING_FROM` then **price** is mandatory and needs to be greater than 0. .. collapse:: TSV Stored in **price** column. ========= ======================== Example .. code-block:: text 1500 ========= ======================== .. collapse:: XML ======= =========================================================== Example .. code-block:: html 1500 ======= =========================================================== | Restrictions: The maximum allowed **price** value is ``10000000000`` given in ``cents`` of the local market currency. (100.000.000,00 EUR / CAD / ... ). .. index:: originalPrice .. _feed_originalPrice: original price """""""""""""" Use **original price** to tell your product price before discount. Ignored if a seller does not have a discount feature enabled. .. collapse:: TSV Stored in **original price** column. ========= ======================== Example .. code-block:: text 1500 ========= ======================== .. collapse:: XML ======= =========================================================== Example .. code-block:: html 1500 ======= =========================================================== | Restrictions: Must be greater than :ref:`feed_price`. The maximum allowed **product price** value is ``10000000000`` given in ``cents`` of the local market currency (100.000.000,00 EUR / CAD / ... ). .. index:: media .. _feed_media: product images """""""""""""" You can provide multiple images for your product. 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. .. collapse:: TSV Use **image link** column to give us a link to the best picture of your product. ========= ======================== Example .. code-block:: text https://images.pexels.com/photos/62289.jpeg ========= ======================== Use **additional image link** for even more pictures of your product. If there are more than one, separate them with commas. ========= ======================== Example .. code-block:: text https://images.pexels.com/photos/62290.jpeg,https://images.pexels.com/photos/62291.jpeg ========= ======================== All URLs must be complete links pointing to an image on a publicly available web server. .. collapse:: XML Use **** tag for grouping your product images. **** should contain from 0 to N **** ordered elements, where the exact limit depends on the category in taxonomy. **** elements must contain a complete URL link pointing to an image on a publicly available web server. ======= =========================================================== Example .. code-block:: html ======= =========================================================== The images will be presented in the provided order. The first image is shown in search results and acts as the main image on the item page. | 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. .. index:: attributes .. _feed_attr: attributes """""""""" Use **attributes** field to provide additional information on your product in a structured way. .. collapse:: TSV Define your attribute as *name*:*value* pair in the **attributes** column. ========= ======================== Example .. code-block:: text model:Adams Family ========= ======================== You can provide multiple attributes in a comma- separated list. ========= ======================== Example .. code-block:: text model:Adams Family,multiball:TRUE,screen size:32" ========= ======================== If the name, or the value of your attribute contains commas, use quotes to escape it. ========= ======================== Example .. code-block:: text resolutions:"1024x768:24dpi,800x600:18dpi" ========= ======================== .. collapse:: XML **attributes** tag contains collection of product :ref:`user_defined_attributes` (category-dependent), that can be used to influence the ad relevance. ======= =========================================================== Example .. code-block:: html color nl Kleur Rood color en Color Red Model Slim Pro ======= =========================================================== | .. index:: budgetDetails .. _feed_budget: 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 Required ============= ========================================== ======== 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 ============= ========================================== ======== .. collapse:: TSV Use **autobid** column for your choice on that option. ========= ======================== Example .. code-block:: text true ========= ======================== Use **cpc** to provide your cost per click in cents. ========= ======================== Example .. code-block:: text 105 ========= ======================== Use **total budget** column to determine total budget for your ad. ========= ======================== Example .. code-block:: text 5000 ========= ======================== Use **daily budget** column to determine daily budget for your ad. ========= ======================== Example .. code-block:: text 1000 ========= ======================== .. collapse:: XML ======= =========================================================== Example .. code-block:: html 5000 1000 2 ======= =========================================================== | 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. .. index:: shippingOptions .. _feed_ship: shipping & pick-up """""""""""""""""" Provide the information on how your product can be delivered to customers. .. collapse:: TSV Use **shipping** field to tell customers about the different cost vs. time options for your product delivery. Each option should be formatted as follows: [*cost in cents*]:[*