Post Offers
  • 27 Mar 2025
  • Dark
    Light

Post Offers

  • Dark
    Light

Article summary

Our Create Offers API allows Advertisers to upload offers directly to the MyOffers system, via the endpoint below. Here, you can upload both promotions and vouchers. However, there will be no voucher attribution or publisher exclusivity in the functional scope of this API. Therefore, vouchers can be uploaded without publisher attribution or exclusivity (this must still be done via the UI).

However, the main benefit of this API is that you can add multiple offers via API, thus allowing you to upload in batches. Below we will give an example of the request for a single upload and batch. They must be written in JSON format to be valid. The values for regions and categories are numeric; see here for the full list and mapping of each. If you would like to apply your offer to all regions, add “true” to “appliesToAllRegions”.

Please note

The “multiple” mentioned can be achieved by making multiple API calls. You can still only upload 1 offer per request. We will give examples of scripts to upload batches. This does mean that the limit is 50 offers per minute (due to the 50 calls/per minute limitation)r content goes here

Endpoint

Endpoint (POST)

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

{advertiser_id} is the ID of your advertiser account.

Authentication

This API uses a Bearer token authentication method.

Body Parameters

Parameter

Required

Type

Description

title

Yes

String

Give your offer a title (e.g. Black Friday 2025). Must be between 1 and 300 characters.

description

Yes

String

Add a description (e.g. Save 30% on all products this Black Friday). Must be between 1 and 500 characters.

terms

Yes

String

Any terms that may apply (e.g. offer valid until the end of the month). Required for Vouchercode type Offers. Must be between 1 and 10000 characters.

type

Yes

String

Use either ‘promotion’ or ‘voucher’

voucherCode

Only for type ‘voucher’

String

The vouchercode (e.g. OFF30). This field is required for offer type Voucher.

url

Yes

String

Provide a specific landing page URL for your publishers to link to. Link must start with either http:// or https://

startDate

Yes

String

When your offer starts (format: YYYY-MM-DD)

endDate

Yes

String

When your offer ends (format: YYYY-MM-DD)

appliestoAllRegions

Yes

Boolean

Set true if your offer is applicable to customers from all regions.

regions

Only if appliestoAllRegions is false

Number (Array)

For mapping see below

promotionCategories

Yes

Number (Array)

For mapping see below

Mapping

Region Mapping

Here we will map out and describe each region and its corresponding number, so you can offers in specific promotional categories:

Region

Corresponding number

United Kingdom

1

Ireland

2

United States of America

3

Canada

4

France

5

Germany

6

Austria

7

Belgium

8

Netherlands

9

Spain

10

Italy

11

Finland

13

Poland

15

Switzerland

16

Sweden

17

Norway

18

Denmark

19

Australia

20

Brazil

21

Portugal

22

Russia

23

Czech Republic

24

Hungary

25

Romania

26

Slovakia

27

Slovenia

28

Ukraine

29

Bulgaria

30

Croatia

31

Greece

32

Latvia

33

Lithuania

34

New Zealand

35

South Africa

36

United Arab Emirates

37

China

38

India

39

Japan

40

Singapore

41

Argentina

42

Chile

43

Colombia

44

Mexico

45

Peru

46

Turkey

47

Brazil USD

48

Category Mapping

Here we will map out and describe each category and its corresponding number. Please note if there is no Parent ID it is the parent category:

Category Name

Corresponding Id

Parent Category ID

Electronics

4

NULL

Audio Equipment

5

4

Home Entertainment

6

4

Photography

7

4

Portable Audio

8

4

Televisions

9

4

Amplifiers & Receivers

10

5

Audio Systems

11

5

Cassette Decks

12

5

CD Players

13

5

Radios

14

5

HiFi Speakers

15

5

MiniDisc Separates

17

5

Tuners

18

5

DJ Equipment

19

5

DVD Players

20

6

DVD Recorders

21

6

Headphones

22

6

Home Cinema

23

6

Projectors

24

6

Remote Controls

25

6

Set Top Boxes & Receivers

26

6

VCR Players

27

6

Camcorders

29

7

Accessories

30

7

Cameras

32

7

Memory

33

61

Photo Development

34

7

Accessories

35

8

Portable Cassette Players

37

8

Portable CD Players

38

8

Portable MiniDisc

39

8

MP3 Players

40

8

Portable Radios

42

8

Stereos

43

8

