Awin

https://help.awin.com/apidocs/
Admin
Awin is an affiliate marketing platform that provides APIs for publishers and advertisers to manage...
Tokens:32,507
Snippets:343
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### API Key Request Examples

Source: https://help.awin.com/apidocs/api-authentication

Examples of how to include an API key in requests using cURL and JavaScript.

```bash
curl -X GET https://api.awin.com/public/data \
  -H "x-api-key: 9e1f55b9-aaaa-47d3-98e8-f9dcba5f4b2b"
```

```javascript
fetch('https://api.awin.com/public/data', {
  headers: {
    'x-api-key': '9e1f55b9-aaaa-47d3-98e8-f9dcba5f4b2b'
  }
})
```

--------------------------------

### Bearer Token Request Examples

Source: https://help.awin.com/apidocs/api-authentication

Examples of how to include a bearer token in API requests using cURL and JavaScript.

```bash
curl -X GET https://api.awin.com/publishers \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
```

```javascript
fetch('https://api.awin.com/publishers', {
  headers: {
    'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
  }
})
```

--------------------------------

### JSON Lines Format Example

Source: https://help.awin.com/apidocs/retail-publisher-productapidocumentation-1

Demonstrates the structure of JSON Lines, where each line is a valid, independent JSON object.

```json
{"json_line":1}
{"json_line":2}
{"json_line":3}
```

--------------------------------

### Transaction Identification Examples

Source: https://help.awin.com/apidocs/approve-decline-amend-batch-transactions-for-a-given-advertiser

Examples of identifying transactions using either a unique ID or a combination of order reference, date, and timezone.

```json
"transactionId": "484816099",
```

```json
"orderRef": "123ABC555", "transactionDate": "2017-02-20T22:04:00", "timezone": "Europe/Paris"
```

--------------------------------

### Download Feed via cURL

Source: https://help.awin.com/apidocs/retail-publisher-productapidocumentation-1

Example request for fetching a specific publisher's feed using cURL.

```json
curl -X 'GET' \
  'https://api.awin.com/publishers/12345/awinfeeds/download/6789-retail-en_GB.jsonl' \
```

--------------------------------

### Product Data JSON Structure

Source: https://help.awin.com/apidocs/retail-advertiser-productapidocumentation

Example of a complete product object containing various attributes such as pricing, shipping, and product details.

```json
{"id": "1001", "title": "Organic Cotton Men's T-Shirt - Blue - M", "description": "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": "https://youtu.be/4VXLCMOB0AI", "virtual_model_link": "https://youtu.be/N7Q2T50IXE6", "image_link": "https://media1.giphy.com/media/JADK24R38B7/giphy.gif", "additional_image_link": ["https://media1.giphy.com/media/GHX7FO8QTP5/giphy.gif", "https://media1.giphy.com/media/58O2UNZTVWD/giphy.gif"], "mobile_link": "https://media1.giphy.com/media/U48N9PLM5TI/giphy.gif", "google_product_category": "Clothing & Accessories > Clothing > Dresses", "product_type": "Home > Women > Dresses > Maxi Dresses", "gtin": "4961311891588", "mpn": "78782792", "brand": "Samsung", "identifier_exists": "yes", "availability": "in_stock", "availability_date": "2022-01-03", "expiration_date": "2024-01-03", "price": "869.06 GBP", "sale_price": "9763.41 USD", "sale_price_effective_date": "2022-01-03/2024-01-03", "unit_pricing_measure": "5 kg", "unit_pricing_base_measure": "100 ml", "installment": {"months": 6, "amount": "5 GBP"}, "subscription_cost": {"period": "month", "period_length": "12", "amount": "4785.89 GBP"}, "condition": "new", "adult": "yes", "multipack": 20, "is_bundle": false, "energy_efficiency_class": "A+", "min_energy_efficiency_class": "C", "max_energy_efficiency_class": "B", "age_group": "adult", "color": "yellow", "gender": "unisex", "material": "Cotton/polyester/elastane", "pattern": "Striped", "size": "L", "size_type": ["plus"], "certification": {"certification_authority": "European_Commission", "certification_name": "EPREL", "certification_code": "Moose", "certification_value": "Goose"}, "size_system": "DE", "item_group_id": "AB12345", "product_weight": "12.8 g", "product_height": "12 cm", "product_width": "120 cm", "product_length": "12 cm", "product_detail": [{"section_name": "General", "attribute_name": "Product Type", "attribute_value": "Digital player"}, {"attribute_name": "Product Type", "attribute_value": "Digital Video"}], "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": "https://media1.giphy.com/media/XFN3V87JH90/giphy.gif", "shipping": [{"country": "US", "region": "CA", "postal_code": "90210", "service": "Overnight", "price": "16.00 USD", "min_handling_time": "1", "max_handling_time": "1", "min_transit_time": "3", "max_transit_time": "3"}], "shipping_weight": "44 kg", "shipping_height": "12 cm", "shipping_width": "120 cm", "shipping_length": "12 cm", "min_handling_time": 100, "max_handling_time": 100, "ships_from_country": "GB", "tax": [{"country": "US", "region": "CA", "postal_code": "90210", "rate": 8.75, "tax_ship": "yes"}]}
```

