{

 "error": 401,

 "message": "Full authentication is required to access this resource."

}

{

 "error": 403,

 "message": "Access Denied."

}

https://api.awin.com/publishers/{PUBLISHER_ID}/awinfeeds/download/{ADVERTISER_ID}-{VERTICAL}-{LOCALE}.jsonl

PUBLISHER_ID

Your Awin Publisher ID

ADVERTISER_ID

An Awin Advertiser ID

VERTICAL

Currently only retail is accepted

LOCALE

The advertiser’s Awin Feed Language, all available combinations of languages and locales are currently available. For example:

• en_GB

• fr_GB

• fr_FR

• de_DE

• nl_NL

• en_NL

• en_US

https://api.awin.com/publishers/12345/awinfeeds/download/6789-retail-en_GB.jsonl

PUBLISHER_ID

12345

ADVERTISER_ID

6789

VERTICAL

retail

LOCALE

en_GB

curl -X 'GET' \

 'https://api.awin.com/publishers/12345/awinfeeds/download/6789-retail-en_GB.jsonl' \

{

 "message": "Locale not found"

}

{"product_details":".."}
{"product_details":".."}

Last Line

If the response is successful, check the last line, if the last line contains an error object, the download is in complete.

Please note once a download starts it’s not possible to change the status code of the response, so always check the final line.

{"meta":{"advertiser_id":1001,"advertiser_name":"Example Merchant"},"product_basic":{"id":"720702","title":"Tweak Sorbet"...]}}

{"error":500,"message":"Internal server error"}

{"json_line":1}

{"json_line":2}

{"json_line":3}

advertiser_id

Awin’s unique ID for the advertiser programme, Integer

advertiser_name

Name of the advertiser programme, String

{"meta": {”advertiser_id”:1001,”advertiser_name”:”Example Merchant”}}

id
- Required

Advertiser’s unique product ID to identify each product

Unicode characters: alphanumeric, underscores, and dashes

1–50 characters

{"product_basic":{"id":"16817108"}}

title
- Required

Product name

String (Unicode characters)

1–150 characters

{"product_basic":{"title":"Organic Cotton Men''s T-Shirt - Blue - M"}}

description
- Required

Product description

String (Unicode characters)

1–5,000 characters

{"product_basic":{"Made from 100% organic cotton, this classic red men''s polo has a slim fit and signature logo embroidered on the left chest. Machine wash cold; imported."}}

link
- Required

Direct link to the product – non-trackable

URL (including http or https), ASCII characters only

RFC 3986 compliant

1–2,000 characters

{"product_basic":{"link":"https://www.example.com/writing/pens"}}

image_link
- Required

Direct link to the product image

URL (including http or https), ASCII characters only

RFC 3986 compliant

1–2,000 characters

{"product_basic":{"image_link":"http://www.example.com/image1.jpg"}}

additional_image link

- Optional

Direct links to additional product images

Json Array of String

URL (including http or https), ASCII characters only

RFC 3986 compliant

1–2,000 characters

{"product_basic":{"additional_image_link":[

        "http://www.example.com/image1.jpg",

        "http://www.example.com/image2.jpg"

]}}

mobile_link

- Optional

A mobile-optimised version of advertiser’s landing page link – non-trackable

URL (including http or https), ASCII characters only

RFC 3986 compliant

1–2,000 characters

{"product_basic":{"mobile_link":"https://www.m.example.com/writing/pens"}}

aw_deep_link

Direct link to the product – trackable

1-2,000 characters

{"product_basic":{"aw_deep_link":" https://www.awin1.com/cread.php?awinmid=12345&awinaffid=6789&ued=https://www.example.com/product/17290"}}

aw_mobile_link

A mobile-optimised version of advertiser’s landing page link - trackable

1–2,000 characters

{"product_basic":{"aw_mobile_link": "https://www.awin1.com/cread.php?awinmid=12345&awinaffid=6789&ued=https://www.m.example.com/writing/pens"}}

virtual_model_link

When provided by an advertiser, use to promote 3D or AR models of the products.

1–2,000 characters