Standard (4:3) TV

44

9

Combi TVs

45

9

LCD TV

46

9

Plasma TV

47

9

Projection TV

48

9

Projector Accessories

49

9

Television Accessories

50

9

Widescreen TV

51

9

Other Memory

52

33

Memory Card Reader

53

33

Compact Flash

54

33

Microdrive

55

33

XD Cards

56

33

Memory Stick

57

33

Multimedia Card

58

33

SmartMedia

59

33

SD Card

60

33

Computers & Software

61

NULL

Computer Components

62

61

Handhelds

63

61

Hardware

64

61

Input Devices

65

61

Peripherals

66

61

ISP & Hosting

67

61

Software

68

61

Storage Media

69

61

Wireless & Networking

70

61

CPUs

71

62

Computer Cases

72

62

Controller Cards

73

62

Fans

74

62

Graphics Cards

75

62

Motherboards

76

62

Power Supplies

77

62

Sound Cards

78

62

TV Cards

79

62

GPS & Sat Nav

80

63

PDAs & Accessories

82

63

Computers

83

64

Laptops

84

64

Monitors

85

64

Headsets

86

65

Joysticks and Gaming

87

65

Keyboards

88

65

Microphones

89

65

Mice

90

65

WebCams

91

65

Broadband

92

67

Web Hosting

94

67

Clothing & Accessories

97

NULL

Children's Clothing

98

97

Health & Beauty

99

NULL

Bodycare & Fitness

100

99

Bodycare Appliances

101

100

Shaving

107

100

Cosmetics & Skincare

110

99

Cosmetics

111

110

Fragrance

113

110

Skincare

114

110

Haircare

115

99

Haircare Appliances

116

115

Haircare Products

118

115

Health

121

99

Contact Lenses

122

121

Nutrition

123

121

Vitamins & Supplements

125

121

Diet

127

121

All-In-One Printers

128

66

Clothing Accessories

129

97

Cables

130

66

Computer Speakers

133

66

Lingerie

135

97

Men's Clothing

137

97

Shoes

139

97

Women's Clothing

141

97

Baby Clothes

142

98

Boys' Clothes

144

98

Girls' Clothes

146

98

Men's Accessories

147

129

Women's Accessories

149

129

Combination Sets

159

135

Socks & Hosiery

161

135

Bodies

163

135

Suspenders & Garters

167

135

Bras

168

135

Nightwear

169

135

Women's Underwear

170

135

Men's Outerwear

171

137

Men's Underwear

172

137

Gifts, Gadgets & Toys

173

NULL

Men's Sportswear

174

137

Men's Trousers

175

137

Gadgets

177

173

Men's Swimwear

178

137

Men's Tops

179

137

Gifts

181

173

Men's Suits

183

137

Toys

187

173

Auctions

188

177

Men's Footwear

189

139

Experiences

193

173

Women's Footwear

194

139

Adult Toys

196

177

Women's Dresses & Skirts

198

141

Women's Swimwear

199

141

Women's Trousers

201

141

Women's Sportswear

203

141

Women's Tops

204

141

Maternity

205

141

Women's Outerwear

206

141

Modems

207

66

Women's Suits

208

141

Printer Consumables

209

66

Printers

210

66

Scanners

211

66

Laptop Bags

212

66

Blank Media

213

69

CD Writers

214

69

CD-ROM Drives

215

69

DAT Drives

216

69

DVD Drives

217

69

DVD Writers

218

69

Floppy Disk Drives

219

69

Hard Drives

220

69

Pen Drives

221

69

Tape Drives

222

69

Zip Drives

223

69

Bluetooth Adapters

224

70

Hubs & Switches

225

70

Networking

226

70

Streaming Media Devices

227

70

Wireless Adapters

228

70

Wireless Routers

229

70

Books

230

634

Audio Books

231

230

Magazine Subscriptions

233

230

DVDs

235

634

DVD Rentals

236

235

UMDs

237

235

Adult Movies

238

235

VHS

239

235

DVDs

240

235

Music

241

634

Musical Instruments

242

241

Music Downloads

244

241

CDs

245

241

Sports

246

NULL

Fitness

247

246

Other Sports

248

246

Racket Sports

249

246

Team Sports

250

246

Sportswear & Swimwear

251

246

Cycling

252

247

Support Aids

255

247

Boxing

256

248

Fishing

258

248

Golf

259

248

Outdoor Adventure