--------------------------------

### Product JSON Structure

Source: https://help.awin.com/apidocs/retail-advertiser-productapidocumentation

A complete example of a valid product object. Ensure there are no new lines within the JSON structure when submitting requests.

```json
{
  "id": "1001",
  "title": "Organic Cotton Men's T-Shirt - Blue - M",
  "description": "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": "https://youtu.be/4VXLCMOB0AI",
  "virtual_model_link": "https://youtu.be/N7Q2T50IXE6",
  "image_link": "https://media1.giphy.com/media/JADK24R38B7/giphy.gif",
  "additional_image_link": [
    "https://media1.giphy.com/media/GHX7FO8QTP5/giphy.gif",
    "https://media1.giphy.com/media/58O2UNZTVWD/giphy.gif"
  ],
  "mobile_link": "https://media1.giphy.com/media/U48N9PLM5TI/giphy.gif",
  "google_product_category": "Clothing & Accessories > Clothing > Dresses",
  "product_type": "Home > Women > Dresses > Maxi Dresses",
  "gtin": "4961311891588",
  "mpn": "78782792",
  "brand": "Samsung",
  "identifier_exists": "yes",
  "availability": "in_stock",
  "availability_date": "2022-01-03",
  "expiration_date": "2024-01-03",
  "price": "869.06 GBP",
  "sale_price": "9763.41 USD",
  "sale_price_effective_date": "2022-01-03/2024-01-03",
  "unit_pricing_measure": "5 kg",
  "unit_pricing_base_measure": "100 ml",
  "installment": {
    "months": 6,
    "amount": "5 GBP"
  },
  "subscription_cost": {
    "period": "month",
    "period_length": "12",
    "amount": "4785.89 GBP"
  },
  "condition": "new",
  "adult": "yes",
  "multipack": 20,
  "is_bundle": false,
  "energy_efficiency_class": "A+",
  "min_energy_efficiency_class": "C",
  "max_energy_efficiency_class": "B",
  "age_group": "adult",
  "color": "yellow",
  "gender": "unisex",
  "material": "Cotton/polyester/elastane",
  "pattern": "Striped",
  "size": "L",
  "size_type": ["plus"],
  "certification": {
    "certification_authority": "European_Commission",
    "certification_name": "EPREL",
    "certification_code": "Moose",
    "certification_value": "Goose"
  },
  "size_system": "DE",
  "item_group_id": "AB12345",
  "product_weight": "12.8 g",
  "product_height": "12 cm",
  "product_width": "120 cm",
  "product_length": "12 cm",
  "product_detail": [
    {
      "section_name": "General",
      "attribute_name": "Product Type",
      "attribute_value": "Digital player"
    },
    {
      "attribute_name": "Product Type",
      "attribute_value": "Digital Video"
    }
  ],
  "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": "https://media1.giphy.com/media/XFN3V87JH90/giphy.gif",
  "shipping": [
    {
      "country": "US",
      "region": "CA",
      "postal_code": "90210",
      "service": "Overnight",
      "price": "16.00 USD",
      "min_handling_time": "1",
      "max_handling_time": "1",
      "min_transit_time": "3",
      "max_transit_time": "3"
    }
  ],
  "shipping_weight": "44 kg",
  "shipping_height": "12 cm",
  "shipping_width": "120 cm",
  "shipping_length": "12 cm",
  "min_handling_time": 100,
  "max_handling_time": 100,
  "ships_from_country": "GB",
  "tax": [
    {
      "country": "US",
      "region": "CA",
      "postal_code": "90210",
      "rate": 8.75,
      "tax_ship": "yes"
    }
  ]
}
```

--------------------------------

### Incomplete Download Error

Source: https://help.awin.com/apidocs/retail-publisher-productapidocumentation-1

Example of a response where the final line indicates an error, signifying an incomplete download.

