Advertiser XML DTD 1.4 File Format

From Wiki

Jump to: navigation, search

Contents

Introduction

We also offer an XML upload for advertisers. Our XML upload supports most but not all product data CSV feed fields.

The supported fields are listed below but only the CSV upload supports all fields you can find in the CSV download.

DTD

Our XML format is described in the Awin Product Data Feed DTD 1.4.

https://ui2.awin.com/DTD/merchant/datafeedupload.1.4.dtd

The older 1.3 version:

https://ui2.awin.com/DTD/merchant/datafeedupload.1.3.dtd

Supported Columns

Not all columns from CSV are supported for XML upload.

Column Descriptions for CSV gives detailed information how our feeds are structured and which data we expect for each column/parameter.

For version 1.4, the following columns are supported.

Please note that the names of the XML fields in some cases are slightly different from those in the above CSV documentation.

The below tables give the XML field names which should be used in your XML feed and their mapping to the columns in the publisher download and CSV upload.


Generic fields: 

All product data feeds may use these fields. *signifies a required field

+-----------------------+-----------------------+
| xmlFieldName          |CSV Documentation Name |
+-----------------------+-----------------------+
| pid*                  | product_id            |
| category              | merchant_category     |
| price*                | price                 |
| brand                 | brand_name            |
| upc                   | upc                   |
| ean                   | ean                   |
| mpn                   | mpn                   |
| isbn                  | isbn                  |
| modelno               | model_number          |
| name*                 | product_name          |
| desc*                 | description           |
| spec                  | specifications        |
| promotext             | promotional_text      |
| lang                  | language              |
| purl*                 | deep_link             |
| thumburl              | merchant_thumb        |
| imgurl*               | image_url             |
| deltime               | delivery_time         |
| validfrom             | valid_from            |
| validto               | valid_to              |
| currency              | currency              |
| delcost               | delivery_cost         |
| weboffer              | web_offer             |
| preorder              | pre_order             |
| instock               | in_stock              |
| stockquant            | stock_quantity        |
| forsale               | is_for_sale           |
| warranty              | warranty              |
| condition             | condition             |
| ptype                 | product_type          |
| parentpid             | parent_product_id     |
| cg                    | commission_group      |
| lastupdated           | last_updated          |
| dimensions            | dimensions            |
| colour                | colour                |
| keywords              | keywords              |
| custom1               | custom1               |
| custom2               | custom2               |
| custom3               | custom3               |
| custom4               | custom4               |
| custom5               | custom5               |
| saving                | saving                |
| delivery_restrictions | delivery_restrictions |
| reviews               | reviews               |
| average_rating        | average_rating        |
| rating                | rating                |
| alternate_image       | alternate_image       |
| large_image           | large_image           |
| basket_link           | basket_link           |
+-----------------------+-----------------------+


fashion:

Specific columns for the 'Fashion' vertical.

+--------------+--------------------+
| xmlFieldName |CSV Name            |
+--------------+--------------------+
| suitable_for | suitable_for       |
| size         | size               |
| material     | material           |
| pattern      | pattern            |
| swatch       | swatch             |
+--------------+--------------------+


tickets:

Specific columns for the 'Tickets' vertical.

+----------------+--------------------+
| xmlFieldName   | CSV Name           |
+----------------+--------------------+
| primary_artist | primary_artist     |
| second_artist  | second_artist      |
| event_date     | event_date         |
| event_name     | event_name         |
| venue_name     | venue_name         |
| venue_address  | venue_address      |
| available_from | available_from     |
| genre          | genre              |
| min_price      | min_price          |
| max_price      | max_price          |
| longitude      | longitude          |
| latitude       | latitude           |
+----------------+--------------------+


travel:

Specific columns for the 'Travel' vertical.

+---------------------+---------------------+
| xmlFieldName        | CSV Name            |
+---------------------+---------------------+
| location            | location            |
| check_in_date       | check_in_date       |
| check_in_time       | check_in_time       |
| check_out_date      | check_out_date      |
| duration            | duration            |
| guests_per_room     | guests_per_room     |
| hotel_name          | hotel_name          |
| hotel_address       | hotel_address       |
| hotel_stars         | hotel_stars         |
| hotel_features      | hotel_features      |
| child_policy        | child_policy        |
| room_type           | room_type           |
| room_description    | room_description    |
| availability        | availability        |
| board_basis         | board_basis         |
| longitude           | longitude           |
| latitude            | latitude            |
| departure_code      | departure_code      |
| arrival_code        | arrival_code        |
| departure_date      | departure_date      |
| return_date         | return_date         |
| inbound_duration    | inbound_duration    |
| starting_from_price | starting_from_price |
| check_out_time      | check_out_time      |
| ticket_type         | ticket_type         |
| cancellation_policy | cancellation_policy |
| room_amenities      | room_amenities      |
+---------------------+---------------------+


