Shopify (GraphQL): Most-used fields

Shopify (GraphQL): Most-used fields#

The table below gives information about most-used fields that you can import from Shopify (GraphQL). Other fields might also be available in Adverity.

The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.

API name

Adverity UI name

Description

Use in Adverity

Amount

Amount

A monetary value, often representing a portion of a total, such as a tax amount or a discount value.

dimension

App title

App title

The official name of an application as it is displayed in an app store.

dimension

Billing address city

Billing address city

The city component of the customer’s billing address.

dimension

Billing address country

Billing address country

The country component of the customer’s billing address.

dimension

Billing address line 1

Billing address line 1

The first line of the street address for the customer’s billing address (e.g., street name and house number).

dimension

Billing address line 2

Billing address line 2

The second line of the street address for the customer’s billing address (e.g., apartment, suite, unit).

dimension

Billing address post code

Billing address post code

The postal code or ZIP code associated with the customer’s billing address.

dimension

Billing city

Billing city

The city specified in the customer’s billing address.

dimension

Billing country

Billing country

The country specified in the customer’s billing address.

dimension

Billing region

Billing region

The state, province, or region specified in the customer’s billing address.

dimension

Calendar Month

Calendar Month

A temporal dimension representing a specific calendar month, used for aggregating and analyzing data over monthly periods.

dimension

Calendar Year

Calendar Year

A temporal dimension representing a specific calendar year, used for aggregating and analyzing data over yearly periods.

metric

Cancel reason

Cancel reason

The reason specified for the cancellation of an order or a transaction.

dimension

Cancellation staff note

Cancellation staff note

An internal note added by staff when an order is canceled, not visible to the customer.

dimension

Cancelled at

Cancelled at

The date and time when an order was canceled.

dimension

Capturable payment

Capturable payment

The amount of an authorized payment that can still be captured by the merchant.

dimension

Channel ID

Channel ID

The globally-unique identifier for the sales channel through which an order originated.

dimension

Channel name

Channel name

The public-facing name of the sales channel.

dimension

Closed at

Closed at

The timestamp indicating when an order was closed.

dimension

Collection ID

Collection ID

A unique identifier for a collection within Shopify, used to retrieve specific collection details. This ID remains constant even if other collection properties change.

dimension

Collection Locale

Collection Locale

The language or region setting for localized content of a collection, enabling the display of collection information in different markets.

dimension

Collection key

Collection key

The unique identifier (key) for a custom field (metafield) associated with a collection, allowing for storage of additional, structured information.

dimension

Collection value

Collection value

The data stored within a custom field (metafield) associated with a collection, identified by its corresponding key and namespace.

dimension

Confirmation number

Confirmation number

A unique alphanumeric code assigned to a purchase transaction to confirm the order.

dimension

Country

Country

The geographical country associated with an address or customer locale.

dimension

Created at

Created at

The timestamp indicating when a record or resource was created.

dimension

Created at date

Created at date

The date component of the timestamp when a record or resource was created.

dimension

Currency

Currency

The monetary unit used for transactions, often represented by its ISO 4217 code.

dimension

Currency code

Currency code

The three-letter ISO 4217 code representing the currency of a transaction or shop.

dimension

Current cart discount amount

Current cart discount amount

The total monetary value of discounts currently applied to the items in the shopping cart.

metric

Current cart discount amount currency code

Current cart discount amount currency code

The currency code of the discount amount applied to the current cart.

dimension

Customer ID

Customer ID

A unique identifier assigned to a customer.

dimension

Customer accepts marketing

Customer accepts marketing

A boolean indicator showing whether the customer has given consent to receive marketing communications.

dimension

Customer email

Customer email

The primary email address of the customer.

dimension

Customer full name

Customer full name

The complete name of the customer, derived from first and last names, or falling back to email or phone number if names are unavailable.

dimension

Customer journey attribution ready

Customer journey attribution ready

Indicates whether the customer journey summary data is available and processed.

dimension

Customer journey first session ID

Customer journey first session ID

The unique identifier for the customer’s first recorded session on the online store.

dimension

Customer journey first session UTM campaign

Customer journey first session UTM campaign

The UTM campaign parameter from the URL of the customer’s first session.

dimension

Customer journey first session UTM content

Customer journey first session UTM content

The UTM content parameter from the URL of the customer’s first session.

dimension

Customer journey first session UTM medium

Customer journey first session UTM medium

