- 06 Dec 2024
- DarkLight
For Advertisers
- Updated on 06 Dec 2024
- DarkLight
The Awin Product Feed feature allows for two file formats:
CSV
XML
We do not accept a Feed in the Excel file format (.xls).
In order to effectively capture these Feeds, we advise making use of our automation methods. The Awin UI may be configured on a schedule (up to 4 times a day) to fetch your Feed from a provided endpoint.
We can capture Feeds from your endpoints using the following request methods:
HTTP
HTTPS
FTP
SFTP
If user credentials are required to access your Feed, please provide those to your Awin contact along with the relevant URL.
If you need to whitelist our server locations, Technical Services can provide this information upon request.
Delimited Text (CSV)
When formatting this type of file, we recommend adding a header row for ease-of-use when completing Column Mapping in the Awin UI. If your header titles match those used by the Awin UI, automatic mapping of your columns will occur saving some time in the setup process.
To review our CSV Headers and their relevant descriptions, please see our CSV Column Descriptions.
Accepted Delimiters | Character |
---|---|
comma |
|
semi-colon |
|
pipe |
|
tab (use TSV file type) |
|
Compression and Character-sets
We accept UTF-8 and, optionally, files compressed in ZIP or GZIP formats.
Considerations
If the descriptions of your products, or, any other field contains a delimiter character (e.g. the comma) that field must be enclosed by double quotes (“
).
Similarly, if a field contains double quotes (“
), those quotes must be wrapped by double quotes (““
).
Please also ensure the encoding of a file is UTF-8 to prevent issues with import, especially if you wish to offer foreign language Feeds.
Extensive Markup Language (XML)
You may also provide your Feed in XML format.
Awin provides a Document Type Definition (DTD) to specify the allowed elements and fields within a provided XML Feed.
You can fetch our current DTD file here: https://productdata.awin.com/DTD/merchant/datafeedupload.1.4.dtd
Supported Columns
Not all columns supported by our CSV format are supported in XML. Similarly, you may notice that some of the column names and/or descriptions in our XML fields differ slightly from those present in the CSV guidance.
For the current version of our XML Feed, the relation of XML fields to CSV fields is as follows:
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 Feed
<?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'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'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>
....