```json
{
  "meta": {
    "advertiser_id": 1001,
    "advertiser_name": "Example Merchant"
  },
  "product_basic": {
    "id": "720702",
    "title": "Tweak Sorbet"
    // The content here is truncated ("..."). The rest of the product details would go here.
  }
}

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

--------------------------------

### Enhanced Product JSON Example

Source: https://help.awin.com/apidocs/retail-publisher-productapidocumentation-1

A sample product object following the Google product data specification. Note that while displayed as formatted JSON here, the actual upload format is JSONL.

```json
{
 	"id": "1001",
 	"title": "Organic Cotton Men's T-Shirt - Blue - M",
 	"description": "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": "https://youtu.be/4VXLCMOB0AI",
 	"virtual_model_link": "https://youtu.be/N7Q2T50IXE6",
 	"image_link": "https://media1.giphy.com/media/JADK24R38B7/giphy.gif",
 	"additional_image_link": [
 	 	"https://media1.giphy.com/media/GHX7FO8QTP5/giphy.gif",
 	 	"https://media1.giphy.com/media/58O2UNZTVWD/giphy.gif"
 	],
 	"mobile_link": "https://media1.giphy.com/media/U48N9PLM5TI/giphy.gif",
 	"google_product_category": "Clothing & Accessories > Clothing > Dresses",
 	"product_type": "Home > Women > Dresses > Maxi Dresses",
 	"gtin": "4961311891588",
 	"mpn": "78782792",
 	"brand": "Samsung",
 	"identifier_exists": "yes",
 	"availability": "in_stock",
 	"availability_date": "2022-01-03",
 	"expiration_date": "2024-01-03",
 	"price": "869.06 GBP",
 	"sale_price": "9763.41 USD",
 	"sale_price_effective_date": "2022-01-03/2024-01-03",
 	"unit_pricing_measure": "5 kg",
 	"unit_pricing_base_measure": "100 ml",
 	"installment": {
 	 	"months": 6,
 	 	"amount": "5 GBP"
 	},
 	"subscription_cost": {
 	 	"period": "month",
 	 	"period_length": "12",
 	 	"amount": "4785.89 GBP"
 	},
 	"condition": "new",
 	"adult": "yes",
 	"multipack": 20,
 	"is_bundle": false,
 	"energy_efficiency_class": "A+",
 	"min_energy_efficiency_class": "C",
 	"max_energy_efficiency_class": "B",
 	"age_group": "adult",
 	"color": "yellow",
 	"gender": "unisex",
 	"material": "Cotton/polyester/elastane",
 	"pattern": "Striped",
 	"size": "L",
 	"size_type": ["plus"],
 	"certification": {
 	 	"certification_authority": "European_Commission",
 	 	"certification_name": "EPREL",
 	 	"certification_code": "Moose",
 	 	"certification_value": "Goose"
 	},
 	"size_system": "DE",
 	"item_group_id": "AB12345",
 	"product_weight": "12.8 g",
 	"product_height": "12 cm",
 	"product_width": "120 cm",
 	"product_length": "12 cm",
 	"product_detail": [
 	 	{
 	 	 	"section_name": "General",
 	 	 	"attribute_name": "Product Type",
 	 	 	"attribute_value": "Digital player"
 	 	},
 	 	{
 	 	 	"attribute_name": "Product Type",
 	 	 	"attribute_value": "Digital Video"
 	 	}
 	],
 	"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": "https://media1.giphy.com/media/XFN3V87JH90/giphy.gif",
 	"shipping": [
 	 	{
 	 	 	"country": "US",
 	 	 	"region": "CA",
 	 	 	"postal_code": "90210",
 	 	 	"service": "Overnight",
 	 	 	"price": "16.00 USD",
 	 	 	"min_handling_time": "1",
 	 	 	"max_handling_time": "1",
 	 	 	"min_transit_time": "3",
 	 	 	"max_transit_time": "3"
 	 	}
 	],
 	"shipping_weight": "44 kg",
 	"shipping_height": "12 cm",
 	"shipping_width": "120 cm",
 	"shipping_length": "12 cm",
 	"min_handling_time": 100,
 	"max_handling_time": 100,
 	"ships_from_country": "GB",
 	"tax": [
 	 	{
 	 	 	"country": "US",
 	 	 	"region": "CA",
 	 	 	"postal_code": "90210",
 	 	 	"rate": 8.75,
 	 	 	"tax_ship": "yes"
 	 	}
 	]
}
```

--------------------------------

### Define installment payment plan

Source: https://help.awin.com/apidocs/retail-publisher-productapidocumentation-1

Configures an installment payment plan with the number of months and monthly amount.

```json
"installment":{ "months":6, "amount":"50 BRL" }
```

--------------------------------

### Handle API Responses

Source: https://help.awin.com/apidocs/retail-advertiser-productapidocumentation

Examples of various API response formats including success, health warnings, and validation errors.

```json
{
  "message": "Locale not found"
}
```

```json
{
  "productsReceived": 10,
  "version": 8
}
```

```json
{
  "productsReceived": 10,
  "version": 8,
  "info": [
    {
      "line": 1,
      "warnings": {
        "price_and_availability": "Additional fields found and ignored: \"sale_price\""
      }
    }
  ]
}
```

```json
{
  "line": 5,
  "errors": {
      "title": "invalid"
    }
}

{
  "line": -1,
  "status": "paused",
  "errors": "Validation paused. Further products will not be validated until the above errors have been fixed."
}
```

```json
{
  "line": 1,
  "errors": {
      "title": "invalid"
  },
  "warnings": {
    "price_and_availability": "Additional fields found and ignored: \"sale_price\""
  }
}

