Refunds
Create and query refunds.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The unique identifier for the refund. | |
| OrderId | Long | False |
Orders.Id |
The id of the order. |
| OrderUpdatedAt | Datetime | True |
Orders.UpdatedAt |
The date and time when the order was last modified. |
| Note | String | False |
The optional note attached to a refund. | |
| Restock | Bool | True |
Whether or not the line items were added back to the store inventory. | |
| UserId | Long | True |
The unique identifier of the user who performed the refund. | |
| CreatedAt | Datetime | True |
The date and time when the refund was created. | |
| ProcessedAt | Datetime | True |
The date and time when the refund was imported. | |
| LineAggregate | String | False |
A JSON aggregate of line items associated with the refund. | |
| OrderTransactionAggregate | String | False |
A JSON aggregate of transactions associated with the refund. |
Pseudo-Columns
Pseudo-columns are fields that can only be used in the types of statements under which they are explicitly listed. They are not standard columns but instead provide additional functionality for specific operations.
| Name | Type | Description |
| Notify | Bool |
Whether or not to send a refund notification to the customer. |
| DiscrepancyReason | String |
An optional comment, used if there is a discrepancy between calculated and actual refund amounts (one of: restock, damage, customer, other) |
| ShippingAmount | Decimal |
Set specific amount of shipping to refund. Takes precedence over FullRefund. |
| ShippingFullRefund | Bool |
Whether or not to to refund all remaining shipping. |