Data - API Reference

Data

# Data

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

## Overview

The data API allows you to view all types of data available.

---

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

## List all data

This API lets you retrieve and view a simple list of available data endpoints.

`retrieveApiData()`

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

### API Call

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

// Call API
ApiData apiData = await WooSignal.instance.retrieveApiData();
```

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

### Response

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

<hr>

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

## List all continents

This API helps you to view all the continents.

`getContinentData()`

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

### API Call

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

// Call API
Continents continents = await WooSignal.instance.getContinentData();
```

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

### Response

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

<hr>

<div id="retrieve-continent-data"></div>

## Retrieve continent data

This API lets you retrieve and view a continent data.

`retrieveContinentDataByLocation(string location)`

<div id="retrieve-continent-data-parameters"></div>

### Parameters

```dart 
String location,
```

<div id="retrieve-continent-data-api-call"></div>

### API Call

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

// Call API
Continents continents = await WooSignal.instance.retrieveContinentDataByLocation("location e.g. eu");
```

<div id="retrieve-continent-data-response"></div>

### Response

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

<hr>

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

## List all countries

This API helps you to view all the countries.

`getCountries()`

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

### API Call

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

// Call API
List<Countries> Countries = await WooSignal.instance.getCountries();
```

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

### Response

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

<hr>

<div id="retrieve-country-data"></div>

## Retrieve country data

This API lets you retrieve and view a country data.

`retrieveCountryData(String location)`

<div id="retrieve-country-data-data-api-call"></div>

### API Call

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

// Call API
Countries countryData = await WooSignal.instance.retrieveCountryData("location");
```

<div id="retrieve-country-data-data-response"></div>

### Response

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

<hr>

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

## List all currencies

This API helps you to view all the currencies.

`getCurrencies()`

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

### API Call

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

// Call API
List<Currencies> currencies = await WooSignal.instance.getCurrencies();
```

<div id="list-all-currencies-data-response"></div>

### Response

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

<hr>

<div id="retrieve-currency-data"></div>

## Retrieve currency data

This API lets you retrieve and view a currency data.

`retrieveCurrencyData(String currency)`

<div id="retrieve-currency-data-api-call"></div>

### API Call

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

// Call API
Currencies currencies = await WooSignal.instance.retrieveCurrencyData("currency e.g. usd");
```

<div id="retrieve-currency-data-response"></div>

### Response

```dart 
Currencies instance
```
Represents the following object - <a href="https://woocommerce.github.io/woocommerce-rest-api-docs/#retrieve-currency-data" target="_BLANK">WooCommerce list all currencies</a>

<hr>

<div id="retrieve-current-currency"></div>

## Retrieve current currency

This API lets you retrieve and view store's current currency data.

`retrieveCurrentCurrencyData()`

<div id="retrieve-current-currency-api-call"></div>

### API Call

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

// Call API
Currencies currencies = await WooSignal.instance.retrieveCurrentCurrencyData();
```

<div id="retrieve-current-currency-response"></div>

### Response

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

Overview

The data API allows you to view all types of data available.

List all data

This API lets you retrieve and view a simple list of available data endpoints.

retrieveApiData()

API Call

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

// Call API
ApiData apiData = await WooSignal.instance.retrieveApiData();

Response

ApiData instance

Represents the following object - WooCommerce list all data

List all continents

This API helps you to view all the continents.

getContinentData()

API Call

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

// Call API
Continents continents = await WooSignal.instance.getContinentData();

Response

Continents instance

Represents the following object - WooCommerce list all continents

Retrieve continent data

This API lets you retrieve and view a continent data.

retrieveContinentDataByLocation(string location)

Parameters

String location,

API Call

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

// Call API
Continents continents = await WooSignal.instance.retrieveContinentDataByLocation("location e.g. eu");

Response

Continents instance

Represents the following object - WooCommerce retrieve continent data

List all countries

This API helps you to view all the countries.

getCountries()

API Call

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

// Call API
List<Countries> Countries = await WooSignal.instance.getCountries();

Response

List<Countries> instance

Represents the following object - WooCommerce list all countries

Retrieve country data

This API lets you retrieve and view a country data.

retrieveCountryData(String location)

API Call

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

// Call API
Countries countryData = await WooSignal.instance.retrieveCountryData("location");

Response

Countries instance

Represents the following object - WooCommerce retrieve country data

List all currencies

This API helps you to view all the currencies.

getCurrencies()

API Call

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

// Call API
List<Currencies> currencies = await WooSignal.instance.getCurrencies();

Response

List<Currencies> instance

Represents the following object - WooCommerce list all currencies

Retrieve currency data

This API lets you retrieve and view a currency data.

retrieveCurrencyData(String currency)

API Call

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

// Call API
Currencies currencies = await WooSignal.instance.retrieveCurrencyData("currency e.g. usd");

Response

Currencies instance

Represents the following object - WooCommerce list all currencies

Retrieve current currency

This API lets you retrieve and view store's current currency data.

retrieveCurrentCurrencyData()

API Call

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

// Call API
Currencies currencies = await WooSignal.instance.retrieveCurrentCurrencyData();

Response

Currencies instance

Represents the following object - WooCommerce retrieve current currency