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
Additional fees amount	Additional fees amount	The monetary amount of additional fees applied to an order, which can include duties, import fees, or special handling charges.	dimension
App title	App title	The title or name of the Shopify application associated with an order or other resource.	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 of the billing address provided by the customer for an order.	dimension
Billing address line 1	Billing address line 1	The first line of the customer’s billing address, typically the street address or PO Box number.	dimension
Billing address line 2	Billing address line 2	The second line of the customer’s billing address, typically the apartment, suite, or unit number.	dimension
Billing address post code	Billing address post code	The postal code or zip code of the billing address associated with the order. This maps to the zip field within the BillingAddress object.	dimension
Cancel reason	Cancel reason	The reason provided for an order cancellation, such as customer request, payment decline, fraud, or insufficient inventory.	dimension
Cancellation staff note	Cancellation staff note	An internal note added by staff regarding the reason for an order’s cancellation, not visible to the customer.	dimension
Cancelled at	Cancelled at	The date and time (ISO 8601 format) when the order was canceled. This field is null if the order has not been canceled.	dimension
Capturable payment	Capturable payment	Indicates whether a payment can still be captured for an authorized transaction on an order.	dimension
Channel ID	Channel ID	The unique identifier for the sales channel through which the order was placed or a product was published. This maps to Channel.id in the API.	dimension
Channel name	Channel name	The human-readable name of the sales channel (e.g., ‘Online Store’, ‘Point of Sale’). This maps to Channel.name in the API.	dimension
Closed at	Closed at	The date and time (ISO 8601 format) when an order was closed, indicating that all line items have been fulfilled or canceled and all financial transactions are complete.	dimension
Confirmation number	Confirmation number	A customer-facing identifier for the order, displayed after checkout. It is an alphanumeric string and is not guaranteed to be unique across all orders.	dimension
Created at	Created at	The timestamp indicating when a record or resource was created.	dimension
Current cart discount amount	Current cart discount amount	The total monetary amount of all discounts applied to the entire cart at the current time.	metric
Current cart discount amount currency code	Current cart discount amount currency code	The ISO 4217 currency code for the current cart discount amount.	dimension
Customer ID	Customer ID	The unique identifier for the customer. This maps to Customer.id in the API.	dimension
Customer accepts marketing	Customer accepts marketing	Indicates whether the customer has consented to receive marketing communications. Note: This field is deprecated as of API version 2022-04 and replaced by emailMarketingConsent for more granular control over marketing channels.	dimension
Customer email	Customer email	The primary email address of the customer. This maps to Customer.email in the API.	dimension
Customer full name	Customer full name	The customer’s full name, derived from their first and last names. If these are not available, it defaults to their email address or phone number.	dimension
Customer journey attribution ready	Customer journey attribution ready	Indicates whether data relevant to customer journey tracking and marketing attribution, such as session data, attribution sources (e.g., UTM parameters, referrers), and the timeline from initial visit to purchase, has been collected and is available for analysis. This leverages Shopify’s CustomerJourney and CustomerJourneySummary objects.	dimension
Customer journey first session ID	Customer journey first session ID	The unique identifier for the customer’s first recorded session leading to the order within the attribution window.	dimension
Customer journey first session UTM campaign	Customer journey first session UTM campaign	The UTM campaign parameter from the customer’s first session, indicating the specific marketing campaign that drove the visit. This is part of the utmParameters.campaign field within CustomerVisit or CustomerJourneySummary objects.	dimension
Customer journey first session UTM content	Customer journey first session UTM content	The UTM content parameter from the customer’s first session, used to differentiate between similar content or links within a marketing campaign. This is part of the utmParameters.content field within CustomerVisit or CustomerJourneySummary objects.	dimension
Customer journey first session UTM medium	Customer journey first session UTM medium	The UTM medium parameter from the customer’s first session, indicating the marketing medium (e.g., email, CPC). This is part of the utmParameters.medium field within CustomerVisit or CustomerJourneySummary objects.	dimension
Customer journey first session UTM source	Customer journey first session UTM source	The UTM source parameter from the customer’s first session, indicating where the traffic originated (e.g., Google, Facebook). This is part of the utmParameters.source field within CustomerVisit or CustomerJourneySummary objects.	dimension
Customer journey first session UTM term	Customer journey first session UTM term	The UTM term parameter captured during the customer’s first session, indicating keywords or specific terms associated with the marketing campaign.	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. This is represented by the landingPage property within CustomerJourneySummary or CustomerVisit objects in the GraphQL Admin API.	dimension
Customer journey first session occured at	Customer journey first session occured at	The date and time when the customer’s first session occurred, leading to the order within the attribution window.	dimension
Customer journey first session referral code	Customer journey first session referral code	The marketing referral code from the link that the customer clicked to visit the store during their first session.	dimension
Customer journey first session referrer URL	Customer journey first session referrer URL	The URL of the page that referred the customer to the store for their first session. This is part of the referrerUrl field within CustomerJourneySummary or CustomerVisit objects.	dimension
Customer journey first session source	Customer journey first session source	The high-level source of traffic for the customer’s first session (e.g., direct, organic, referral). This is part of the source field within CustomerJourneySummary or CustomerVisit objects.	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, providing more context than the source type.	dimension
Customer journey first session source type	Customer journey first session source type	The type of source from which the customer visited the store during their first session, such as a platform (e.g., Facebook, Google), email, direct, or unknown.	dimension
Customer journey last session ID	Customer journey last session ID	The unique identifier for the customer’s last recorded session immediately preceding the order within the attribution window.	dimension
Customer journey last session UTM campaign	Customer journey last session UTM campaign	The UTM campaign parameter from the customer’s last session, indicating the specific marketing campaign that drove the most recent visit. This is part of the utmParameters.campaign field within CustomerVisit or CustomerJourneySummary objects.	dimension
Customer journey last session UTM content	Customer journey last session UTM content	The UTM content parameter from the customer’s last session, used to differentiate between similar content or links within a campaign. This is part of the utmParameters.content field within CustomerVisit or CustomerJourneySummary objects.	dimension
Customer journey last session UTM medium	Customer journey last session UTM medium	The UTM medium parameter from the customer’s last session, indicating the marketing medium (e.g., email, CPC). This is part of the utmParameters.medium field within CustomerVisit or CustomerJourneySummary objects.	dimension
Customer journey last session UTM source	Customer journey last session UTM source	The UTM source parameter from the customer’s last session, indicating where the traffic originated (e.g., Google, Facebook). This is part of the utmParameters.source field within CustomerVisit or CustomerJourneySummary objects.	dimension
Customer journey last session UTM term	Customer journey last session UTM term	The UTM term parameter captured during the customer’s last session, indicating keywords or specific terms associated with the marketing campaign.	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 most recent session. This is represented by the landingPage property within CustomerJourneySummary or CustomerVisit objects in the GraphQL Admin API.	dimension
Customer journey last session occured at	Customer journey last session occured at	The date and time when the customer’s last session occurred, immediately preceding the order within the attribution window.	dimension
Customer journey last session referral code	Customer journey last session referral code	The marketing referral code from the link that the customer clicked to visit the store during their last session.	dimension
Customer journey last session referrer URL	Customer journey last session referrer URL	The URL of the page that referred the customer to the store for their last session. This is part of the referrerUrl field within CustomerJourneySummary or CustomerVisit objects.	dimension
Customer journey last session source	Customer journey last session source	The high-level source of traffic for the customer’s last session (e.g., direct, organic, referral). This is part of the source field within CustomerJourneySummary or CustomerVisit objects.	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, providing more context than the source type.	dimension
Customer journey last session source type	Customer journey last session source type	The type of source from which the customer visited the store during their last session, such as a platform (e.g., Facebook, Google), email, direct, or unknown.	dimension
Customer journey order index	Customer journey order index	The sequential position of the current order within the customer’s complete purchase history.	metric
Customer locale	Customer locale	The locale of the customer, typically represented by a language and country/region code (e.g., en-US, fr-FR), indicating their preferred language and region.	dimension
Customer number of orders	Customer number of orders	The total number of orders placed by the customer at the store in their lifetime.	metric
Customer sale type (by fetch date)	Customer sale type (by fetch date)	The type of action that the sale represents, such as an order, return, or update.	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 code	Discount code	The specific code entered by a customer at checkout to apply a discount to an order.	dimension
Discount codes	Discount codes	A list of all discount codes applied to an order.	dimension
Disputes ID	Disputes ID	The unique identifier for a payment dispute associated with an order.	dimension
Disputes status	Disputes status	The current status of a Shopify Payments dispute, indicating its progression from initiation through resolution. Examples include needs_response, under_review, won, or lost.	dimension
Estimated taxes	Estimated taxes	Indicates whether the taxes on an order are currently estimated. This field returns false when taxes are finalized.	dimension
Financial status	Financial status	The current financial status of an order, such as PAID, PENDING, AUTHORIZED, PARTIALLY_REFUNDED, or VOIDED.	dimension
Fulfillable	Fulfillable	Indicates whether there are line items in an order that are currently eligible for fulfillment.	dimension
Fulfillment status	Fulfillment status	The aggregated fulfillment status of an order, summarizing the state of all line items. Examples include UNFULFILLED, PARTIALLY_FULFILLED, or FULFILLED.	dimension
Fully paid	Fully paid	Indicates whether the full payment for the order has been received.	dimension
ID	ID	The globally unique identifier (GID) for the specific resource (e.g., order, customer, product).	dimension
Inventory reservation confirmed	Inventory reservation confirmed	Indicates whether inventory quantities for an order’s line items have been successfully reserved.	dimension
Line items quantities	Line items quantities	The total quantity of all individual items (line items) within an order. This is a sum of the LineItem.quantity for all line items associated with an order.	metric
Order ID	Order ID	A unique internal identifier assigned by Shopify to each order.	dimension
Order closed	Order closed	Indicates whether the order has been closed, meaning all line items are either fulfilled or canceled, and all financial transactions are complete.	dimension
Order currency code	Order currency code	The three-letter ISO 4217 currency code used for the order’s payment, for example, USD or EUR.	dimension
Order edited	Order edited	Indicates whether any edits, such as adding/removing line items, updating quantities, or changing prices, have been applied to the order.	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.	dimension
Order net payment amount	Order net payment amount	The net monetary amount of the order, calculated as the total amount received minus the total amount refunded, in both shop and presentment currencies.	metric
Order note	Order note	Additional information or instructions associated with the order, typically added by merchants or customers (e.g., gift messages, delivery instructions).	dimension
Processed at	Processed at	The date and time when an order was processed.	dimension
Publication ID	Publication ID	The unique identifier for a publication, which represents a group of products and collections published to a specific sales channel or app.	dimension
Publication name	Publication name	The name of the publication or sales channel where a product or collection is published. This relates to the Channel.name field.	dimension
Refundable	Refundable	Indicates whether an item or order is eligible for a refund.	dimension
Requires shipping	Requires shipping	Indicates whether a line item in an order requires physical shipping.	dimension
Restockable	Restockable	Indicates whether a line item in an order is eligible to be returned to inventory and resold after a return.	dimension
Return status	Return status	The aggregated status of returns for an order, reflecting the overall state of the return process. This can include statuses like in_progress, open, or returned.	dimension
Sale action type	Sale action type	The type of action that the sale represents, such as a purchase, return, or price adjustment.	dimension
Sale line type	Sale line type	The specific type of line item within a sale, such as a product, shipping, additional fee, or adjustment.	dimension
Shipping address 1	Shipping address 1	The first line of the customer’s shipping address, typically the street address or PO Box number.	dimension
Shipping address 2	Shipping address 2	The second line of the customer’s shipping address, typically the apartment, suite, or unit number.	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 specified in the shipping address for the order. This maps to the country field within the ShippingAddress object.	dimension
Shipping address post code	Shipping address post code	The postal code or zip code of the customer’s shipping address.	dimension
Shipping lines removed	Shipping lines removed	Indicates whether a shipping line has been removed from an order during an order edit.	dimension
Tags	Tags	A list of searchable, custom tags associated with an order or customer. This is a standard field on Order and Customer objects.	dimension
Tax exempt	Tax exempt	Indicates whether the order is exempt from taxes. This is typically true for customers globally marked as tax-exempt or specific draft orders, but not necessarily for product-level exemptions or zero-rated taxes.	dimension
Tax lines amount	Tax lines amount	The monetary amount of tax for a specific tax line, shown in both shop and presentment currencies, after any applicable discounts and before returns.	dimension
Tax lines channel liable	Tax lines channel liable	Indicates whether the sales channel that submitted the order is responsible for remitting this specific tax line.	dimension
Tax lines rate	Tax lines rate	The tax rate applied to a line item, expressed as a decimal value (e.g., 0.05 for 5%).	dimension
Tax lines rate percentage	Tax lines rate percentage	The tax rate applied to a line item, expressed as a percentage.	dimension
Tax lines title	Tax lines title	The name or title of the tax applied to a line item (e.g., ‘VAT’, ‘GST’, ‘Sales Tax’).	dimension
Taxes included	Taxes included	Indicates whether taxes are included in the price of the order’s items.	dimension
Total discounts amount	Total discounts amount	The total monetary amount of all discounts applied to an order. This is represented by totalDiscountsSet.shopMoney.amount on the Order object.	metric
Total duties amount	Total duties amount	The current total monetary amount of all duties applied to an order, including any adjustments due to returns or modifications.	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 that remains to be paid on an order.	metric
Total refunded amount	Total refunded amount	The total monetary amount that has been refunded for an order, in both shop and presentment currencies.	metric
Total refunded shipping amount	Total refunded shipping amount	The total monetary amount of shipping costs that have been refunded for an order.	metric
Total shipping amount	Total shipping amount	The total monetary amount charged for shipping on an order. This is represented by totalShippingPriceSet.shopMoney.amount on the Order object.	metric
Total tax amount	Total tax amount	The total monetary amount of all taxes applied to an order. This is represented by totalTaxSet.shopMoney.amount on the Order object.	metric
Total tip received amount	Total tip received amount	The total monetary amount of tips received for an order.	metric
Total weight	Total weight	The total weight of all line items within an order, excluding packaging.	metric
Updated at	Updated at	The timestamp indicating when a record or resource was last modified.	dimension
createdAt	createdAt	The date and time when the record (e.g., order, customer) was created. This is a standard API field available on many Shopify GraphQL objects.	dimension
createdAt.date	createdAt.date	The date and time when the record (e.g., Order, Product, Discount code) was created.	dimension
customer_id	customer_id	The unique identifier for the customer. This is an alias for ‘Customer ID’ and maps to Customer.id in the API.	dimension
customer_type	customer_type	A classification or categorization of a customer, derived from various customer attributes such as purchase history, total amount spent, contact details, and marketing preferences. The platform collects detailed customer information, enabling users to segment and define customer types based on their specific business needs.	dimension
date	date	A timestamp indicating a specific point in time related to an order or resource, such as when an order was created (createdAt) or last updated (updatedAt).	dimension
order_date	order_date	The date when the order was placed by the customer. This is often represented by a date component of createdAt on the Order object and can be used as a filter for order queries.	dimension
orders	orders	Represents a collection of customer orders. This refers to the Order object in the Shopify GraphQL Admin API.	metric
ownerId	ownerId	The globally unique identifier (GID) of the resource that owns a specific record, such as the customer, product, product variant, collection, or order to which a metafield is attached.	metric
revenue	revenue	Represents the total sales revenue generated by the Shopify store. This value is derived from the sales dataset, which reflects sale agreements with customers, including pending and unpaid orders, rather than strictly completed revenue. It reports when there’s a reasonable belief that the value will be exchanged, but does not wait for actual payment or fulfillment.	metric
updatedAt	updatedAt	The date and time when the record (e.g., order, customer) was last updated. This is a standard API field available on many Shopify GraphQL objects.	dimension
updatedAt.date	updatedAt.date	The date and time when the record (e.g., Order, Metafield, Discount code, Return, Collection) was last updated or modified.	dimension