Skip to content
Book a demo

Connect documentation

All documentation
Documentation

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.

FieldAdverity UI nameType
Billing address post codeDimension

The postal code or zip code of the billing address associated with the order. This maps to the `zip` field within the `BillingAddress` object.

Channel IDDimension

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.

Channel nameDimension

The human-readable name of the sales channel (e.g., 'Online Store', 'Point of Sale'). This maps to `Channel.name` in the API.

Confirmation numberDimension

The customer-facing identifier for an order, often formatted as '#XXXX'. This is used as the order number in the Shopify Admin GraphQL API.

Created atDimension

The timestamp indicating when a record or resource was created.

Customer IDDimension

The unique identifier for the customer. This maps to `Customer.id` in the API.

Customer emailDimension

The primary email address of the customer. This maps to `Customer.email` in the API.

Customer journey attribution readyDimension

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.

Customer journey first session IDDimension

The unique identifier for the customer's first recorded session leading to the order within the attribution window.

Customer journey first session UTM campaignDimension

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.

Customer journey first session UTM contentDimension

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.

Customer journey first session UTM mediumDimension

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.

Customer journey first session UTM sourceDimension

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.

Customer journey first session UTM termDimension

The UTM term parameter captured during the customer's first session, indicating keywords or specific terms associated with the marketing campaign.

Customer journey first session landing pageDimension

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.

Customer journey first session occured atDimension

The date and time when the customer's first session occurred, leading to the order within the attribution window.

Customer journey first session referral codeDimension

The marketing referral code from the link that the customer clicked to visit the store during their first session.

Customer journey first session referrer URLDimension

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.

Customer journey first session sourceDimension

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.

Customer journey first session source descriptionDimension

A detailed description of the source from which the customer visited the store during their first session, providing more context than the source type.

Customer journey first session source typeDimension

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.

Customer journey last session IDDimension

The unique identifier for the customer's last recorded session immediately preceding the order within the attribution window.

Customer journey last session UTM campaignDimension

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.

Customer journey last session UTM contentDimension

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.

Customer journey last session UTM mediumDimension

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.

Customer journey last session UTM sourceDimension

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.

Customer journey last session UTM termDimension

The UTM term parameter captured during the customer's last session, indicating keywords or specific terms associated with the marketing campaign.

Customer journey last session landing pageDimension

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.

Customer journey last session occured atDimension

The date and time when the customer's last session occurred, immediately preceding the order within the attribution window.

Customer journey last session referral codeDimension

The marketing referral code from the link that the customer clicked to visit the store during their last session.

Customer journey last session referrer URLDimension

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.

Customer journey last session sourceDimension

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.

Customer journey last session source descriptionDimension

A detailed description of the source from which the customer visited the store during their last session, providing more context than the source type.

Customer journey last session source typeDimension

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.

Customer journey order indexMetric

The sequential position of the current order within the customer's complete purchase history.

Customer localeDimension

The preferred locale (language and region) of the customer, typically in a format like 'en-US' or 'fr-FR'.

Customer number of ordersMetric

The total number of orders placed by a specific customer. This value is retrieved by filtering the `ordersCount` query with the customer's unique ID or email address.

DayDimension

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

Line items quantitiesMetric

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.

Order IDDimension

A unique internal identifier assigned by Shopify to each order.

Order idMetric

A unique internal identifier assigned by Shopify to each order.

Order nameDimension

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

Processed atDimension

The date and time when an order was processed.

Publication nameDimension

The name of the publication or sales channel where a product or collection is published. This relates to the `Channel.name` field.

Shipping address countryDimension

The country specified in the shipping address for the order. This maps to the `country` field within the `ShippingAddress` object.

Shipping address post codeDimension

The postal code or ZIP code associated with the shipping address for an order or customer.

TagsDimension

A list of searchable, custom tags associated with an order or customer. This is a standard field on `Order` and `Customer` objects.

Total discounts amountMetric

The total monetary amount of all discounts applied to an order. This is represented by `totalDiscountsSet.shopMoney.amount` on the `Order` object.

Total order amountMetric

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

Total shipping amountMetric

The total monetary amount charged for shipping on an order. This is represented by `totalShippingPriceSet.shopMoney.amount` on the `Order` object.

Total tax amountMetric

The total monetary amount of all taxes applied to an order. This is represented by `totalTaxSet.shopMoney.amount` on the `Order` object.

Updated atDimension

This field captures the date and time when a specific record, such as an order, product, or collection, was last modified in Shopify. This timestamp can change due to various actions, including inventory adjustments or other updates to the record's attributes.

dateDimension

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`).

metafield.idMetric

The unique identifier for the metafield.

metafield.keyDimension

A unique key within a given namespace used to identify the metafield.

metafield.namespaceDimension

A container for a group of metafields, used to organize and categorize custom data.

metafield.ownerTypeDimension

The type of Shopify resource (e.g., PRODUCT, CUSTOMER, ORDER) that the metafield is associated with.

metafield.valueDimension

The data stored in the metafield, which can be of various types (e.g., string, integer, JSON).

ordersMetric

Represents a collection of customer orders. This refers to the `Order` object in the Shopify GraphQL Admin API.

ownerIdMetric

The unique identifier (Global ID) of the Shopify resource (e.g., product, customer, order) that owns the metafield.

revenueMetric

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.