{
  "line": 3,
  "errors": {
    "json": "invalid"
  }
}
```

--------------------------------

### Create an Offer Request Body

Source: https://help.awin.com/apidocs/offers-api

Example JSON structure for creating a new offer. The voucherCode field is mandatory only when the offer type is set to 'voucher'.

```json
{
 	"title": "Black Friday 30% Off",
 	"description": "Save 30% on all products this Black Friday.",
 	"terms": "Offer valid until the end of the month.",
 	"type": "voucher",
 	"voucherCode": "30OFF", //this field is only required for the Offer type 'voucher'
 	"url": "https://www.example.com",
 	"startDate": "2023-10-15",
 	"endDate": "2023-11-15",
 	"startTime": "12:00:00",
 	"timeZone": "Europe/London",
 	"appliesToAllRegions": false,
 	"regions": [
 	 	29
 	],
 	"promotionCategories": [
 	 	12
 	]
}
```

--------------------------------

### Example Request Body with Multiple Commission Groups

Source: https://help.awin.com/apidocs/conversion-api

A JSON structure demonstrating how to define an order with multiple commission groups and associated basket items.

```json
{
 	"orders": [
 	 	{
 	 	 	"orderReference": "%231100011",
 	 	 	"amount": 111,
 	 	 	"channel": "aw",
 	 	 	"currency": "GBP",
 	 	 	"voucher": "10_OFF",
 	 	 	"awc": "1001_xxx_xxx",
 	 	 	"customerAcquisition": "NEW",
 	 	 	"clickRef": "clickRef",
 	 	 	"linkId": 12345,
 	 	 	"commissionGroups": [
 	 	 	 	{
 	 	 	 	 	"code": "SHOES",
 	 	 	 	 	"amount": 100
 	 	 	 	},
 	 	 	 	{
 	 	 	 	 	"code": "SHIRTS",
 	 	 	 	 	"amount": 11
 	 	 	 	}
 	 	 	 	...
 	 	 	],
 	 	 	"custom": {
 	 	 	 	"1": "s2sAPI"
 	 	 	},
 	 	 	"basket": [
 	 	 	 	{
 	 	 	 	 	"id": "123",
 	 	 	 	 	"name": "Shoe",
 	 	 	 	 	"price": 100,
 	 	 	 	 	"quantity": 1,
 	 	 	 	 	"commissionGroupCode": "SHOES",
 	 	 	 	 	"category": "Shoes",
 	 	 	 	 	"sku": "321"
 	 	 	 	},
 	 	 	 	{
 	 	 	 	 	"id": "456",
 	 	 	 	 	"name": "Shirt",
 	 	 	 	 	"price": 11,
 	 	 	 	 	"quantity": 1,
 	 	 	 	 	"commissionGroupCode": "SHIRTS",
 	 	 	 	 	"category": "Shirts",
 	 	 	 	 	"sku": "654"
 	 	 	 	}
 	 	 	 ...
 	 	 	]
 	 	}
 	 ...
 	],
 	"webhook": {
 	 	"url":
 	}
}
```

--------------------------------

### Example API Response Structure

Source: https://help.awin.com/apidocs/conversion-api

JSON structure returned after processing a batch of orders, including successful and failed order details.

```json
{ 	 
 	 "message": "",
 	 "batchId": "1111-1692271186-8274157a-bd07-4b7a-a8d4-ddb21e741d11",
 	 "successfulOrders": [
 	 	 	 {
 	 	 	 	 	 "orderReference": "#1100011",
 	 	 	 	 	 "amount": 10,
 	 	 	 	 	 "channel": "aw",
 	 	 	 	 	 "currency": "GBP",
 	 	 	 	 	 "voucher": "10_OFF",
 	 	 	 	 	 "isTest": false,
 	 	 	 	 	 "awc": "1111_xxx_xxx",
 	 	 	 	 	 "customerAcquisition": "NEW",
 	 	 	 	 	 "commissionGroups": [
 	 	 	 	 	 	 	 {
 	 	 	 	 	 	 	 	 	 "code": "DEFAULT",
 	 	 	 	 	 	 	 	 	 "amount": 1.2
 	 	 	 	 	 	 	 },
 	 	 	 	 	 	 	 ...
 	 	 	 	 	 ],
 	 	 	 	 	 "custom": {
 	 	 	 	 	 	 	 "1": "s2sAPI"
 	 	 	 	 	 },
 	 	 	 	 	 "basket": [
 	 	 	 	 	 	 	 {
 	 	 	 	 	 	 	 	 	 "id": "125",
 	 	 	 	 	 	 	 	 	 "name": "Fish",
 	 	 	 	 	 	 	 	 	 "price": 10,
 	 	 	 	 	 	 	 	 	 "quantity": 1,
 	 	 	 	 	 	 	 	 	 "commissionGroupCode": "DEFAULT",
 	 	 	 	 	 	 	 	 	 "category": "Food",
 	 	 	 	 	 	 	 	 	 "sku": "11111"
 	 	 	 	 	 	 	 }
 	 	 	 	 	 	 	 ...
 	 	 	 	 	 ],
 	 	 	 	 	 "advertiserId": 1111,
 	 	 	 	 	 "correlationId": "e653481f-94d6-497d-8279-8c925b3a1cc8"
 	 	 	 }
 	 	 	 ...
 	 	],
 	 	"failedOrders": [
 	 	 	 {
 	 	 	 	 	 "order":
 	 	 	 	 	 {
 	 	 	 	 	 	 	 "orderReference": "#1100012",
 	 	 	 	 	 	 	 "amount": "123",
 	 	 	 	 	 	 	 "channel": "aw",
 	 	 	 	 	 	 	 "currency": "GBP",
 	 	 	 	 	 	 	 "voucher": "10_OFF",
 	 	 	 	 	 	 	 "isTest": false,
 	 	 	 	 	 	 	 "awc": "1111_xxx_xxx",
 	 	 	 	 	 	 	 "customerAcquisition": "NEW",
 	 	 	 	 	 	 	 "commissionGroups": [
 	 	 	 	 	 	 	 	 	 {
 	 	 	 	 	 	 	 	 	 	 	 "code": "DEFAULT",
 	 	 	 	 	 	 	 	 	 	 	 "amount": 1
 	 	 	 	 	 	 	 	 	 },
 	 	 	 	 	 	 	 	 	 ...
 	 	 	 	 	 	 	 ],
 	 	 	 	 	 	 	 "custom": {
 	 	 	 	 	 	 	 	 	 "1": "s2sAPI"
 	 	 	 	 	 	 	 },
 	 	 	 	 	 	 	 "basket": [
 	 	 	 	 	 	 	 	 	 {
 	 	 	 	 	 	 	 	 	 	 	 "id": "",
 	 	 	 	 	 	 	 	 	 	 	 "name": "",
 	 	 	 	 	 	 	 	 	 	 	 "price": 20,
 	 	 	 	 	 	 	 	 	 	 	 "quantity": 1,
 	 	 	 	 	 	 	 	 	 	 	 "commissionGroupCode": "DEFAULT",
 	 	 	 	 	 	 	 	 	 	 	 "category": "",
 	 	 	 	 	 	 	 	 	 	 	 "sku": ""
 	 	 	 	 	 	 	 	 	 },
 	 	 	 	 	 	 	 	 	 ...
 	 	 	 	 	 	 	 ],
 	 	 	 	 	 	 	 "advertiserId": 1111,
 	 	 	 	 	 	 	 "correlationId": "55d2ee39-eae1-440c-a3ff-bc2fba496c8f"
 	 	 	 	 	 },
 	 	 	 	 	 "errors": 	 [
 	 	 	 	 	 	 	 {
 	 	 	 	 	 	 	 	 	 "field":"amount",
 	 	 	 	 	 	 	 	 	 "message":"Property 'amount' must be of type 'number'" 	
 	 	 	 	 	 	 	 },
 	 	 	 	 	 	 	 ...
 	 	 	 	 	 ]
 	 	 	 },
 	 	 	 ...
 	 ]
}
```

--------------------------------

### Webhook Notifier Example

Source: https://help.awin.com/apidocs/conversion-api

JSON payload structure sent by the Webhook notifier to provide real-time processing status of orders.

```json
{ 	 
 	 "batchId": "15716-1697459823-d5d0d86d-eb5b-423b-a70e-03551219eb67",
 	 "successfulOrders": [
 	 	 	{
 	 	 	 	 "orderReference": "#1100011",
 	 	 	 	 "correlationId": "52ee5b94-e5eb-4d21-88ee-22fe07cd1238"
 	 	 	}
 	 	],
 	 	"pendingOrders": [
 	 	 	{
 	 	 	 	 "orderReference": "#2200022",
 	 	 	 	 "correlationId": "52ee5b94-e5eb-4d21-88ee-22fe07cd1248"
 	 	 	}
 	 	],
 	 	failedOrders": [
 	 	 	{
 	 	 	 	 "orderReference": "#3300033",
 	 	 	 	 "correlationId": "52ee5b94-e5eb-4d21-88ee-22fe07cd1258",
 	 	 	 	 "code": "VAL_NO_CLICKS_MATCHED",
 	 	 	 	 "message": "No clicks matched to transaction"
 	 	 	}
 	 	],
 	 	 	 	 "timestamp": 16492495245
}
```

--------------------------------

### GET /accounts

Source: https://help.awin.com/apidocs/returns-information-about-accounts-for-a-given-user

Retrieves a list of accounts for the authenticated user, including account IDs, names, types, and user roles.

```APIDOC
## GET /accounts

