Get Balance Transaction Filter Options
GET/api/shopify/:integrationInstance/balance-transactions/filter-options
Returns the distinct filter values present in the synced balance transactions for the integration instance: every balance-transaction type and every financial code, so a client can populate the balance-transaction filters.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
Each balance-transaction line carries transaction_date (Shopify's transaction date, as a calendar date in the account timezone) and, when linked, order.order_date (the order's date in the account timezone, which payout entry dates are calculated from).
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.