The UTM medium parameter from the URL of the customer’s first session.

dimension

Customer journey first session UTM source

Customer journey first session UTM source

The UTM source parameter from the URL of the customer’s first session.

dimension

Customer journey first session UTM term

Customer journey first session UTM term

The UTM term parameter from the URL of the customer’s first session.

dimension

Customer journey first session landing page

Customer journey first session landing page

The URL of the first page the customer landed on during their initial session.

dimension

Customer journey first session occured at

Customer journey first session occured at

The date and time when the customer’s first session occurred.

dimension

Customer journey first session referral code

Customer journey first session referral code

A marketing referral code from the link the customer used to visit the store for their first session.

dimension

Customer journey first session referrer URL

Customer journey first session referrer URL

The URL of the webpage from which the customer was referred to the online store during their first session.

dimension

Customer journey first session source

Customer journey first session source

The origin from which the customer visited the store during their first session (e.g., social media, search engine, direct).

dimension

Customer journey first session source description

Customer journey first session source description

A detailed description of the source from which the customer visited the store during their first session.

dimension

Customer journey first session source type

Customer journey first session source type

The type of marketing tactic associated with the source of the customer’s first session.

dimension

Customer journey last session ID

Customer journey last session ID

The unique identifier for the customer’s last recorded session on the online store before an order.

dimension

Customer journey last session UTM campaign

Customer journey last session UTM campaign

The UTM campaign parameter from the URL of the customer’s last session.

dimension

Customer journey last session UTM content

Customer journey last session UTM content

The UTM content parameter from the URL of the customer’s last session.

dimension

Customer journey last session UTM medium

Customer journey last session UTM medium

The UTM medium parameter from the URL of the customer’s last session.

dimension

Customer journey last session UTM source

Customer journey last session UTM source

The UTM source parameter from the URL of the customer’s last session.

dimension

Customer journey last session UTM term

Customer journey last session UTM term

The UTM term parameter from the URL of the customer’s last session.

dimension

Customer journey last session landing page

Customer journey last session landing page

The URL of the last page the customer landed on during their last session.

dimension

Customer journey last session occured at

Customer journey last session occured at

The date and time when the customer’s last session occurred.

dimension

Customer journey last session referral code

Customer journey last session referral code

A marketing referral code from the link the customer used to visit the store for their last session.

dimension

Customer journey last session referrer URL

Customer journey last session referrer URL

The URL of the webpage from which the customer was referred to the online store during their last session.

dimension

Customer journey last session source

Customer journey last session source

The origin from which the customer visited the store during their last session (e.g., social media, search engine, direct).

dimension

Customer journey last session source description

Customer journey last session source description

A detailed description of the source from which the customer visited the store during their last session.

dimension

Customer journey last session source type

Customer journey last session source type

The type of marketing tactic associated with the source of the customer’s last session.

dimension

Customer journey order index

Customer journey order index

The position of the current order within the customer’s order history, excluding test orders.

metric

Customer locale

Customer locale

The customer’s preferred language and regional settings, influencing displayed content and formatting.

dimension

Day

Day

A temporal dimension representing a specific day, used for reporting and aggregating sales or other data on a daily basis.

dimension

Discount class

Discount class

The classification of a discount, used to control how it can be combined with other discounts.

dimension

Discount code

Discount code

The unique code that customers enter to apply a specific discount to their order.

dimension

Discount codes

Discount codes

A collection of unique codes that offer price reductions or promotions.

dimension

Discount redeem code ID

Discount redeem code ID

A unique identifier assigned to a specific discount code that can be redeemed by a customer.

dimension

Discounts

Discounts

The total monetary value of price reductions applied to an order or products.

metric

Discounts adjustments

Discounts adjustments

The modifications or net effect of discounts applied to an order’s financial totals.

metric

Disputes ID

Disputes ID

A unique identifier for a customer dispute or chargeback.

dimension

Disputes status

Disputes status

The current state of a customer dispute or chargeback (e.g., pending, won, lost).

dimension

Duties

Duties

Additional fees applied to an order, such as import duties or customs charges.

metric

Ends at

Ends at

The date and time when a discount or promotion expires and is no longer valid.

dimension

Ends at date

Ends at date

The calendar date when a discount or promotion is no longer valid.

dimension

Estimated taxes

Estimated taxes

The calculated tax amount for an order, particularly relevant during the draft order stage before finalization.

dimension

Financial status