{"product_basic":{"avirtual_model_link: "https://www.awin1.com/cread.php?awinmid=12345&awinaffid=6789&ued=https://www.m.example.com/writing/pens"}}

availability
- Required

Product Availability

Supported values are available in English only

• in_stock (products that are available for purchase)

• out_ouf_stock (products currently not available to purchase)

• preorder (products that have not yet been released for sale, but orders are being taken for)

• backorder (products currently not available, but are orders are being taken for)

If 'preorder' or 'backorder' are set, the 'availability_date' will be provided

{"price_and_availability":{"availability":"in_stock"}}

availability_date
- Required if product availability is set to ‘preorder’ or ‘backorder’/Optional otherwise

Date a product set to 'preorder' or 'backorder' becomes available

YYYY-MM-DDThh:mm[±hhmm], or YYYY-MM-DDThh:mmZ

{"price_and_availability":{"availability_date":"2023-12-25T13:00-0800"}}

expiration_date

- Optional

The date the product will stop being available

YYYY-MM-DDThh:mm[±hhmm], or YYYY-MM-DDThh:mmZ

{"price_and_availability": "expiration_date":"2023-12-26T13:00-0800"}}

price
- Required

Product price

Number plus currency (ISO 4217)

{"price_and_availability":{"price":"15.00 GBP"}}

sale_price
- Recommended

Product price during sale periods

Number plus currency (ISO 4217)

{"price_and_availability":{"sale_price":"5.00 GBP"}}

sale_price_effective_date
- Recommended

To indicate the date range the sale will run for when using the sale_price attribute

YYYY-MM-DDThh:mm[±hh:mm]/YYYY-MM-DDThh:mm[±hh:mm]/, or YYYY-MM-DDThh:mmZ/YYYY-MM-DDThh:mmZ

{"price_and_availability":{"sale_price_effective_date":"2022-02-24T13:00-0800/2022-03-29T15:30-0800"}}

unit_pricing_measure

- Optional

The measure and dimension of the product

Positive number plus unit

Supported units:

• Weight: oz, lb, mg, g, kg

• Volume (US imperial): floz, pt, qt, gal

• Volume (metric): ml, cl, l, cbm

• Length: in, ft, yd, cm, m

• Area: sqft, sqm

• Per unit: ct

{"price_and_availability":{"unit_pricing_measure":"750 ml"}}

unit_pricing_base_measure

- Optional

The product’s base measure for pricing (for example, ‘100ml’ means the price is calculated based on a 100ml units)

Positive number or positive number plus unit

Supported units:

• Weight: oz, lb, mg, g, kg

• Volume (US imperial): floz, pt, qt, gal

• Volume (metric): ml, cl, l, cbm

• Length: in, ft, yd, cm, m

• Area: sqft, sqm

• Per unit: ct

Supported integers:

• 1

• 10

• 100

• 2

• 4

• 8

Additional supported metric integer + unit combinations:

• 75 cl

• 750 ml

• 50 kg

• 1000 kg

{"price_and_availability":{"unit_pricing_base_measure":"100 ml"}}

installment

- Optional

The installment payment plan available for the product.

Supported values:

• ‘months’ - the number of installments the buyer has to pay

Integer

• ‘amount’ - the amount the buyer must pay per month

ISO 4217

{"price_and_availability":{"installment":{

        "months":6,

        "amount":"50 BRL"

}}}

subscription_cost

- Optional

The details of a monthly or annual payment plan that bundles a communications service contract with a wireless product (mobile phone or tablet

Supported values:

• ‘period’ - the duration of a single subscription period. Values ‘month’ or ‘year’

• ‘period_length’ - the number of subscription periods (months or years) that the buyer must pay
  ‘amount’ - the amount the buyer must pay per month
  ISO 4217

{"price_and_availability":{"subscription_cost":{

        "period":"month",

        "period_length":12,

        "amount":"35.00 EUR"

}}}

loyalty_program
- Optional

Specifies how many and what type of loyalty points a customer receives when buying the product.

String (Unicode characters, Recommend: ASCII only)

JSON array of objects:

• ‘program_label’: the name of your loyalty programme

• ‘tier_label’: the tier, e.g. silver or gold

• ‘price’: the price of the offer

• ‘loyalty_points’: the points that can be earned

{"price_and_availability":{"loyalty_program":[

           {

              "program_label":"Progamme A"

              "tier_label":"silver"

              "price":"100 USD"

              "loyalty_points":"0.5"

           }

]}}

google_product_category_id

- Recommended

Google-defined product ID for the product

Refer to the Google product category [google_product_category] - Google Merchant Center Help

{"product_category":{"google_product_category_id

":1234}}

google_product_category

- Recommended

Google-defined product category for the product

Refer to the Google product category [google_product_category] - Google Merchant Center Help

The full category path.

Currently, we only support Google categories in English.

{"product_category":{"google_product_category":"Apparel & Accessories > Clothing > Dresses"}}

product_type
- Optional

Advertiser's product category

Unicode characters

1–750 characters

{"product_category":{"product_type":"Home > Women > Dresses > Maxi Dresses"}}

brand
- Required for all ‘new’ products/Optional otherwise

Name of the product's brand

Unicode characters (Recommended: ASCII only)

1–70 characters

{"product_identifiers":{"brand":"Google"}}

gtin

- Required/Optional for products that don’t have a GTIN

Global Trade Item Number (GTIN), a unique and internationally recognised identifier for a product.

UPC (in North America / GTIN-12)
12-digit number like 323456789012

EAN (in Europe / GTIN-13)
13-digit number like 3001234567892

JAN (in Japan / GTIN-13)
8 or 13-digit number like 49123456 or 4901234567894

ISBN (for books)
10 or 13-digit number like 1455582344 or 978-1455582341.

ITF-14 (for multipacks / GTIN-14)
14-digit number like 10856435001702

Each product and variant of a product (different colours or sizes) has its own GTIN.

If the product doesn't have a GTIN (e.g. vintage clothing or handmade goods), advertiser will provide the 'MPN' and 'brand' attributes.

{"product_identifiers":{"gtin":"3243567980126"}}

mpn
- Required if the product does not have a manufacturer assigned GTIN/Optional

Product's Manufacturer Part Number (MPN), a unique number issued by manufacturers to identify individual products

String (Alphanumeric, Unicode characters. Recommended: ASCII only)

1–70 characters

{"product_identifiers":{"mpn":"EXA12345MPLE"}}

identifier_exists
- Optional

Indicates that unique product identifiers (GTIN, MPN, Brand) aren’t available for the product.

Values is in English:

• yes

• true

• no

• false

If no value is submitted, the default is ‘yes’

{"product_identifiers":{"identifier_exists":”yes”}}

condition
- Required for ‘used’ and ‘refurbished’ products /Optional for ‘new’ products

Condition of the product

Supported values are available in English only:

• new

• refurbished

• used

{"product_detailed":{"condition":"new"}}

certification
- Required for products that require certain information to be shown in your Shopping ads or free listings, for example due to local energy efficiency or emissions related labeling regulations. Optional for all other products

If your products target any of the EU or EFTA member states or the UK, consult EU energy efficiency regulations or any applicable local law to determine if you need to provide this attribute. This includes products covered by rescaled EU energy labels

Json Array containing Json Object with keys:

Authority [certification_authority] (Required) - The authority or certification body responsible for issuing the certification. At this time, we support the following values:

• "EC" or “European_Commission” for energy labels in the EU

• “ADEME” for the French CO2 emissions class for vehicles

• “BMWK” for the German CO2 emissions classes for vehicles

Name [certification_name] (Required): The name of the certification. At this time, we support the following values:

• "EPREL", which represents energy efficiency certifications in the EU European Registry for Energy Labeling (EPREL) database.

• “Vehicle_CO2_Class” for the overall CO2 class of a vehicle

• “Vehicle_CO2_Class_Discharged_Battery” for the CO2 class of a vehicle with a discharged battery

Code [certification_code] (Sometimes Required):

The code of the certification. For example, for the EPREL certificate with the link https://eprel.ec.europa.eu/screen/product/dishwashers2019/123456 the code is 123456. The code is required for European Energy Labels. Not required for Vehicle ads.

Value [certification_value] (Sometimes Required): The value of the certification. This field is ignored for certifications that require a certification code, like EPREL, but can be provided for specific certifications where a code isn't applicable. Specifically, the value of the appropriate CO2 Emission Class is required when listing vehicles in some countries. For details, refer to the Vehicle ads overview.

{"certification":{
   "certification_authority":" European_Commission",
   "certification_name":"EPREL",
   "certification_code":"123456",
   "certification_value":"ABC123"
}}

adult
- Required for ‘used’ and ‘refurbished’ products /Optional for ‘new’ products

Indicates that the product is for adults only because it contains adult content such as nudity, sexually suggestive content, or is intended to enhance sexual activity.

Supported values are available in English only:

• yes

• true

• no

• false

{"product_detailed":{"adult":true}}

multipack
- Optional

Indicates that multiple identical products have been grouped for sale as one product

Positive number greater than 2

{"product_detailed":{"multipack":20}}

is_bundle
- Optional

Indicates that a main product is grouped with other, different products, sold together as one package for a single price.

Supported values are available in English only:

• yes

• true

• no

• false

{"product_detailed":{"is_bundle":false}}

energy_efficiency_class
- Optional

The energy efficiency label of the product. In combination with ‘min_energy_efficiency_class’ and ‘max_energy_efficiency_class’ creates an energy efficiency label, for example, A+ (A+++ to G)

Values:

• A+++

• A++

• A+

• A

• B

• C

• D

• E

• F

• G

{"product_detailed":{"energy_efficiency_class":"A+"}}

min_energy_efficiency_class
- Optional

The minimum energy efficiency label of the product. In combination with ‘energy_efficiency_class’ and  'max_energy_efficiency_class' creates an energy efficiency label, for example, A+ (A+++ to D)

Values:

• A+++

• A++

• A+

• A

• B

• C

• D

• E

• F

• G

{"product_detailed":{"min_energy_efficiency_class":"A+"}}

max_energy_efficiency_class
- Optional

The maximum energy efficiency label of the product. In combination with ‘energy_efficiency_class’ and ‘min_energy_efficiency_class’ creates an energy efficiency label, for example, A+ (A+++ to D)

Values:

• A+++

• A++

• A+

• A

• B

• C

• D

• E

• F

• G

{"product_detailed":{"max_energy_efficiency_class":"D"}}

age_group
- Required for certain apparel products/Optional

The demographic the product is designed for

Supported values are available in English only:

• newborn (0-3 months old)

• infant (3-12 months old)

• toddler (1-5 years old)

• kids (5-13 years old)

• adult (Teens or older)

{"product_detailed":{"age_group":"adult"}}

color
- Required for certain apparel products/Optional

The product’s colour

String (Alphanumeric, Unicode characters)

1–100 characters total

If the product is made up of more than one colour, the primary colour is followed by up to two secondary colours that are each separated by slash.

{"product_detailed":{"color":"yellow"}}

gender
- Required for certain apparel products/Optional

The gender the product is designed for

Supported values are available in English only:

• male

• female

• unisex

{"product_detailed":{"gender":"unisex"}}

material
- Optional/ Recommended for apparel products

The main fabric or material the product is made of

String (Alphanumeric, Unicode characters)

Max 200 characters

For multiple materials (not variants), a primary material followed by up to two secondary materials that are each separated by slash

{"product_detailed":{"material":"Cotton/polyester/elastane"}}

pattern
- Optional/ Recommended for apparel products

The pattern or graphic print on the product

String (Alphanumeric, Unicode characters)

Max 100 characters

{"product_detailed":{"pattern":"Striped"}}

size
- Required for certain apparel products/Optional

The standardised size of the product

String (Alphanumeric, Unicode characters)

1–100 characters

{"product_detailed":{"size":"L"}}

size_type
- Optional/ Recommended for apparel products

The product’s size type or cut

Json Array of String

Supported values are available in English only:

• regular

• petite

• plus

• tall

• big

• maternity

Advertisers can submit up to 2 values per product

{"product_detailed":{"size_type":[

        "regular",

        "plus"

]}}

size_system
- Optional/ Recommended for apparel products

The country’s sizing system the product uses

Supported values are available in English only:

• AU

• BR

• CN

• DE

• EU

• FR

• IT

• JP

• MEX

• UK

• US

{"product_detailed":{"size_system":"UK"}}

item_group_id
- Required/Optional

The product’s group ID. If the product is one variation of a set of products (e.g. the same shoes in multiple sizes and colours), this attribute is the ID/SKU of the product.

String (Alphanumeric, Unicode characters)

1–50 characters

{"product_detailed":{"item_group_id":"AB12345"}}

product_length
- Optional

Length of the product

Number plus measurement unit

Units:

• cm

• in

Values between 1–3,000

Decimal values are supported (.)

{"product_detailed":{"product_length":"14 cm"}}

product_width
- Optional

Width of the product

Number plus measurement unit

Units:

• cm

• in

Values between 1–3,000

Decimal values are supported (.)

{"product_detailed":{"product_width":"14 cm"}}

product_height
- Optional

Length of the product

Number plus measurement unit

Units:

• cm

• in

Values between 1–3,000

Decimal values are supported (.)

{"product_detailed":{"product_height":"14 cm"}}

product_weight
- Optional

Weight of the product

Number plus measurement unit

Supported units:

g

kg

lb

oz

Values between 0–2,000  

Decimal values are supported (.)

{"product_detailed":{"product_weight":"173 g"}}

product_detail

- Optional

Technical specifications or additional details of the product not explicitly covered by other attributes

Json Array containing Json Object with keys:

• section_name

• attribute_name

• attribute_value

String (Alphanumeric, Unicode characters)

{"product_detailed":{"product_detail":[

        {

           "section_name":"General",

           "attribute_name":"Product Type",

           "attribute_value":"Digital player"

        },

        {                 "attribute_name":"Product Type",

           "attribute_value":"Digital Video"

        }

]}}

product_highlight

- Optional

A short, bulleted lists of the most relevant highlights of the products

Json Array of String

String (Alphanumeric, Unicode characters)

1–150 characters per highlight

Minimum 2, Maximum of 100 highlights

{"product_detailed":{“product_highlight":[

        "Supports thousands of apps, including Netflix, YouTube, HBO Now, Spotify, Showtime, Pandora, Google Play Movies",

        "Supports thousands of apps, including Netflix, YouTube, HBO Now, Spotify, Showtime, Pandora, Google Play Movies",

        "Supports thousands of apps, including Netflix, YouTube, HBO Now, Spotify, Showtime, Pandora, Google Play Movies"

]}}

lifestyle_image_link

- Optional

The URL for a lifestyle image to showcase the product in a real-world context
URL (including http or https), ASCII characters only, and RFC 3986 compliant

1–2,000 characters

{"shopping_campaign":{"lifestyle_image_link":"https://www.example.com/image1.jpg"}}

shipping

- Optional

Shipping speed and cost for the product. The ‘shipping’ attribute uses sub-attributes to define country, delivery area, service, price, handling time, and transit time.

Json Array containing Json Object with keys:

• ‘country’ (required) - the country that the product can be delivered to
  ISO 3166-1 country code

• Delivery area - advertisers submit one of the following:

  • ‘region’ (optional) - region/state/territory or prefecture

  • ‘postal_code' (optional) - postal code range

    • A ZIP or postal code (for example, 94043 for US and 2009 for Australia).

    • A range of postal codes (for example, 94002-95460 for US and 2009-3000 Australia).

  • location_id (optional) -  numeric criteria ID of the advertiser’s location defined by Google Ads API (AdWords API)

    • Awin accepts feeds with the location_id value, but advertisers are advised to use ‘region’ or ‘postal code’ for easier interpretation

  • location_group_name (optional) - location group set in Google Merchant Centre

    • Awin accepts feeds with the location_id value, but advertisers are advised to use ‘region’ or ‘postal code’ for easier interpretation

  • ‘service’ (optional) - service class or shipping speed

  • ‘price’ (optional) - shipping cost

  • Handling time (optional)

    • min_handling_time (optional) - minimum number of days between when an order is placed and when it's handed off to a shipping carrier

      • Whole number between 1–1,000

  • max_handling_time (optional) - maximum number of days between when an order is placed and when it's handed off to a shipping carrier

    • Whole number between 1–1,000

  • transit_time (optional)  

    • min_transit_time: minimum number of days between when a product is handed off to a shipping carrier and when it's delivered to the customer

      • Whole number between 1–1,000

    • max_transit_time: maxium number of days between when a product is handed off to a shipping carrier and when it's delivered to the customer

      • Whole number between 1–1,000

{"delivery":{"shipping": [

        {

           "country":"US",

           "region":"US",

           "postal_code":"80302",

           "location_id":21137,

           "location_group_name":"Outback",

           "service":"Overnight",

           "price":"16.00 USD",

           "min_handling_time":1,

           "max_handling_time":1,

           "min_transit_time":3,

           "max_transit_time":3

        }

]}}

shipping_weight

- Optional

The weight of the product used to calculate shipping costs

Number plus measurement unit

Units:

• g

• kg

• lb

• oz

Values between 1–1,000 for metric and 1–2,000 for imperial

Decimal points (e.g. 1.5 kg) are supported

{"delivery":{"shipping_weight":"3 kg"}

shipping_length

- Optional

Length dimensions of the package for the product

Number plus measurement unit

Units:

• cm

• in
  

Values between 1–400 for metric and 1–150 for imperial

{"delivery":{"shipping_length":"20 in"}

shipping_width

- Optional

Width dimensions of the package for the product

Number plus measurement unit

Units:

• cm

• in
  

Values between 1–400 for metric and 1–150 for imperial

{"delivery":{"shipping_width":"40 cm"}

shipping_ height

- Optional

Height dimensions of the package for the product

Number plus measurement unit

Units:

• cm

• in
  

Values between 1–400 for metric and 1–150 for imperial

{"delivery":{"shipping_height":"20 in"}

ships_from_country

- Optional

The country from which the product will usually be dispatched from

String (Unicode characters)

ISO 3166-1 Alpha-2 country code

{"delivery":{"ships_from_country":"DE"}

min_handling_time

- Optional

The shortest amount of time between when an order is placed for a product and when the product ships

Number (whole number), greater than or equal to 0

Integer, greater than or equal to 0

{"delivery":{"min_handling_time":1}

max_handling_time

- Optional

The longest amount of time between when an order is placed for a product and when the product ships

Number (whole number), greater than or equal to 0

{"delivery":{"max_handling_time":10}

tax

- Required for the United States/Optional

The product’s sales tax. Google only support this for US sales tax.

Json Array containing Json Object with keys:

• ‘country’ (optional) - the country a product can be delivered to

• Area (optional) - provide one of the following:

  • ‘region’ (optional) - submit a state

    • =ISO 3166-2 code without country prefix (e.g. 'CA')

  • ‘postal_code’ (optional) - a postal code range

    • A postal code (for example, “94043")

    • A range of postal codes (for example, “94002-95460”)

    • A range of postal codes using a prefix with a wildcard ( * ) (for example, “94*”)

    • A range of postal codes using 2 prefixes with wildcards ( * ) (for example, “94*-95*”)

  • ‘location_id’ (optional) -  numeric criteria ID of the advertiser’s location defined by Google Ads API (AdWords API)

  • Awin accepts feeds with the location_id value, but recommends but advertisers are advised to use ‘region’ or ‘postal code’ for easier interpretation

• ‘rate’ (required) - Tax rate as a percentage of the price

  • Number with decimal point (e.g. 8.75 to indicate 8.75%)

• ‘tax_ship' (optional) - whether tax is charged on shipping

  • Accepted values are ‘yes’ and ‘no’

{"tax":{

     "tax":[

        {

           "country":"US",

           "region":"CA",

           "postal_code":"94043",

           "rate":8.75,

           "tax_ship":"yes"

        }

     ]

}}