Documentation Index

Fetch the complete documentation index at: https://help.awin.com/llms.txt

Use this file to discover all available pages before exploring further.

Hosting and column descriptions

Prev Next

If you are automating a product feed, please consider that we are able to retrieve a feed via HTTP(S), SFTP, or FTP. If you choose to use method, please ensure you whitelist our office and server locations, a Technical Services representative can provide this information on request.

Supported columns

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 product feed data

All product data feeds may use these fields (e.g. vertical: retail & shopping). 
* 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           |
+-----------------------+-----------------------+

*signifies a required field

Fashion product feed data

In addition to the general data fields (see above), further specific data fields may optionally be provided. Here are the specific columns for the Fashion vertical:

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

Tickets single offer data

In addition to the general data fields (see above), further specific data fields may optionally be provided. Here are the 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 single offer data

In addition to the general data fields (see above), further specific data fields may optionally be provided. Here are the 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 single offer data

In addition to the general data fields (see above), further specific data fields may optionally be provided. Here are the 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 single offer data

In addition to the general data fields (see above), further specific data fields may optionally be provided. Here are the 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   |
+------------------+--------------------+

XML product data feed

We recommend providing the product data for single offers as a CSV file, as experience has shown this to be less error-prone. For automatic import of the article list via xml file, we recommend using the Awin XML labels (see previous section).

XML Scheme:

<products><product>…</product></products>

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

Note

For Google Shopping feed XML files in the Google Shopping feed format (using Google labels instead of Awin XML feed labels), a feed import script adjustment is required. Alternatively, use the Awin feed API (based on the Google Shopping feed format).

Example:

<products>
<product>
<pid>Z187552zGDNst2b</pid>
<name>example single offer abc123</name>
<purl>https://shop-advertiserdomain.com/product/37f2c197a930?utm_source=awin&utm_medium=affiliate&utm_campaign=product-data-feed&utm_content=product-ads&utm_term=!!!productid!!!</purl>
<price>99.00</price>
<delcost>9.00</delcost>
<currency>EUR</currency>
<brand>examplebrandname</brand>
<category>examplecategoryname</category>
<colour>beige</colour>
<condition>new or refurbished</condition>
<deltime>7-12 days</deltime>
<desc>this product offer is the best, because...</desc>
<lang>EN</lang>
<basket_link>https://shop-advertiserdomain.com/product/37f2c197a930?add-to-cart=1&utm_source=awin&utm_medium=affiliate&utm_campaign=product-data-feed&utm_content=product-ads&utm_term=!!!productid!!!</basket_link>
<instock>1</instock>
<weboffer>1</weboffer>
<forsale>1</forsale>
<imgurl>https://images.cdn....com/...v0-middle.jpg</imgurl>
<thumburl>https://images.cdn....com/...v0-very-small-preview.jpg</thumburl>
<large_image>https://images.cdn....com/...v0-large.jpg</large_image>
<alternate_image>
https://images.cdn....com/...v1.jpg</alternate_image>
<modelno>ABC-387V3a</modelno>
</product>
<products>

CSV product data feed - column descriptions

Generic column descriptions

CSV column name

Vertical name

Frequency

Validation /

restrictions

Advertiser mapping notes

Description

Sample

deep_link

generic

always used

must be an URL

mandatory

direct link to single offer or product

'https://www.example.com/product/17290'

product_id

generic

always used

Must be present, unique

and non empty.

Must be 75

characters or

shorter. No control

characters allowed.

Must satisfy the

regex

/^[\p{Cc}]+$/u

/^[\p{Cc}]+$/u

mandatory

advertiser's unique

Product ID

'9815', '1',

'13546421',

'd8fea6e6-787b-401

6-9dcc-a78c005ab3

a5', '16817108',

'255', 'SANSOCKS',

'0070691',

'SHADLA', '2965'

product_name

generic

always used

Must be present

and non-empty.

HTML tags are

stripped

mandatory

advertiser's product

or single offer name

'Coin 2,5 kg',

'Madeira',

'Aberdeen Central

(Family Room -

Saver rate) Check

...', 'Adnams Jack

Brand Crystal Rye

IPA, 12 x 330ml

bott...', 'Concord

Subject Dividers

230 Micron 10-Part

Multip...', 'Calvet