Financial status

The current financial state of an order (e.g., authorized, paid, refunded, voided).

dimension

Fiscal Month

Fiscal Month

A monthly accounting period defined by a business’s fiscal calendar.

dimension

Fiscal Year

Fiscal Year

metric

Fulfillable

Fulfillable

A boolean indicator showing whether an order or its line items are eligible for fulfillment.

dimension

Fulfillment status

Fulfillment status

The current stage of an order’s processing and delivery (e.g., unfulfilled, partially fulfilled, fulfilled).

dimension

Fully paid

Fully paid

A boolean indicator confirming that the entire outstanding amount for an order has been successfully paid.

dimension

Gross sales

Gross sales

The total amount of revenue generated from sales before any deductions for returns, allowances, or discounts.

metric

Gross sales adjustments

Gross sales adjustments

Monetary changes or corrections applied to gross sales, which can include refunds, returns, or other edits made to an order after its initial creation.

metric

ID

ID

A unique identifier for a record or resource.

dimension

Inventory reservation confirmed

Inventory reservation confirmed

A boolean indicator confirming that inventory for the items in an order has been successfully reserved.

dimension

Line items quantities

Line items quantities

The quantities of each distinct product or service included as a line item in an order.

metric

Max Month

Max Month

The latest month in a specified date range or data set.

metric

Max date

Max date

The latest date in a specified date range or data set.

dimension

Metafield ID

Metafield ID

A unique identifier for a metafield, which stores additional information attached to a Shopify resource like products or collections.

dimension

Metafield Locale

Metafield Locale

The language or region setting for localized content of a metafield’s value, supporting multilingual data storage for custom fields.

dimension

Metafield key

Metafield key

The unique identifier (key) for a custom field (metafield), used in conjunction with a namespace to store structured additional information on Shopify resources.

dimension

Metafield value

Metafield value

The data stored within a custom field (metafield), identified by its unique key and namespace, providing extended attributes for Shopify resources.

dimension

Min Date

Min Date

The earliest date in a specified date range or data set.

dimension

Min Month

Min Month

The earliest month in a specified date range or data set.

metric

Net product quantity

Net product quantity

The quantity of products in an order after any adjustments, such as returns or cancellations.

metric

Net sales

Net sales

The total revenue from sales after subtracting returns, allowances, and discounts.

metric

Once per customer

Once per customer

A flag indicating whether a discount can be used only once by a specific customer.

dimension

Order Count

Order Count

The total number of orders placed, which can be filtered by various criteria.

metric

Order ID

Order ID

A unique internal identifier assigned by Shopify to each order.

dimension

Order closed

Order closed

Indicates whether an order is considered closed, meaning all line items are fulfilled or canceled, and all financial transactions are complete.

dimension

Order currency code

Order currency code

The three-letter ISO 4217 code representing the currency in which the order was placed.

dimension

Order edited

Order edited

Indicates whether an order has undergone modifications after its initial creation.

dimension

Order id

Order id

A unique internal identifier assigned by Shopify to each order.

metric

Order name

Order name

A customer-facing and customizable name or number for an order, often visible in the Shopify admin.

metric

Order net payment amount

Order net payment amount

The total amount of money received for an order after all applicable discounts, returns, and allowances have been applied.

metric

Order note

Order note

A general note or comment associated with an order, visible to merchants in the Shopify admin.

dimension

Ordered product quantity

Ordered product quantity

The total quantity of a specific product ordered by the customer within an order.

metric

Orders

Orders

A collection of customer purchase transactions, including details like products, customer information, and financial data.

metric

Percentage

Percentage

A numerical value expressed as a fraction of 100, often used for discounts or rates.

metric

Prerequisite quantity

Prerequisite quantity

The minimum quantity of items required for a discount or promotion to be applied.

dimension

Prerequisite quantity range greater than

Prerequisite quantity range greater than

A discount condition specifying that the item quantity must be strictly greater than a defined value.

dimension

Prerequisite quantity range greater than or equal to

Prerequisite quantity range greater than or equal to

A discount condition specifying that the item quantity must be greater than or equal to a defined value.

metric

Prerequisite quantity range less than

Prerequisite quantity range less than

A discount condition specifying that the item quantity must be strictly less than a defined value.

dimension

Prerequisite quantity range less than or equal to

Prerequisite quantity range less than or equal to

A discount condition specifying that the item quantity must be less than or equal to a defined value.