### Description
Retrieves a list of accounts associated with the authenticated user. This is useful for programmatically managing requests across multiple publisher or advertiser accounts.

### Method
GET

### Endpoint
/accounts

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - accessToken

#### Query Parameters
- **accessToken** (string) - Required - access token
- **type** (string) - Optional - type of account: advertiser or publisher

### Response
#### Success Response (200)
- **accountId** (string) - ID of the account, as known from the frontend URLs
- **accountName** (string) - Programme name for an advertiser and company name for a publisher
- **accountType** (string) - Can be either publisher or advertiser
- **userRole** (string) - The role your user account has for the account
```

--------------------------------

### GET /publishers/{PUBLISHER_ID}/awinfeeds/download/{ADVERTISER_ID}-{VERTICAL}-{LOCALE}

Source: https://help.awin.com/apidocs/retail-publisher-productapidocumentation-1

Retrieves an Enhanced/Google feed for a specific advertiser in JSONL format.

```APIDOC
## GET /publishers/{PUBLISHER_ID}/awinfeeds/download/{ADVERTISER_ID}-{VERTICAL}-{LOCALE}

### Description
Downloads an Awin feed in Google-Format. This endpoint requires Bearer token authentication.

### Method
GET

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

### Parameters
#### Path Parameters
- **PUBLISHER_ID** (string) - Required - Your Awin Publisher ID
- **ADVERTISER_ID** (string) - Required - The Awin Advertiser ID of the feed
- **VERTICAL** (string) - Required - Currently only "retail" is accepted
- **LOCALE** (string) - Required - The Awin Feed Language (e.g., en_GB, fr_FR)