Cotes Du Rhone

Reserve 2014, Red

Wine', 'Vans Leena

Mary Jane Shoes',

'5 Star Wrestling',

'Microfibre moulded

strapless bra',

'Aquabord PVC

Tongue & Groove

Travertine Beige'

price

generic

always used

Must be a number.

mandatory

price online

'110.00', '6.88',

'5.00', '12.00',

'2107.43'

image_url

generic

always used

Must be present

and non-empty.

direct link to image

'https://www.example.com/images/123875.jpg'

alternate_image

generic

sometimes used

optional

direct link to an

additional product

image

'https://www.example.com/images/123875-a.jpg'

alternate_image_tw

o

generic

sometimes used

optional

direct link to an

additional product

image

'https://www.example.com/images/123875-b.jpg'

alternate_image_thr

ee

generic

sometimes used

optional

direct link to an

additional product

image

'https://www.example.com/images/123875-c.jpg'

alternate_image_fo

ur

generic

sometimes used

optional

direct link to an

additional product

image

'https://www.example.com/images/123875-d.jpg'

average_rating

generic

sometimes used

use rating

How users have

rated the product

(see also 'rating')

base_price

generic

sometimes used

Whenever possible

use price, old_price

or rrp_price

Price per unit in

numbers

'20.49', '0.00',

'52.69', '10.85'

base_price_amount

generic

sometimes used

Whenever possible

use price, old_price

or rrp_price

Amount the base

price is relative to.

This should just be

a price

'15.99', '2625', '50'

base_price_text

generic

sometimes used

Unit the BasePrice

refers to. This

should be text e.g.

'100ml', 'kg'

'100ml', 'lb', 'kg',

'litre'

basket_link

generic

sometimes used

Trackable link for pre-filled customer basket

'https://shop-advertiserdomain.com/product/37f2c197a930?add-to-cart=1&utm_source=awin&utm_medium=affiliate&utm_campaign=product-data-feed&utm_content=product-ads&utm_term=!!!productid!!!'

brand_name

generic

often used

Name of product

brand according to

the advertiser

'Apple', 'Alcatel',

'Oakworth

Furniture', 'Ferm

Living', 'Beats by

Dr. Dre'

colour

generic

often used

Colour of the

product

'Grey', 'Blue',

'Orange'

commission_group

generic

sometimes used

Commission group

of the product

'CAR_TOOLS',

'ACCESSORIES'

condition

generic

often used

Condition of the product

'New'

currency

generic

often used

Must be a three letter ISO 4217 code. If blank will be the programme currency

Three letter ISO

4217 currency code

of price and

associated costs

(like shipping,

discounts, etc).

'GBP', 'EUR', 'USD'

custom1

generic

often used

additional field used

as needed

custom2

generic

often used

additional field used

as needed

custom3

generic

often used

additional field used

as needed

custom4

generic

sometimes used

additional field used

as needed

custom5

generic

sometimes used

additional field used

as needed

custom6

generic

sometimes used

additional field used

as needed

custom7

generic

seldom used

additional field used

as needed

custom8

generic

seldom used

additional field used

as needed

custom9

generic

seldom used

additional field used

as needed

delivery_cost

generic

often used

important within the EU

Cost of delivering the product

'0.00', '0', '4.99'

delivery_restrictions

generic

sometimes used

Whenever possible, use delivery_cost

Description of any

restrictions on

delivering the

product (e.g. age or

location)

'Not available in

Northern Ireland',

'Alcohol can only be

sent to recipients

over 18. ID may be

required on

delivery.'

delivery_time

generic

sometimes used

Estimated delivery

time and unit

(usually in days)

'7-10 working days',

'1 to 6 days', 'Next

Day', '1-3 Days', '3',

'4-5 jours', '2 to 3

days', '2-3 Days',

'2', '3-5 days'

delviery_weight

generic

seldom used

Weight of the

product (for

delivery)

description

generic

mostly used

recoomendation: remove html tags

Product or offer  description

provided by

advertiser

'West Ham United

1986 Avco Home

Shirt Frank

McAvenn...', 'Let

your little one step

out in style in these

inf...', 'The

Alessandra

Adjustable Bed has

been designed to...',

'Climbing frame

Jungle Gym

Mansion Box. With

