1
- # Order - Refunds #
1
+ # Refunds #
2
2
3
3
This section lists all API endpoints that can be used to create, edit or otherwise manipulate order refunds.
4
4
5
- ## Order Refunds Properties ##
5
+ ## Refund properties ##
6
6
7
7
| Attribute | Type | Description |
8
8
| ----------------| -----------| ----------------------------------------------------------------------------------------------------------|
9
9
| ` id ` | integer | Unique identifier for the resource. <i class =" label label-info " >read-only</i > |
10
10
| ` date_created ` | date-time | The date the order refund was created, in the site's timezone. <i class =" label label-info " >read-only</i > |
11
11
| ` amount ` | string | Refund amount. <i class =" label label-info " >required</i > |
12
12
| ` 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 ) . |
14
14
15
- ### Refunds Line Items Properties ###
15
+ ### Refund line item properties ###
16
16
17
17
| Attribute | Type | Description |
18
18
| ----------------| ---------| ------------------------------------------------------------------------------------------------|
@@ -31,11 +31,11 @@ This section lists all API endpoints that can be used to create, edit or otherwi
31
31
| ` taxes ` | array | Line total tax with ` id ` , ` total ` and ` subtotal ` . <i class =" label label-info " >read-only</i > |
32
32
| ` meta ` | array | Line item meta data with ` key ` , ` label ` and ` value ` . <i class =" label label-info " >read-only</i > |
33
33
34
- ## Create a Refund For an Order ##
34
+ ## Create a refund ##
35
35
36
36
This API helps you to create a new refund for an order.
37
37
38
- ### HTTP Request ###
38
+ ### HTTP request ###
39
39
40
40
<div class =" api-endpoint " >
41
41
<div class="endpoint-data">
@@ -118,11 +118,11 @@ woocommerce.post("orders/116/refunds", data).parsed_response
118
118
}
119
119
```
120
120
121
- ## View an Order Refund ##
121
+ ## Retrieve a refund ##
122
122
123
123
This API lets you retrieve and view a specific refund from an order.
124
124
125
- ### HTTP Request ###
125
+ ### HTTP request ###
126
126
127
127
<div class =" api-endpoint " >
128
128
<div class="endpoint-data">
@@ -183,17 +183,17 @@ woocommerce.get("orders/116/refunds/150").parsed_response
183
183
}
184
184
```
185
185
186
- #### Available Parameters ####
186
+ #### Available parameters ####
187
187
188
188
| Parameter | Type | Description |
189
189
| -----------| --------| ---------------------------------------------------|
190
190
| ` dp ` | string | Number of decimal points to use in each resource. |
191
191
192
- ## View List of Refunds From an Order ##
192
+ ## List all refunds ##
193
193
194
194
This API helps you to view all the refunds from an order.
195
195
196
- ### HTTP Request ###
196
+ ### HTTP request ###
197
197
198
198
<div class =" api-endpoint " >
199
199
<div class="endpoint-data">
@@ -297,7 +297,7 @@ woocommerce.get("orders/116/refunds").parsed_response
297
297
]
298
298
```
299
299
300
- #### Available Parameters ####
300
+ #### Available parameters ####
301
301
302
302
| Parameter | Type | Description |
303
303
| ------------| ---------| ---------------------------------------------------------------------------------------------------------------|
@@ -315,11 +315,11 @@ woocommerce.get("orders/116/refunds").parsed_response
315
315
| ` filter ` | string | Use WP Query arguments to modify the response; private query vars require appropriate authorization. |
316
316
| ` dp ` | string | Number of decimal points to use in each resource. |
317
317
318
- ## Delete an Order Refund ##
318
+ ## Delete a refund ##
319
319
320
320
This API helps you delete an order refund.
321
321
322
- ### HTTP Request ###
322
+ ### HTTP request ###
323
323
324
324
<div class =" api-endpoint " >
325
325
<div class="endpoint-data">
@@ -380,7 +380,7 @@ woocommerce.delete("orders/116/refunds/150", force: true).parsed_response
380
380
}
381
381
```
382
382
383
- #### Available Parameters ####
383
+ #### Available parameters ####
384
384
385
385
| Parameter | Type | Description |
386
386
| -----------| --------| ---------------------------------------------------------------|
0 commit comments