Get transactions
The Get Transactions API retrieves a list of transactions with optional filtering, sorting, and pagination.
Query parameters
Filter transactions by state code.
Filter transactions by state code.
Filter by transaction type (e.g., SALE, FULL_CREDIT_NOTE, PARTIAL_CREDIT_NOTE, ARCHIVE etc.).
Filter by transaction type (e.g., SALE, FULL_CREDIT_NOTE, PARTIAL_CREDIT_NOTE, ARCHIVE etc.).
Filter transactions based on the source.
Filter transactions based on the source.
Search for transactions using a general query (e.g., order ID, customer name).
Search for transactions using a general query (e.g., order ID, customer name).
Filter transactions by country code (ISO 3166-1 alpha-2 format, e.g., US).
Filter by full state name (e.g., California).
Filter by full state name (e.g., California).
Filter by address status (e.g., UNVERIFIED, INVALID, PARTIALLY_VERIFIED, VERIFIED, UNVERIFIABLE).
Filter by address status (e.g., UNVERIFIED, INVALID, PARTIALLY_VERIFIED, VERIFIED, UNVERIFIABLE).
Filter by transaction status (e.g., PENDING, COMMITTED, CANCELLED, ARCHIVED). For refund filtering use the refund_status parameter.
Shopify has 2 order statuses for refund case: refunded and partially_refunded If the given order has different status from these 2, we will set the transaction's refund_status to PARTIALLY_REFUNDED by default.
Filter by refund status (e.g., FULLY_REFUNDED, PARTIALLY_REFUNDED).
Retrieve transactions linked to a specific filing ID.
Retrieve transactions linked to a specific filing ID.
Sort results based on specified fields. Prefix with - for descending order (e.g., -date for newest first).
Sort results based on specified fields. Prefix with - for descending order (e.g., -date for newest first).
Retrieve transactions with a date greater than or equal to the bound (YYYY-MM-DD or ISO datetime in UTC). Defaults to 12 months ago when neither date__gte nor date__lte is provided.
Retrieve transactions with a date greater than or equal to the bound (YYYY-MM-DD or ISO datetime in UTC). Defaults to 12 months ago when neither date__gte nor date__lte is provided.
Retrieve transactions with a date less than or equal to the bound (YYYY-MM-DD or ISO datetime in UTC).
Retrieve transactions with a date less than or equal to the bound (YYYY-MM-DD or ISO datetime in UTC).
Filter transactions based on processing status. Multiple values can be passed as a comma-separated list.
Filter transactions based on processing status. Multiple values can be passed as a comma-separated list.
Filter transactions by marketplace (e.g., AMAZON, EBAY).
Filter transactions by marketplace (e.g., AMAZON, EBAY).
Filter transactions by exemption status. Multiple values can be passed as a comma-separated list (e.g., EXEMPT,TAXABLE).
Filter transactions by exemption status. Multiple values can be passed as a comma-separated list (e.g., EXEMPT,TAXABLE).
Filter transactions by connection ID (comma-separated)
Filter transactions by connection ID (comma-separated)
Filter by transaction direction (SALE or PURCHASE). When unset, the list includes both directions.
Optional upper bound for the pagination COUNT query. When set, the returned total is capped at this value and pages is derived from the capped total, making large result sets faster to paginate at the cost of approximate totals. When unset, total and pages reflect the exact count (existing behavior).
Optional upper bound for the pagination COUNT query. When set, the returned total is capped at this value and pages is derived from the capped total, making large result sets faster to paginate at the cost of approximate totals. When unset, total and pages reflect the exact count (existing behavior).
Page number
Page number
Page size
Page size
Headers
The unique identifier for the organization making the request
The unique identifier for the organization making the request
Response
Successfully retrieved transactions