our ex...'

dimensions

generic

sometimes used

for fashion, use

size

Product dimensions

usually given as

length x width x

height

'143.4 x 70.5 x 6.8

mm', '12 x 30 cm',

'15 inches'

ean

generic

often used

Whenever possible,

use productGTIN.

EAN is also a valid

GTIN. EAN is only

in Europe.

European Article

Number. We do not

validate the EAN.

'5019093001530',

'34262626',

'9336328002213'

in_stock

generic

often used

Where possible

use 1 to indicate in

stock and 0 to

indicate no stock.

Leaving the field

blank will also

assume there is no

stock. Populating

the field with any

text apart from 1 or

0 will assume there

is stock.

Denotes if the

product is in stock

'0', '1'

is_for_sale

generic

often used

Consider in_stock

Denotes if the item

can be bought

'0', '1'

isbn

generic

sometimes used

Whenever possible,

use productGTIN.

ISBN is also a valid

GTIN.

International

Standard Book

Number. We do not

validate the ISBN.

'8695700',

'50220922',

'5060167489525',

'5060020625954',

'5055534397954'

keywords

generic

sometimes used

Product's keywords

'Dash Fashion,

Navy Jogger

Regular,

055041557,

Regu...', 'beurre,

corporel, noix,

coco', 'Triple

Stacking Storage

Trunk,G2291, 2291,

toybox,...',

'Screwfix, 1¼"

Bottle Trap

Chrome-Plated

Brass, Chr...',

'aquafloor,

waterproof floor,

waterproof flooring,

...', 'Minuet Petite,

Asymmetric Neck

Top, 075034378,

Pet...', 'abonnement

Orange', 'Mens',

'Planet, Lotus Red

Suede Ankle Boot,

010041609, Sal...',

'thirty, days,

thirtydays'

language

generic

often used

Must be two-letter

ISO 639-1 code. If empty, defaults to 'en'

Language of the

product data as

two-letter ISO 639-1

code

'FR', 'en_GB',

'de_DE'

large_image

generic

sometimes used

direct link to a large image (non-trackable)

'https://www.example.com/images/123875.jpg'

last_updated

generic

often used

Must be a date time

Date the product was last updated

'2026-05-25','2026-05-25T00:00:00', '2026-05-25 00:00:00'

merchant_category

generic

often used

Advertiser's product

categorisation

'Nutrition', 'Beauty',

'Men's Lace-up

shoes', 'Gifts >

Anti-Ageing Sets',

'Fitness Equipment',

'SALE', 'Home',

'Women's

Jewellery', 'Surge

Protectors & Power

Strips'

merchant_product_

category_path

generic

often used

use also “merchant_category”

Product's category

path as specified by

the advertiser

'Apparel > Clothing

> T-Shirts & Tops'

merchant_product_

second_category

generic

sometimes used

Product's

sub-category as

specified by the

advertiser

'Bath & Body',

'Jongensfietsen',

'DVDs'

merchant_product_t

hird_category

generic

sometimes used

Product's third

category level as

specified by the

advertiser

'Pulls', 'Mattresses',

'Films'

merchant_thumb

generic

often used

maybe 70×70 pixels

direct link to

thumbnail image

(non-trackable)

'https://www.example.com/images/123875small.jpg'

model_number

generic

often used

Manufacturer Model

Number

'HD130', '1940000',

'4YH63',

'70-100-05',

'230011700302540'

mpn

generic

often used

Manufacturer Part

Number

'95760',

'P1089NAVSHAKE

R700ML',

'7110513092012',

'5068-01VG',

'MAS015',

'10270109',

'1108-BT-BF-Q21'

number_available

generic

seldom used

use also ‘stock_quantity‘

Product stock

available (see

stock_quantity)

parent_product_id

generic

sometimes used

Product ID of other

bundled product(s)

'AAFCK', '60405',

'10216434', 'PP-44',

'10076451',

'FH7938', '023162',

'370631',

'10000654'

pre_order

generic

often used

Can the user pre

order if not yet in

stock

'0', '1'

product_GTIN

generic

often used

Global Trade Item

Number. We do not

validate GTIN.

'5051145189278',

'5055534322987',

'0040818088319',

'074469475983'

product_model

generic

seldom used

Whenever possible,

