Choose a version:

store_credit_transactions

The store_credit_transactions schema captures individual store credit movements. Use it to trace why store credit changed and which customer, order, company, source, or event a movement belongs to.

Anchor to Use casesUse cases

Movement by event: Group credited_store_credit_value, debited_store_credit_value, and expired_store_credit_value by store_credit_event to break down how much credit was issued, redeemed, and expired.
Movement source: Filter or group by store_credit_source to show where credit movements originated.
Account link: Use customer_id, order_id, and company_id to connect transactions to the affected account or commerce object.
Currency: Compare transaction values by store_credit_currency to separate credit movement across the currencies you operate in.

Examples

ShopifyQL

View in adminView query results in the ShopifyQL editor

FROM store_credit_transactions

SHOW credited_store_credit_value, debited_store_credit_value,

expired_store_credit_value

GROUP BY store_credit_source WITH TOTALS

DURING this_quarter

ORDER BY credited_store_credit_value DESC

VISUALIZE credited_store_credit_value TYPE horizontal_bar

Examples

Description

Compare store-credit sources this quarter by `credited_store_credit_value`, with the value redeemed and expired beside it. This example uses [`WITH TOTALS`](/docs/api/shopifyql/latest/syntax/with#total-columns) to add the all-source total to every row.

ShopifyQL

FROM store_credit_transactions
  SHOW credited_store_credit_value, debited_store_credit_value,
    expired_store_credit_value
  GROUP BY store_credit_source WITH TOTALS
  DURING this_quarter
  ORDER BY credited_store_credit_value DESC
VISUALIZE credited_store_credit_value TYPE horizontal_bar

Description
Rank the top 100 customers by total store-credit activity, the combined sum of [`credited_store_credit_value`](#storecredittransactionsmetric-propertydetail-creditedstorecreditvalue) and `debited_store_credit_value`. This example aliases that sum as `total_store_credit_value` with `AS`, then orders by it descending so the most active customers rank first.
ShopifyQL
```
FROM store_credit_transactions
  SHOW credited_store_credit_value, debited_store_credit_value,
    credited_store_credit_value + debited_store_credit_value AS
    total_store_credit_value
  GROUP BY customer_name, customer_email WITH TOTALS
  ORDER BY total_store_credit_value DESC
  LIMIT 100
VISUALIZE total_store_credit_value TYPE horizontal_bar
```
Description
See whether store credit grew or shrank last month by comparing how much was issued, redeemed, and expired against the prior month. This example uses [`WITH PERCENT_CHANGE`](/docs/api/shopifyql/latest/syntax/with#percent-change-columns) with [`COMPARE TO previous_period`](/docs/api/shopifyql/latest/syntax/compare-to) to add the month-over-month change for each.
ShopifyQL
```
FROM store_credit_transactions
  SHOW credited_store_credit_value, debited_store_credit_value,
    expired_store_credit_value
  WITH PERCENT_CHANGE
  DURING last_month
  COMPARE TO previous_period
```
Description
Track weekly `debited_store_credit_value` across last quarter. This example uses [`WITH TOTALS`](/docs/api/shopifyql/latest/syntax/with#total-columns) to add a total for last quarter beside the weekly rows.
ShopifyQL
```
FROM store_credit_transactions
  SHOW debited_store_credit_value
  TIMESERIES week WITH TOTALS
  DURING last_quarter
  ORDER BY week ASC
VISUALIZE debited_store_credit_value TYPE line
```

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 store_credit_transactions.

Anchor to credited_store_credit_value credited_store_credit_value: The value of store credit added to customer balances by transactions in your results. Use store_credit_currency to see the currency for those amounts.
Anchor to debited_store_credit_value debited_store_credit_value: The value of store credit taken from customer balances by transactions in your results. Use store_credit_currency to see the currency for those amounts.
Anchor to expired_store_credit_value expired_store_credit_value: The value of store credit that expired in transactions in your results. Use store_credit_currency to see the currency for those amounts.

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 store_credit_transactions.

Anchor to company_id company_id: company_id is the unique Shopify identifier for the B2B company linked to the store credit transaction. Use it with company_name to show readable labels.
Anchor to company_location_id company_location_id: company_location_id is the unique Shopify identifier for the company location linked to the store credit transaction. Use it with company_location_name to show readable labels.
Anchor to customer_id customer_id: customer_id is the unique Shopify identifier for the customer linked to the store credit transaction. Use it with customer_name or customer_email to show readable labels.
Anchor to day day: The day a store credit transaction happened.
Anchor to day_of_week day_of_week: The day of the week a store credit transaction happened, with values Monday through Sunday.
Anchor to hour hour: The hour a store credit transaction happened.
Anchor to hour_of_day hour_of_day: The hour of day a store credit transaction happened, with values 0 through 23.
Anchor to minute minute: The minute a store credit transaction happened.
Anchor to month month: The month a store credit transaction happened.
Anchor to month_of_year month_of_year: The month of year a store credit transaction happened, with values 1 through 12.
Anchor to order_id order_id: order_id is the unique Shopify identifier for the order linked to the store credit transaction. Use it with order_name to show the customer-facing order name or number.
Anchor to quarter quarter: The quarter a store credit transaction happened.
Anchor to second second: The second a store credit transaction happened.
Anchor to shop_id shop_id: The unique Shopify identifier for your store. Use shop_id with shop_name to show readable store labels.
Anchor to store_credit_currency store_credit_currency: Currency of the store credit transaction
Anchor to store_credit_event store_credit_event: Values include Adjustment, Order cancellation, Order payment, Order refund, and Payment failure.
Anchor to store_credit_expires_at store_credit_expires_at: The date and time a credited store credit amount is set to expire.
Anchor to store_credit_id store_credit_id: Shopify identifier for the store credit transaction
Anchor to store_credit_source store_credit_source: The origin can appear as Shopify, a staff member's name, or an app name.
Anchor to week week: The week a store credit transaction happened.
Anchor to week_of_year week_of_year: The week of year a store credit transaction happened, with values 1 through 53.
Anchor to year year: The year a store credit transaction happened.
Anchor to company_name company_name: Name of the company
Anchor to shop_name shop_name: Name of your store
Anchor to company_location_name company_location_name: Name of the company location
Anchor to abandoned_checkout_date abandoned_checkout_date: Date the customer most recently abandoned a cart
Anchor to customer_account_status customer_account_status: The customer's account state, with values Declined, Disabled, Enabled, and Invited.
Anchor to customer_added_date customer_added_date: The day the customer record was added, reported in your store's time zone.
Anchor to customer_created_by_app_id customer_created_by_app_id: The Shopify identifier for the app that created the customer.
Anchor to customer_email customer_email: Email address of the customer
Anchor to customer_email_domain customer_email_domain: The part of the customer's email address after the @ symbol, such as gmail.com or your company's domain.
Anchor to customer_language customer_language: Language associated with the customer
Anchor to customer_name customer_name: Full name of the customer
Anchor to is_b2b_order is_b2b_order: Whether the order is a B2B order, with values true and false.
Anchor to is_canceled_order is_canceled_order: Whether the order is canceled, with values true and false.
Anchor to order_checkout_currency order_checkout_currency: The currency the buyer saw at checkout when placing the order. Values are currency codes such as USD, CAD, EUR, and GBP.
Anchor to order_fulfillment_status order_fulfillment_status: The order's fulfillment state, with values Fulfilled, Partial, Restocked, and Unfulfilled.
Anchor to order_includes_duties order_includes_duties: Whether the order includes duties, with values true and false.
Anchor to order_name order_name: The name or number of the order as the customer sees it.
Anchor to order_payment_status order_payment_status: The order's payment state, such as Authorized, Paid, Partially refunded, or Pending.
Anchor to order_sales_channel order_sales_channel: The sales channel where the order was placed, shown as a channel name such as Online Store or POS.
Anchor to order_sales_channel_id order_sales_channel_id: The unique Shopify identifier for the order's sales channel. Use order_sales_channel_id with order_sales_channel to show readable channel labels.

IDENTITY

A unique identifier for a Shopify resource such as a customer, product, or order.

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.

QUARTER_TIMESTAMP

A date value representing the start of a fiscal quarter.

SECOND_TIMESTAMP

A timestamp truncated to second precision.

STRING

A sequence of characters representing text data.

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.

BOOLEAN

A true or false value representing binary states.

Anchor to MATCHES expressionsMATCHES expressions

Use these expressions inside a MATCHES filter to keep store_credit_transactions rows that have at least one related record matching the parameters. Each parameter filters on a dimension or metric of the related records.

Anchor to customer.orders_placed customer.orders_placed: Orders the customer placed, filterable by order date, source app, location, order count, and spend.
Anchor to customer.products_purchased customer.products_purchased: Products the customer bought, filterable by product ID, purchase date, quantity per order, and total quantity.
Anchor to customer.shopify_email.bounced customer.shopify_email.bounced: Emails that bounced for the customer, filterable by marketing activity, bounce date, and bounce count.
Anchor to customer.shopify_email.clicked customer.shopify_email.clicked: Emails the customer clicked, filterable by marketing activity, click date, and click count.
Anchor to customer.shopify_email.delivered customer.shopify_email.delivered: Emails delivered to the customer, filterable by marketing activity, delivery date, and delivery count.
Anchor to customer.shopify_email.marked_as_spam customer.shopify_email.marked_as_spam: Emails the customer marked as spam, filterable by marketing activity, spam-report date, and spam-report count.
Anchor to customer.shopify_email.opened customer.shopify_email.opened: Emails the customer opened, filterable by marketing activity, open date, and open count.
Anchor to customer.shopify_email.unsubscribed customer.shopify_email.unsubscribed: Email unsubscribe events for the customer, filterable by marketing activity, unsubscribe date, and unsubscribe count.
Anchor to customer.store_credit_accounts customer.store_credit_accounts: Store credit accounts for the customer, filterable by balance, currency, expiry date, and most recent credit date.
Anchor to customer.storefront_event.collection_viewed customer.storefront_event.collection_viewed: Collection pages the customer viewed, filterable by collection ID, view date, and view count.
Anchor to customer.storefront_event.product_viewed customer.storefront_event.product_viewed: Product pages the customer viewed, filterable by product ID, view date, and view count.
Anchor to customer.within_distance customer.within_distance: Customers with an address within a distance of a location, filterable by coordinates and radius.

StoreCreditTransactionsCustomerOrdersPlacedConditions

Fields you can use inside `customer.orders_placed MATCHES (...)` when querying `FROM store_credit_transactions`.

amount
Filter. Amount spent per order.
```
MONEY
```
app_id
Filter. App ID associated with the order.
```
IDENTITY
```
date
Filter. Date the order was placed.
```
TIMESTAMP
```
location_id
Filter. Location ID associated with the order.
```
IDENTITY
```
count
Metric. Number of orders placed.
```
INTEGER
```
sum_amount
Metric. Amount spent in the date range.
```
MONEY
```

TIMESTAMP

A full-precision timestamp including date and time.

INTEGER

A whole number without decimal places, used for counts, quantities, and other discrete numeric values.

StoreCreditTransactionsCustomerProductsPurchasedConditions

Fields you can use inside `customer.products_purchased MATCHES (...)` when querying `FROM store_credit_transactions`.

date
Filter. Date the product(s) were purchased.
```
TIMESTAMP
```
id
Filter. Product IDs.
```
IDENTITY
```
quantity
Filter. Number purchased per order.
```
INTEGER
```
sum_quantity
Metric. Number purchased within the date range.
```
INTEGER
```

StoreCreditTransactionsCustomerShopifyEmailBouncedConditions

Fields you can use inside `customer.shopify_email.bounced MATCHES (...)` when querying `FROM store_credit_transactions`.

activity_id
Filter. Marketing activity ID of the email campaign.
```
IDENTITY
```
date
Filter. Date on which the email was bounced.
```
TIMESTAMP
```
count
Metric. Exact number of times an email was bounced.
```
INTEGER
```

StoreCreditTransactionsCustomerShopifyEmailClickedConditions

Fields you can use inside `customer.shopify_email.clicked MATCHES (...)` when querying `FROM store_credit_transactions`.

activity_id
Filter. Marketing activity ID of the email campaign.
```
IDENTITY
```
date
Filter. Date on which the email was clicked.
```
TIMESTAMP
```
count
Metric. Exact number of times an email was clicked.
```
INTEGER
```

StoreCreditTransactionsCustomerShopifyEmailDeliveredConditions

Fields you can use inside `customer.shopify_email.delivered MATCHES (...)` when querying `FROM store_credit_transactions`.

activity_id
Filter. Marketing activity ID of the email campaign.
```
IDENTITY
```
date
Filter. Date on which the email was delivered.
```
TIMESTAMP
```
count
Metric. Exact number of times an email was delivered.
```
INTEGER
```

StoreCreditTransactionsCustomerShopifyEmailMarkedAsSpamConditions

Fields you can use inside `customer.shopify_email.marked_as_spam MATCHES (...)` when querying `FROM store_credit_transactions`.

activity_id
Filter. Marketing activity ID of the email campaign.
```
IDENTITY
```
date
Filter. Date on which the email was marked as spam.
```
TIMESTAMP
```
count
Metric. Exact number of times an email was marked as spam.
```
INTEGER
```

StoreCreditTransactionsCustomerShopifyEmailOpenedConditions

Fields you can use inside `customer.shopify_email.opened MATCHES (...)` when querying `FROM store_credit_transactions`.

activity_id
Filter. Marketing activity ID of the email campaign.
```
IDENTITY
```
date
Filter. Date on which the email was opened.
```
TIMESTAMP
```
count
Metric. Exact number of times an email was opened.
```
INTEGER
```

StoreCreditTransactionsCustomerShopifyEmailUnsubscribedConditions

Fields you can use inside `customer.shopify_email.unsubscribed MATCHES (...)` when querying `FROM store_credit_transactions`.

activity_id
Filter. Marketing activity ID of the email campaign.
```
IDENTITY
```
date
Filter. Date on which the email was unsubscribed.
```
TIMESTAMP
```
count
Metric. Exact number of times an email was unsubscribed.
```
INTEGER
```

StoreCreditTransactionsCustomerStoreCreditAccountsConditions

Fields you can use inside `customer.store_credit_accounts MATCHES (...)` when querying `FROM store_credit_transactions`.

balance
Filter. Amount available to spend.
```
FLOAT
```
currency
Filter. Currency associated with the account.
```
STRING
```
last_credit_date
Filter. Date when credits were last added.
```
TIMESTAMP
```
next_expiry_date
Filter. Date when credits expire.
```
TIMESTAMP
```

FLOAT

A floating-point number used for measurements, rates, and other continuous numeric values.

StoreCreditTransactionsCustomerStorefrontEventCollectionViewedConditions

Fields you can use inside `customer.storefront_event.collection_viewed MATCHES (...)` when querying `FROM store_credit_transactions`.

date
Filter. Date collection was viewed.
```
TIMESTAMP
```
id
Filter. Collection ID.
```
IDENTITY
```
count
Metric. Times collection was viewed.
```
INTEGER
```

StoreCreditTransactionsCustomerStorefrontEventProductViewedConditions

Fields you can use inside `customer.storefront_event.product_viewed MATCHES (...)` when querying `FROM store_credit_transactions`.

date
Filter. Date product was viewed.
```
TIMESTAMP
```
id
Filter. Product ID.
```
IDENTITY
```
count
Metric. Times product was viewed.
```
INTEGER
```

StoreCreditTransactionsCustomerWithinDistanceConditions

Fields you can use inside `customer.within_distance MATCHES (...)` when querying `FROM store_credit_transactions`.

coordinates
Filter. Latitude and longitude of location. Required.
```
GEO_COORDINATE
```
distance_km
Filter. Maximum distance from location, in kilometers. Required: provide one of the `distance_km/mi` group.
```
FLOAT
```
distance_mi
Filter. Maximum distance from location, in miles. Required: provide one of the `distance_km/mi` group.
```
FLOAT
```

GEO_COORDINATE

A geographic coordinate value.

Anchor to Related schemasRelated schemas

store_credit_summaries: Daily balance snapshots aggregated from these transactions.
payments: Transaction data when you want to see how store credit fits into the full payment mix.
customers: Customer-level data to enrich the top-spender list with lifetime value.

Was this page helpful?