dimension

Prerequisite shipping price range greater than

Prerequisite shipping price range greater than

The lower boundary for a shipping price to qualify for a specific discount or promotion.

dimension

Prerequisite shipping price range greater than or equal to

Prerequisite shipping price range greater than or equal to

The inclusive lower boundary for a shipping price to qualify for a specific discount or promotion.

dimension

Prerequisite shipping price range less than

Prerequisite shipping price range less than

The upper boundary for a shipping price to qualify for a specific discount or promotion.

dimension

Prerequisite shipping price range less than or equal to

Prerequisite shipping price range less than or equal to

The inclusive upper boundary for a shipping price to qualify for a specific discount or promotion.

dimension

Prerequisite subtotal range greater than

Prerequisite subtotal range greater than

A discount condition specifying that the order subtotal must be strictly greater than a defined value.

dimension

Prerequisite subtotal range greater than or equal to

Prerequisite subtotal range greater than or equal to

A discount condition specifying that the order subtotal must be greater than or equal to a defined value.

metric

Prerequisite subtotal range less than

Prerequisite subtotal range less than

A discount condition specifying that the order subtotal must be strictly less than a defined value.

dimension

Prerequisite subtotal range less than or equal to

Prerequisite subtotal range less than or equal to

A discount condition specifying that the order subtotal must be less than or equal to a defined value.

dimension

Processed at

Processed at

The date and time when an order or transaction was processed.

dimension

Publication ID

Publication ID

A unique identifier for a publication or sales channel where products are listed.

dimension

Publication name

Publication name

The name of the publication or sales channel where products are listed.

dimension

Refundable

Refundable

A boolean indicator showing if a payment or a portion of an order is eligible to be refunded.

dimension

Requires shipping

Requires shipping

Indicates whether the order contains physical products that require shipment to the customer.

dimension

Restockable

Restockable

Indicates whether any line items in the order can be returned to inventory.

dimension

Return status

Return status

The current stage or condition of a customer return (e.g., pending, received, processed).

dimension

Returned product quantity

Returned product quantity

The quantity of a particular product that has been returned by a customer.

metric

Returns

Returns

A collection of transactions where customers have sent back purchased items for a refund or exchange.

metric

Sales channel

Sales channel

The platform or avenue (e.g., online store, retail, social media) through which products are sold to customers.

dimension

Shipping

Shipping

The shipping costs associated with an order, including any discounts or taxes applied.

metric

Shipping address 1

Shipping address 1

The first line of the street address for the customer’s shipping address (e.g., street name and house number).

dimension

Shipping address 2

Shipping address 2

The second line of the street address for the customer’s shipping address (e.g., apartment, suite, unit).

dimension

Shipping address city

Shipping address city

The city component of the customer’s shipping address.

dimension

Shipping address country

Shipping address country

The country component of the customer’s shipping address.

dimension

Shipping address post code

Shipping address post code

The postal code or ZIP code associated with the customer’s shipping address.

dimension

Shipping city

Shipping city

The city for the shipping destination.

dimension

Shipping country

Shipping country

The country for the shipping destination.

dimension

Shipping lines removed

Shipping lines removed

Indicates whether a specific shipping line has been removed from an order.

dimension

Shipping region

Shipping region

The state, province, or region for the shipping destination.

dimension

Start Date

Start Date

The calendar date when a discount or promotion becomes active.

dimension

Starts at

Starts at

The date and time when a discount or promotion becomes active and available for customer use.

dimension

Starts at date

Starts at date

The calendar date when a discount or promotion becomes active.

dimension

Status

Status

The current condition or state of a record, entity, or process (e.g., active, pending, completed).

dimension

Tags

Tags

Keywords or labels associated with a resource (e.g., product, customer, order) for categorization and filtering.

dimension

Target

Target

The specific entity or group to which a discount, action, or operation applies, such as customers, products, or shipping.

dimension

Target all line items

Target all line items

A discount setting indicating that the promotion applies to all line items within an order.

dimension

Target all shipping lines

Target all shipping lines

A discount setting indicating that the promotion applies to all shipping charges on an order.

dimension

Tax exempt

Tax exempt

A boolean indicator showing if an order or customer is exempt from paying certain taxes.

dimension

Tax lines amount

Tax lines amount

The monetary value of a specific tax component applied to an order.

dimension

Tax lines channel liable

Tax lines channel liable

