OrderRefundAgreements
Shows agreements governing refunded orders, including refund rules and financial references.
View-Specific Information
Select
The connector uses the Shopify API to process WHERE clause conditions built with the following column and operators. The connector processes other filters client-side within the connector.
- OrderId supports the '=, IN' comparison operators.
For example, the following query is processed server-side:
SELECT * FROM OrderRefundAgreements WHERE OrderId = 'Val1'
Columns
| Name | Type | References | Description |
| OrderId | String |
Orders.Id | The identifier of the parent order that this refund agreement is associated with. |
| Id [KEY] | String | A unique identifier for the refund agreement record within the order. | |
| HappenedAt | Datetime | The date and time when the refund agreement was created or executed. | |
| Reason | String | A brief description of the reason for the refund agreement, such as product return, adjustment, or customer service issue. | |
| UserId | String | The identifier of the staff member who created or authorized the refund agreement. Available only for Shopify Plus stores. Globally unique value. | |
| AppApiKey | String | The API key of the application that initiated or created the refund agreement, identifying the integration source. | |
| RefundId | String |
Refunds.Id | The identifier of the refund transaction associated with this agreement, linking it to related refund records. |