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 total monetary amount of any additional fees applied to an order. This maps to additionalFees on the Order object, which is mentioned in the connector’s implementation details. |
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 |
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 |
Created at |
Created at |
The timestamp indicating when a record or resource was created. |
dimension |
Customer ID |
Customer ID |
The unique identifier for the customer. This maps to Customer.id in the API. |
dimension |
Customer email |
Customer email |
The primary email address of the customer. This maps to Customer.email in the API. |
dimension |
Customer journey attribution ready |
Customer journey attribution ready |
dimension |
|
Customer journey first session ID |
Customer journey first session ID |
A unique identifier for the customer’s first recorded session on the store. This is typically represented by CustomerVisit.id within customer journey data. |
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 from the customer’s first session, typically used for paid search keywords. This is part of the utmParameters.term field within CustomerVisit or CustomerJourneySummary objects. |
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 timestamp when the customer’s first session occurred. This is typically represented by the occurredAt field on the CustomerVisit object. |
dimension |
Customer journey first session referral code |
Customer journey first session referral code |
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 |
dimension |
|
Customer journey first session source type |
Customer journey first session source type |
dimension |
|
Customer journey last session ID |
Customer journey last session ID |
A unique identifier for the customer’s most recent recorded session on the store. This is typically represented by CustomerVisit.id for the latest visit within customer journey data. |
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 from the customer’s last session, typically used for paid search keywords. This is part of the utmParameters.term field within CustomerVisit or CustomerJourneySummary objects. |
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 timestamp when the customer’s last session occurred. This is typically represented by the occurredAt field on the CustomerVisit object. |
dimension |
Customer journey last session referral code |
Customer journey last session referral code |
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 |
dimension |
|
Customer journey last session source type |
Customer journey last session source type |
dimension |
|
Customer journey order index |
Customer journey order index |
metric |
|
Day |
Day |
A temporal dimension representing a specific day, used for reporting and aggregating sales or other data on a daily basis. |
dimension |
Financial status |
Financial status |
The payment status of the order, such as PAID, PENDING, AUTHORIZED, or REFUNDED. This corresponds to OrderDisplayFinancialStatus or OrderCreateFinancialStatus in the API. |
dimension |
Fully paid |
Fully paid |
A boolean indicator specifying whether the order has been fully paid. This can be inferred from the Financial status being ‘PAID’. |
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. |
metric |
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 total amount of money received for an order after all applicable discounts, returns, and allowances have been applied. |
metric |
Processed at |
Processed at |
The timestamp indicating when the order or record was processed. This typically corresponds to a processedAt field on the Order object or a similar timestamp for other resources. |
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 |
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 |
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 |
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 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 is still owed on an order. This is represented by totalOutstandingSet.shopMoney.amount on the Order object. |
metric |
Total refunded amount |
Total refunded amount |
The total monetary amount that has been refunded for an order. This is represented by totalRefundedSet.shopMoney.amount on the Order object. |
metric |
Total refunded shipping amount |
Total refunded shipping amount |
The total monetary amount of shipping costs that have been refunded for an order. This is represented by totalRefundedShippingSet.shopMoney.amount on the Order object. |
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 |
Updated at |
Updated at |
The timestamp indicating when a record or resource was last modified. |
dimension |
channelInformation |
channelInformation |
Contains details about the sales channel associated with a resource, typically an order. This is an object on the Order that provides channel-specific details. |
dimension |
channelInformation.channelDefinition |
channelInformation.channelDefinition |
Provides the definition and characteristics of the sales channel within the channelInformation object. This defines the properties of the channel itself. |
dimension |
channel_name |
channel_name |
The human-readable name of the sales channel. This is an alias for ‘Channel name’ and maps to Channel.name in the API. |
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 part of the createdAt timestamp, without time information. This is typically a derived field from the createdAt timestamp. |
dimension |
customer.created |
customer.created |
The date and time when the customer record was created. This maps to Customer.createdAt in the API. |
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 |
dimension |
|
date |
date |
dimension |
|
discount_amount |
discount_amount |
The monetary amount of a specific discount applied. This could refer to an individual discount allocation or the total discount for a line item. |
metric |
id |
id |
The unique identifier for the discount entry. |
metric |
netPaymentSet.shopMoney |
netPaymentSet.shopMoney |
The net payment for the order in the shop’s currency, based on the total amount received minus the total amount refunded. This is a field on the Order object. |
dimension |
net_payment_amount |
net_payment_amount |
The monetary amount of the net payment for an order, derived from netPaymentSet.shopMoney.amount. |
metric |
numberOfOrders |
numberOfOrders |
The total count of orders placed by a customer. This can be retrieved by querying the Customer.orders.totalCount or similar aggregation of orders associated with a customer. |
metric |
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 |
metric |
|
revenue |
revenue |
The total revenue for an order. In Shopify’s GraphQL, this is typically represented by totalPriceSet.shopMoney.amount on the Order object, which is the total price including taxes and shipping in the shop’s currency. |
metric |
shipping_amount |
shipping_amount |
The monetary amount charged for shipping on an order. This could refer to an individual ShippingLine.priceSet.shopMoney.amount or the total shipping for an order. |
metric |
totalDiscountsSet.shopMoney |
totalDiscountsSet.shopMoney |
The total monetary amount of all discounts applied to an order, represented in the shop’s currency. This is a field on the Order object. |
dimension |
totalOutstandingSet.shopMoney |
totalOutstandingSet.shopMoney |
The total monetary amount still outstanding for an order, represented in the shop’s currency. This is a field on the Order object. |
dimension |
totalPriceSet.shopMoney |
totalPriceSet.shopMoney |
The total price of the order, including taxes and shipping, represented in the shop’s currency. This is a field on the Order object. |
dimension |
totalRefundedSet.shopMoney |
totalRefundedSet.shopMoney |
The total monetary amount that has been refunded for an order, represented in the shop’s currency. This is a field on the Order object. |
dimension |
totalRefundedShippingSet.shopMoney |
totalRefundedShippingSet.shopMoney |
The total monetary amount of shipping costs that have been refunded for an order, represented in the shop’s currency. This is a field on the Order object. |
dimension |
totalShippingPriceSet.shopMoney |
totalShippingPriceSet.shopMoney |
The total monetary amount charged for shipping on an order, represented in the shop’s currency. This is a field on the Order object. |
dimension |
totalTaxSet.shopMoney |
totalTaxSet.shopMoney |
The total monetary amount of taxes applied to an order, represented in the shop’s currency. This is a field on the Order object. |
dimension |
total_order_amount |
total_order_amount |
The total monetary amount of the order, including taxes and shipping. This is derived from totalPriceSet.shopMoney.amount. |
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 part of the updatedAt timestamp, without time information. This is typically a derived field from the updatedAt timestamp. |
dimension |