Skip to content

Commit bfc286a

Browse files
committed
refunds
1 parent e4561cf commit bfc286a

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

source/includes/wp-api-v1/_order-refunds.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# Order - Refunds #
1+
# Refunds #
22

33
This section lists all API endpoints that can be used to create, edit or otherwise manipulate order refunds.
44

5-
## Order Refunds Properties ##
5+
## Refund properties ##
66

77
| Attribute | Type | Description |
88
|----------------|-----------|----------------------------------------------------------------------------------------------------------|
99
| `id` | integer | Unique identifier for the resource. <i class="label label-info">read-only</i> |
1010
| `date_created` | date-time | The date the order refund was created, in the site's timezone. <i class="label label-info">read-only</i> |
1111
| `amount` | string | Refund amount. <i class="label label-info">required</i> |
1212
| `reason` | string | Reason for refund. |
13-
| `line_items` | array | Line items data. See [Refunds Line Items Properties](#refunds-line-items-properties). |
13+
| `line_items` | array | Line items data. See [Refunds Line Items Properties](#refund-line-item-properties). |
1414

15-
### Refunds Line Items Properties ###
15+
### Refund line item properties ###
1616

1717
| Attribute | Type | Description |
1818
|----------------|---------|------------------------------------------------------------------------------------------------|
@@ -31,11 +31,11 @@ This section lists all API endpoints that can be used to create, edit or otherwi
3131
| `taxes` | array | Line total tax with `id`, `total` and `subtotal`. <i class="label label-info">read-only</i> |
3232
| `meta` | array | Line item meta data with `key`, `label` and `value`. <i class="label label-info">read-only</i> |
3333

34-
## Create a Refund For an Order ##
34+
## Create a refund ##
3535

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

38-
### HTTP Request ###
38+
### HTTP request ###
3939

4040
<div class="api-endpoint">
4141
<div class="endpoint-data">
@@ -118,11 +118,11 @@ woocommerce.post("orders/116/refunds", data).parsed_response
118118
}
119119
```
120120

121-
## View an Order Refund ##
121+
## Retrieve a refund ##
122122

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

125-
### HTTP Request ###
125+
### HTTP request ###
126126

127127
<div class="api-endpoint">
128128
<div class="endpoint-data">
@@ -183,17 +183,17 @@ woocommerce.get("orders/116/refunds/150").parsed_response
183183
}
184184
```
185185

186-
#### Available Parameters ####
186+
#### Available parameters ####
187187

188188
| Parameter | Type | Description |
189189
|-----------|--------|---------------------------------------------------|
190190
| `dp` | string | Number of decimal points to use in each resource. |
191191

192-
## View List of Refunds From an Order ##
192+
## List all refunds ##
193193

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

196-
### HTTP Request ###
196+
### HTTP request ###
197197

198198
<div class="api-endpoint">
199199
<div class="endpoint-data">
@@ -297,7 +297,7 @@ woocommerce.get("orders/116/refunds").parsed_response
297297
]
298298
```
299299

300-
#### Available Parameters ####
300+
#### Available parameters ####
301301

302302
| Parameter | Type | Description |
303303
|------------|---------|---------------------------------------------------------------------------------------------------------------|
@@ -315,11 +315,11 @@ woocommerce.get("orders/116/refunds").parsed_response
315315
| `filter` | string | Use WP Query arguments to modify the response; private query vars require appropriate authorization. |
316316
| `dp` | string | Number of decimal points to use in each resource. |
317317

318-
## Delete an Order Refund ##
318+
## Delete a refund ##
319319

320320
This API helps you delete an order refund.
321321

322-
### HTTP Request ###
322+
### HTTP request ###
323323

324324
<div class="api-endpoint">
325325
<div class="endpoint-data">
@@ -380,7 +380,7 @@ woocommerce.delete("orders/116/refunds/150", force: true).parsed_response
380380
}
381381
```
382382

383-
#### Available Parameters ####
383+
#### Available parameters ####
384384

385385
| Parameter | Type | Description |
386386
|-----------|--------|---------------------------------------------------------------|

0 commit comments

Comments
 (0)