Indicates whether the sales channel that submitted the tax line is responsible for remitting the tax.

dimension

Tax lines rate

Tax lines rate

The proportional rate of tax applied to a line item, expressed as a decimal or percentage.

dimension

Tax lines rate percentage

Tax lines rate percentage

The tax rate applied, represented as a percentage, for a specific tax line.

dimension

Tax lines title

Tax lines title

The name or description of the tax applied.

dimension

Taxes

Taxes

The total taxes applied to an order or its individual line items and shipping charges.

metric

Taxes included

Taxes included

Indicates whether taxes are included in the listed prices of an order or its components.

dimension

Tips

Tips

Additional voluntary payments added by the customer to an order.

metric

Title

Title

A descriptive name or heading for a resource (e.g., product, collection, order).

dimension

Total discounts amount

Total discounts amount

The sum of all monetary discounts applied to an order.

metric

Total duties amount

Total duties amount

The total monetary value of all duties levied on an order’s items.

dimension

Total order amount

Total order amount

The grand total value of an order, including products, shipping, and taxes, before any refunds.

metric

Total outstanding amount

Total outstanding amount

The total monetary amount of an order that remains unpaid.

metric

Total refunded amount

Total refunded amount

The total monetary amount that has been returned to the customer for an order.

metric

Total refunded shipping amount

Total refunded shipping amount

The aggregate amount of shipping costs that have been refunded to the customer.

metric

Total shipping amount

Total shipping amount

The total monetary cost associated with shipping for an order.

metric

Total tax amount

Total tax amount

The total monetary amount of all taxes applied to an order.

metric

Total tip received amount

Total tip received amount

The total monetary value of tips received on an order.

metric

Total weight

Total weight

The combined weight of all physical products within an order.

metric

Updated at

Updated at

The timestamp indicating when a record or resource was last modified.

dimension

Updated at Date

Updated at Date

The timestamp indicating the last time a Shopify resource was modified. This field is commonly used for filtering data to retrieve recently updated records.

dimension

Updated at date

Updated at date

The date component of the timestamp when a record or resource was last modified.

dimension

Usage count

Usage count

The number of times a discount code or other defined resource has been utilized.

metric

Usage limit

Usage limit

The maximum number of times a discount code or resource can be used.

metric

Variant ID

Variant ID

A globally unique identifier for the product variant.

metric

Variant Inventory quantity

Variant Inventory quantity

The total quantity of this product variant available for sale.

metric

Variant SKU

Variant SKU

The Stock Keeping Unit (SKU), a unique identifier for a specific product variant.

dimension

Variant barcode

Variant barcode

The barcode (e.g., UPC, EAN) associated with the product variant.

dimension

Variant compare at price

Variant compare at price

The original price of the product variant that it’s compared against for a sale, in the shop’s default currency.

dimension

Variant image ID

Variant image ID

The globally unique identifier for the image associated with this product variant.

dimension

Variant inventory item ID

Variant inventory item ID

The globally unique identifier for the inventory item linked to this product variant, used for inventory tracking across locations.

dimension

Variant inventory policy

Variant inventory policy

Determines whether customers can order the product variant when it is out of stock.

dimension

Variant position

Variant position

The numerical position of the variant within the product’s list of variants.

metric

Variant price

Variant price

The selling price of a specific product variant.

metric

Variant product ID

Variant product ID

The globally unique identifier of the parent product that this variant belongs to.

dimension

Variant requires shipping

Variant requires shipping

Indicates whether a shipping address is required when purchasing this product variant.

dimension

Variant tax code

Variant tax code

The tax code associated with the product variant, used for tax classification. This field is deprecated as of API version 2025-10.

dimension

Variant taxable

Variant taxable

Indicates whether the product variant is subject to taxes.

dimension

Variant title

Variant title

The specific title of the product variant (e.g., ‘Small’, ‘Blue’).

dimension

Variant weight

Variant weight

The physical weight of the product variant, obtained from its associated inventory item’s measurement.

metric

Variant weight unit

Variant weight unit

The unit of measurement (e.g., GRAMS, KILOGRAMS) for the product variant’s weight.

dimension

Week

Week

The sequential number of a week within a year, often following ISO 8601 standards.

metric

Week Range

Week Range

A temporal dimension representing a specific range of days within a week, typically used for weekly reporting and data aggregation.

dimension

addresses

addresses

A list of mailing and billing addresses associated with a customer.

dimension

channelInformation

channelInformation

