Admin GraphQL API2024-07
Additions to the GraphQL API for Shopify Payments payouts and balance transactions
We are introducing updates to our API that will enhance your experience and provide you with more flexibility:
Support for Query Arguments on Payouts GraphQL Field:
- You can now utilize Shopify's API search syntax to filter and sort payouts using the
and
parameters. This functionality allows you to efficiently search and organize payouts based on specific criteria such as
,
status
,amount
,currency
, and.
- You can now utilize Shopify's API search syntax to filter and sort payouts using the
Addition of Missing Attributes to ShopifyPaymentsBalanceTransaction GraphQL Object:
- We have enriched the
GraphQL object by introducing the following attributes:
: Represents the ID of the resource that led to the transaction.
: Indicates the ID of the Order Transaction that triggered the balance transaction. If the
is an adjustment, this value will be null.
: An array of associated order transactions that resulted in the balance transaction. If the
is not an adjustment, this array will be null. Each object in the array includes:
: Specifies the reason for the adjustment associated with the transaction. If the
is not an adjustment, this value will be null.
- We have enriched the
Was this section helpful?