### Request Example
curl -X 'GET' 'https://api.awin.com/publishers/12345/awinfeeds/download/6789-retail-en_GB.jsonl'

### Response
#### Success Response (200)
- **JSONL** (object) - The feed content in JSON Lines format.

#### Error Response (404)
- **message** (string) - Error message indicating if the locale or resource was not found.
```

--------------------------------

### Example Bearer Token

Source: https://help.awin.com/apidocs/api-authentication

A truncated representation of a JWT-based bearer token.

```plaintext
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
```

--------------------------------

### GET /publishers/{publisherId}/transactions

Source: https://help.awin.com/apidocs/returns-a-list-of-transactions-for-a-given-publisher-by-ids

Retrieves a list of transactions for a given publisher by their IDs.

```APIDOC
## GET /publishers/{publisherId}/transactions

### Description
Allows publishers to pull individual transactions by their IDs. This can be used to check transaction status and obtain additional information shared between publishers and advertisers.

### Method
GET

### Endpoint
/publishers/{publisherId}/transactions

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - accessToken

#### Path Parameters
- **publisherId** (integer) - Required - The publisher ID.

#### Query Parameters
- **accessToken** (string) - Required - Access token.
- **ids** (string) - Required - Comma-separated numeric transaction IDs.
- **showBasketProducts** (boolean) - Optional - Whether to show basket products (Default: False).
- **timezone** (string) - Optional - Time zone in short or default format (Default: UTC).

### Response
#### Success Response (200)
- **OK** - Returns transaction data in application/json;charset=UTF-8 format.
```

--------------------------------

### GET /publishers/{publisherId}/commissionsharingrules

Source: https://help.awin.com/apidocs/gets-list-of-commission-sharing-rules-for-a-publisher

Retrieves a list of commission-sharing rules for a specific publisher.

```APIDOC
## GET /publishers/{publisherId}/commissionsharingrules

### Description
Service partners can pull a complete list of the commission-sharing rules they have setup with their publishers.

### Method
GET

### Endpoint
/publishers/{publisherId}/commissionsharingrules

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - accessToken

#### Path Parameters
- **publisherId** (integer) - Required - publisherId

#### Query Parameters
- **accessToken** (string) - Required - access token

### Response
#### Success Response (200)
- **ruleId** (string) - ID of the commission sharing rule
- **servicePartnerId** (string) - ID of the service partner
- **publisherID** (string) - ID of the publisher
- **servicePartnerShare** (string) - The commission that the service partner receives, in percent
- **publisherShare** (string) - The commission that the publisher receives, in percent
- **ruleTitle** (string) - The title or name of the commission sharing rule, as a string
- **created** (string) - The date and time that the rule was created
- **modified** (string) - The date and time that the rule was last modified
```

--------------------------------

### Define product condition

Source: https://help.awin.com/apidocs/retail-publisher-productapidocumentation-1

Sets the condition of the product.

```json
“condition":"new"
```

--------------------------------

### GET /advertisers/{advertiserId}/transactions/jobs

Source: https://help.awin.com/apidocs/check-the-status-of-the-validation-batch-job

Retrieves the status of validation batch jobs for a given advertiser.

```APIDOC
## GET /advertisers/{advertiserId}/transactions/jobs

### Description
Retrieves the status of validation batch jobs for a specified advertiser.

### Method
GET

### Endpoint
/advertisers/{advertiserId}/transactions/jobs

### Parameters
#### Path Parameters
- **advertiserId** (integer) - Required - The unique identifier of the advertiser.