260

248

Snooker, Pool & Billiards

261

248

Trampolines

262

248

Darts

265

248

Badminton

266

249

Squash

267

249

Table Tennis

268

249

Tennis

269

249

Cricket

270

250

Football

271

250

Basketball

272

250

Hockey

273

250

Swimming Accessories

277

251

Finance

281

NULL

Loans

282

281

Credit Cards

283

281

Insurance

285

281

Investments

286

281

Mortgages

287

281

Personal Banking

288

281

Bad Credit Loans

289

282

Finance

290

282

Home Loans

291

282

Personal Loans

292

282

Secured Loans

293

282

Car Loans

294

282

Unsecured Loans

296

282

Cashback & Reward Credit Cards

297

283

Credit Cards

298

283

Health Insurance

299

285

Home Insurance

300

285

Life Insurance

301

285

Mortgage Insurance

302

285

Travel Insurance

303

285

Vehicle Insurance

304

285

Bonds

305

286

Cash ISAs

306

286

Pensions

307

286

Quotes

308

286

Shares

309

286

Stockbrokers

310

286

Stocks & Shares ISAs

311

286

Bad Credit Mortgages

312

287

Buy to Let Mortgages

313

287

Flexible Mortgages

314

287

Mortgage Advice

315

287

Mortgage Insurance

316

287

Mortgage Protection

317

287

Remortgages

318

287

Self Certification Mortgages

319

287

Standard Variable Mortgages

320

287

Discounted Mortgages

321

287

Capped Mortgages

322

287

Fixed Rate Mortgages

323

287

Bank Accounts

324

288

Current Accounts

325

288

Online Banking

326

288

Savings Accounts

327

288

Travel

328

NULL

Airport Parking

329

328

Car Hire

330

328

Cruises

333

328

Ferries & Eurotunnel

335

328

Flights

336

328

Holidays

338

328

Telephones & Faxes

347

NULL

Mobile Phones

348

347

Other Telephones

349

347

Mobile Phone Accessories

350

348

Pay Monthly

351

348

Prepay Mobile Phones

352

348

Mobile Downloads

353

348

Handsets

354

348

All-In-Ones

355

349

Fax Machines

356

349

Home Telephone Accessories

357

349

House Telephones

358

349

IP Phones

359

349

Video Conferencing

360

349

Home Appliances

361

NULL

Cooking

362

361

Laundry & Cleaning

363

361

Refrigeration

364

361

Small Appliances

365

361

Cooker Hoods

366

362

Cookers & Ovens

367

362

Grills

368

362

Microwaves

369

362

Hobs

371

362

Dishwashers

372

363

Irons

373

363

Tumble Dryers

374

363

Vacuum Cleaners

375

363

Vacuum Cleaner Accessories

377

363

Freezers

378

364

Electronic Gadgets

379

177

Fridge Freezers

380

364

Fridges

381

364

Blenders

383

365

Anniversary Gifts

384

181

Breadmakers

385

365

Can Openers

386

365

Birthday Gifts

387

181

Coffee Makers

390

365

Decorations

391

181

Deep Fryers

392

365

Flowers

393

181

Electric Kettles

394

365

Hampers

395

181

Electric Shavers

396

365

Food Processors

397

365

Ice Cream Makers

399

365

Juicers

402

365

Other Appliances

404

365

Wedding Gifts

405

181

Sandwich / Waffle Makers

406

365

Toasters

407

365

Action Figures

411

187

Baby Toys

412

187

Creative & Construction

413

187

Dolls

414

187

Electronic & RC Toys

415

187

Games, Puzzles & Learning

416

187

Musical Toys

417

187

Outdoor Toys

418

187

Soft Toys

419

187

Toy Models

420

187

Home & Garden

421

NULL

Bathrooms & Accessories

422

421

Food

423

421

Furniture

424

421

Garden

425

421

General Household

426

421

Home Accessories

427

421

DIY

428

421

Household Bills

429

421

Kitchen

430

421

Property

431

421

Wine, Spirits & Tobacco

432

421

Bathroom Scales

433

422

Bathrooms

434

422

Bathtubs

435

422

Bespoke Bathrooms

436

422

Chocolate

437

423

Condiments

438

423

Dairy

440

423

Drinks

441

423

Fruit & Vegetables

442

423

Meat, Poultry & Fish

444

423

Organic Food

445

423

Party Food

446

423

Ready Meals

