payouts
The payouts schema reports on the deposits Shopify sends you, not the individual transactions inside them. Use it to build payout timelines and summarize payouts by currency.
Anchor to Use casesUse cases
- Payout timeline: Group
payout_amountby week or month to see how much Shopify deposited and when. - Currency view: Compare
payout_amountwithpayout_amount_in_payout_currencybypayout_currencyto reconcile deposits across the currencies you settle in.
ShopifyQL
Examples
Description
Compare cumulative `payout_amount` by month for the year to date against last year. This example uses [`CUMULATIVE_VALUES`](/docs/api/shopifyql/latest/syntax/with#cumulative-values) for a running total, with [`WITH PERCENT_CHANGE`](/docs/api/shopifyql/latest/syntax/with#percent-change-columns) and [`COMPARE TO previous_year`](/docs/api/shopifyql/latest/syntax/compare-to) adding the year-over-year change column.
ShopifyQL
FROM payouts SHOW payout_amount, payout_amount_in_payout_currency TIMESERIES month WITH CUMULATIVE_VALUES, TOTALS, PERCENT_CHANGE DURING this_year COMPARE TO previous_year ORDER BY month ASC VISUALIZE payout_amount TYPE lineDescription
Split last quarter's `payout_amount` by currency. This example uses [`WITH TOTALS`](/docs/api/shopifyql/latest/syntax/with#total-columns) to add the combined all-currency total to every row.
ShopifyQL
FROM payouts SHOW payout_amount, payout_amount_in_payout_currency GROUP BY payout_currency WITH TOTALS DURING last_quarter ORDER BY payout_amount DESC VISUALIZE payout_amount TYPE donutDescription
Track your weekly payout totals last quarter in both your store currency and the currency each payout settled in. This example uses [`WITH TOTALS`](/docs/api/shopifyql/latest/syntax/with#total-columns) to add a last-quarter total beside the weekly rows.
ShopifyQL
FROM payouts SHOW payout_amount, payout_amount_in_payout_currency TIMESERIES week WITH TOTALS DURING last_quarter ORDER BY week ASC VISUALIZE payout_amount TYPE lineDescription
Track weekly `payout_amount` split by `payout_currency` across last quarter. This example uses [`GROUP_TOTALS`](/docs/api/shopifyql/latest/syntax/with#group-total-columns) to add a per-week total across currencies beside the per-currency bands.
ShopifyQL
FROM payouts SHOW payout_amount GROUP BY payout_currency WITH TOTALS, GROUP_TOTALS TIMESERIES week DURING last_quarter ORDER BY week ASC VISUALIZE payout_amount TYPE stacked_bar
Anchor to MetricsMetrics
Counts and calculations that let you track key business indicators. Metrics show up as the columns when queried.
Metrics you can use when querying FROM payouts.
- Anchor to payout_amountpayout_
amountpayout_ amount MONEYMONEY The value of payouts issued to your store, reported in your store's currency.
- Anchor to payout_amount_in_payout_currencypayout_
amount_ in_ payout_ currencypayout_ amount_ in_ payout_ currency MONEYMONEY
MONEY
A monetary amount representing currency values such as prices, revenue, costs, and discounts.
Anchor to DimensionsDimensions
Attributes of your data that let you look more granularly at aspects of the data. Group and filter by dimensions to shape the rows your query returns.
Dimensions you can use when querying FROM payouts.
- Anchor to daydaydayDAY_TIMESTAMPDAY_TIMESTAMP
The day a payout was issued.
- Anchor to day_of_weekday_
of_ weekday_ of_ week DAY_OF_WEEKDAY_OF_WEEK The day of the week a payout was issued, with values Monday through Sunday.
- Anchor to hourhourhourHOUR_TIMESTAMPHOUR_TIMESTAMP
The hour a payout was issued.
- Anchor to hour_of_dayhour_
of_ dayhour_ of_ day HOUR_OF_DAYHOUR_OF_DAY The hour of the day when the payout was issued, with values 0 through 23.
- Anchor to minuteminuteminuteMINUTE_TIMESTAMPMINUTE_TIMESTAMP
The minute a payout was issued.
- Anchor to monthmonthmonthMONTH_TIMESTAMPMONTH_TIMESTAMP
The month a payout was issued.
- Anchor to month_of_yearmonth_
of_ yearmonth_ of_ year MONTH_OF_YEARMONTH_OF_YEAR The month of the year when the payout was issued, with values 1 through 12.
- Anchor to payout_currencypayout_
currencypayout_ currency STRINGSTRING Currency the payout was issued in
- Anchor to quarterquarterquarterQUARTER_TIMESTAMPQUARTER_TIMESTAMP
The quarter a payout was issued.
- Anchor to secondsecondsecondSECOND_TIMESTAMPSECOND_TIMESTAMP
The second a payout was issued.
- Anchor to shop_idshop_
idshop_ id IDENTITYIDENTITY - Anchor to weekweekweekWEEK_TIMESTAMPWEEK_TIMESTAMP
The week a payout was issued.
- Anchor to week_of_yearweek_
of_ yearweek_ of_ year WEEK_OF_YEARWEEK_OF_YEAR The week of the year when the payout was issued, with values 1 through 53.
- Anchor to yearyearyearYEAR_TIMESTAMPYEAR_TIMESTAMP
The year a payout was issued.
- Anchor to shop_nameshop_
nameshop_ name STRINGSTRING Name of your store
DAY_TIMESTAMP
A date value truncated to day precision.
DAY_OF_WEEK
A day within a week, used for weekday-based grouping and filtering.
HOUR_TIMESTAMP
A timestamp truncated to hour precision.
HOUR_OF_DAY
An hour within a day, typically represented as an integer from 0 to 23.
MINUTE_TIMESTAMP
A timestamp truncated to minute precision.
MONTH_TIMESTAMP
A date value representing the start of a month.
MONTH_OF_YEAR
A month number within a year.
STRING
A sequence of characters representing text data.
QUARTER_TIMESTAMP
A date value representing the start of a fiscal quarter.
SECOND_TIMESTAMP
A timestamp truncated to second precision.
IDENTITY
A unique identifier for a Shopify resource such as a customer, product, or order.
WEEK_TIMESTAMP
A date value representing the start of a week.
WEEK_OF_YEAR
A week number within a year.
YEAR_TIMESTAMP
A date value representing the start of a year.
payments: Transaction data upstream of these payouts.fees: Processing and FX costs deducted from payouts.chargebacks: Disputed transactions that reduce payout amounts.