#### Header Parameters
- **Authorization** (string) - Required - The access token for authentication.
```

--------------------------------

### Define product highlights

Source: https://help.awin.com/apidocs/retail-publisher-productapidocumentation-1

Provide a JSON array of strings representing product features. Each highlight must be between 1 and 150 characters.

```json
“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" ]
```

--------------------------------

### Download Feed Endpoint

Source: https://help.awin.com/apidocs/retail-publisher-productapidocumentation-1

The base URL structure for making a GET request to download a Google-formatted feed.

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

--------------------------------

### Create Offer

Source: https://help.awin.com/apidocs/offers-api

This section outlines the structure of a request body for creating a new promotional offer.

```APIDOC
### Request Body
- **title** (string) - Required - The title of the offer.
- **description** (string) - Required - A brief description of the offer.
- **terms** (string) - Required - Terms and conditions for the offer.
- **type** (string) - Required - The type of offer (e.g., 'voucher').
- **voucherCode** (string) - Optional - The voucher code, required only if type is 'voucher'.
- **url** (string) - Required - The landing page URL for the offer.
- **startDate** (string) - Required - The start date of the offer (YYYY-MM-DD).
- **endDate** (string) - Required - The end date of the offer (YYYY-MM-DD).
- **startTime** (string) - Required - The start time of the offer.
- **timeZone** (string) - Required - The time zone for the offer.
- **appliesToAllRegions** (boolean) - Required - Whether the offer applies to all regions.
- **regions** (array) - Required - List of region IDs.
- **promotionCategories** (array) - Required - List of promotion category IDs.

### Request Example
{
  "title": "Black Friday 30% Off",
  "description": "Save 30% on all products this Black Friday.",
  "terms": "Offer valid until the end of the month.",
  "type": "voucher",
  "voucherCode": "30OFF",
  "url": "https://www.example.com",
  "startDate": "2023-10-15",
  "endDate": "2023-11-15",
  "startTime": "12:00:00",
  "timeZone": "Europe/London",
  "appliesToAllRegions": false,
  "regions": [29],
  "promotionCategories": [12]
}
```

--------------------------------

### GET /advertisers/{advertiserId}/reports/publisher

Source: https://help.awin.com/apidocs/get-publisher-performance-report

Retrieves a report of performance metrics aggregated by publisher for a specific advertiser.

```APIDOC
## GET /advertisers/{advertiserId}/reports/publisher

### Description
The publisher performance report aggregates transactions, clicks, and impressions for all publishers an advertiser works with. Publishers with no activity during the selected time frame are excluded from the report.

### Method
GET

### Endpoint
/advertisers/{advertiserId}/reports/publisher

### Parameters
#### Path Parameters
- **advertiserId** (integer) - Required - advertiser id

#### Header Parameters
- **Authorization** (string) - Required - accessToken

#### Query Parameters
- **accessToken** (string) - Required - access token
- **startDate** (string) - Required - start date (format: yyyy-MM-dd)
- **endDate** (string) - Required - end date (format: yyyy-MM-dd)
- **dateType** (string) - Optional - date type, defaults to 'transaction'. Valid values: "transaction", "validation"
- **timezone** (string) - Required - time zone in short or default format

### Response
#### Success Response (200)
- **statusCode** (string) - Status code of the response
- **statusCodeValue** (integer) - Integer value of the status code
```

--------------------------------

### Order Parameters

Source: https://help.awin.com/apidocs/conversion-api

Details the required and optional fields for submitting an order through the Conversion API.

```APIDOC
## Order Parameters

### Parameters
- **orderReference** (String) - Required - The URL-encoded reference id for your booking or order.
- **amount** (Float) - Required - The order subtotal amount after discounts.
- **channel** (String) - Required - The name of the channel that identified as the last click referrer.
- **awc** (String) - Conditional - The parameter Awin adds to the landing page URL to identify the source of the click.
- **publisherId** (Number) - Conditional - Required if clickTime is present. Populate with the Id of the publisher that generated the sale.
- **clickTime** (Integer) - Conditional - Required if publisherId is present. The time that the click that drove the transaction happened as a unix timestamp in seconds.
- **voucher** (String) - Conditional - The URL-encoded voucher code used in the transaction.
- **currency** (String) - Required - The ISO currency code of the currency.
- **transactionTime** (Integer) - Optional - The timestamp of when the transaction happened as a unix timestamp in seconds.
- **customerAcquisition** (String) - Optional - Type of customer (NEW or RETURNING).
- **commissionGroups** (Array) - Required - Use commission groups to attribute the whole or parts of the transaction.
- **custom** (Object) - Optional - Custom key-value pairs.
- **basket** (Array) - Optional - Object array of basket items.
- **clickRef** (String) - Optional - Custom tracking references added to affiliate links.
- **linkId** (Integer) - Optional - Numeric identifier associated with a banner or creative.
```

--------------------------------

### GET /advertisers/{advertiserId}/transactions

Source: https://help.awin.com/apidocs/returns-a-list-of-transactions-for-a-given-advertiser-by-ids

Retrieves a list of transactions for a given advertiser based on provided transaction IDs.

```APIDOC
## GET /advertisers/{advertiserId}/transactions

### Description
Allows advertisers to pull individual transactions by their IDs. This can be used to check transaction status or retrieve additional information shared between publishers and advertisers.

### Method
GET

### Endpoint
/advertisers/{advertiserId}/transactions

### Parameters
#### Path Parameters
- **advertiserId** (integer) - Required - The unique identifier for the advertiser.

#### Query Parameters
- **accessToken** (string) - Required - The access token for authentication.
- **ids** (string) - Required - Numeric, comma-separated list of transaction IDs.
- **showBasketProducts** (boolean) - Optional - Whether to show basket products (default: False).
- **timezone** (string) - Optional - Time zone in short or default format (default: UTC).

