Coupons - API Reference

Coupons

# Coupons

<div id="overview"></div>

## Overview
The coupons API allows you to create, view, update, and delete individual, or a batch, of coupon codes.

---

<div id="create-a-coupon"></div>

## Create a coupon

This API helps you to create a new coupon.

`createCoupon({})`

<div id="create-a-coupon-parameters"></div>

### Parameters

```dart
required String code,
required String discountType,
required String amount,
required bool individualUse,
required bool excludeSaleItems,
required String minimumAmount,
```

<div id="create-a-coupon-api-call"></div>

### API Call

```dart
// Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");

// Call API
Coupon coupon = await WooSignal.instance.createCoupon({
      code,
      discountType,
      amount,
      individualUse,
      excludeSaleItems,
      minimumAmount,
      });
```

<div id="create-a-coupon-response"></div>

### Response

```dart 
Coupon instance
```
Represents the following object - <a href="https://woocommerce.github.io/woocommerce-rest-api-docs/#create-a-coupon" target="_BLANK">WooCommerce Coupon</a>

<hr>

<div id="retrieve-a-coupon"></div>

## Retrieve a coupon

This API lets you retrieve and view a specific coupon by ID.

`retrieveCoupon({int id})`

<div id="retrieve-a-coupon-parameters"></div>

### Parameters

```dart
int id
```

<div id="retrieve-a-coupon-api-call"></div>

### API Call

```dart
// Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");

// Call API
Coupon coupon = await WooSignal.instance.retrieveCoupon(id: "coupon id");
```

<div id="retrieve-a-coupon-response"></div>

### Response

```dart 
Coupon instance
```
Represents the following object - <a href="https://woocommerce.github.io/woocommerce-rest-api-docs/#retrieve-a-coupon" target="_BLANK">WooCommerce Coupon</a>

<hr>

<div id="list-all-coupons"></div>

## List all coupons

This API helps you to list all the coupons that have been created.

`getCoupons()`

<div id="list-all-coupons-parameters"></div>

### Parameters

```dart
String context
int page
int perPage
String search
String after
String before
List<int> exclude
List<int> include
String order
String orderby
String code
```

<div id="list-all-coupons-api-call"></div>

### API Call

```dart
// Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");

// Call API
List<Coupon> coupons = await WooSignal.instance.getCoupons();
```

<div id="list-all-coupons-response"></div>

### Response

```dart 
List<Coupon> instance
```
Represents the following object - <a href="https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-coupons" target="_BLANK">WooCommerce Coupon List</a>

<hr>

<div id="update-a-coupon"></div>

## Update a coupon

This API lets you make changes to a coupon.

`updateCoupon(int id, {Map<String, dynamic> data})`

<div id="update-a-coupon-parameters"></div>

### Parameters

```dart
int id, 
{Map<String, dynamic> data}
```

<div id="update-a-coupon-api-call"></div>

### API Call

```dart
// Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");

// Call API
Coupon coupon = await WooSignal.instance.updateCoupon(id: "coupon id", data: {});
```

<div id="update-a-coupon-response"></div>

### Response

```dart 
Coupon instance
```
Represents the following object - <a href="https://woocommerce.github.io/woocommerce-rest-api-docs/#update-a-coupon" target="_BLANK">WooCommerce Coupon</a>

<hr>

<div id="delete-a-coupon"></div>

## Delete a coupon

This API helps you delete a coupon.

`deleteCoupon(int id)`

<div id="delete-a-coupon-parameters"></div>

### Parameters

```dart
int id
```

<div id="delete-a-coupon-api-call"></div>

### API Call

```dart
// Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");

// Call API
Coupon coupon = await WooSignal.instance.deleteCoupon(id: "coupon id");
```

<div id="delete-a-coupon-response"></div>

### Response

```dart 
Coupon instance
```
Represents the following object - <a href="https://woocommerce.github.io/woocommerce-rest-api-docs/#delete-a-coupon" target="_BLANK">WooCommerce Coupon</a>

<hr>

<div id="batch-update-coupons"></div>

## Batch update coupons

This API helps you to batch create, update and delete multiple coupons.

`batchCoupon({Map<String, dynamic> data})`

<div id="batch-update-coupons-parameters"></div>

### Parameters

```dart
Map<String, dynamic> data
```

<div id="batch-update-coupons-api-call"></div>

### API Call

```dart
// Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");

// Call API
CouponBatch couponBatch = await WooSignal.instance.batchCoupon(data: {});
```

<div id="batch-update-coupons-response"></div>

### Response

```dart 
CouponBatch instance
```
Represents the following object - <a href="https://woocommerce.github.io/woocommerce-rest-api-docs/#batch-update-coupons" target="_BLANK">WooCommerce CouponBatch</a>

Overview

The coupons API allows you to create, view, update, and delete individual, or a batch, of coupon codes.

Create a coupon

This API helps you to create a new coupon.

createCoupon({})

Parameters

required String code,
required String discountType,
required String amount,
required bool individualUse,
required bool excludeSaleItems,
required String minimumAmount,

API Call

// Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");

// Call API
Coupon coupon = await WooSignal.instance.createCoupon({
      code,
      discountType,
      amount,
      individualUse,
      excludeSaleItems,
      minimumAmount,
      });

Response

Coupon instance

Represents the following object - WooCommerce Coupon

Retrieve a coupon

This API lets you retrieve and view a specific coupon by ID.

retrieveCoupon({int id})

Parameters

int id

API Call

// Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");

// Call API
Coupon coupon = await WooSignal.instance.retrieveCoupon(id: "coupon id");

Response

Coupon instance

Represents the following object - WooCommerce Coupon

List all coupons

This API helps you to list all the coupons that have been created.

getCoupons()

Parameters

String context
int page
int perPage
String search
String after
String before
List<int> exclude
List<int> include
String order
String orderby
String code

API Call

// Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");

// Call API
List<Coupon> coupons = await WooSignal.instance.getCoupons();

Response

List<Coupon> instance

Represents the following object - WooCommerce Coupon List

Update a coupon

This API lets you make changes to a coupon.

updateCoupon(int id, {Map<String, dynamic> data})

Parameters

int id, 
{Map<String, dynamic> data}

API Call

// Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");

// Call API
Coupon coupon = await WooSignal.instance.updateCoupon(id: "coupon id", data: {});

Response

Coupon instance

Represents the following object - WooCommerce Coupon

Delete a coupon

This API helps you delete a coupon.

deleteCoupon(int id)

Parameters

int id

API Call

// Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");

// Call API
Coupon coupon = await WooSignal.instance.deleteCoupon(id: "coupon id");

Response

Coupon instance

Represents the following object - WooCommerce Coupon

Batch update coupons

This API helps you to batch create, update and delete multiple coupons.

batchCoupon({Map<String, dynamic> data})

Parameters

Map<String, dynamic> data

API Call

// Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");

// Call API
CouponBatch couponBatch = await WooSignal.instance.batchCoupon(data: {});

Response

CouponBatch instance

Represents the following object - WooCommerce CouponBatch