Products - API Reference

Products

# Products

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

## Overview
The products API allows you to view individual or a batch of products.

---

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

## List all products

Returns products back from WooCommerce, include parameters to query data.

`getProducts()`

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

### Parameters

```dart 
	int page,
    int perPage,
    String search,
    String after,
    String before,
    String order,
    String orderBy,
    String slug,
    String status,
    String type,
    String sku,
    String category,
    String tag,
    String shippingClass,
    String attribute,
    String attributeTerm,
    String taxClass,
    String minPrice,
    String maxPrice,
    String stockStatus,
    List<int> exclude,
    List<int> parentExclude,
    List<int> include,
    List<int> parent,
    int offset = 0,
    bool featured,
    bool onSale
```

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

### API Call

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

// Call API
List<Product> products = await WooSignal.instance.getProducts();
```

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

### Response

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

<hr>

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

## Retrieve a product

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

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

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

### Parameters

```dart 
    int id
```

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

### API Call

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

// Call API
Product product = await WooSignal.instance.retrieveProduct(id: "product id");
```

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

### Response

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

<hr>

<div id="batch-products"></div>

## Batch Products

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

`batchProduct({ data })`

<div id="batch-products-parameters"></div>

### Parameters

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

<div id="batch-products-api-call"></div>

### API Call

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

// Call API
ProductBatch productBatch = await WooSignal.instance.batchProduct(data: "batch update data");
```

<div id="batch-products-response"></div>

### Response

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

<hr>

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

## Delete a product

This API helps you delete a product.

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

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

### Parameters

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

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

### API Call

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

// Call API
Product product = await WooSignal.instance.deleteProduct(id: "product id");
```

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

### Response

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

<hr>

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

## Update a product

This API lets you make changes to a product.

`updateProduct(int id, { data })`

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

### Parameters

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

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

### API Call

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

// Call API
Product product = await WooSignal.instance.updateProduct(id: "product id");
```

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

### Response

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

<hr>

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

## Create a product

This API helps you to create a new product.

`createProduct({})`

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

### Parameters

```dart 
required String name,
required String type, // simple, grouped, external and variable.
required String regularPrice,
required String description,
required String shortDescription,
required Map<String, dynamic> categories,
required Map<String, dynamic> images,
```

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

### API Call

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

// Call API
Product product = await WooSignal.instance.createProduct({
    required String name,
    required String type,
    required String regularPrice,
    required String description,
    required String shortDescription,
    required Map<String, dynamic> categories,
    required Map<String, dynamic> images,
    });
```

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

### Response

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

Overview

The products API allows you to view individual or a batch of products.

List all products

Returns products back from WooCommerce, include parameters to query data.

getProducts()

Parameters

	int page,
    int perPage,
    String search,
    String after,
    String before,
    String order,
    String orderBy,
    String slug,
    String status,
    String type,
    String sku,
    String category,
    String tag,
    String shippingClass,
    String attribute,
    String attributeTerm,
    String taxClass,
    String minPrice,
    String maxPrice,
    String stockStatus,
    List<int> exclude,
    List<int> parentExclude,
    List<int> include,
    List<int> parent,
    int offset = 0,
    bool featured,
    bool onSale

API Call

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

// Call API
List<Product> products = await WooSignal.instance.getProducts();

Response

List<Product> instance

Represents the following object - WooCommerce list all products

Retrieve a product

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

retrieveProduct({id:"product id"})

Parameters

    int id

API Call

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

// Call API
Product product = await WooSignal.instance.retrieveProduct(id: "product id");

Response

Product instance

Represents the following object - WooCommerce retrieve a product

Batch Products

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

batchProduct({ data })

Parameters

Map<String, dynamic> data

API Call

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

// Call API
ProductBatch productBatch = await WooSignal.instance.batchProduct(data: "batch update data");

Response

ProductBatch instance

Represents the following object - WooCommerce batch product

Delete a product

This API helps you delete a product.

deleteProduct(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
Product product = await WooSignal.instance.deleteProduct(id: "product id");

Response

Product instance

Represents the following object - WooCommerce product

Update a product

This API lets you make changes to a product.

updateProduct(int id, { data })

Parameters

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

API Call

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

// Call API
Product product = await WooSignal.instance.updateProduct(id: "product id");

Response

Product instance

Represents the following object - WooCommerce product

Create a product

This API helps you to create a new product.

createProduct({})

Parameters

required String name,
required String type, // simple, grouped, external and variable.
required String regularPrice,
required String description,
required String shortDescription,
required Map<String, dynamic> categories,
required Map<String, dynamic> images,

API Call

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

// Call API
Product product = await WooSignal.instance.createProduct({
    required String name,
    required String type,
    required String regularPrice,
    required String description,
    required String shortDescription,
    required Map<String, dynamic> categories,
    required Map<String, dynamic> images,
    });

Response

Product instance

Represents the following object - WooCommerce product