### Response
#### Success Response (200)
- **OK** - Returns a list of transactions in application/json;charset=UTF-8 format.
```

--------------------------------

### Define product size system

Source: https://help.awin.com/apidocs/retail-publisher-productapidocumentation-1

Specifies the country-specific sizing convention used for the product.

```json
"size_system":"UK"
```

--------------------------------

### POST https://api.awin.com/promotion/advertiser/{advertiser_id}

Source: https://help.awin.com/apidocs/offers-api

Creates a new promotional offer or voucher for a specific advertiser account.

```APIDOC
## POST https://api.awin.com/promotion/advertiser/{advertiser_id}

### Description
Creates a new promotional offer or voucher for the specified advertiser account. This endpoint requires Bearer token authentication.

### Method
POST

### Endpoint
https://api.awin.com/promotion/advertiser/{advertiser_id}

### Parameters
#### Path Parameters
- **advertiser_id** (String) - Required - The ID of your advertiser account.

#### Request Body
- **title** (String) - Required - Offer title (1-300 characters).
- **description** (String) - Required - Offer description (1-500 characters).
- **terms** (String) - Required - Terms applicable to the offer (1-10000 characters).
- **type** (String) - Required - Use either ‘promotion’ or ‘voucher’.
- **voucherCode** (String) - Optional - Required only if type is ‘voucher’.
- **url** (String) - Required - Landing page URL (must start with http:// or https://).
- **startDate** (String) - Required - Start date (YYYY-MM-DD).
- **endDate** (String) - Required - End date (YYYY-MM-DD).
- **startTime** (String) - Optional - Start time (HH:MM:SS).
- **endTime** (String) - Optional - End time (HH:MM:SS).
- **timeZone** (String) - Optional - Timezone (e.g., Europe/London).
- **campaign** (String) - Optional - Campaign name.
- **appliestoAllRegions** (Boolean) - Required - Set true if applicable to all regions.
- **regions** (Number Array) - Optional - Required if appliestoAllRegions is false.
- **promotionCategories** (Number Array) - Required - List of category IDs.
```

--------------------------------

### GET /publishers/{publisherId}/reports/creative

Source: https://help.awin.com/apidocs/get-publisher-creative-performance-report

Retrieves a report of transactions, clicks, and impressions aggregated by creative for a specific publisher.

```APIDOC
## GET /publishers/{publisherId}/reports/creative

### Description
The creative performance report aggregates transactions, clicks and impressions for the creatives a publisher uses.

### Method
GET

### Endpoint
/publishers/{publisherId}/reports/creative

### Parameters
#### Path Parameters
- **publisherId** (integer) - Required - publisher id

#### Query Parameters
- **accessToken** (string) - Required - access token
- **dateType** (string) - Optional - date type, if not set - 'transaction' is the default. Valid values: "transaction", "validation"
- **startDate** (string) - Required - start date (format: yyyy-MM-dd)
- **endDate** (string) - Required - end date (format: yyyy-MM-dd)
- **region** (string) - Required - region. Valid values: AT, AU, BE, BR, BU, CA, CH, DE, DK, ES, FI, FR, GB, IE, IT, NL, NO, PL, SE, US
- **timezone** (string) - Optional - time zone in short or default format

### Response
#### Success Response (200)
- **statusCode** (string) - Status code of the response
- **statusCodeValue** (integer) - Integer value of the status code
```

--------------------------------

### Define product GTIN

Source: https://help.awin.com/apidocs/retail-publisher-productapidocumentation-1

Sets the Global Trade Item Number for the product.

```json
"gtin":"3243567980126"
```

--------------------------------

### GET /advertisers/{advertiserId}/reports/creative

Source: https://help.awin.com/apidocs/get-advertiser-creative-performance-report

Retrieves a report of transactions, clicks, and impressions aggregated by the creatives used by an advertiser.

```APIDOC
## GET /advertisers/{advertiserId}/reports/creative

### Description
The creative performance report aggregates transactions, clicks and impressions for the creatives an advertiser uses.

### Method
GET

### Endpoint
/advertisers/{advertiserId}/reports/creative

### Parameters
#### Path Parameters
- **advertiserId** (integer) - Required - advertiser id

#### Query Parameters
- **accessToken** (string) - Required - access token
- **startDate** (string) - Required - start date (format: yyyy-MM-dd)
- **endDate** (string) - Required - end date (format: yyyy-MM-dd)
- **dateType** (string) - Optional - date type, defaults to 'transaction'. Valid values: "transaction", "validation"
- **region** (string) - Required - region. Valid values: AT, AU, BE, BR, BU, CA, CH, DE, DK, ES, FI, FR, GB, IE, IT, NL, NO, PL, SE, US
- **timezone** (string) - Required - time zone in short or default format

### Response
#### Success Response (200)
- **statusCode** (string) - Status code description
- **statusCodeValue** (integer) - Status code value
```
Tokens:
Raw