Details identifying the sales channel and associated app from which an order originated, providing attribution information.

dimension

channelInformation.channelDefinition

channelInformation.channelDefinition

Provides details about the specific selling surface or sub-channel within a sales channel (e.g., Instagram Shopping, TikTok Live).

dimension

channel_name

channel_name

The name of the sales channel (e.g., ‘Online Store’, ‘Point of Sale’) through which the order originated.

dimension

createdAt

createdAt

The full timestamp indicating the creation time of a resource.

dimension

createdAt.date

createdAt.date

The date component of the timestamp when a resource was created.

dimension

currency

currency

The currency used for an entity or transaction, often represented by its ISO 4217 code.

dimension

customer

customer

An object containing all associated details for a customer, such as contact information and preferences.

dimension

customer.created

customer.created

The date and time when the customer account was created and added to the store.

dimension

customerJourneySummary.firstVisit

customerJourneySummary.firstVisit

A summary of the customer’s initial visit to the online store, including session details and attribution sources.

dimension

customer_id

customer_id

A globally unique identifier for the customer.

dimension

customer_type

customer_type

A classification or category assigned to a customer, which could include segments like “retail” or “wholesale,” or other custom distinctions. This information is typically stored as a metafield on the Customer object or derived from other customer attributes.

dimension

data

data

dimension

date

date

The timestamp indicating when a record or event occurred, such as creation or last update.

dimension

defaultEmailAddress.emailAddress

defaultEmailAddress.emailAddress

The customer’s primary email address used for communication and marketing.

dimension

defaultEmailAddress.marketingOptInLevel

defaultEmailAddress.marketingOptInLevel

The level of consent a customer has given for email marketing (e.g., CONFIRMED_OPT_IN, SINGLE_OPT_IN, UNKNOWN). This field is part of the emailMarketingConsent object.

dimension

defaultEmailAddress.marketingState

defaultEmailAddress.marketingState

The current email marketing status for the customer (e.g., SUBSCRIBED, UNSUBSCRIBED, PENDING). This field is part of the emailMarketingConsent object.

dimension

defaultEmailAddress.marketingUpdatedAt

defaultEmailAddress.marketingUpdatedAt

The date and time when the customer’s email marketing consent was last updated.

dimension

defaultPhoneNumber.phoneNumber

defaultPhoneNumber.phoneNumber

The customer’s primary phone number.

metric

descriptionHtml

descriptionHtml

The detailed description of a product or resource, including HTML formatting.

dimension

discount_amount

discount_amount

The total monetary amount of discounts applied to an order.

metric

email

email

The primary email address of a customer or associated entity.

dimension

emailMarketingConsent.consentUpdatedAt

emailMarketingConsent.consentUpdatedAt

The timestamp of the last update to the customer’s email marketing consent status.

dimension

emailMarketingConsent.marketingOptInLevel

emailMarketingConsent.marketingOptInLevel

The marketing subscription opt-in level a customer provided for email marketing, as per M3AAWG guidelines.

dimension

emailMarketingConsent.marketingState

emailMarketingConsent.marketingState

The current status of the customer’s email marketing consent (e.g., subscribed, not consented).

dimension

exchangeLineItems.id

exchangeLineItems.id

The unique identifier for a line item within a customer exchange.

dimension

exchangeLineItems.lineItem.id

exchangeLineItems.lineItem.id

The unique identifier of the original line item that is part of an exchange.

dimension

extensions

extensions

Provides supplementary information about the GraphQL query execution, such as rate limit status and query cost, rather than business data.

dimension

firstName

firstName

The first name of the customer.

dimension

fulfillmentLineItem.lineItem.id

fulfillmentLineItem.lineItem.id

The unique identifier of a line item that is part of a fulfillment record.

dimension

gross_sales

gross_sales

The total sales amount before any deductions for discounts, returns, or other adjustments.

metric

handle

handle

A URL-friendly, unique string identifier for a resource, often used in permalinks.

dimension

id

id

A unique identifier for a record or resource.

dimension

lastName

lastName

The last name of the customer.

dimension

metafield.createdAt

metafield.createdAt

The date and time when the metafield was created.

dimension

metafield.description

metafield.description

The description of a metafield definition, outlining its purpose or usage.

dimension

metafield.id

metafield.id

The unique identifier for a specific metafield entry.

metric

metafield.key

metafield.key

The unique identifier for a metafield within its assigned namespace.