groupbuy:

Specific columns for the 'Group Buying' vertical.

+-----------------+--------------------+
| xmlFieldName    | CSV Name           |
+-----------------+--------------------+
| event_city      | event_city         |
| event_address   | event_address      |
| number_sessions | number_sessions    |
| terms           | terms              |
| number_sold     | number_sold        |
| min_required    | min_required       |
| supplier        | supplier           |
| group_latitude  | group_latitude     |
| group_longitude | group_longitude    |
| deal_start      | deal_start         |
| deal_end        | deal_end           |
+-----------------+--------------------+


telco:

Specific columns for the 'Telco' vertical.

+------------------+--------------------+
| xmlFieldName     | CSV Name           |
+------------------+--------------------+
| contract_type    | contract_type      |
| term             | term               |
| initial_cost     | initial_cost       |
| month_cost       | month_cost         |
| gift             | gift               |
| inc_minutes      | inc_minutes        |
| inc_data         | inc_data           |
| connectivity     | connectivity       |
| inc_texts        | inc_texts          |
| tariff           | tariff             |
| storage_size     | storage_size       |
| special_offer    | special_offer      |
| network          | network            |
| operating_system | operating_system   |
+------------------+--------------------+


Example

<?xml version="1.0" encoding="utf-8"?>
<merchant>
	<product weboffer="no" preorder="no" instock="yes" forsale="yes">
		<name><![CDATA[Egyptian Cotton Socks, Pack of 2, Black]]></name>
		<pid>12345689</pid>
		<desc><![CDATA[Men's socks. Perfect for any suit.]]></desc>
		<category>Clothing > Men > Men&apos;s Socks</category>
		<purl>https://www.example.com/deep_link</purl>
		<imgurl>https://www.example.com/images/123456789.jpg</imgurl>
		<price>
			<actualp>10.00</actualp>
			<rrpp>15.00</rrpp>
			<storep>15.00</storep>
		</price>
		<ean>123456789</ean>
		<upc/>
		<isbn/>
		<mpn/>
		<parentpid>123456788</parentpid>
		<brand>The Great Sock Company</brand>
		<modelno/>
		<basket_link/>
		<colour>Black</colour>
		<cg/>
		<condition>new</condition>
		<dimensions></dimensions>
		<keywords>men, socks, black, egyptian cotton</keywords>
		<lang>EN</lang>
		<ptype>Men&apos;s Socks</ptype>
		<weight>100g</weight>
		<promotext><![CDATA[]]></promotext>
		<spec>100% Cotton, Machine washable, Tumble dry</spec>
		<warranty>1 year</warranty>
		<currency>GBP</currency>
		<delcost>3.50</delcost>
		<deltime>Standard delivery in 2 working days</deltime>
		<stockquant>50</stockquant>
		<saving/>
		<validfrom/>
		<validto/>
		<alternate_image>https://www.example.com/images/back/123456789.jpg</alternate_image>
		<large_image>https://www.example.com/images/big/123456789.jpg</large_image>
		<thumburl>https://www.example.com/images/small/123456789.jpg</thumburl>
		<average_rating/>
		<reviews/>
		<rating/>
		<custom1></custom1>
		<custom2></custom2>
		<custom3/>
		<custom4>Europe (EU) 10.00 GBP</custom4>
		<custom5/>
		<fashion>
			<size>7,8,9,10,12,14</size>
		</fashion>
		<travel/>
		<groupbuy/>
		<telco/>
		<giftoptions/>
		<lastupdated>2017-07-09 07:41:01</lastupdated>
	</product>
....

Privacy

Due to new European legislation regarding how websites store information about you, AWIN is updating its privacy policy. You can see the new version of our policy here. If you would like to see the information we capture on this website, please click here for further details. In order to accept cookies on this site please click the 'I ACCEPT' button