use model_number

Model name of the

product

'Cartouche Couleur

CANON CL-511',

'Slim Fit', 'Red',

'Space Grey'

product_price_old

generic

sometimes used

Whenever possible, use also: rrp_price

The original price;

will be empty if

bigger than or equal

to the price

'10.95', '15.95',

'39.99'

product_short_desc

ription

generic

often used

Brief product description

'White cultured

pearl in graduate

size lariat neckl...',

'Lave et prolonge

l'éclat des cheveux

colorés',

'Experience

unrivalled moisture

with Mio

Skincare's...', 'Try

Beanies Irish

Cream instant

coffee as an alter...',

'Porte-monnaie, 1

emplacement carte',

'Aperçu du Produit

Nos Flocons

d'Avoine

Instantané...',

'Balance your

complexion with the

Bulldog Oil Contr...'

product_type

generic

often used

Consider using

category

Product type

'Accessory', 'Rent',

'Buy'

promotional_text

generic

sometimes used

HTML tags are

stripped

Product promotional

message

Try 6 issues of

History Revealed

magazine for just...',

'Web Exclusive',

'Postage and

Packing USD 6.95.

Free shipping for

pu...', 'Discounted

by', 'Get in cockpit

of a fighter jet for an

amazing fli...', 'The

goodybag is valid

for 30 days. Share

our gusto...', 'Free

next working day

(Mon-Fri) delivery

when you ...', 'The

rates displayed are

based on a rate

search con...',

'FREE DELIVERY',

'100% Guarantee

and First Class

Delivery Included'

rating

generic

seldom used

Product rating

'7', '8', '8.5', '3.5'

reviews

generic

sometimes used

Consider using

rating

Textual reviews

from customers

'Wonderful!', 'We

loved it!',

'Disappointing'

rrp_price

generic

often used

Recommended

retail price

Recommended

Retail Price of

product

'10.95', '15.95',

'39.99', '3970.29'

saving

generic

sometimes used

Absolute savings in

currency. Consider

using

savings_percent for

savings in pecent

Product saving

'16.68', '6.60',

'140.00'

savings_percent

generic

sometimes used

Savings in

percentage.

Consider using

saving for absolute

savings.

The discount

expressed in %

'40.00', '39.39',

'0.00'

size_stock_amount

generic

seldom used

Number of products

in stock for each

size

'S:0|M:0|L:0|XL:0|X

XL:13|XXXL:30|4XL

:1',

'39:1,41:7,42:21,43:

25,43+:15,44:15,44

+:2,45:10,46:...'

size_stock_status

generic

seldom used

Stock status of the product for each size

'24;28;29;30;31;32;

33;34',

'XS:available|S:avai

lable|M:available|L:

available|X...'

specifications

generic

often used

HTML tags are

stripped

Product technical

specifications

'Black',

''Cups&Band: 100%

polyester; Cup &

Band Lining:

100%...', '* Colour:

Black * SIM Type:

Micro SIM *

Camera Meg...'

stock_quantity

generic

often used

Product stock

available

'200', '9', '1475', '3'

stock_status

generic

sometimes used

use in_stock

Stock status

indication

'in stock', 'out of stock', 'available', 'not available

store_price

generic

often used

Price in-store

'10.74', '16.79', '43'

terms_of_contract

generic

seldom used

Conditions of

contract for the

product

'Your Activity:

Using your

gift voucher...'

upc

generic

sometimes used

Whenever possible,

use productGTIN.

UPC is also a valid

GTIN.

Universal Product

Code

'05034948040403',

'700053288591',

'077315000056'

valid_from

generic

sometimes used

Product offer start

date

'2026-05-25','2026-05-25T00:00:00', '2026-05-25 00:00:00'

valid_to

generic

sometimes used

Product offer expiry

date

'2026-12-31','2026-12-31T23:59:59', '2027-01-01 00:00:00'

warranty

generic

sometimes used

HTML tags are

stripped

Product warranty

'Furniture Insurance

available: 3 Year

Protection £...', '1

year', 'No quibbles

money back

quarantee'

web_offer

generic

often used

Must be '1' or '0' or

'yes' or 'no'. Default

'0'

Denotes if the

product is only

available online

(usually True/False

or Yes/No)

'0', '1'