OrderRefunds
Returns a list of refunds.
Table Specific Information
Select
The driver will use the BigCommerce API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the driver.
- Id supports the '=, IN' comparison.
- OrderId supports the '=, IN' comparison.
- Created supports the '=, >, <, IN' comparison.
For example, the following queries are processed server side:
SELECT * FROM OrderRefunds SELECT * FROM OrderRefunds WHERE Id = 1 SELECT * FROM OrderRefunds WHERE OrderId = 2
Columns
| Name | Type | Description |
| Id [KEY] | Integer | Refund resource ID. |
| Created [KEY] | Datetime | Timestamp of when this refund was created. |
| OrderId | Integer | Reference to order id. |
| Reason | String | Reason for refund. |
| TotalAmount | Decimal | A non-negative 2 decimal place rounded value that represents the amount that can be charged/refunded via payment providers. |
| TotalTax | Decimal | Total tax amount refunded back to the shopper. Note: order_level_amount does not affect tax liability. |
| UserId | Integer | Reference to the user's id who create this refund. |
| UsesMerchantOverrideValues | Boolean | Whether refund amount and tax are provided explicitly by merchant override |