Product Tags

# Product Tags

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

## Overview
The product tags API allows you to create, view, update, and delete individual product tags.

---

<div id="list-all-products-tags"></div>

## List all product tags

Returns product tags back from WooCommerce, include parameters to query data.

`getProductTags()`

<div id="list-all-product-tags-parameters"></div>

### Parameters

```dart 
    String? context,
    int? page,
    int? perPage,
    String? search,
    List<int>? exclude,
    List<int>? include,
    int? offset,
    String? order,
    String? orderBy,
    bool? hideEmpty,
    int? product,
    String? slug
```

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

### API Call

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

// Call API
List<ProductTag> productTags = await WooSignal.instance.getProductTags();
```

<div id="list-all-product-tags-response"></div>

### Response

```dart 
List<ProductTag> instance
```
Represents the following object - <a href="https://woocommerce.github.io/woocommerce-rest-api-docs/?php#list-all-products" target="_BLANK">WooCommerce list all product tags</a>

<hr>

<div id="retrive-a-product-tag"></div>

## Retrieve a product tag

Returns a product tag back from WooCommerce, include parameters to query data.

`retrieveProductTag({id:"product id"})`

<div id="retrive-a-product-tag-parameters"></div>

### Parameters

```dart 
    int id
```

<div id="retrive-a-product-tag-api-call"></div>

### API Call

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

// Call API
ProductTag productTag = await WooSignal.instance.retrieveProductTag(id: "product id");
```

<div id="retrive-a-product-response"></div>

### Response

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

<hr>

<div id="delete-a-product-tag"></div>

## Delete a product tag

This API helps you delete a product tag.

`deleteProductTag(int id, {bool force = true})`

<div id="delete-a-product-tag-parameters"></div>

### Parameters

```dart 
int id, 
{bool force = true}
```

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

### API Call

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

// Call API
ProductTag productTag = await WooSignal.instance.deleteProductTag(id: "product id");
```

<div id="delete-a-product-tag-response"></div>

### Response

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

<hr>

<div id="update-a-product-tag"></div>

## Update a product

This API lets you make changes to a product tag.

`updateProductTag(int id, { data })`

<div id="update-a-product-tag-parameters"></div>

### Parameters

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

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

### API Call

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

// Call API
ProductTag productTag = await WooSignal.instance.updateProductTag(id: "product id");
```

<div id="update-a-product-tag-response"></div>

### Response

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

<hr>

<div id="create-a-product-tag"></div>

## Create a product tag

This API helps you to create a new product tag.

`createProductTag({})`

<div id="create-a-product-tag-parameters"></div>

### Parameters

```dart 
required String name,
required String? slug,
required String? description
```

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

### API Call

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

// Call API
ProductTag product = await WooSignal.instance.createProductTag({
    required String name,
    String? slug,
    String? description
    });
```

<div id="create-a-product-tag-response"></div>

### Response

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

Overview

The product tags API allows you to create, view, update, and delete individual product tags.

List all product tags

Returns product tags back from WooCommerce, include parameters to query data.

getProductTags()

Parameters

    String? context,
    int? page,
    int? perPage,
    String? search,
    List<int>? exclude,
    List<int>? include,
    int? offset,
    String? order,
    String? orderBy,
    bool? hideEmpty,
    int? product,
    String? slug

API Call

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

// Call API
List<ProductTag> productTags = await WooSignal.instance.getProductTags();

Response

List<ProductTag> instance

Represents the following object - WooCommerce list all product tags

Retrieve a product tag

Returns a product tag back from WooCommerce, include parameters to query data.

retrieveProductTag({id:"product id"})

Parameters

    int id

API Call

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

// Call API
ProductTag productTag = await WooSignal.instance.retrieveProductTag(id: "product id");

Response

ProductTag instance

Represents the following object - WooCommerce retrieve a product tag

Delete a product tag

This API helps you delete a product tag.

deleteProductTag(int id, {bool force = true})

Parameters

int id, 
{bool force = true}

API Call

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

// Call API
ProductTag productTag = await WooSignal.instance.deleteProductTag(id: "product id");

Response

ProductTag instance

Represents the following object - WooCommerce product tag

Update a product

This API lets you make changes to a product tag.

updateProductTag(int id, { data })

Parameters

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

API Call

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

// Call API
ProductTag productTag = await WooSignal.instance.updateProductTag(id: "product id");

Response

ProductTag instance

Represents the following object - WooCommerce product tag

Create a product tag

This API helps you to create a new product tag.

createProductTag({})

Parameters

required String name,
required String? slug,
required String? description

API Call

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

// Call API
ProductTag product = await WooSignal.instance.createProductTag({
    required String name,
    String? slug,
    String? description
    });

Response

ProductTag instance

Represents the following object - WooCommerce product