RefundTransactions
Query transactions for Refund Object.
Table-Specific Information
Select
The add-in uses the Shopify API to process search criteria that refer to the OrderId and RefundId column. The add-in processes other filters client-side within the add-in.The Shopify APIs requires the search criteria to contain OrderId. For example, the following query is processed server-side.
SELECT * FROM RefundTransactions WHERE OrderId = '123'
When performing a query without a filter or a filter other then the OrderId column, the add-in will retrieve the entire list of refunds and perform the filters client-side.
The Shopify API requires that an OrderId be specified when retrieving refunds. Therefore to retrieve all the refunds, the add-in will first retrieve all the OrderIds
from the Orders table (essentially performing the query: SELECT Id FROM Orders). Once the OrderId values have been retrieved, the add-in will issue individual requests to the
Shopify API to retrieve all the refunds for each OrderId to build the result set.
SELECT * FROM RefundTransactions WHERE OrderId = '123' AND RefundId = '123'
Columns
Name | Type | References | Description |
TransactionsId [KEY] | Long | The ID for the refund transaction. | |
OrderId | Long |
Orders.Id | The ID for the order that the transaction is associated with. |
RefundId | Long |
Refunds.Id | The unique identifier for the refund associated with. |
Amount | Decimal | The amount of money included in the transaction. | |
Authorization | String | The authorization code associated with the transaction.. | |
CreatedAt | Datetime | The date and time (ISO 8601 format) when the transaction was created. | |
Currency | String | The three-letter code (ISO 4217 format) for the currency used for the payment. | |
DeviceId | String | The ID for the device. | |
ErrorCode | String | A standardized error code, independent of the payment provider. | |
GraphqlAPIId | String | The order adjustment type. | |
Gateway | String | The name of the gateway the transaction was issued through. | |
Kind | String | The transaction's type. | |
LocationId | String | The ID of the physical location where the transaction was processed. | |
Message | String | A string generated by the payment provider with additional information about why the transaction succeeded or failed. | |
ParentId | Long | The ID of an associated transaction.. | |
ProcessedAt | Datetime | The date and time (ISO 8601 format) when a transaction was processed. | |
Status | String | The status of the transaction. | |
SourceName | String | The origin of the transaction. | |
Test | Bool | Whether the transaction is a test transaction. | |
UserId | String | The ID for the user who was logged into the Shopify POS device when the order was processed, if applicable. |