dimension

metafield.namespace

metafield.namespace

A container for grouping related metafields, preventing naming conflicts and organizing custom data.

dimension

metafield.ownerType

metafield.ownerType

The type of resource (e.g., Product, Customer, Order) that a metafield is associated with.

dimension

metafield.type

metafield.type

The type of data stored in the metafield, such as string, integer, or JSON.

dimension

metafield.updatedAt

metafield.updatedAt

The date and time when the metafield was last updated.

dimension

metafield.value

metafield.value

The data content stored within a metafield.

dimension

multipassIdentifier

multipassIdentifier

A unique identifier for the customer used with Multipass login, facilitating seamless authentication between an external website and the Shopify store.

dimension

netPaymentSet.shopMoney

netPaymentSet.shopMoney

The net payment amount for an order in the shop’s local currency, reflecting total received minus total refunded.

dimension

net_payment_amount

net_payment_amount

The net payment amount for an order, after accounting for all received and refunded amounts.

metric

note

note

A general note or comment about the customer.

dimension

numberOfOrders

numberOfOrders

The total number of orders the customer has placed at the store in their lifetime.

metric

options

options

A list of product options (e.g., ‘Size’, ‘Color’) that define the different variations available for a product.

dimension

order_date

order_date

The date on which an order was placed by a customer.

dimension

order_publication_id

order_publication_id

The unique identifier of the sales channel (publication) through which the order originated.

dimension

orders

orders

A list of orders placed by the customer.

metric

ownerId

ownerId

The unique identifier (Global ID) of the resource to which a metafield is attached.

metric

phone

phone

The customer’s primary phone number.

metric

productType

productType

The type or category of the product, as defined by the merchant.

dimension

publishedAt

publishedAt

The date and time when the product was published to the online store and other sales channels.

dimension

publishedAt.date

publishedAt.date

The date component of when the product was published.

dimension

return.id

return.id

A globally unique identifier for the return.

dimension

return.name

return.name

The customer-facing identifier or name of the return.

dimension

return.order.created_at

return.order.created_at

The date and time when the original order associated with the return was created.

dimension

return.order.id

return.order.id

The globally unique identifier of the original order that the return belongs to.

dimension

return.order.updated_at

return.order.updated_at

The date and time when the original order associated with the return was last updated.

dimension

return.status

return.status

The current status of the return (e.g., Requested, In Progress, Completed).

dimension

return.totalQuantity

return.totalQuantity

The total quantity of items included in the return.

metric

returnLineItems.customerNote

returnLineItems.customerNote

A note from the customer describing the item being returned.

dimension

returnLineItems.id

returnLineItems.id

A globally unique identifier for the return line item.

dimension

returnLineItems.quantity

returnLineItems.quantity

The quantity of this specific item being returned.

metric

returnLineItems.refundableQuantity

returnLineItems.refundableQuantity

The quantity of this item that is eligible to be refunded.

metric

returnLineItems.refundedQuantity

returnLineItems.refundedQuantity

The quantity of this item that has already been refunded.

metric

returnLineItems.returnReason

returnLineItems.returnReason

The standardized reason provided by the customer for returning the item (e.g., COLOR, DEFECTIVE, UNWANTED).

dimension

returnLineItems.returnReasonNote

returnLineItems.returnReasonNote

Additional free-form text provided by the customer to elaborate on the return reason.

dimension

revenue

revenue

The total monetary value generated from sales. This can be derived from order data, often by summing the ‘totalPriceSet’ values of relevant orders.

metric

shipping_amount

shipping_amount

The monetary cost of shipping an order, after applying any relevant refunds and discounts.

metric

shop.address1

shop.address1

The first line of the shop’s primary address.

dimension

shop.address2

shop.address2

The second line of the shop’s primary address.

dimension

shop.city

shop.city

The city of the shop’s billing address.

dimension

shop.country

shop.country

The name of the country for the shop’s billing address.

dimension

shop.created_at

shop.created_at

The date and time when the Shopify store was created.

dimension

shop.currency

shop.currency

The three-letter ISO 4217 code for the currency in which the shop conducts sales.

dimension

shop.customer_email

shop.customer_email

The public-facing contact email address for the shop.

dimension

shop.domain

shop.domain

The primary domain name of the Shopify store’s online presence.

dimension

shop.email

shop.email

The email address of the shop owner.

dimension

shop.iana_timezone

shop.iana_timezone

