Refunds - API Reference

Refunds

# Refunds

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

## Overview

The refunds API allows you to create, view, and delete individual refunds.

---

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

## Create a order note

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

`createRefund({})`

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

### Parameters

```dart
required String amount,
required int orderId,
```

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

### API Call

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

// Call API
Refund refund = await WooSignal.instance.createRefund({String amount, int orderId});
```

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

### Response

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

<hr>

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

## Retrieve a refund

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

`retrieveRefund({})`

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

### Parameters

```dart
required int orderId,
required int refundId,
String dp,
```

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

### API Call

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

// Call API
Refund refund = await WooSignal.instance.retrieveRefund(orderId: "order Id", refundId: "refund Id");
```

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

### Response

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

<hr>

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

## List all refunds

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

`getRefunds(int orderId)`

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

### Parameters

```dart
String context,
int page,
int perPage,
String search,
String after,
String before,
List<int> exclude,
List<int> include,
int offset,
String order,
String orderby,
List<int> parent,
List<int> parentExclude,
int dp
```

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

### API Call

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

// Call API
List<Refund> refunds = await WooSignal.instance.getRefunds(id: "order id");
```

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

### Response

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

<hr>

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

## Delete a refund

This API helps you delete an order refund.

`deleteRefund(int orderId, int refundId)`

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

### Parameters

```dart
int orderId,
int refundId
```

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

### API Call

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

// Call API
Refund refunds = await WooSignal.instance.deleteRefund(int orderId, int refundId);
```

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

### Response

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

Overview

The refunds API allows you to create, view, and delete individual refunds.

Create a order note

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

createRefund({})

Parameters

required String amount,
required int orderId,

API Call

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

// Call API
Refund refund = await WooSignal.instance.createRefund({String amount, int orderId});

Response

Refund instance

Represents the following object - WooCommerce create a refund

Retrieve a refund

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

retrieveRefund({})

Parameters

required int orderId,
required int refundId,
String dp,

API Call

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

// Call API
Refund refund = await WooSignal.instance.retrieveRefund(orderId: "order Id", refundId: "refund Id");

Response

Refund instance

Represents the following object - WooCommerce retrieve a refund

List all refunds

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

getRefunds(int orderId)

Parameters

String context,
int page,
int perPage,
String search,
String after,
String before,
List<int> exclude,
List<int> include,
int offset,
String order,
String orderby,
List<int> parent,
List<int> parentExclude,
int dp

API Call

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

// Call API
List<Refund> refunds = await WooSignal.instance.getRefunds(id: "order id");

Response

List<Refund> instance

Represents the following object - WooCommerce list all refunds

Delete a refund

This API helps you delete an order refund.

deleteRefund(int orderId, int refundId)

Parameters

int orderId,
int refundId

API Call

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

// Call API
Refund refunds = await WooSignal.instance.deleteRefund(int orderId, int refundId);

Response

Refund instance

Represents the following object - WooCommerce delete a refund