447

423

Chairs

448

424

Sofas

449

424

Tables

450

424

Beds

451

424

Storage

452

424

Mattresses

453

424

Barbecues & Accessories

455

425

Plants & Seeds

456

425

Garden & Leisure

457

425

Sheds & Garden Furniture

458

425

Garden Tools

459

425

Lawn Mowers

460

425

Flooring & Carpeting

463

426

Heating & Cooling

464

426

Lighting

465

426

Pets

466

426

Radiators

467

426

Furniture Accessories

469

427

House Accessories

470

427

Decorations

473

427

Hand Tools

474

428

Home Security

475

428

Painting & Decorating

476

428

Power Tools

477

428

Telephone Bills

478

429

Gas & Electric Bills

479

429

Bespoke Kitchens

481

430

Crockery

483

430

Cutlery

484

430

Glassware

485

430

Kitchen Sinks and Taps

487

430

Kitchen Units

488

430

Alcoholic Drinks

489

432

Wine

490

432

Rent Property

491

431

Buy Property

492

431

Vehicles, Parts and Accessories

493

NULL

Car Accessories

495

493

Custom Number Plates

496

495

Car Parts

507

495

Video Gaming

521

634

Living Room

529

421

Bathroom Sinks & Taps

530

422

Showers

532

422

Sinks

533

422

Washing Machines

535

363

Washer Dryers

536

363

Cables, Parts & Power Supplies

537

5

Books

538

230

Children's Accessories

539

129

Jewellery

540

NULL

Men's Jewellery

542

540

Men's Watches

544

540

Women's Jewellery

546

540

Women's Watches

547

540

Men's Socks

548

137

Film Downloads

549

235

Blu-Ray

550

235

Blu-Ray Players

551

6

HD DVD Players

553

6

Pre-pay Credit Cards

554

283

Specialist Insurance

555

285

Cassettes & Vinyl

556

241

Water Sports

557

248

Extreme Sports

558

246

Fitness Equipment

559

247

Winter Sports

560

246

Other Team Sports

561

250

In-Car Entertainment

563

495

Motorcycles

564

493

New & Used Cars

565

493

Tyres

566

493

Vehicle Security

567

493

Wheels

568

493

Vehicle Servicing

569

493

Personalised Gifts

570

181

Vehicle Finance

571

493

Console Accessories

575

521

Console

576

521

Retro Games

577

521

Video Games

579

521

Contents Insurance

580

285

Glasses

581

121

Vehicle Leasing

583

493

HD DVD

585

235

Tickets

586

NULL

Theatre

588

586

Tourist Attractions

589

586

Concerts

590

586

Theme Parks

591

586

Sporting Events

592

586

Equestrian

593

248

Oral Health

594

121

Bags

595

129

Office Supplies

596

421

Curtains & Blinds

597

427

Christmas Gifts

598

181

Baby Products

599

421

Valentine's Day

600

181

Other Occasions

602

181

RAM

603

33

Arts & Crafts

604

421

Agricultural Products

605

421

Tobacco

606

432

Tinned Food

607

423

Cakes, Snacks & Sweets

608

423

Adult Books

609

230

Collectibles

611

181

Sports Memorabilia

612

246

Fancy Dress

613

97

Children's Footwear

614

139

Cookware & Utensils

615

430

Cleaning

616

426

Home Textiles

617

427

Batteries

618

8

Optical Devices

619

7

Dating

620

NULL

Novelty T-Shirts

623

97

Medical

624

121

Art

625

427

General Clothing

626

97

General Clothing

627

NULL

Accommodation

629

328

Novelty Gifts

631

181

Motorsport

632

248

Appliance Spares

633

361

Entertainment

634

NULL

Auto Care

635

493

Driving

637

193

Extreme

639

193

Flying

640

193

Short Breaks

641

193

Lifestyle

642

193

Other Experiences

643

193

Pampering

644

193

Adult Gifts

645

181

Calendars

646

181

Greeting Cards

647

181

Other Gadgets

648

177

Other Toys

649

187

Water Experiences

650

193

LED TV

651

9

3D TV

652

9

Example Request Body

{
  "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",
  "appliesToAllRegions": false,
  "regions": [
    29
  ],
  "promotionCategories": [
    12
  ]
}

Response

Code

Description

200

Offer was created successfully

400

Invalid input

404

The specified resource was not found,

Media type


Was this article helpful?