Order notes

# Order notes

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

## Overview
The order notes API allows you to create, view, and delete individual order notes.
Order notes are added by administrators and programmatically to store data about an order, or order events.

---

<div id="create-an-order-note"></div>

## Create a order note

This API helps you to create a new note for an order.

`createOrderNote({})`

<div id="create-an-order-note-parameters"></div>

### Parameters

```dart
required int id,
Map<String, dynamic> data,
```

<div id="create-an-order-note-api-call"></div>

### API Call

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

// Call API
OrderNote orderNote = await WooSignal.instance.createOrderNote(id: "order id", data: {});
```

<div id="create-an-order-note-response"></div>

### Response

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

<hr>

<div id="retrieve-an-order-note"></div>

## Retrieve an order note

This API lets you retrieve and view a specific note from an order.

`retrieveOrderNote({})`

<div id="retrieve-an-order-note-parameters"></div>

### Parameters

```dart
required int orderId,
required int noteId
```

<div id="retrieve-an-order-note-api-call"></div>

### API Call

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

// Call API
OrderNote orderNote = await WooSignal.instance.retrieveOrderNote(orderId: "order id", noteId: "note id");
```

<div id="retrieve-an-order-note-response"></div>

### Response

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

<hr>

<div id="list-all-order-notes"></div>

## List all order notes

This API helps you to view all the notes from an order.

`getOrderNotes(id: "order id")`

<div id="list-all-order-notes-parameters"></div>

### Parameters

```dart
required int orderId,
String context,
String type
```

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

### API Call

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

// Call API
List<OrderNote> orderNotes = await WooSignal.instance.getOrderNotes(id: "order id");
```

<div id="list-all-order-notes-response"></div>

### Response

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

<hr>

<div id="delete-an-order-note"></div>

## Delete an order note

This API helps you delete an order note.

`deleteOrderNote({})`

<div id="delete-an-order-note-parameters"></div>

### Parameters

```dart
int orderId,
int noteId
```

<div id="delete-an-order-note-api-call"></div>

### API Call

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

// Call API
OrderNote orderNote = await WooSignal.instance.deleteOrderNote(int orderId, int noteId);
```

<div id="delete-an-order-note-response"></div>

### Response

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

<hr>

Overview

The order notes API allows you to create, view, and delete individual order notes. Order notes are added by administrators and programmatically to store data about an order, or order events.

Create a order note

This API helps you to create a new note for an order.

createOrderNote({})

Parameters

required int id,
Map<String, dynamic> data,

API Call

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

// Call API
OrderNote orderNote = await WooSignal.instance.createOrderNote(id: "order id", data: {});

Response

OrderNote instance

Represents the following object - WooCommerce create an order note

Retrieve an order note

This API lets you retrieve and view a specific note from an order.

retrieveOrderNote({})

Parameters

required int orderId,
required int noteId

API Call

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

// Call API
OrderNote orderNote = await WooSignal.instance.retrieveOrderNote(orderId: "order id", noteId: "note id");

Response

OrderNote instance

Represents the following object - WooCommerce retrieve an order note

List all order notes

This API helps you to view all the notes from an order.

getOrderNotes(id: "order id")

Parameters

required int orderId,
String context,
String type

API Call

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

// Call API
List<OrderNote> orderNotes = await WooSignal.instance.getOrderNotes(id: "order id");

Response

List<OrderNote> instance

Represents the following object - WooCommerce list all order notes

Delete an order note

This API helps you delete an order note.

deleteOrderNote({})

Parameters

int orderId,
int noteId

API Call

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

// Call API
OrderNote orderNote = await WooSignal.instance.deleteOrderNote(int orderId, int noteId);

Response

OrderNote instance

Represents the following object - WooCommerce delete an order note