The IANA time zone of the shop.

dimension

shop.id

shop.id

A globally unique identifier for the Shopify store.

metric

shop.latitude

shop.latitude

The approximate latitude coordinate of the shop’s address.

metric

shop.longitude

shop.longitude

The approximate longitude coordinate of the shop’s address.

metric

shop.name

shop.name

The public-facing name of the Shopify store.

dimension

shop.phone

shop.phone

The primary phone number associated with the shop.

dimension

shop.plan_name

shop.plan_name

The public display name of the shop’s billing plan (e.g., ‘Basic Shopify’, ‘Advanced Shopify’, ‘Shopify Plus’).

dimension

shop.province

shop.province

The province, state, or district of the shop’s billing address.

dimension

shop.province_code

shop.province_code

The two-letter alphanumeric code for the province, state, or district of the shop’s billing address.

dimension

shop.shop_owner

shop.shop_owner

The name of the Shopify store owner.

dimension

shop.source

shop.source

The sales channel or origin through which an order associated with the shop was placed.

dimension

shop.timezone

shop.timezone

The IANA time zone string (e.g., ‘America/New_York’) configured for the shop.

dimension

shop.updated_at

shop.updated_at

The date and time when the shop’s settings or information was last updated.

dimension

shop.zip

shop.zip

The zip or postal code of the shop’s billing address.

dimension

sku

sku

A unique identifier for a specific product variant, used for inventory tracking and product identification.

dimension

state

state

The state or province within an order’s address.

dimension

status

status

The overall status of the order, which can include financial status, fulfillment status, or a general lifecycle state (e.g., open, closed, cancelled).

dimension

tags

tags

A comma-separated list of tags associated with the customer, used for organization and filtering.

dimension

taxExempt

taxExempt

Indicates whether the customer is exempt from sales taxes on their orders.

dimension

templateSuffix

templateSuffix

The unique identifier for the theme template used when customers view the product in a store.

dimension

title

title

The name or title of the product, displayed to customers.

dimension

totalDiscountsSet.shopMoney

totalDiscountsSet.shopMoney

The total amount of all discounts applied to the entire order, after returns, refunds, order edits, and cancellations, in the shop’s currency.

dimension

totalOutstandingSet.shopMoney

totalOutstandingSet.shopMoney

The total outstanding monetary amount for an order in the shop’s local currency.

dimension

totalPriceSet.shopMoney

totalPriceSet.shopMoney

The total price of the order, including taxes and discounts, after returns and refunds, in the shop’s currency.

dimension

totalRefundedSet.shopMoney

totalRefundedSet.shopMoney

The total amount refunded on the order in the shop’s currency.

dimension

totalRefundedShippingSet.shopMoney

totalRefundedShippingSet.shopMoney

The total amount of shipping costs refunded for the order in the shop’s currency.

dimension

totalShippingPriceSet.shopMoney

totalShippingPriceSet.shopMoney

The current shipping price for the order, after applying refunds and discounts, in the shop’s currency.

dimension

totalSpent

totalSpent

The total amount of money the customer has spent on orders in their lifetime.

metric

totalTaxSet.shopMoney

totalTaxSet.shopMoney

The sum of all tax lines applied to line items on the order, after returns and refunds, in the shop’s currency.

dimension

total_order_amount

total_order_amount

The total price of the order, including taxes and discounts, after accounting for any returns and refunds.

metric

total_sales

total_sales

The overall total sales value for the store or a collection of orders, often derived from order totals.

metric

updatedAt

updatedAt

The date and time when the order was last updated in Shopify’s system.

dimension

updatedAt.date

updatedAt.date

The date component of when the order was last updated.

dimension

utm_campaign

utm_campaign

The UTM campaign parameter from the URL that led to the order or customer acquisition.

dimension

utm_content

utm_content

The UTM content parameter from the URL that led to the order or customer acquisition.

dimension

utm_medium

utm_medium

The UTM medium parameter from the URL that led to the order or customer acquisition.

dimension

utm_source

utm_source

The UTM source parameter from the URL that led to the order or customer acquisition.

dimension

utm_term

utm_term

The UTM term parameter from the URL that led to the order or customer acquisition.

dimension

vendor

vendor

The name of the company or individual who supplies the product.

dimension

verifiedEmail

verifiedEmail

Indicates whether the customer’s email address has been verified. Defaults to true for customers created via the Shopify admin or API.

dimension