OrderAgreements
Displays active order agreements, including terms, conditions, and associated sales data.
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 OrderAgreements WHERE OrderId = 'Val1'
Columns
| Name | Type | References | Description |
| OrderId | String |
Orders.Id | The unique identifier of the parent order associated with this agreement. |
| Id [KEY] | String | A unique identifier for the order agreement record. | |
| HappenedAt | Datetime | The date and time when the agreement was created or executed. | |
| Reason | String | The explanation or purpose for creating the agreement, such as an adjustment, correction, or special authorization. | |
| UserId | String | The unique identifier of the staff member associated with this agreement. Available only for stores on Shopify Plus. | |
| AppApiKey | String | The API key of the application that created or triggered this agreement, identifying the source app responsible for the action. |