Refunds
Holds refund headers for orders, including totals, currency, refund reasons, and associated transactions.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The unique numeric identifier for the refund. | |
| OrderId | Long | False |
Orders.Id |
The unique numeric identifier for the order associated with this refund. |
| OrderUpdatedAt | Datetime | True |
Orders.UpdatedAt |
The date and time when the order associated with the refund was last updated. |
| Note | String | False |
An optional note added by the merchant to provide context about the refund. | |
| Restock | Bool | True |
Indicates whether the refunded line items were restocked in inventory. | |
| UserId | Long | True |
The unique numeric identifier of the user who created 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 processed or imported. | |
| LineAggregate | String | False |
A JSON aggregate that lists all line items included in the refund. | |
| OrderTransactionAggregate | String | False |
A JSON aggregate that contains all related transactions associated with the refund. |
Pseudo-Columns
疑似カラムは、明示的にリストされているタイプのステートメントでのみ使用できるフィールドです。これらは標準的なカラムではなく、特定の操作のための追加機能を提供するものです。
| Name | Type | Description |
| Notify | Bool |
Indicates whether a refund notification email should be sent to the customer. |
| DiscrepancyReason | String |
A comment explaining any difference between the calculated and actual refund amount. Possible values include 'restock', 'damage', 'customer', or 'other'. |
| ShippingAmount | Decimal |
The specific shipping amount to refund. This value overrides ShippingFullRefund when both are provided. |
| ShippingFullRefund | Bool |
Indicates whether the full remaining shipping cost should be refunded. |