Shopify
This catalog provides dimensions for the Shopify
data source.
customer_id
Type:
string
Description: The "customer_id" dimension represents a unique identifier for a customer in the Shopify platform. This ID is used to distinguish individual customers across various data records and transactions. In the context of Shopify's Admin REST API, the "customer_id" is associated with customer accounts and orders, allowing you to link specific orders, actions, and marketing insights to the respective customer who made a purchase or engaged with the store. This is crucial for customer relationship management, enabling merchants to track purchase history, segment customers, and personalize marketing strategies.
order_id
Type:
string
Description: The "order_id" dimension in Shopify refers to the unique identifier assigned to each individual order placed through a Shopify store. This ID is a distinct numerical value that allows merchants and systems to track, manage, and reference specific orders. It is crucial for order management, enabling actions such as order retrieval, fulfillment, and analysis. The "order_id" is utilized in various API calls to access detailed information about an order, including customer details, products purchased, payment, and shipping information.
customer_email
Type:
string
Description: The "customer_email" dimension in Shopify represents the email address associated with a customer who has placed an order. This dimension is used to identify and track individual customers, enabling retailers to analyze customer behavior, send order confirmations, and facilitate communications. In the context of Shopify's data, the "customer_email" serves as a unique identifier for customer interactions and order processing within the e-commerce platform.
customer_name
Type:
string
Description: The "customer_name" dimension in Shopify e-commerce analysis represents the full name of the customer associated with a particular order. This is typically a combination of the first and last names of the customer who placed the order. It's used to identify and analyze customer-related data within the context of orders, allowing businesses to track purchasing behavior and patterns linked to individual customers.
lifetime_duration
Type:
N/A
Description: No description available.
email_marketing_consent_state
Type:
N/A
Description: No description available.
email_marketing_consent_opt_in_level
Type:
N/A
Description: No description available.
customer_first_order_date
Type:
date
Description: The dimension "customer_first_order_date" refers to the date when a customer made their first purchase on the Shopify store. This data point is used to track when a customer began their relationship with the store by making their initial order. It helps store owners analyze customer acquisition patterns, understand customer lifetime value, and segment customers based on the duration of their loyalty.
purchase_type
Type:
string
Description: The dimension "purchase_type" in the context of Shopify's e-commerce data analysis typically refers to the classification of a transaction based on how the purchase was made. This can include distinctions like "online" for purchases made through an e-commerce platform, "in-store" for physical store purchases using Shopify POS, or other types of specific transaction methods. This dimension helps businesses analyze and differentiate between various sales channels or methods through which customers place orders. It provides insights into customer purchasing behavior and helps in strategic decision-making regarding sales channels.
is_refund
Type:
boolean
Description: The "is_refund" dimension in the context of Shopify's e-commerce data analysis typically indicates whether a particular transaction or order line item involves a refund. When this dimension is true, it signifies that the transaction is a refund, meaning money has been returned to the customer for that portion of the order. This can help merchants identify and analyze refunds separately from sales, allowing for better financial tracking and customer service assessments.
first_order_sales_channel
Type:
string
Description: The "first_order_sales_channel" dimension in Shopify e-commerce data analysis represents the sales channel through which a customer made their first purchase on your store. Essentially, this dimension identifies the source or platform (such as online store, POS, mobile app, social media platform, etc.) where the customer's initial order occurred. This information is valuable for understanding customer acquisition patterns and the effectiveness of different sales channels in attracting new customers.
first_order_sales_channel_name
Type:
string
Description: The dimension "first_order_sales_channel_name" represents the name of the sales channel through which a customer made their first purchase on a Shopify store. This could include various sales platforms integrated with Shopify, such as the online store, point of sale, mobile app, Facebook shop, or other third-party sales channels. This dimension is useful for analyzing and understanding where new customers are initially engaging with the store, allowing businesses to assess the effectiveness of different sales channels in attracting first-time buyers.
shipping_country
Type:
string
Description: The "shipping_country" dimension in Shopify refers to the country to which an order is being shipped. It represents the destination country specified in the shipping address associated with a customer's order. This dimension is vital for analyzing sales distribution across different countries, understanding international shipping needs, and tailoring marketing strategies to various geographic regions. The value of "shipping_country" is typically formatted as a two-letter ISO 3166-1 alpha-2 country code.
billing_country
Type:
string
Description: The "billing_country" dimension in Shopify represents the country associated with the billing address provided by the customer during the checkout process. This dimension indicates the country to which the billing address belongs, usually corresponding to the location of the customer's payment method, such as a credit card. It is a vital piece of information used for understanding customer demographics, regional sales reporting, and potentially for assessing tax liabilities and compliance with international shipping regulations.
shipping_city
Type:
string
Description: The "shipping_city" dimension in Shopify represents the city name to which an order is being shipped. This is extracted from the shipping address provided by the customer during the checkout process. It is a crucial component in order fulfillment and logistics, helping businesses to analyze shipping patterns and optimize delivery services based on geographical data.
shipping_country_code
Type:
string
Description: The dimension "shipping_country_code" in Shopify e-commerce data analysis represents the ISO 3166-1 alpha-2 country code for the destination country to which a customer's order is being shipped. This two-letter code is used to identify the specific country where the order's shipping address is located. For example, "US" would indicate that the shipment is going to the United States, while "CA" would represent Canada. This dimension is useful for analyzing and segmenting orders based on their shipping destinations.
shipping_province
Type:
string
Description: The "shipping_province" dimension in Shopify refers to the specific province or state to which an order is being shipped. This dimension is part of the shipping address information provided by the customer during the checkout process. It helps in analyzing order distribution based on geographic regions, calculating shipping costs, and understanding sales trends within specific areas. This dimension is particularly important for merchants who operate in regions with province-specific taxation or shipping regulations.
shipping_province_code
Type:
string
Description: The "shipping_province_code" dimension in Shopify represents the specific code or abbreviation of the province or state to which an order is being shipped. This dimension is used to identify the regional area within a country that is the destination for the shipment, helping with logistical planning, tax calculations, and geographic sales analysis.
shipping_zip
Type:
string
Description: The "shipping_zip" dimension in Shopify e-commerce data represents the postal or ZIP code of the shipping address associated with a specific order. It indicates the geographic area to which the order is being shipped and is a component of the broader shipping address information. This dimension is often used in data analysis to understand regional shipping patterns, calculate shipping costs, assess delivery zones, or conduct targeted marketing efforts based on geographic location.
billing_city
Type:
string
Description: The "billing_city" dimension in Shopify refers to the city specified in the billing address of an order. This information is captured when a customer makes a purchase and provides their payment details. It represents the city where the billing address is located, which is typically the address associated with the payment method used for the transaction. This dimension is useful for analyzing geographic trends in sales and understanding the distribution of customers by city location.
billing_country_code
Type:
string
Description: The "billing_country_code" dimension in Shopify represents the two-letter ISO 3166-1 alpha-2 country code for the country associated with the billing address provided by the customer during the checkout process. This code indicates the country where the billing information, such as the customer's payment details, is registered. This dimension is commonly used in e-commerce data analysis to segment orders or examine purchasing trends based on the geographical location of the billing address.
billing_province
Type:
string
Description: The "billing_province" dimension in Shopify refers to the state, region, or province associated with the billing address of an order. This dimension captures the geographic administrative area where the billing information of the customer is located. It is a part of the billing address details provided by the customer during the checkout process. Understanding the "billing_province" can be useful for analyzing regional sales trends, tax calculations, and customer demographics in e-commerce data.
billing_province_code
Type:
string
Description: The dimension "billing_province_code" in Shopify refers to the standardized code representing the province or region of the billing address associated with an order. This code is typically a short form or abbreviation used to identify the geographic area within the billing country. For example, in Canada, it would be the two-letter code for the province such as "ON" for Ontario. This dimension is useful in e-commerce data analysis for identifying and segmenting orders based on the billing region, which can help in understanding customer demographics and regional sales patterns.
billing_zip
Type:
string
Description: In the context of Shopify and e-commerce data analysis, the dimension key "billing_zip" represents the postal or ZIP code associated with a customer's billing address for an order. This is the ZIP code where the customer receives their credit card statements or bills, which is collected during the checkout process. It is important for verifying the customer's billing information and can be used for analysis related to the geographical distribution of customers, as well as for fraud prevention and payment processing purposes.
financial_status
Type:
string
Description: The "financial_status" dimension in Shopify's context refers to the current state of an order in terms of its payment processing. It indicates whether the payment for an order has been successfully completed, is pending, has failed, or has been refunded, among other potential statuses. This dimension is crucial for understanding the financial progress and completion status of an order. Common statuses include "paid", "pending", "authorized", "partially_paid", "refunded", and "voided". Each status helps merchants track and manage the financial lifecycle of orders.
note
Type:
string
Description: In the context of Shopify's Admin REST API and e-commerce terminology, the dimension "note" refers to an optional field associated with an order that can be used by merchants to add internal comments or additional information about that order. This field is not visible to customers and is typically used by store staff for various purposes such as recording special instructions, noting customer preferences, or documenting other relevant information that assists in processing the order internally.
app_id
Type:
string
Description: The dimension key "app_id" in the context of Shopify's Admin REST API typically represents the unique identifier of an application that is integrated or used within a Shopify store. This ID helps track and attribute certain activities or data points back to the specific app responsible for them. For example, if an app processes an order or contributes to a sales channel, the "app_id" dimension would be used to identify which app handled or influenced that part of the transaction. This is important for merchants to analyze the performance and impact of different apps on their store's activities.
order_number
Type:
string
Description: The "order_number" dimension in Shopify represents a unique identifier assigned to each order in a sequential manner. This number is used to track and reference individual orders within the Shopify platform. It typically begins with a starting number (usually 1001 for new stores) and increments by one for each subsequent order. It's important to note that the "order_number" is distinct from the "id" or "order_id," which is a globally unique identifier (GUID) used internally by Shopify. The "order_number" is often used in customer communication and reports as it is more user-friendly and easier to reference when compared to the internal IDs.
fulfillment_status
Type:
string
Description: The "fulfillment_status" dimension in Shopify refers to the current state of an order's fulfillment process. It indicates whether the items in an order have been shipped or delivered to the customer. Common statuses include:
unfulfilled: No items in the order have been fulfilled.
partial: Some items in the order have been fulfilled, while others have not.
fulfilled: All items in the order have been fulfilled and shipped to the customer.
This dimension is used to track and manage the shipping of products, providing vital information on order processing and delivery progress.
processing_method
Type:
string
Description: The "processing_method" dimension in Shopify's context refers to the method by which a payment was processed for an order. This dimension indicates the mechanism through which the transaction was completed, such as whether it was handled through a manual payment, an automatic capture of funds, or other specific methods associated with payment gateways integrated into the store. Understanding this dimension helps in analyzing payment trends and processing efficiency within the e-commerce store.
referring_site
Type:
string
Description: The "referring_site" dimension in Shopify e-commerce data analysis represents the URL of the website that directed a customer to the Shopify store, leading to a transaction. This field helps in tracking the source of incoming traffic that results in sales, providing insights into the effectiveness of external websites or marketing channels in driving purchases. This can include search engines, social media platforms, affiliate links, or other websites. Understanding the referring sites can assist businesses in optimizing their marketing strategies and partnerships.
referring_source
Type:
string
Description: The "referring_source" dimension in Shopify e-commerce data analysis represents the origin or medium through which a customer was directed to your online store before making a purchase. This dimension helps identify how customers found your store, whether it was through search engines, social media, direct links, ads, or other referral channels. Understanding the "referring_source" allows you to evaluate the effectiveness of your marketing channels and optimize your strategies for driving traffic to your store.
landing_site_ref
Type:
string
Description: The "landing_site_ref" dimension in Shopify represents the reference information or the URL of the site from which a customer was referred or directed before making a visit or purchase on the Shopify store. It is essentially the referral source, helping store owners understand the origin of their incoming traffic, often used to analyze the effectiveness of marketing campaigns or track how external links drive traffic to their store.
presentment_currency
Type:
string
Description: The "presentment_currency" dimension in Shopify represents the currency in which prices are shown to customers on the storefront. It is particularly relevant in international stores that display prices in local currencies based on the buyer's location or preference. This currency setting helps customers understand product prices in a familiar currency and can differ from the shop's base currency, which is the primary currency set for transactions and reporting in the Shopify admin.
reference
Type:
string
Description: In the context of Shopify's Admin REST API and e-commerce terminology, the "reference" dimension typically represents a unique identifier used to correlate or track specific transactions, orders, or interactions. While it is not explicitly detailed in the API documentation you've linked, "reference" often serves as a custom field that a merchant or external system can use to assign their own meaningful identifier or code to an order or customer interaction. This could be a purchase order number, a transaction code provided by a payment processor, or any other alphanumeric string that helps in associating Shopify data with other business processes or systems.
source_identifier
Type:
string
Description: The dimension "source_identifier" in Shopify typically refers to a unique identifier associated with the source of an order. This can represent different sales channels or platforms from which the order originated, such as a specific online store, a third-party sales channel, or an internal sales tool. In the context of Shopify's ecosystem, it helps merchants and analysts track and distinguish the origins of orders for better sales channel management and performance analysis.
For more detailed information, you can refer to Shopify's API documentation linked in your question, specifically in the contexts where this dimension is applied, such as order reporting and analytics.
payment_gateway_names
Type:
string
Description: The "payment_gateway_names" dimension in Shopify represents the name(s) of the payment gateway(s) used to process transactions for an order. In the context of Shopify's Admin REST API and e-commerce data analysis, this dimension provides insights into which payment service providers are being utilized for processing payments, such as PayPal, Stripe, or Shopify Payments. It helps in understanding the distribution of payment preferences among customers and can be used for reporting and analytics to optimize payment options offered in the store.
landing_site_base_url
Type:
string
Description: The dimension "landing_site_base_url" in the context of Shopify's e-commerce data represents the base URL of the landing page where a customer first arrives before making a purchase. In essence, it captures the initial web address that directs a visitor to an online store, which can be crucial for understanding traffic sources and marketing effectiveness. This URL often comes from external sources such as advertisements, referral links, or email campaigns. Analyzing this dimension helps store owners determine which channels are successfully driving traffic to their site.
order_status_url
Type:
string
Description: The "order_status_url" dimension in Shopify represents a URL that leads to a customer-facing webpage where they can view the current status of their order. This page typically provides information such as whether the order has been processed, shipped, or delivered. The URL is unique for each order and allows customers to track their order updates without needing to log into their Shopify account. This dimension is especially useful for providing transparency and enhancing the customer experience by making order tracking accessible and straightforward.
pos_location_name
Type:
string
Description: The "pos_location_name" dimension in Shopify typically represents the name of the physical location or retail store where a point of sale (POS) transaction occurs. In the context of e-commerce data analysis, this dimension is used to identify and differentiate sales based on the specific physical location where the order was processed. This is particularly useful for merchants who operate multiple physical stores or outlets, allowing them to analyze and compare sales performance across different locations.
first_order_ga_source
Type:
string
Description: The dimension "first_order_ga_source" in the context of Shopify and e-commerce data analysis typically represents the source from which a customer came when they made their first purchase on the store. It is linked to Google Analytics (GA) and reflects the original traffic source or medium that led the customer to the store for their initial order. This can include sources such as direct traffic, organic search, paid search, social media, referrals, email, and others that Google Analytics categorizes. This dimension helps merchants understand where their first-time customers are originating, aiding in marketing and attribution analysis.
first_order_ga_campaign
Type:
string
Description: The dimension "first_order_ga_campaign" in the context of Shopify e-commerce data analysis likely refers to the Google Analytics campaign associated with a customer's first order. This dimension would capture the specific marketing campaign from Google Analytics that led to a customer's initial purchase on a Shopify store. It helps store owners understand which marketing efforts are effective in acquiring new customers by linking the first purchase to the campaign that influenced the customer's decision.
first_order_ga_medium
Type:
string
Description: The dimension "first_order_ga_medium" in Shopify e-commerce data analysis represents the marketing medium associated with a customer's first order. This is typically used in conjunction with Google Analytics tracking, where "ga_medium" refers to the general category of traffic source or marketing channel that brought the customer to the store for their initial purchase. Examples of mediums include "organic" (for organic search), "cpc" (cost per click for paid search), "email" (from email campaigns), and "referral" (from referring sites). This dimension helps in understanding and analyzing which marketing channels are effectively driving first-time purchases.
product_title
Type:
string
Description: The dimension key "product_title" in Shopify represents the name or title of a product as it appears in the Shopify store. This is the human-readable name that merchants assign to each product to describe it to potential buyers. It is a key attribute used for identifying, categorizing, and displaying products across the Shopify ecosystem, including orders, reports, and the storefront. The "product_title" is significant for customer-facing interactions and helps in distinguishing products in the merchant's inventory.
product_id
Type:
string
Description: The "product_id" dimension in Shopify represents the unique identifier for a specific product within a store. This identifier is used to distinguish each product in the store's database, facilitating product management, tracking inventory levels, and analyzing sales performance. In the context of Shopify's Admin REST API, "product_id" is used to retrieve or manipulate data related to a particular product, such as fetching product details, updating information, or generating sales reports.
collection_title
Type:
string
Description: The "collection_title" dimension in Shopify refers to the name of a collection within a Shopify store. A collection is a group of products that are organized together, typically for marketing or navigational purposes. This can include groupings like "Summer Sale," "New Arrivals," or "Best Sellers." The "collection_title" helps store owners and analysts categorize and analyze sales and performance data specific to each collection. By examining this dimension, businesses can gain insights into how various collections are performing and make informed decisions on merchandising and promotions.
selling_plan_names_in_order
Type:
string
Description: The dimension "selling_plan_names_in_order" in Shopify's e-commerce data analysis represents the names of any selling plans associated with the order. Selling plans in Shopify are used to define how products are sold according to different subscription models or payment plans. This dimension helps identify the specific plans that were applied at the time the customer placed the order, such as subscription plans, installment payments, or any other custom plan configured on the Shopify store. Understanding this dimension allows store owners to analyze the effectiveness and popularity of different selling plans among their customers.
is_gift_card
Type:
boolean
Description: The dimension key "is_gift_card" in Shopify's e-commerce data analysis represents a boolean attribute indicating whether a particular product or item in an order is a gift card. It is used to identify transactions involving gift cards, which are products that can be purchased and later redeemed as store credit. This dimension is particularly useful for distinguishing gift card transactions from the sales of other physical or digital products, allowing retailers to analyze and manage gift card usage, sales, and redemptions separately within their order data.
customer_first_order_timestamp
Type:
string
Description: The "customer_first_order_timestamp" dimension in Shopify e-commerce data analysis represents the date and time when a customer placed their first order on the Shopify store. This timestamp marks the initial transaction time registered in the system for a customer, helping merchants to identify when a customer began their purchasing journey. It is useful for analyzing customer acquisition timelines, understanding lifetime value, and segmenting customers based on their tenure with the store.
customer_total_spent
Type:
integer
Description: The dimension "customer_total_spent" in the context of Shopify e-commerce data analysis likely represents the cumulative total amount of money a customer has spent at a store over their lifetime. This metric aggregates all orders placed by the customer, providing valuable insights into customer value and purchasing behavior. It helps businesses understand the overall contribution of a customer to the store's revenue.
order_tag
Type:
string
Description: The dimension "order_tag" in Shopify represents a label or keyword assigned to an order within the Shopify platform. Order tags are used to categorize, organize, and manage orders more effectively. Merchants can apply one or multiple tags to each order to denote special characteristics, conditions, or handling instructions. For example, tags can be used to indicate that an order is a priority, requires gift wrapping, or belongs to a specific marketing campaign. These tags are highly customizable and serve as an efficient means for filtering and searching orders in the Shopify admin dashboard.
order_tags_in_order
Type:
string
Description: The dimension "order_tags_in_order" in Shopify represents the tags associated with a particular order. In Shopify, tags are used to categorize and organize orders for better management and analysis. These tags can be applied manually by a store owner or automatically through apps and workflows based on certain criteria. The "order_tags_in_order" dimension helps in filtering and analyzing order data based on these tags, allowing store owners to identify patterns or group orders with similar characteristics. This dimension is particularly useful for segmenting orders for reporting, fulfillment, and customer service purposes.
customer_tag
Type:
string
Description: The dimension key "customer_tag" in Shopify represents labels or keywords assigned to customers that help categorize them based on certain characteristics or behaviors. These tags allow merchants to segment their customer base for targeted marketing, personalized experiences, and better customer management. For example, a customer might have tags like "VIP," "Newsletter Subscriber," or "Wholesale Client." The "customer_tag" is useful for filtering and organizing customers within the Shopify platform, enabling merchants to tailor their interactions and offerings accordingly.
order_discount_code
Type:
string
Description: The "order_discount_code" dimension in Shopify e-commerce data analysis represents the code or identifier used for a discount applied to an order. This code typically corresponds to promotional discounts, coupons, or special offers that customers can enter during the checkout process to receive a reduction in price. The dimension captures the specific discount code used for a given order, allowing businesses to analyze the effectiveness and usage of various discount campaigns and promotions.
order_discount_code_amount
Type:
string
Description: The dimension "order_discount_code_amount" in Shopify refers to the total amount of discounts that have been applied to an order as a result of discount codes. Discount codes are promotional codes that customers can enter at checkout to receive a reduction in the order price. This particular dimension captures the cumulative value of all such reductions applied to the order, reflecting how much the order total has been decreased due to the use of discount codes.
order_discount_code_type
Type:
string
Description: The dimension "order_discount_code_type" in Shopify refers to the classification of discount codes applied to an order. In the context of Shopify's e-commerce platform, discount codes are promotional codes that customers can enter at checkout to receive deductions on their purchase total. These discount codes can be of various types, such as:
Percentage Discount: The discount code reduces the order total by a certain percentage.
Fixed Amount Discount: The discount code reduces the order total by a specific flat amount.
Free Shipping: The discount code provides free shipping for the order.
Buy X Get Y: The discount code triggers an offer such as buying a certain quantity of items to get additional items free or at a discounted rate.
The "order_discount_code_type" dimension helps in identifying the type of discount applied, allowing merchants and analysts to assess the effectiveness and impact of different types of promotions on sales and customer behavior.
is_cancelled
Type:
boolean
Description: The "is_cancelled" dimension in Shopify's context typically refers to whether an order has been canceled or not. This dimension would indicate a boolean value:
true
if the order has been canceled andfalse
if it remains active or unfulfilled. In e-commerce, tracking whether an order is canceled is crucial for understanding order status, managing inventory, and analyzing sales metrics. When referencing the Shopify Admin REST API, this dimension helps in filtering or identifying orders that have been canceled during the processing lifecycle.
store_currency
Type:
string
Description: The dimension "store_currency" in Shopify represents the currency that a store is set up to use for its operations, transactions, and financial reporting. This currency is used as the default currency for displaying product prices, processing orders, and generating financial reports within the Shopify store. It is defined in the store's settings and ensures consistency for financial data analysis and customer transactions.
processed_timestamp
Type:
string
Description: The "processed_timestamp" dimension in the context of Shopify e-commerce data analysis refers to the specific date and time when an order is processed. This timestamp indicates when the order has transitioned from pending or unfulfilled to a stage where it is confirmed for fulfillment. It is crucial for understanding the timeline and efficiency of order processing within the store’s operations. This dimension helps in tracking operational performance and can be used to analyze how quickly orders are being processed after they are placed. The "processed_timestamp" is typically presented in ISO 8601 format, providing a precise and standardized time reference.
processed_date
Type:
date
Description: The "processed_date" dimension in Shopify refers to the date and time when an order was processed. In the context of order management and e-commerce operations, this typically means the date when the order has been prepared for fulfillment, such as being packaged, labeled, or otherwise confirmed for shipping to the customer. This timestamp is crucial for tracking fulfillment operations and for understanding the efficiency of order processing workflows. In data analysis, this information can be used to evaluate order processing times, ensure timely fulfillment, and improve overall customer satisfaction by analyzing the gap between order placement and processing.
updated_timestamp
Type:
string
Description: The "updated_timestamp" dimension in the context of Shopify's Admin REST API typically represents the exact date and time when the resource, such as an order, was last modified. This timestamp indicates the most recent update made to the record, whether that update involved a change in order status, a modification of the order details, or any other update action performed. It is essential for tracking the latest activity on an order and is crucial for tasks like synchronization, data consistency, and audit trails in e-commerce operations.
updated_date
Type:
date
Description: The "updated_date" dimension in Shopify e-commerce data typically represents the date and time when a specific record, such as an order, product, or customer, was last modified or updated in the Shopify system. This includes any changes made to the record's details, such as status updates, edits to product descriptions, changes in customer information, or any other modifications. The "updated_date" helps in tracking the most recent changes to the record and can be useful for analyzing trends, syncing data, and maintaining accurate records over time.
order_id
Type:
string
Description: The "order_id" dimension in Shopify refers to the unique identifier assigned to each individual order placed through a Shopify store. This ID is a distinct numerical value that allows merchants and systems to track, manage, and reference specific orders. It is crucial for order management, enabling actions such as order retrieval, fulfillment, and analysis. The "order_id" is utilized in various API calls to access detailed information about an order, including customer details, products purchased, payment, and shipping information.
taxes_included
Type:
boolean
Description: The "taxes_included" dimension in Shopify represents a Boolean value indicating whether the prices of items in an order include applicable taxes. When this dimension is set to "true," it means that the tax amounts are already included in the item prices shown to the customer. Conversely, if it is "false," taxes are calculated and added separately at checkout. This setting can affect how prices are displayed to customers and how tax calculations are handled during the ordering process.
cancel_reason
Type:
string
Description: The "cancel_reason" dimension in Shopify represents the reason why an order was canceled in the system. It provides context for cancellations, helping merchants understand the circumstances under which orders do not proceed to fulfillment. Common reasons include:
Customer - The customer requested the cancellation.
Fraud - The order was identified as fraudulent.
Inventory - The items in the order are out of stock.
Other - Any other reason not specifically categorized.
This dimension is useful for analyzing cancellation trends and improving operations related to order processing and customer satisfaction.
checkout_token
Type:
string
Description: The "checkout_token" in Shopify represents a unique identifier for a checkout session. When a customer initiates the checkout process on a Shopify store, a token is generated to track this specific checkout session. This token ensures that all actions and data—such as items in the cart, customer information, and shipping details—are consistently associated with the individual checkout as the customer progresses towards completing their purchase. In the context of data analysis, the "checkout_token" allows you to analyze and track specific checkout sessions, which can be useful for understanding conversion rates, identifying abandoned checkouts, and personalizing the checkout experience.
customer_locale
Type:
string
Description: The "customer_locale" dimension in Shopify represents the language and regional settings that the customer used when placing an order. This locale setting typically includes information about the customer's language preference and geographical location, formatted in a standard locale code (e.g., "en-US" for English - United States). It helps businesses understand and analyze the diversity of their customer base in terms of language and regional preferences, allowing them to tailor their marketing strategies and communications accordingly.
device_id
Type:
string
Description: In the context of Shopify's e-commerce data analysis, "device_id" typically refers to a unique identifier associated with the device used by a customer to place an order or interact with the online store. This dimension helps track and analyze user behavior across different devices, such as smartphones, tablets, or computers. By understanding device usage, merchants can optimize their store's performance on various platforms and tailor their marketing strategies to target users based on their preferred device types. The "device_id" can play a crucial role in personalizing the shopping experience and improving conversion rates by providing insights into the most commonly used devices among the store's customers.
variant_id
Type:
string
Description: The "variant_id" in Shopify represents the unique identifier for a specific variant of a product. In e-commerce and Shopify's context, products can have multiple variants, which are different versions of the same product, distinguished by attributes like size, color, or material. Each variant is considered a distinct item with its own inventory level, price, and SKU (Stock Keeping Unit). The "variant_id" is crucial for tracking and managing these individual product variants in the Shopify system, allowing for precise inventory management, order processing, and data analysis.
sku
Type:
string
Description: In the context of Shopify and e-commerce data analysis, the dimension key "sku" stands for "Stock Keeping Unit." It is an alphanumeric code used to uniquely identify a specific product or variant in your inventory. The SKU is crucial for inventory management, allowing merchants to track products, manage stock levels, and streamline operations. Each SKU is unique to a variant of a product, which means even different sizes or colors of the same product will typically have different SKUs. This helps ensure that the right product is tracked and sold, reducing errors and improving order fulfillment efficiency.
variant_title
Type:
string
Description: The "variant_title" dimension in Shopify refers to the title of a specific product variant. In e-commerce, a product variant is a version of a product that has different attributes, such as size, color, or material. The "variant_title" provides a concise description of these attributes for a particular product variant. For example, if a product is a t-shirt available in different sizes and colors, the "variant_title" might specify "Large / Red" to indicate the specific variant. This dimension is useful for distinguishing between different versions of the same product in data analysis and reporting.
product_type
Type:
string
Description: The "product_type" dimension in Shopify represents a categorization attribute that describes the category to which a product belongs. It is used to group and organize products within the store, making it easier to manage inventory, analyze sales data, and enhance the shopping experience. This categorization can be based on characteristics such as the product's intended use, design, or target market. Examples of product types might include "Apparel," "Electronics," "Home Goods," etc. Merchants can utilize this attribute to filter products, create collections, and run specific analysis on product categories.
product_status
Type:
string
Description: The "product_status" dimension in Shopify's context represents the current state or condition of a product in the Shopify store's inventory. It typically indicates whether a product is available for purchase or not, and can include various statuses such as:
Active: The product is available and visible to customers. It can be purchased through the online store or other sales channels.
Draft: The product is not yet available for purchase. It might be a new product that is still being set up or edited.
Archived: The product is no longer active and is removed from sales channels but is retained in the store's records for future reference or reporting.
Understanding "product_status" is crucial for managing inventory, sales, and marketing strategies within a Shopify store.
collection_id
Type:
string
Description: The "collection_id" in Shopify refers to the unique identifier for a collection, which is a grouping of products in a Shopify store. Collections are used to organize products into categories, making it easier for customers to find items. These collections can be based on various attributes, such as product type, vendor, price range, or custom criteria set by the store owner. The "collection_id" allows for tracking and referencing specific collections within Shopify's Admin REST API and facilitates the analysis of product grouping and categorization in e-commerce data.
collection_handle
Type:
string
Description: The "collection_handle" dimension in Shopify refers to a unique identifier for a specific collection within a Shopify store. Collections are groups of products organized together under a common theme or category, making it easier for customers to browse and find products. The "handle" is a URL-friendly version of the collection's name, typically in lowercase and with spaces replaced by hyphens. This handle is used in the store's URLs and the Shopify API to reliably reference a collection across different parts of the Shopify platform.
collection_template_suffix
Type:
string
Description: The "collection_template_suffix" in Shopify refers to the template suffix used to render a specific collection page within a Shopify store. In Shopify, merchants can create custom templates to modify the appearance and functionality of collection pages. By using a template suffix, Shopify allows the assignment of different templates to different collections, enabling the merchant to customize how each collection is displayed to customers. The "collection_template_suffix" is the part of the template file name that appears after "collection." (e.g., "collection.special" where "special" is the suffix). This dimension is useful in e-commerce data analysis for understanding how different collections are presented to customers and potentially analyzing the impact of different page layouts or designs on customer engagement or sales.
vendor
Type:
string
Description: The "vendor" dimension in Shopify represents the manufacturer, wholesaler, or distributor of a product. This dimension is used to categorize and organize products based on their source or brand, which can be particularly useful in analyzing sales data, managing inventory, and assessing the performance of different suppliers. In Shopify's product catalog, each product can have a vendor attribute, allowing merchants to easily filter and report on inventory or orders by vendor.
product_image
Type:
string
Description: The "product_image" dimension in the context of Shopify's Admin REST API refers to the visual representation of a product that is used in an online store. It typically includes the URL or path to the image file that visually depicts the product, which can be used on product detail pages, in listings, and wherever a product might be displayed within the storefront or back-end. These images help attract and inform customers, providing a crucial aspect of the browsing and selection experience in e-commerce. This dimension is essential for showcasing the product's aesthetic and functional attributes, potentially influencing purchasing decisions.
fulfillment_location_id
Type:
string
Description: The dimension "fulfillment_location_id" in Shopify represents the unique identifier for the location from which an order is fulfilled. This ID is linked to a specific physical location, such as a warehouse or a store, where inventory is stored and managed. During the fulfillment process, this ID helps in tracking which location is responsible for fulfilling a particular order, aiding in inventory management, logistics, and reporting.
fulfillment_location_name
Type:
string
Description: The dimension "fulfillment_location_name" in Shopify refers to the name of the location from which an order is fulfilled. This can represent the warehouse, store, or any other physical facility where the items in an order are picked, packed, and shipped to the customer. It helps in tracking and managing inventory across different locations and assists in order fulfillment processes by identifying the specific place responsible for dispatching the goods.
customer_first_order_month
Type:
date
Description: The "customer_first_order_month" dimension represents the month in which a customer made their first purchase on a Shopify store. This dimension is derived by examining a customer's order history and identifying the specific month and year of their initial transaction. It can be used in e-commerce data analysis to understand customer acquisition trends, cohort analysis, and to evaluate marketing campaign effectiveness over time. By analyzing this dimension, businesses can gain insights into the timing of customer onboarding and tailor their strategies accordingly.
customer_order_number
Type:
integer
Description: The "customer_order_number" dimension represents the sequential number assigned to an order by a specific customer within Shopify. It is a unique identifier for each order placed by a customer, often used to track and reference individual orders in customer service and reporting. This number is typically sequential for each customer, starting from their first purchase, and helps distinguish one customer's orders from another's, providing easier order management and organization for merchants.
store
Type:
string
Description: The "store" dimension in Shopify typically represents the specific online shop or storefront on the Shopify platform. Each store is essentially a unique entity within Shopify, identified by a unique store name or store ID. It encompasses all the settings, products, orders, and other data specific to that particular business or merchant using Shopify's services. In e-commerce analysis, this dimension is used to segment and analyze data at the level of individual storefronts, allowing merchants or analysts to assess performance, sales, and other metrics within each separate Shopify store.
customer_id
Type:
string
Description: The "customer_id" dimension represents a unique identifier for a customer in the Shopify platform. This ID is used to distinguish individual customers across various data records and transactions. In the context of Shopify's Admin REST API, the "customer_id" is associated with customer accounts and orders, allowing you to link specific orders, actions, and marketing insights to the respective customer who made a purchase or engaged with the store. This is crucial for customer relationship management, enabling merchants to track purchase history, segment customers, and personalize marketing strategies.
timezone
Type:
string
Description: The "timezone" dimension in Shopify's context represents the time zone setting of the store as configured in the Shopify admin. This dimension is crucial for understanding the timing of order-related activities and sales performance since it dictates how dates and times are displayed and processed in reports and analyses. It ensures that all time-dependent data, such as order timestamps and customer interactions, are accurately aligned with the store's local time zone rather than defaulting to a standard time like UTC. This dimension is especially important for businesses operating across multiple time zones, allowing them to effectively plan and analyze their operations based on their specific local time settings.
klaviyo_acquisition_channel
Type:
string
Description: The dimension "klaviyo_acquisition_channel" refers to the specific channel or source through which a customer was acquired, as identified and tracked by Klaviyo, a popular email marketing and customer engagement platform often integrated with Shopify. This dimension helps merchants understand the origin or path through which new or existing customers engaged with their store, potentially through campaigns like email marketing, social media, ads, or other channels Klaviyo can track. Understanding this dimension allows businesses to analyze and optimize their marketing strategies to improve customer acquisition and retention.
customer_lifetime_duration
Type:
string
Description: The dimension key "customer_lifetime_duration" in the context of Shopify and e-commerce data analysis typically refers to the total time span from when a customer places their first order to their most recent order. It is a measure of how long a customer has been active on the store, providing insight into customer loyalty and engagement over time. This metric can be used to analyze customer behavior, retention, and the effectiveness of marketing strategies designed to prolong customer relationships.
customer_email
Type:
string
Description: The "customer_email" dimension in Shopify represents the email address associated with a customer who has placed an order. This dimension is used to identify and track individual customers, enabling retailers to analyze customer behavior, send order confirmations, and facilitate communications. In the context of Shopify's data, the "customer_email" serves as a unique identifier for customer interactions and order processing within the e-commerce platform.
customer_name
Type:
string
Description: The "customer_name" dimension in Shopify e-commerce analysis represents the full name of the customer associated with a particular order. This is typically a combination of the first and last names of the customer who placed the order. It's used to identify and analyze customer-related data within the context of orders, allowing businesses to track purchasing behavior and patterns linked to individual customers.
customer_email_marketing_consent_state
Type:
string
Description: The dimension "customer_email_marketing_consent_state" represents the current status of a customer's consent to receive marketing emails. This value indicates whether a customer has opted in or out of email marketing communications. It is used to manage and track customer preferences regarding promotional emails and ensure compliance with privacy regulations. Common states include "subscribed" (indicating consent has been given), "unsubscribed" (indicating consent has been withdrawn), or "not_subscribed" (indicating that the customer has never opted in). This dimension is essential for segmenting customers and targeting marketing campaigns effectively.
customer_email_marketing_consent_opt_in_level
Type:
string
Description: The "customer_email_marketing_consent_opt_in_level" dimension represents the level or status of consent given by a customer for receiving marketing communications via email. In the context of e-commerce and Shopify, this typically indicates how a customer's permission to receive marketing emails is recorded or classified, such as:
Subscribed: The customer has explicitly opted in to receive marketing emails.
Unsubscribed: The customer has opted out or has not subscribed to receive marketing emails.
Pending: The customer's consent is in a pending state, possibly due to an incomplete opt-in process.
This dimension is crucial for understanding and managing customer engagement strategies, ensuring compliance with email marketing regulations, and tailoring marketing efforts based on customer preferences.
company_billing_address
Type:
string
Description: The dimension "company_billing_address" in Shopify's e-commerce data analysis represents the billing address associated with a company's order. This typically includes details such as the company's name, street address, city, state or province, postal code, and country where the billing information is sent or registered. It is used to identify and verify the company responsible for the payment of the order. This dimension is crucial for processing payments, fraud prevention, and financial reporting in e-commerce.
company_shipping_address
Type:
string
Description: The "company_shipping_address" dimension in a Shopify context typically represents the shipping address associated with a company for an order placed on a Shopify store. This dimension would detail the address where goods are intended to be delivered, including information such as the company name, street address, city, state or province, postal code, and country. It is a part of the order data used in analyzing and managing shipments within an e-commerce business. This dimension is crucial for logistics and fulfillment processes, ensuring that orders are shipped to the correct location specified by the customer.
days_since_first_order
Type:
integer
Description: The "days_since_first_order" dimension in Shopify represents the number of days that have passed since a customer placed their first order on a Shopify store. This metric is typically used to analyze customer purchasing behavior over time, allowing merchants to understand how recently a customer made their initial purchase and to segment customers based on their engagement and loyalty. By tracking this dimension, store owners can tailor marketing strategies and offerings to re-engage customers who have not made a purchase for a significant period or to reward loyal customers who have been with the store for a longer duration.
months_since_first_order
Type:
integer
Description: The dimension "months_since_first_order" typically represents the number of months that have passed since a customer placed their first order on the Shopify store. This dimension is used in e-commerce data analysis to track customer longevity and engagement with the store over time. It helps businesses understand customer retention patterns and allows for segmenting customers based on how long they have been purchasing from the store. This metric is valuable for analyzing customer loyalty and targeting marketing efforts accordingly.
customer_lifespan_in_days
Type:
integer
Description: The dimension "customer_lifespan_in_days" represents the number of days between the first purchase and the latest purchase made by a customer on a Shopify store. It measures how long a customer has been active or engaged with the store, from their initial transaction to their most recent one. This metric helps businesses understand customer engagement and retention over time.
market_id
Type:
string
Description: The "market_id" in Shopify represents a unique identifier for a specific market associated with an order or a store. In the context of Shopify's multi-market features, a market typically refers to a geographic region, a specific currency, or a particular language setting in which a store operates. This dimension allows merchants to analyze and differentiate data based on various markets where they sell their products, enabling more targeted market analysis and strategy development.
market_name
Type:
string
Description: The "market_name" dimension in Shopify e-commerce data analysis refers to the name of the marketplace or sales channel where the order was placed. This can include various sales channels that a Shopify store might be utilizing, such as online storefronts, physical retail locations, mobile applications, social media platforms, or third-party marketplaces. The dimension helps merchants understand the origin of their sales, allowing them to analyze performance across different channels and make informed decisions regarding marketing and inventory strategies.
market_handle
Type:
string
Description: The "market_handle" dimension in Shopify typically refers to a unique identifier or handle for a specific market or sales channel associated with an order or product. In the context of e-commerce, a market or sales channel could be a specific storefront, platform, region, or method by which products are sold (e.g., online store, point of sale, wholesale). This dimension allows businesses to segment and analyze data based on the source or environment in which transactions occur, providing insights into performance across different sales channels.
customer_id
Type:
string
Description: The "customer_id" dimension represents a unique identifier for a customer in the Shopify platform. This ID is used to distinguish individual customers across various data records and transactions. In the context of Shopify's Admin REST API, the "customer_id" is associated with customer accounts and orders, allowing you to link specific orders, actions, and marketing insights to the respective customer who made a purchase or engaged with the store. This is crucial for customer relationship management, enabling merchants to track purchase history, segment customers, and personalize marketing strategies.
purchase_type
Type:
string
Description: The dimension "purchase_type" in the context of Shopify's e-commerce data analysis typically refers to the classification of a transaction based on how the purchase was made. This can include distinctions like "online" for purchases made through an e-commerce platform, "in-store" for physical store purchases using Shopify POS, or other types of specific transaction methods. This dimension helps businesses analyze and differentiate between various sales channels or methods through which customers place orders. It provides insights into customer purchasing behavior and helps in strategic decision-making regarding sales channels.
utm_source
Type:
string
Description: The "utm_source" dimension in Shopify data analysis represents the specific source or channel where the traffic originated before arriving at your Shopify store. This is part of the UTM parameters used in tracking the performance of marketing campaigns. Typically, "utm_source" is used to identify the platform or entity, such as a search engine (Google), social network (Facebook), or newsletter (Email), that directed a user to your site. Utilizing "utm_source" helps merchants analyze and compare the effectiveness of different traffic sources in generating visits, conversions, or sales within the Shopify platform.
utm_campaign
Type:
string
Description: The "utm_campaign" dimension in Shopify's context typically refers to a tracking parameter used within URLs to identify the specific marketing campaign that brought a visitor to an online store. This parameter is a part of the UTM (Urchin Tracking Module) system, which is used for tracking the effectiveness of online marketing campaigns across different traffic sources.
In e-commerce data analysis, "utm_campaign" helps store owners and marketers understand which marketing initiatives are generating traffic and conversions. When a user clicks on a link with UTM parameters included, such as in an email, a social media post, or an online ad, the "utm_campaign" value specifies the name or code of the marketing campaign responsible for that visit or sale. This information is crucial for assessing campaign performance and optimizing marketing strategies.
utm_medium
Type:
string
Description: The "utm_medium" dimension in Shopify's context refers to a UTM parameter that helps track the medium through which website traffic arrives at the store, particularly related to marketing campaigns. It is a key component of UTM tracking codes, which are used to gauge the effectiveness of online marketing efforts. In e-commerce data analysis, "utm_medium" specifies the marketing or advertising medium, such as email, social, CPC (cost-per-click), or any other channel that directs traffic to the store. By analyzing "utm_medium," merchants can understand which marketing channels are most effective in driving traffic and conversions on their Shopify store.
utm_content
Type:
string
Description: The "utm_content" dimension in Shopify's context refers to a parameter typically used in marketing and advertising tracking. It is part of the UTM (Urchin Tracking Module) parameters that are appended to URLs for tracking purposes. Specifically, "utm_content" is often used to differentiate variations of the same ad or link. This can include identifying specific elements such as different ads within a campaign, versions of an email, or various banners on a website.
In e-commerce data analysis within Shopify, "utm_content" helps merchants track the effectiveness of these specific elements by capturing and reporting the data on interactions or conversions that occur from these different variants. By analyzing the "utm_content" data, merchants can understand which content segments perform best and optimize their marketing strategies accordingly.
utm_term
Type:
string
Description: The "utm_term" dimension in Shopify's e-commerce data represents the keyword or term that a visitor used in a search engine, which led them to a marketing campaign or directly to the store. This is often used in pay-per-click (PPC) campaigns to track the specific search terms that drove traffic to the website. In essence, "utm_term" helps store owners understand which keywords are effectively attracting visitors to their online store, aiding in the analysis and optimization of marketing strategies.
utm_campaign_id
Type:
string
Description: The "utm_campaign_id" is a dimension used in e-commerce data analysis to track the specific marketing campaign that led customers to visit a Shopify store or make a purchase. It's part of the UTM (Urchin Tracking Module) parameters, which are tags added to the URL of marketing materials like emails, ads, or social media posts. The "utm_campaign_id" specifically identifies the unique ID of the campaign, allowing Shopify store owners to analyze the effectiveness of their marketing efforts and understand which campaigns are driving traffic and conversions. This can help in optimizing marketing strategies and allocating resources effectively.
campaign_id
Type:
string
Description: The dimension key "campaign_id" in the context of Shopify and common e-commerce terminology typically represents an identifier associated with a specific marketing or advertising campaign. This ID is used to track and attribute orders, sales, or customer interactions to particular promotional efforts. By using "campaign_id," businesses can analyze the performance of various marketing campaigns, understand which initiatives are driving sales, and optimize their marketing strategy accordingly. It helps in linking the sales data back to specific campaigns run through different advertising platforms or marketing channels.
utm_ad_id
Type:
string
Description: The dimension "utm_ad_id" in Shopify represents a unique identifier associated with a specific advertisement or marketing campaign. It is typically used to track and analyze the effectiveness of marketing efforts by linking user activity or conversions back to the particular ad that attracted the customer's attention. In the context of Shopify and e-commerce, this identifier helps merchants understand which ads are driving traffic and sales, allowing for more informed marketing decisions and optimizations. The "utm_ad_id" is commonly used in conjunction with other UTM parameters to provide a comprehensive picture of campaign performance across various channels.
channel
Type:
string
Description: In the context of Shopify and e-commerce data analysis, the "channel" dimension refers to the various platforms or pathways through which sales or interactions occur. This could include different sales channels like the online store, point of sale (POS), mobile apps, third-party marketplaces (such as Amazon or eBay), and social media platforms. In Shopify's Admin REST API, the "channel" dimension helps businesses track and analyze where their sales are originating, enabling them to better understand customer behavior and optimize their sales strategies across different platforms.
channel_touchpoints
Type:
string
Description: [{'type': 'header', 'text': 'Channel Touchpoints'}, {'type': 'paragraph', 'text': 'Shows the touchpoints that triggered a new session on your store, and are eligible for attribution.'}, {'type': 'paragraph', 'text': "To see all touchpoints, including those that didn't initiate a session, open order details."}]
channel_touchpoints_count
Type:
integer
Description: The dimension "channel_touchpoints_count" in the context of Shopify and e-commerce analytics typically refers to the number of interactions or 'touchpoints' a customer has with various sales channels before making a purchase. These touchpoints can include browsing a product via different channels such as online stores, social media, mobile apps, or physical retail locations. This count helps businesses understand the customer's journey and how various channels contribute to sales, aiding in the analysis of multi-channel marketing effectiveness and customer behavior patterns.
first_touch_channel
Type:
string
Description: The "first_touch_channel" dimension in Shopify represents the initial marketing or traffic source through which a customer discovered or interacted with the store for the first time before making a purchase. This could include sources such as search engines, social media platforms, email campaigns, or direct visits. Understanding the first_touch_channel helps store owners analyze and optimize their marketing efforts by identifying which channels effectively lead new customers to their store.
last_touch_channel
Type:
string
Description: The "last_touch_channel" dimension in Shopify e-commerce data analysis refers to the final marketing channel through which a customer interacted before completing a purchase. This dimension helps businesses understand which channel was most effective in converting a visitor into a buyer, providing insights that can aid in optimizing marketing strategies. It typically captures information such as direct, organic search, paid search, email, social media, or referral traffic as the last touchpoint leading to the conversion. This data is crucial for attribution analysis and for assessing the performance of different marketing campaigns.
first_touch_campaign
Type:
string
Description: The "first_touch_campaign" dimension in Shopify e-commerce data analysis typically represents the marketing campaign that initially attracted a customer to your store, which eventually led to a purchase. This dimension tracks the first interaction or touchpoint a customer had with your marketing efforts, helping you understand which campaign was responsible for initially capturing the customer’s interest. This can be particularly useful for attribution analysis, as it allows you to evaluate the effectiveness of different marketing campaigns in terms of initiating customer relationships.
last_touch_campaign
Type:
string
Description: The "last_touch_campaign" dimension in Shopify e-commerce data analysis represents the marketing campaign through which a customer interacted with the store most recently before completing a purchase. This dimension attributes the conversion to the last campaign the customer engaged with, helping merchants understand which marketing efforts were most effective in driving sales. It's useful for analyzing the performance of various campaigns and understanding the customer journey leading to a purchase.
account_id
Type:
string
Description: The "account_id" dimension in Shopify's e-commerce data analysis typically represents a unique identifier for a specific account within the Shopify platform. In the context of Shopify's Admin REST API, it is often used to identify and differentiate between different accounts, such as merchant accounts or customer accounts, depending on the specific use case. This identifier is important for organizing and managing data related to orders, customers, and other entities within the Shopify ecosystem. It helps in attributing actions, transactions, or entities to the correct account in e-commerce analysis and operations.
account_name
Type:
string
Description: The "account_name" dimension in the context of Shopify's e-commerce data analysis typically represents the name associated with a Shopify account or store. This dimension is used to identify and differentiate between various Shopify accounts or merchants within data reports and analyses. It helps in organizing and filtering data based on the specific Shopify store or account being analyzed, allowing users to perform store-specific analytics and gain insights into the performance and operations of individual stores.
campaign
Type:
string
Description: In the context of e-commerce data analysis, the "campaign" dimension typically refers to a marketing or sales initiative designed to promote products and drive sales. This dimension is used to track and analyze the performance of specific campaigns, enabling merchants to assess the effectiveness of their marketing efforts.
In Shopify, while there isn't a direct reference to a "campaign" dimension within the Admin REST API specifically for orders, this term can often be associated with marketing or referral data that tracks how customers are directed to the store (e.g., via UTM parameters, referral codes, or specific promotions). This helps merchants evaluate the source of their traffic and determine which marketing strategies are contributing to conversions and sales.
is_paid_channel
Type:
boolean
Description: The dimension "is_paid_channel" typically indicates whether a sale or order originates from a paid marketing channel. In the context of Shopify and e-commerce, this might reflect if the traffic leading to a sale was generated through paid advertising efforts, such as Google Ads, Facebook Ads, or other paid digital marketing campaigns. This dimension helps businesses analyze the impact and ROI of their paid marketing activities by distinguishing between orders from paid channels and those from organic or unpaid sources.
order_is_only_refunds_or_edits
Type:
boolean
Description: The dimension "order_is_only_refunds_or_edits" likely represents a specific attribute of an order in Shopify's e-commerce data analysis framework. This dimension would identify orders that exclusively consist of refunds or edits, meaning the order did not include any new or fulfilled items that were successfully delivered to the customer. Instead, the order was entirely made up of refund transactions or modifications (edits) to previous orders. This dimension helps in distinguishing typical sales orders from those that are merely administrative adjustments or corrections within the Shopify platform.
order_is_only_refunds_or_edits_or_non_items
Type:
boolean
Description: The dimension "order_is_only_refunds_or_edits_or_non_items" likely represents a classification of Shopify orders based on their content and status. Specifically, it indicates whether an order is composed solely of refunds, edits, or items that do not involve physical goods. This could include cases where:
The entire order total is made up of refunds, suggesting a return or cancellation.
The order has been edited to the point where only non-item related changes (like discounts or price adjustments) remain.
The items listed are non-physical products, such as digital downloads or service-based products, not requiring shipment or inventory considerations.
In summary, this dimension serves to identify orders that do not include typical shippable or inventory-related items, instead consisting solely of adjustments, refunds, or non-tangible product entries.
order_includes_refunds
Type:
boolean
Description: The dimension "order_includes_refunds" represents a binary indicator that specifies whether an order contains any refunded items or transactions. In the context of Shopify's e-commerce data analysis, this dimension helps in identifying orders that have had financial adjustments due to returns or exchanges, allowing businesses to distinguish between fully processed sales and those that required some level of refund processing.
utm_adset
Type:
string
Description: The "utm_adset" dimension in the context of e-commerce data analysis on Shopify refers to a specific parameter used in tracking and analytics that identifies the advertising set associated with a particular visitor or transaction. In digital marketing, an "ad set" is a grouping of ads that share the same budget, audience targeting, and delivery criteria within an advertising campaign. This UTM parameter is part of the URL that is used to track the performance of different ad sets across various platforms like Facebook, Google Ads, and others.
In the context of Shopify's data analysis, "utm_adset" helps merchants understand which specific ad set led users to their store and subsequently contributed to sales or interactions. This dimension is crucial for marketers to analyze the effectiveness and return on investment (ROI) of different ad sets within their campaigns, allowing optimizations for better targeting and budget allocation.
utm_ad
Type:
string
Description: The "utm_ad" dimension in the context of Shopify and common e-commerce terminology typically refers to a parameter used in UTM (Urchin Tracking Module) tracking codes. Specifically, "utm_ad" is likely a custom parameter that represents the specific advertisement or promotional content that led a visitor to your website. This parameter can be used to identify the individual ad within a campaign that contributed to the traffic or conversions, helping merchants analyze which specific ads are performing best. In the Shopify ecosystem, tracking such parameters can aid in evaluating the effectiveness of different advertising strategies and optimizing marketing efforts.
utm_adset_id
Type:
string
Description: The dimension key "utm_adset_id" in e-commerce data analysis refers to a specific identifier used to track the performance of an ad set through UTM (Urchin Tracking Module) parameters. When used in the context of Shopify's data, it indicates the unique identifier for the advertisement set associated with a particular marketing campaign. This dimension allows retailers to monitor which ad sets drive traffic to their Shopify store, helping them analyze the effectiveness and ROI (Return on Investment) of different ad strategies. It is typically appended to URLs as part of the UTM parameters to facilitate detailed tracking in web analytics.
adset_id
Type:
string
Description: The dimension key "adset_id" represents the unique identifier for an ad set in advertising data associated with an e-commerce platform like Shopify. In the context of e-commerce and digital marketing, an "ad set" is part of a marketing campaign structure commonly used on platforms like Facebook Ads, where a campaign contains multiple ad sets, and each ad set contains specific targeting, budget, schedule, and bidding information. The "adset_id" is used to track and analyze the performance of specific ad sets within broader marketing campaigns. In Shopify, this data could be used to understand which ad sets are driving traffic and sales to the store.
store
Type:
string
Description: The "store" dimension in Shopify typically represents the specific online shop or storefront on the Shopify platform. Each store is essentially a unique entity within Shopify, identified by a unique store name or store ID. It encompasses all the settings, products, orders, and other data specific to that particular business or merchant using Shopify's services. In e-commerce analysis, this dimension is used to segment and analyze data at the level of individual storefronts, allowing merchants or analysts to assess performance, sales, and other metrics within each separate Shopify store.
timezone
Type:
string
Description: The "timezone" dimension in Shopify's context represents the time zone setting of the store as configured in the Shopify admin. This dimension is crucial for understanding the timing of order-related activities and sales performance since it dictates how dates and times are displayed and processed in reports and analyses. It ensures that all time-dependent data, such as order timestamps and customer interactions, are accurately aligned with the store's local time zone rather than defaulting to a standard time like UTC. This dimension is especially important for businesses operating across multiple time zones, allowing them to effectively plan and analyze their operations based on their specific local time settings.
klaviyo_acquisition_channel
Type:
string
Description: The dimension "klaviyo_acquisition_channel" refers to the specific channel or source through which a customer was acquired, as identified and tracked by Klaviyo, a popular email marketing and customer engagement platform often integrated with Shopify. This dimension helps merchants understand the origin or path through which new or existing customers engaged with their store, potentially through campaigns like email marketing, social media, ads, or other channels Klaviyo can track. Understanding this dimension allows businesses to analyze and optimize their marketing strategies to improve customer acquisition and retention.
is_gift_card
Type:
boolean
Description: The dimension key "is_gift_card" in Shopify's e-commerce data analysis represents a boolean attribute indicating whether a particular product or item in an order is a gift card. It is used to identify transactions involving gift cards, which are products that can be purchased and later redeemed as store credit. This dimension is particularly useful for distinguishing gift card transactions from the sales of other physical or digital products, allowing retailers to analyze and manage gift card usage, sales, and redemptions separately within their order data.
customer_first_order_timestamp
Type:
string
Description: The "customer_first_order_timestamp" dimension in Shopify e-commerce data analysis represents the date and time when a customer placed their first order on the Shopify store. This timestamp marks the initial transaction time registered in the system for a customer, helping merchants to identify when a customer began their purchasing journey. It is useful for analyzing customer acquisition timelines, understanding lifetime value, and segmenting customers based on their tenure with the store.
type_of_product_in_order
Type:
string
Description: The dimension "type_of_product_in_order" likely refers to the categorization or classification of products included within an order on a Shopify store. In e-commerce and within Shopify's context, this dimension would typically be used to identify the different categories or types of products (e.g., clothing, electronics, accessories) that are part of a customer's purchase order. This helps in analyzing which product types are frequently ordered, thus enabling a store owner to understand customer preferences and trends. Keep in mind that the exact implementation or presence of this dimension may require custom logic, as Shopify's standard data does not inherently categorize products without additional setup such as tags or custom product types.
customer_lifetime_duration
Type:
string
Description: The dimension key "customer_lifetime_duration" in the context of Shopify and e-commerce data analysis typically refers to the total time span from when a customer places their first order to their most recent order. It is a measure of how long a customer has been active on the store, providing insight into customer loyalty and engagement over time. This metric can be used to analyze customer behavior, retention, and the effectiveness of marketing strategies designed to prolong customer relationships.
customer_email
Type:
string
Description: The "customer_email" dimension in Shopify represents the email address associated with a customer who has placed an order. This dimension is used to identify and track individual customers, enabling retailers to analyze customer behavior, send order confirmations, and facilitate communications. In the context of Shopify's data, the "customer_email" serves as a unique identifier for customer interactions and order processing within the e-commerce platform.
customer_name
Type:
string
Description: The "customer_name" dimension in Shopify e-commerce analysis represents the full name of the customer associated with a particular order. This is typically a combination of the first and last names of the customer who placed the order. It's used to identify and analyze customer-related data within the context of orders, allowing businesses to track purchasing behavior and patterns linked to individual customers.
customer_email_marketing_consent_state
Type:
string
Description: The dimension "customer_email_marketing_consent_state" represents the current status of a customer's consent to receive marketing emails. This value indicates whether a customer has opted in or out of email marketing communications. It is used to manage and track customer preferences regarding promotional emails and ensure compliance with privacy regulations. Common states include "subscribed" (indicating consent has been given), "unsubscribed" (indicating consent has been withdrawn), or "not_subscribed" (indicating that the customer has never opted in). This dimension is essential for segmenting customers and targeting marketing campaigns effectively.
customer_email_marketing_consent_opt_in_level
Type:
string
Description: The "customer_email_marketing_consent_opt_in_level" dimension represents the level or status of consent given by a customer for receiving marketing communications via email. In the context of e-commerce and Shopify, this typically indicates how a customer's permission to receive marketing emails is recorded or classified, such as:
Subscribed: The customer has explicitly opted in to receive marketing emails.
Unsubscribed: The customer has opted out or has not subscribed to receive marketing emails.
Pending: The customer's consent is in a pending state, possibly due to an incomplete opt-in process.
This dimension is crucial for understanding and managing customer engagement strategies, ensuring compliance with email marketing regulations, and tailoring marketing efforts based on customer preferences.
company_billing_address
Type:
string
Description: The dimension "company_billing_address" in Shopify's e-commerce data analysis represents the billing address associated with a company's order. This typically includes details such as the company's name, street address, city, state or province, postal code, and country where the billing information is sent or registered. It is used to identify and verify the company responsible for the payment of the order. This dimension is crucial for processing payments, fraud prevention, and financial reporting in e-commerce.
company_shipping_address
Type:
string
Description: The "company_shipping_address" dimension in a Shopify context typically represents the shipping address associated with a company for an order placed on a Shopify store. This dimension would detail the address where goods are intended to be delivered, including information such as the company name, street address, city, state or province, postal code, and country. It is a part of the order data used in analyzing and managing shipments within an e-commerce business. This dimension is crucial for logistics and fulfillment processes, ensuring that orders are shipped to the correct location specified by the customer.
customer_total_spent
Type:
integer
Description: The dimension "customer_total_spent" in the context of Shopify e-commerce data analysis likely represents the cumulative total amount of money a customer has spent at a store over their lifetime. This metric aggregates all orders placed by the customer, providing valuable insights into customer value and purchasing behavior. It helps businesses understand the overall contribution of a customer to the store's revenue.
expenses_type
Type:
string
Description: The dimension "expenses_type" in the context of Shopify and e-commerce data analysis refers to the categorization of different types of expenses associated with running an online store. This could include cost categories like product costs, shipping expenses, payment processing fees, refunds, discounts, marketing expenses, operational costs, and more. By analyzing this dimension, businesses can better understand where their money is going and how to optimize their expenses for improved profitability and efficiency. It helps in tracking and managing various financial outflows in the e-commerce operations.
product_tag
Type:
string
Description: The "product_tag" dimension in Shopify represents the labels or keywords assigned to a product to help categorize and filter it within a store's inventory. These tags are user-defined and can be used to describe product characteristics, such as style, season, or any other relevant attributes. The purpose of product tags is to enhance the organization of products, facilitate search and navigation for customers, and enable easier merchandising and marketing strategies within the Shopify platform.
cancelled_timestamp
Type:
string
Description: The dimension "cancelled_timestamp" in Shopify represents the exact date and time when an order was cancelled. This timestamp indicates when the cancellation action was finalized in the Shopify system, providing insights into the timeline of an order's lifecycle. This can be useful for tracking order management efficiency, understanding customer behavior, or analyzing cancellation trends over time.
cancelled_date
Type:
date
Description: The "cancelled_date" dimension in the context of Shopify and e-commerce data analysis represents the specific date and time when an order was officially canceled in the Shopify platform. This timestamp indicates when the cancellation action was performed, which can help businesses track and analyze order cancellations over time, understand customer behavior, and assess any operational or logistical issues that may lead to cancellations. This data is crucial for reporting and analysis, allowing merchants to optimize their processes and improve customer satisfaction.
variant_id
Type:
string
Description: The "variant_id" in Shopify represents the unique identifier for a specific variant of a product. In e-commerce and Shopify's context, products can have multiple variants, which are different versions of the same product, distinguished by attributes like size, color, or material. Each variant is considered a distinct item with its own inventory level, price, and SKU (Stock Keeping Unit). The "variant_id" is crucial for tracking and managing these individual product variants in the Shopify system, allowing for precise inventory management, order processing, and data analysis.
sku
Type:
string
Description: In the context of Shopify and e-commerce data analysis, the dimension key "sku" stands for "Stock Keeping Unit." It is an alphanumeric code used to uniquely identify a specific product or variant in your inventory. The SKU is crucial for inventory management, allowing merchants to track products, manage stock levels, and streamline operations. Each SKU is unique to a variant of a product, which means even different sizes or colors of the same product will typically have different SKUs. This helps ensure that the right product is tracked and sold, reducing errors and improving order fulfillment efficiency.
customer_first_order_skus
Type:
string
Description: The dimension "customer_first_order_skus" represents the Stock Keeping Units (SKUs) associated with the first order placed by a customer. In Shopify, an SKU is a unique identifier for each distinct product and its variations, such as size or color. This dimension is valuable for analyzing purchasing behavior and trends by identifying which specific products initiated a customer's shopping journey with a store. It helps in understanding initial customer preferences and can be crucial for targeting marketing and retention strategies.
skus_in_order
Type:
string
Description: The dimension "skus_in_order" refers to the total number of distinct Stock Keeping Units (SKUs) present within a single order. In the context of Shopify's e-commerce data, a SKU is a unique identifier for each distinct product or item variant sold through the platform. Therefore, "skus_in_order" counts how many different product variants have been purchased in a particular order, regardless of the quantity of each variant. This metric is useful for understanding the diversity of products within an order and can help in analyzing purchase patterns and inventory distribution.
product_titles_in_order
Type:
string
Description: The dimension "product_titles_in_order" in Shopify e-commerce data analysis represents a list of the titles of all products included in a specific order. Each product in the order is identified by its title, providing a human-readable way to understand which products were purchased as part of that order. This dimension helps merchants analyze sales trends by reviewing the actual names of products sold in each transaction. This can be particularly useful for reporting and insights into popular products and customer purchasing behavior.
vendors_in_order
Type:
string
Description: The "vendors_in_order" dimension represents the list of distinct suppliers or brands associated with the products included in a specific order. In the context of Shopify, a vendor is typically the entity that manufactures, sells, or supplies a particular product listed in the store. This dimension helps in analyzing an order by identifying the different vendors whose products have been purchased, which can be useful for inventory management, order fulfillment, and vendor performance analysis.
product_types_in_order
Type:
string
Description: The dimension "product_types_in_order" represents a list or set of distinct product types present in a particular order. Each product type corresponds to a specific category or classification assigned to products within a Shopify store. This dimension helps identify and analyze the variety of product categories included in a single order. It is useful for understanding customer purchasing patterns and for inventory and sales analysis by categorizing items under various product types defined in the store.
product_tags
Type:
string
Description: The "product_tags" dimension in Shopify represents a set of descriptive labels or keywords assigned to a product. These tags are used to categorize and organize products within a Shopify store, making it easier for both store owners and customers to search for and filter products. Tags can denote various attributes like season, material, style, or any other classification relevant to the product. They enhance the browsing and searching experience by allowing products to be grouped or queried based on these associated tags.
customer_first_order_product_titles
Type:
string
Description: The dimension key "customer_first_order_product_titles" represents the titles of the products that a customer purchased in their first order with the store. This information is typically used to understand what products first attracted and converted a customer, which can be important for marketing and analytics purposes. By analyzing this data, merchants can identify which products are most effective at drawing in new customers.
customer_first_order_vendors
Type:
string
Description: The dimension "customer_first_order_vendors" in the context of Shopify e-commerce data analysis refers to the list of vendors associated with the products purchased in a customer's first order on the platform. This dimension helps in understanding which vendors initially attracted customers, providing insights into vendor performance in acquiring new customers. When analyzing customer purchase behavior, this dimension can reveal trends or patterns about the vendors that are effective in generating customers' first-time purchases.
customer_first_order_product_types
Type:
string
Description: The dimension "customer_first_order_product_types" refers to the types or categories of products that a customer purchased in their very first order with a store on the Shopify platform. This dimension helps businesses analyze customer behavior by understanding what types of products tend to attract new customers. By examining this data, merchants can identify trends or patterns in product categories that successfully convert first-time visitors into buyers. This information can be useful for marketing, inventory management, and strategic planning to optimize the onboarding of new customers and drive future sales.
product_id
Type:
string
Description: The "product_id" dimension in Shopify represents the unique identifier for a specific product within a store. This identifier is used to distinguish each product in the store's database, facilitating product management, tracking inventory levels, and analyzing sales performance. In the context of Shopify's Admin REST API, "product_id" is used to retrieve or manipulate data related to a particular product, such as fetching product details, updating information, or generating sales reports.
variant_title
Type:
string
Description: The "variant_title" dimension in Shopify refers to the title of a specific product variant. In e-commerce, a product variant is a version of a product that has different attributes, such as size, color, or material. The "variant_title" provides a concise description of these attributes for a particular product variant. For example, if a product is a t-shirt available in different sizes and colors, the "variant_title" might specify "Large / Red" to indicate the specific variant. This dimension is useful for distinguishing between different versions of the same product in data analysis and reporting.
product_title
Type:
string
Description: The dimension key "product_title" in Shopify represents the name or title of a product as it appears in the Shopify store. This is the human-readable name that merchants assign to each product to describe it to potential buyers. It is a key attribute used for identifying, categorizing, and displaying products across the Shopify ecosystem, including orders, reports, and the storefront. The "product_title" is significant for customer-facing interactions and helps in distinguishing products in the merchant's inventory.
product_type
Type:
string
Description: The "product_type" dimension in Shopify represents a categorization attribute that describes the category to which a product belongs. It is used to group and organize products within the store, making it easier to manage inventory, analyze sales data, and enhance the shopping experience. This categorization can be based on characteristics such as the product's intended use, design, or target market. Examples of product types might include "Apparel," "Electronics," "Home Goods," etc. Merchants can utilize this attribute to filter products, create collections, and run specific analysis on product categories.
product_status
Type:
string
Description: The "product_status" dimension in Shopify's context represents the current state or condition of a product in the Shopify store's inventory. It typically indicates whether a product is available for purchase or not, and can include various statuses such as:
Active: The product is available and visible to customers. It can be purchased through the online store or other sales channels.
Draft: The product is not yet available for purchase. It might be a new product that is still being set up or edited.
Archived: The product is no longer active and is removed from sales channels but is retained in the store's records for future reference or reporting.
Understanding "product_status" is crucial for managing inventory, sales, and marketing strategies within a Shopify store.
collection_title
Type:
string
Description: The "collection_title" dimension in Shopify refers to the name of a collection within a Shopify store. A collection is a group of products that are organized together, typically for marketing or navigational purposes. This can include groupings like "Summer Sale," "New Arrivals," or "Best Sellers." The "collection_title" helps store owners and analysts categorize and analyze sales and performance data specific to each collection. By examining this dimension, businesses can gain insights into how various collections are performing and make informed decisions on merchandising and promotions.
collection_id
Type:
string
Description: The "collection_id" in Shopify refers to the unique identifier for a collection, which is a grouping of products in a Shopify store. Collections are used to organize products into categories, making it easier for customers to find items. These collections can be based on various attributes, such as product type, vendor, price range, or custom criteria set by the store owner. The "collection_id" allows for tracking and referencing specific collections within Shopify's Admin REST API and facilitates the analysis of product grouping and categorization in e-commerce data.
collection_handle
Type:
string
Description: The "collection_handle" dimension in Shopify refers to a unique identifier for a specific collection within a Shopify store. Collections are groups of products organized together under a common theme or category, making it easier for customers to browse and find products. The "handle" is a URL-friendly version of the collection's name, typically in lowercase and with spaces replaced by hyphens. This handle is used in the store's URLs and the Shopify API to reliably reference a collection across different parts of the Shopify platform.
collection_template_suffix
Type:
string
Description: The "collection_template_suffix" in Shopify refers to the template suffix used to render a specific collection page within a Shopify store. In Shopify, merchants can create custom templates to modify the appearance and functionality of collection pages. By using a template suffix, Shopify allows the assignment of different templates to different collections, enabling the merchant to customize how each collection is displayed to customers. The "collection_template_suffix" is the part of the template file name that appears after "collection." (e.g., "collection.special" where "special" is the suffix). This dimension is useful in e-commerce data analysis for understanding how different collections are presented to customers and potentially analyzing the impact of different page layouts or designs on customer engagement or sales.
url
Type:
string
Description: In the context of Shopify's e-commerce data analysis and using common e-commerce terminology, the dimension key "url" typically represents a web address or link associated with a specific entity or action within the Shopify platform. This might include:
Product URL: The web link to a specific product page on the online store, enabling direct access to the product's detailed information and purchase options.
Order URL: A unique link that merchants can use to view order details in the Shopify admin interface.
Collection URL: The link directing users to a collection page where multiple products are grouped together based on specific attributes like category, type, etc.
Customer URL: A link to view a specific customer's details within the Shopify admin.
In a broader sense, when analyzing Shopify data, the "url" dimension could be utilized to associate user interactions with specific pages, track referral paths, manage SEO attributes, or offer direct navigation to key resources in Shopify's ecosystem.
inventory_management
Type:
string
Description: The "inventory_management" dimension in Shopify refers to how inventory levels for a product variant are tracked and managed. Specifically, it indicates whether Shopify or another external system is responsible for managing the inventory of a product variant. If "inventory_management" is set to Shopify, it means that Shopify will automatically update the inventory count as orders are placed and items are fulfilled. If it's set to an external system, that system will handle inventory updates and Shopify will not modify these counts automatically. This dimension is crucial for understanding and analyzing how inventory is controlled across different sales channels and fulfillment processes.
product_image
Type:
string
Description: The "product_image" dimension in the context of Shopify's Admin REST API refers to the visual representation of a product that is used in an online store. It typically includes the URL or path to the image file that visually depicts the product, which can be used on product detail pages, in listings, and wherever a product might be displayed within the storefront or back-end. These images help attract and inform customers, providing a crucial aspect of the browsing and selection experience in e-commerce. This dimension is essential for showcasing the product's aesthetic and functional attributes, potentially influencing purchasing decisions.
vendor
Type:
string
Description: The "vendor" dimension in Shopify represents the manufacturer, wholesaler, or distributor of a product. This dimension is used to categorize and organize products based on their source or brand, which can be particularly useful in analyzing sales data, managing inventory, and assessing the performance of different suppliers. In Shopify's product catalog, each product can have a vendor attribute, allowing merchants to easily filter and report on inventory or orders by vendor.
customer_first_order_month
Type:
date
Description: The "customer_first_order_month" dimension represents the month in which a customer made their first purchase on a Shopify store. This dimension is derived by examining a customer's order history and identifying the specific month and year of their initial transaction. It can be used in e-commerce data analysis to understand customer acquisition trends, cohort analysis, and to evaluate marketing campaign effectiveness over time. By analyzing this dimension, businesses can gain insights into the timing of customer onboarding and tailor their strategies accordingly.
customer_first_order_date
Type:
date
Description: The dimension "customer_first_order_date" refers to the date when a customer made their first purchase on the Shopify store. This data point is used to track when a customer began their relationship with the store by making their initial order. It helps store owners analyze customer acquisition patterns, understand customer lifetime value, and segment customers based on the duration of their loyalty.
sales_channel
Type:
string
Description: In the context of Shopify's Admin REST API and e-commerce data analysis, the "sales_channel" dimension represents the platform or method through which an order or transaction is made. This could include online stores, physical retail locations, mobile apps, social media platforms, marketplaces, or any other integrated sales channel that a merchant uses to sell their products. The "sales_channel" helps in categorizing and analyzing sales data based on where the sales originate, allowing merchants to assess the performance of different sales channels and make informed strategic decisions.
sales_channel_name
Type:
string
Description: The "sales_channel_name" dimension represents the specific platform or medium through which an order was placed or a sale was processed within a Shopify store. This can include various sales channels such as the online store, point of sale (POS), mobile app, social media platforms like Facebook or Instagram, and other third-party marketplaces that are integrated with Shopify. By analyzing this dimension, merchants can gain insights into which channels are performing best and strategize accordingly to optimize their sales efforts across different platforms.
order_tag
Type:
string
Description: The dimension "order_tag" in Shopify represents a label or keyword assigned to an order within the Shopify platform. Order tags are used to categorize, organize, and manage orders more effectively. Merchants can apply one or multiple tags to each order to denote special characteristics, conditions, or handling instructions. For example, tags can be used to indicate that an order is a priority, requires gift wrapping, or belongs to a specific marketing campaign. These tags are highly customizable and serve as an efficient means for filtering and searching orders in the Shopify admin dashboard.
order_tags_in_order
Type:
string
Description: The dimension "order_tags_in_order" in Shopify represents the tags associated with a particular order. In Shopify, tags are used to categorize and organize orders for better management and analysis. These tags can be applied manually by a store owner or automatically through apps and workflows based on certain criteria. The "order_tags_in_order" dimension helps in filtering and analyzing order data based on these tags, allowing store owners to identify patterns or group orders with similar characteristics. This dimension is particularly useful for segmenting orders for reporting, fulfillment, and customer service purposes.
billing_country
Type:
string
Description: The "billing_country" dimension in Shopify represents the country associated with the billing address provided by the customer during the checkout process. This dimension indicates the country to which the billing address belongs, usually corresponding to the location of the customer's payment method, such as a credit card. It is a vital piece of information used for understanding customer demographics, regional sales reporting, and potentially for assessing tax liabilities and compliance with international shipping regulations.
customer_tag
Type:
string
Description: The dimension key "customer_tag" in Shopify represents labels or keywords assigned to customers that help categorize them based on certain characteristics or behaviors. These tags allow merchants to segment their customer base for targeted marketing, personalized experiences, and better customer management. For example, a customer might have tags like "VIP," "Newsletter Subscriber," or "Wholesale Client." The "customer_tag" is useful for filtering and organizing customers within the Shopify platform, enabling merchants to tailor their interactions and offerings accordingly.
order_discount_code
Type:
string
Description: The "order_discount_code" dimension in Shopify e-commerce data analysis represents the code or identifier used for a discount applied to an order. This code typically corresponds to promotional discounts, coupons, or special offers that customers can enter during the checkout process to receive a reduction in price. The dimension captures the specific discount code used for a given order, allowing businesses to analyze the effectiveness and usage of various discount campaigns and promotions.
order_discount_code_amount
Type:
string
Description: The dimension "order_discount_code_amount" in Shopify refers to the total amount of discounts that have been applied to an order as a result of discount codes. Discount codes are promotional codes that customers can enter at checkout to receive a reduction in the order price. This particular dimension captures the cumulative value of all such reductions applied to the order, reflecting how much the order total has been decreased due to the use of discount codes.
order_discount_code_type
Type:
string
Description: The dimension "order_discount_code_type" in Shopify refers to the classification of discount codes applied to an order. In the context of Shopify's e-commerce platform, discount codes are promotional codes that customers can enter at checkout to receive deductions on their purchase total. These discount codes can be of various types, such as:
Percentage Discount: The discount code reduces the order total by a certain percentage.
Fixed Amount Discount: The discount code reduces the order total by a specific flat amount.
Free Shipping: The discount code provides free shipping for the order.
Buy X Get Y: The discount code triggers an offer such as buying a certain quantity of items to get additional items free or at a discounted rate.
The "order_discount_code_type" dimension helps in identifying the type of discount applied, allowing merchants and analysts to assess the effectiveness and impact of different types of promotions on sales and customer behavior.
is_cancelled
Type:
boolean
Description: The "is_cancelled" dimension in Shopify's context typically refers to whether an order has been canceled or not. This dimension would indicate a boolean value:
true
if the order has been canceled andfalse
if it remains active or unfulfilled. In e-commerce, tracking whether an order is canceled is crucial for understanding order status, managing inventory, and analyzing sales metrics. When referencing the Shopify Admin REST API, this dimension helps in filtering or identifying orders that have been canceled during the processing lifecycle.
shipping_country
Type:
string
Description: The "shipping_country" dimension in Shopify refers to the country to which an order is being shipped. It represents the destination country specified in the shipping address associated with a customer's order. This dimension is vital for analyzing sales distribution across different countries, understanding international shipping needs, and tailoring marketing strategies to various geographic regions. The value of "shipping_country" is typically formatted as a two-letter ISO 3166-1 alpha-2 country code.
user_type
Type:
string
Description: The "user_type" dimension in the context of Shopify's e-commerce data analysis typically refers to the classification of users interacting with your store, primarily indicating whether a user is a "guest" or a "registered customer." This dimension helps in segmenting users based on their account status or interaction level with the store.
Guest: A user who makes a purchase without creating an account or logging into an existing account on the Shopify store.
Registered Customer: A user who has created an account or logged into an existing account on the Shopify store before making a purchase.
Understanding the "user_type" dimension allows businesses to analyze purchasing behavior and engagement for different customer segments, facilitating more targeted marketing strategies and personalized shopping experiences.
store_currency
Type:
string
Description: The dimension "store_currency" in Shopify represents the currency that a store is set up to use for its operations, transactions, and financial reporting. This currency is used as the default currency for displaying product prices, processing orders, and generating financial reports within the Shopify store. It is defined in the store's settings and ensures consistency for financial data analysis and customer transactions.
processing_method
Type:
string
Description: The "processing_method" dimension in Shopify's context refers to the method by which a payment was processed for an order. This dimension indicates the mechanism through which the transaction was completed, such as whether it was handled through a manual payment, an automatic capture of funds, or other specific methods associated with payment gateways integrated into the store. Understanding this dimension helps in analyzing payment trends and processing efficiency within the e-commerce store.
payment_gateway_names
Type:
string
Description: The "payment_gateway_names" dimension in Shopify represents the name(s) of the payment gateway(s) used to process transactions for an order. In the context of Shopify's Admin REST API and e-commerce data analysis, this dimension provides insights into which payment service providers are being utilized for processing payments, such as PayPal, Stripe, or Shopify Payments. It helps in understanding the distribution of payment preferences among customers and can be used for reporting and analytics to optimize payment options offered in the store.
referring_site
Type:
string
Description: The "referring_site" dimension in Shopify e-commerce data analysis represents the URL of the website that directed a customer to the Shopify store, leading to a transaction. This field helps in tracking the source of incoming traffic that results in sales, providing insights into the effectiveness of external websites or marketing channels in driving purchases. This can include search engines, social media platforms, affiliate links, or other websites. Understanding the referring sites can assist businesses in optimizing their marketing strategies and partnerships.
referring_source
Type:
string
Description: The "referring_source" dimension in Shopify e-commerce data analysis represents the origin or medium through which a customer was directed to your online store before making a purchase. This dimension helps identify how customers found your store, whether it was through search engines, social media, direct links, ads, or other referral channels. Understanding the "referring_source" allows you to evaluate the effectiveness of your marketing channels and optimize your strategies for driving traffic to your store.
processed_timestamp
Type:
string
Description: The "processed_timestamp" dimension in the context of Shopify e-commerce data analysis refers to the specific date and time when an order is processed. This timestamp indicates when the order has transitioned from pending or unfulfilled to a stage where it is confirmed for fulfillment. It is crucial for understanding the timeline and efficiency of order processing within the store’s operations. This dimension helps in tracking operational performance and can be used to analyze how quickly orders are being processed after they are placed. The "processed_timestamp" is typically presented in ISO 8601 format, providing a precise and standardized time reference.
processed_date
Type:
date
Description: The "processed_date" dimension in Shopify refers to the date and time when an order was processed. In the context of order management and e-commerce operations, this typically means the date when the order has been prepared for fulfillment, such as being packaged, labeled, or otherwise confirmed for shipping to the customer. This timestamp is crucial for tracking fulfillment operations and for understanding the efficiency of order processing workflows. In data analysis, this information can be used to evaluate order processing times, ensure timely fulfillment, and improve overall customer satisfaction by analyzing the gap between order placement and processing.
updated_timestamp
Type:
string
Description: The "updated_timestamp" dimension in the context of Shopify's Admin REST API typically represents the exact date and time when the resource, such as an order, was last modified. This timestamp indicates the most recent update made to the record, whether that update involved a change in order status, a modification of the order details, or any other update action performed. It is essential for tracking the latest activity on an order and is crucial for tasks like synchronization, data consistency, and audit trails in e-commerce operations.
updated_date
Type:
date
Description: The "updated_date" dimension in Shopify e-commerce data typically represents the date and time when a specific record, such as an order, product, or customer, was last modified or updated in the Shopify system. This includes any changes made to the record's details, such as status updates, edits to product descriptions, changes in customer information, or any other modifications. The "updated_date" helps in tracking the most recent changes to the record and can be useful for analyzing trends, syncing data, and maintaining accurate records over time.
customer_order_number
Type:
integer
Description: The "customer_order_number" dimension represents the sequential number assigned to an order by a specific customer within Shopify. It is a unique identifier for each order placed by a customer, often used to track and reference individual orders in customer service and reporting. This number is typically sequential for each customer, starting from their first purchase, and helps distinguish one customer's orders from another's, providing easier order management and organization for merchants.
customer_order_segment
Type:
string
Description: The "customer_order_segment" dimension in the context of Shopify e-commerce data analysis likely refers to the categorization or grouping of customers based on their purchasing behavior or order characteristics. This might include segmenting customers into different groups based on criteria such as the frequency of purchases, order value, recency of their last purchase, or other buying patterns. Utilizing this dimension allows businesses to analyze and understand the different segments of their customer base, tailor marketing strategies, and improve customer engagement by identifying key segments like loyal customers, high-spending customers, or new customers. While this specific term is not explicitly detailed in the Shopify API documentation, it aligns with common e-commerce practices of using customer segmentation for actionable insights.
order_id
Type:
string
Description: The "order_id" dimension in Shopify refers to the unique identifier assigned to each individual order placed through a Shopify store. This ID is a distinct numerical value that allows merchants and systems to track, manage, and reference specific orders. It is crucial for order management, enabling actions such as order retrieval, fulfillment, and analysis. The "order_id" is utilized in various API calls to access detailed information about an order, including customer details, products purchased, payment, and shipping information.
order_number
Type:
string
Description: The "order_number" dimension in Shopify represents a unique identifier assigned to each order in a sequential manner. This number is used to track and reference individual orders within the Shopify platform. It typically begins with a starting number (usually 1001 for new stores) and increments by one for each subsequent order. It's important to note that the "order_number" is distinct from the "id" or "order_id," which is a globally unique identifier (GUID) used internally by Shopify. The "order_number" is often used in customer communication and reports as it is more user-friendly and easier to reference when compared to the internal IDs.
refund_id
Type:
string
Description: The "refund_id" in Shopify represents a unique identifier for a refund transaction associated with an order. When a refund is processed on an order, it is assigned a specific "refund_id" to distinguish it from other refunds or transactions. This ID is used to track and manage the refund details within the Shopify system, such as the refunded amount, items refunded, and date of the refund. It is a critical dimension for analyzing refund activities related to customer orders in e-commerce data analysis.
is_refund
Type:
boolean
Description: The "is_refund" dimension in the context of Shopify's e-commerce data analysis typically indicates whether a particular transaction or order line item involves a refund. When this dimension is true, it signifies that the transaction is a refund, meaning money has been returned to the customer for that portion of the order. This can help merchants identify and analyze refunds separately from sales, allowing for better financial tracking and customer service assessments.
pos_location_name
Type:
string
Description: The "pos_location_name" dimension in Shopify typically represents the name of the physical location or retail store where a point of sale (POS) transaction occurs. In the context of e-commerce data analysis, this dimension is used to identify and differentiate sales based on the specific physical location where the order was processed. This is particularly useful for merchants who operate multiple physical stores or outlets, allowing them to analyze and compare sales performance across different locations.
financial_status
Type:
string
Description: The "financial_status" dimension in Shopify's context refers to the current state of an order in terms of its payment processing. It indicates whether the payment for an order has been successfully completed, is pending, has failed, or has been refunded, among other potential statuses. This dimension is crucial for understanding the financial progress and completion status of an order. Common statuses include "paid", "pending", "authorized", "partially_paid", "refunded", and "voided". Each status helps merchants track and manage the financial lifecycle of orders.
fulfillment_status
Type:
string
Description: The "fulfillment_status" dimension in Shopify refers to the current state of an order's fulfillment process. It indicates whether the items in an order have been shipped or delivered to the customer. Common statuses include:
unfulfilled: No items in the order have been fulfilled.
partial: Some items in the order have been fulfilled, while others have not.
fulfilled: All items in the order have been fulfilled and shipped to the customer.
This dimension is used to track and manage the shipping of products, providing vital information on order processing and delivery progress.
shipping_city
Type:
string
Description: The "shipping_city" dimension in Shopify represents the city name to which an order is being shipped. This is extracted from the shipping address provided by the customer during the checkout process. It is a crucial component in order fulfillment and logistics, helping businesses to analyze shipping patterns and optimize delivery services based on geographical data.
shipping_country_code
Type:
string
Description: The dimension "shipping_country_code" in Shopify e-commerce data analysis represents the ISO 3166-1 alpha-2 country code for the destination country to which a customer's order is being shipped. This two-letter code is used to identify the specific country where the order's shipping address is located. For example, "US" would indicate that the shipment is going to the United States, while "CA" would represent Canada. This dimension is useful for analyzing and segmenting orders based on their shipping destinations.
shipping_province
Type:
string
Description: The "shipping_province" dimension in Shopify refers to the specific province or state to which an order is being shipped. This dimension is part of the shipping address information provided by the customer during the checkout process. It helps in analyzing order distribution based on geographic regions, calculating shipping costs, and understanding sales trends within specific areas. This dimension is particularly important for merchants who operate in regions with province-specific taxation or shipping regulations.
shipping_province_code
Type:
string
Description: The "shipping_province_code" dimension in Shopify represents the specific code or abbreviation of the province or state to which an order is being shipped. This dimension is used to identify the regional area within a country that is the destination for the shipment, helping with logistical planning, tax calculations, and geographic sales analysis.
shipping_zip
Type:
string
Description: The "shipping_zip" dimension in Shopify e-commerce data represents the postal or ZIP code of the shipping address associated with a specific order. It indicates the geographic area to which the order is being shipped and is a component of the broader shipping address information. This dimension is often used in data analysis to understand regional shipping patterns, calculate shipping costs, assess delivery zones, or conduct targeted marketing efforts based on geographic location.
billing_city
Type:
string
Description: The "billing_city" dimension in Shopify refers to the city specified in the billing address of an order. This information is captured when a customer makes a purchase and provides their payment details. It represents the city where the billing address is located, which is typically the address associated with the payment method used for the transaction. This dimension is useful for analyzing geographic trends in sales and understanding the distribution of customers by city location.
billing_country_code
Type:
string
Description: The "billing_country_code" dimension in Shopify represents the two-letter ISO 3166-1 alpha-2 country code for the country associated with the billing address provided by the customer during the checkout process. This code indicates the country where the billing information, such as the customer's payment details, is registered. This dimension is commonly used in e-commerce data analysis to segment orders or examine purchasing trends based on the geographical location of the billing address.
billing_province
Type:
string
Description: The "billing_province" dimension in Shopify refers to the state, region, or province associated with the billing address of an order. This dimension captures the geographic administrative area where the billing information of the customer is located. It is a part of the billing address details provided by the customer during the checkout process. Understanding the "billing_province" can be useful for analyzing regional sales trends, tax calculations, and customer demographics in e-commerce data.
billing_province_code
Type:
string
Description: The dimension "billing_province_code" in Shopify refers to the standardized code representing the province or region of the billing address associated with an order. This code is typically a short form or abbreviation used to identify the geographic area within the billing country. For example, in Canada, it would be the two-letter code for the province such as "ON" for Ontario. This dimension is useful in e-commerce data analysis for identifying and segmenting orders based on the billing region, which can help in understanding customer demographics and regional sales patterns.
billing_zip
Type:
string
Description: In the context of Shopify and e-commerce data analysis, the dimension key "billing_zip" represents the postal or ZIP code associated with a customer's billing address for an order. This is the ZIP code where the customer receives their credit card statements or bills, which is collected during the checkout process. It is important for verifying the customer's billing information and can be used for analysis related to the geographical distribution of customers, as well as for fraud prevention and payment processing purposes.
taxes_included
Type:
boolean
Description: The "taxes_included" dimension in Shopify represents a Boolean value indicating whether the prices of items in an order include applicable taxes. When this dimension is set to "true," it means that the tax amounts are already included in the item prices shown to the customer. Conversely, if it is "false," taxes are calculated and added separately at checkout. This setting can affect how prices are displayed to customers and how tax calculations are handled during the ordering process.
note
Type:
string
Description: In the context of Shopify's Admin REST API and e-commerce terminology, the dimension "note" refers to an optional field associated with an order that can be used by merchants to add internal comments or additional information about that order. This field is not visible to customers and is typically used by store staff for various purposes such as recording special instructions, noting customer preferences, or documenting other relevant information that assists in processing the order internally.
app_id
Type:
string
Description: The dimension key "app_id" in the context of Shopify's Admin REST API typically represents the unique identifier of an application that is integrated or used within a Shopify store. This ID helps track and attribute certain activities or data points back to the specific app responsible for them. For example, if an app processes an order or contributes to a sales channel, the "app_id" dimension would be used to identify which app handled or influenced that part of the transaction. This is important for merchants to analyze the performance and impact of different apps on their store's activities.
cancel_reason
Type:
string
Description: The "cancel_reason" dimension in Shopify represents the reason why an order was canceled in the system. It provides context for cancellations, helping merchants understand the circumstances under which orders do not proceed to fulfillment. Common reasons include:
Customer - The customer requested the cancellation.
Fraud - The order was identified as fraudulent.
Inventory - The items in the order are out of stock.
Other - Any other reason not specifically categorized.
This dimension is useful for analyzing cancellation trends and improving operations related to order processing and customer satisfaction.
checkout_token
Type:
string
Description: The "checkout_token" in Shopify represents a unique identifier for a checkout session. When a customer initiates the checkout process on a Shopify store, a token is generated to track this specific checkout session. This token ensures that all actions and data—such as items in the cart, customer information, and shipping details—are consistently associated with the individual checkout as the customer progresses towards completing their purchase. In the context of data analysis, the "checkout_token" allows you to analyze and track specific checkout sessions, which can be useful for understanding conversion rates, identifying abandoned checkouts, and personalizing the checkout experience.
customer_locale
Type:
string
Description: The "customer_locale" dimension in Shopify represents the language and regional settings that the customer used when placing an order. This locale setting typically includes information about the customer's language preference and geographical location, formatted in a standard locale code (e.g., "en-US" for English - United States). It helps businesses understand and analyze the diversity of their customer base in terms of language and regional preferences, allowing them to tailor their marketing strategies and communications accordingly.
device_id
Type:
string
Description: In the context of Shopify's e-commerce data analysis, "device_id" typically refers to a unique identifier associated with the device used by a customer to place an order or interact with the online store. This dimension helps track and analyze user behavior across different devices, such as smartphones, tablets, or computers. By understanding device usage, merchants can optimize their store's performance on various platforms and tailor their marketing strategies to target users based on their preferred device types. The "device_id" can play a crucial role in personalizing the shopping experience and improving conversion rates by providing insights into the most commonly used devices among the store's customers.
landing_site_ref
Type:
string
Description: The "landing_site_ref" dimension in Shopify represents the reference information or the URL of the site from which a customer was referred or directed before making a visit or purchase on the Shopify store. It is essentially the referral source, helping store owners understand the origin of their incoming traffic, often used to analyze the effectiveness of marketing campaigns or track how external links drive traffic to their store.
presentment_currency
Type:
string
Description: The "presentment_currency" dimension in Shopify represents the currency in which prices are shown to customers on the storefront. It is particularly relevant in international stores that display prices in local currencies based on the buyer's location or preference. This currency setting helps customers understand product prices in a familiar currency and can differ from the shop's base currency, which is the primary currency set for transactions and reporting in the Shopify admin.
reference
Type:
string
Description: In the context of Shopify's Admin REST API and e-commerce terminology, the "reference" dimension typically represents a unique identifier used to correlate or track specific transactions, orders, or interactions. While it is not explicitly detailed in the API documentation you've linked, "reference" often serves as a custom field that a merchant or external system can use to assign their own meaningful identifier or code to an order or customer interaction. This could be a purchase order number, a transaction code provided by a payment processor, or any other alphanumeric string that helps in associating Shopify data with other business processes or systems.
source_identifier
Type:
string
Description: The dimension "source_identifier" in Shopify typically refers to a unique identifier associated with the source of an order. This can represent different sales channels or platforms from which the order originated, such as a specific online store, a third-party sales channel, or an internal sales tool. In the context of Shopify's ecosystem, it helps merchants and analysts track and distinguish the origins of orders for better sales channel management and performance analysis.
For more detailed information, you can refer to Shopify's API documentation linked in your question, specifically in the contexts where this dimension is applied, such as order reporting and analytics.
landing_site_base_url
Type:
string
Description: The dimension "landing_site_base_url" in the context of Shopify's e-commerce data represents the base URL of the landing page where a customer first arrives before making a purchase. In essence, it captures the initial web address that directs a visitor to an online store, which can be crucial for understanding traffic sources and marketing effectiveness. This URL often comes from external sources such as advertisements, referral links, or email campaigns. Analyzing this dimension helps store owners determine which channels are successfully driving traffic to their site.
order_status_url
Type:
string
Description: The "order_status_url" dimension in Shopify represents a URL that leads to a customer-facing webpage where they can view the current status of their order. This page typically provides information such as whether the order has been processed, shipped, or delivered. The URL is unique for each order and allows customers to track their order updates without needing to log into their Shopify account. This dimension is especially useful for providing transparency and enhancing the customer experience by making order tracking accessible and straightforward.
adset_name
Type:
string
Description: The "adset_name" dimension in e-commerce and advertising analysis typically refers to the name assigned to a specific ad set within an advertising campaign. In platforms like Facebook Ads or Google Ads, an ad set is a group of advertisements that share the same audience targeting, budget, schedule, and bidding strategy. The "adset_name" helps marketers and analysts identify and report on the performance of that particular group of ads, including metrics such as impressions, clicks, conversions, and revenue attributed to those ads. In the context of Shopify, while the platform itself may not natively manage ad campaign details, "adset_name" could be used in data integrations or reporting tools to align Shopify's sales data with advertising performance data from external sources.
ad_name
Type:
string
Description: The "ad_name" dimension typically represents the name or identifier of a specific advertisement or marketing campaign that led to a customer interaction, such as a visit to a Shopify store or a purchase. This dimension is crucial for tracking the effectiveness of different advertising efforts across platforms. It allows merchants to attribute sales or traffic to specific ads or campaigns, enabling them to analyze and optimize their marketing strategies. This information usually comes from tracking pixels or parameters appended to URLs, and it helps in evaluating the return on investment for various advertising channels used by the store.
first_click_attribution_window_in_days
Type:
integer
Description: The dimension "first_click_attribution_window_in_days" in Shopify's e-commerce data analysis refers to the time frame, measured in days, during which the initial interaction or click from a customer on a marketing campaign is attributed to a subsequent purchase. This means that if a customer first clicks on an advertisement or promotional link, any purchase they make within this specified number of days will be attributed to that initial click, for the purposes of analyzing the effectiveness of the marketing campaign. This dimension helps businesses understand the influence of their marketing efforts over a period of time and how long it typically takes for customers to make a purchase after their first interaction.
first_event_time
Type:
N/A
Description: No description available.
last_event_time
Type:
N/A
Description: No description available.
ga_campaign
Type:
string
Description: The dimension "ga_campaign" in e-commerce data analysis represents the campaign name associated with Google Analytics tracking. It is used to identify and attribute the traffic coming to a Shopify store from specific marketing campaigns. When a URL includes UTM parameters, such as "utm_campaign", Google Analytics can track which marketing efforts are driving users to the site. In the context of Shopify, "ga_campaign" helps store owners understand which campaigns are leading to orders and conversions, allowing them to assess the effectiveness of their marketing strategies.
ga_medium
Type:
string
Description: The dimension key "ga_medium" in the context of Shopify e-commerce data analysis generally refers to the medium through which customers arrived at your online store, often related to Google's analytics parameters. It is a part of UTM parameters used in campaign tagging. The "medium" dimension helps in identifying the type of channel or pathway utilized in driving traffic. Common examples include "organic," "cpc" (cost-per-click), "email," "referral," and "social." This information is essential for understanding the performance of different marketing channels and optimizing marketing strategies accordingly. Although "ga_medium" is not directly specified in the Shopify Admin REST API for orders, it can be integrated into analytics for tracking and performance purposes.
ga_source
Type:
string
Description: The dimension "ga_source" typically represents the origin or source of traffic that leads a user to an e-commerce site, often in the context of Google Analytics data integrated with Shopify. This dimension identifies where a user came from before visiting or making a purchase on your Shopify store. Common sources include search engines (like Google), social media platforms (like Facebook), referral sites, or direct traffic. This allows merchants to analyze the effectiveness of various marketing channels and optimize their strategies accordingly.
ga_source_raw
Type:
string
Description: The "ga_source_raw" dimension in Shopify's e-commerce data analysis represents the original source from which a buyer originated when visiting your online store. This could include various channels such as direct traffic, search engines, social media platforms, referral links, or email campaigns. This dimension is useful for understanding the effectiveness of different traffic sources in driving visitors to your store, allowing you to analyze and optimize your marketing strategies accordingly.
ga_channel_grouping
Type:
string
Description: The "ga_channel_grouping" dimension is typically related to Google Analytics and represents the categorization of your incoming website traffic based on the channel through which users arrived at your store. In the context of Shopify and e-commerce data analysis, this dimension helps you understand the sources of your website visitors, such as Organic Search, Direct, Paid Search, Social, Referral, Email, or other custom campaign channels.
Each channel grouping provides insights into the effectiveness of different marketing efforts and traffic sources, allowing you to analyze user behavior and sales performance from each channel. This categorization is crucial for assessing the ROI of your marketing campaigns and making informed decisions about where to allocate resources to maximize online sales and customer engagement.
is_order_edit
Type:
string
Description: The dimension "is_order_edit" in the context of Shopify's Admin REST API likely represents whether an order has been edited after its initial creation. It would be a boolean value where "true" indicates that the order has undergone changes (such as updates to products, quantities, or customer details) after being placed, and "false" signifies that the order remains in its original state without any modifications. This dimension helps merchants and analysts track and assess the frequency and impact of order modifications on their e-commerce operations.
client_details_user_agent
Type:
string
Description: The "client_details_user_agent" dimension in Shopify represents the user agent string sent by the browser or device that a customer used to access your Shopify store. This string includes information about the customer's browser type and version, operating system, and device details. It is used to help identify the software and device configuration of the visitor, which can be useful for understanding customer behavior, troubleshooting issues, or optimizing the user experience across different platforms and devices.
order_line_properties
Type:
string
Description: The "order_line_properties" dimension in Shopify represents a set of custom information or metadata that can be associated with individual items within an order. These properties are typically used to store additional details that are not covered by the standard product attributes. For example, "order_line_properties" might include custom engraving messages, gift wrap instructions, or other personalized options selected by the customer during checkout. These properties are key-value pairs and provide merchants with flexibility to capture specific information related to each product variant within an order.
shipping_method
Type:
string
Description: The "shipping_method" dimension in Shopify represents the type of delivery service chosen by a customer for an order. This includes information such as the name or type of shipping service (e.g., standard shipping, express delivery), which is generally specified during the checkout process. This dimension helps in analyzing logistics and shipping preferences, allowing merchants to understand customer choices related to the speed and cost of delivery.
order_processed_date
Type:
date
Description: The dimension "order_processed_date" in Shopify's data analysis likely represents the date on which an order has been completed in terms of processing. This includes all necessary steps from payment confirmation, inventory checks, and fulfillment preparation before transitioning to shipment. While the specific term may not be directly found in the Shopify Admin REST API, in common e-commerce contexts, it refers to the point at which the order is fully processed and ready for delivery, symbolizing the backend completion of an order's handling.
order_processed_timestamp
Type:
datetime
Description: [{'type': 'header', 'text': 'Order Processed Timestamp'}, {'type': 'paragraph', 'text': 'Shown in the timezone of the store on which the order was placed.'}]
selling_plan_id
Type:
string
Description: The dimension key "selling_plan_id" in Shopify represents the unique identifier for a selling plan associated with an order, product, or line item. Selling plans are part of Shopify's subscription or installment offerings, allowing merchants to offer products on a recurring basis or as part of a payment plan. This identifier links the order or item to a specific plan that dictates the terms and frequency of purchase, such as weekly, monthly, or custom intervals. It is used to manage and track the specifics of such plans across Shopify's platform.
selling_plan_name
Type:
string
Description: The "selling_plan_name" dimension in Shopify refers to the name of the specific selling plan associated with a product or an order. Selling plans are used in Shopify to define subscription or recurring purchase options for products. For example, a selling plan might be a monthly subscription for a product, and the "selling_plan_name" would identify the specific plan name set by the merchant, such as "Monthly Subscription" or "Weekly Delivery Plan." This dimension allows merchants and analysts to segment and analyze orders or sales data based on the different subscription offerings available within their store.
fulfillment_location_id
Type:
string
Description: The dimension "fulfillment_location_id" in Shopify represents the unique identifier for the location from which an order is fulfilled. This ID is linked to a specific physical location, such as a warehouse or a store, where inventory is stored and managed. During the fulfillment process, this ID helps in tracking which location is responsible for fulfilling a particular order, aiding in inventory management, logistics, and reporting.
fulfillment_location_name
Type:
string
Description: The dimension "fulfillment_location_name" in Shopify refers to the name of the location from which an order is fulfilled. This can represent the warehouse, store, or any other physical facility where the items in an order are picked, packed, and shipped to the customer. It helps in tracking and managing inventory across different locations and assists in order fulfillment processes by identifying the specific place responsible for dispatching the goods.
line_type
Type:
string
Description: In the context of Shopify's e-commerce data analysis, the dimension "line_type" typically refers to the categorization of each line item within an order. This dimension helps distinguish between different kinds of items or services included in an order. Specifically, in Shopify, "line_type" can differentiate between:
Product: This indicates a standard item sold and shipped to a customer. It is the typical line item representing goods being purchased.
Shipping line: Represents shipping charges associated with the order. This helps in analyzing the cost impact of shipping without conflating it with the revenue from product sales.
Discount: Covers discount codes or price reductions applied to the order, which is important for analyzing promotional impacts.
Tax line: Represents tax charges applied to an order, useful for tracking tax-related costs and governmental obligations.
Understanding "line_type" is crucial for parsing order data correctly, enabling businesses to analyze sales performance, manage inventory, and evaluate the effectiveness of promotions or burden of additional charges.
To see detailed information on "line_type" via Shopify's Admin REST API, you can refer to the endpoint related to orders, which will provide you with the specific types of line items and their attributes for further analysis.
cost_type
Type:
string
Description: The "cost_type" dimension in the context of Shopify e-commerce data analysis typically refers to the classification of different types of costs associated with an order. This can include various expenses such as:
Product Costs: Direct costs related to the production or acquisition of the goods sold.
Shipping Costs: Expenses incurred for delivering the product to the customer.
Transaction/Payment Fees: Costs associated with processing customer payment methods.
Handling Fees: Fees related to preparing the product for shipment.
Duty and Import Taxes: Additional charges for international orders.
This categorization helps businesses analyze and manage their expenditures by understanding which parts of the order fulfillment process are more costly, allowing for better financial planning and pricing strategies.
fairing_question_id
Type:
string
Description: The dimension key "fairing_question_id" in Shopify's context typically refers to an identifier associated with a specific question from Fairing, a tool used for post-purchase surveys or other types of customer feedback. When an order is placed, Fairing can present a survey to the customer, and each possible question within this survey is assigned a unique identifier, known as the "fairing_question_id". This ID allows you to track responses to specific questions on orders, providing insights into customer preferences, behaviors, or feedback directly related to the purchase journey.
fairing_question
Type:
string
Description: The dimension "fairing_question" likely refers to a custom or internal attribute used within Shopify or a specific application or integration to track or manage specific questions or survey responses related to a customer's order or shopping experience. The term "fairing" might not directly correspond to a standard Shopify attribute but could be associated with third-party apps or custom fields used for collecting feedback or data relevant to customer interactions and order processing. This dimension would be useful for analyzing customer feedback patterns and improving customer service or product offerings based on the responses collected.
fairing_question_type
Type:
string
Description: The dimension key "fairing_question_type" in the context of Shopify's e-commerce data analysis likely refers to the categorization of survey or feedback questions presented to customers during their shopping experience. Specifically, this could be linked to the Fairing app (formerly EnquireLabs Post Purchase Surveys), which is used to gather insights from customers via surveys at different touchpoints, such as post-purchase or during checkout. The "question type" dimension would denote the type or nature of questions being asked, such as multiple-choice, open-ended, or rating scale questions. This categorization helps businesses analyze and report on customer feedback efficiently.
fairing_response_id
Type:
string
Description: The dimension key "fairing_response_id" in the context of Shopify analytics likely refers to an identifier for responses or data processed by a Shopify Fairing. Fairings in Shopify are features or functionalities that collect and process data, often used for enhancing customer engagement or operational workflows. The "fairing_response_id" would be a unique identifier associated with a specific response or instance of data processed by such a feature, enabling detailed tracking and analysis in e-commerce data.
fairing_response
Type:
string
Description: The dimension key "fairing_response" does not directly appear in Shopify's Admin REST API documentation or common e-commerce terminology specifically related to standard dimensions or metrics. However, based on the context of Shopify and e-commerce, it is likely that "fairing_response" refers to a system or component within Shopify that deals with responses or data related to integrations, extensions, or enhancements.
In general, "fairing" in tech might refer to a service or module that aids in extensions or communication with external systems. Therefore, if "fairing_response" is used in the context of Shopify data analysis, it might represent responses or data captured as part of an integration process, potentially relating to third-party apps, AI enhancements, or similar.
For precise usage, the specific context in which "fairing_response" appears should be reviewed, possibly in custom reports or scripts involving Shopify's APIs, to better understand the exact nature of this dimension.
fairing_response_position
Type:
string
Description: The dimension "fairing_response_position" is not a standard term within Shopify's Admin REST API or commonly used e-commerce terminology. However, a fairing in e-commerce can typically refer to a system or feature that gathers customer feedback or responses, such as surveys or form submissions on a website.
Based on this understanding, "fairing_response_position" could represent the position or order in which a specific response or interaction occurred within a series of responses from a customer feedback mechanism. This could be useful in analyzing the sequence of interactions or understanding at what point in a user journey specific feedback was provided.
For more precise information, you might want to consult further Shopify documentation or specific implementation guides related to any custom surveys, feedback tools, or apps you are using that integrate with Shopify.
fairing_is_other
Type:
boolean
Description: The dimension key "fairing_is_other" in the context of Shopify's Admin REST API and common e-commerce terminology likely refers to categorizing orders or items that do not fit into the predefined segments of standard analysis or sales channels provided by Shopify.
In e-commerce data analysis, segments or classifications might include various channels like physical retail, online storefront, marketplaces, etc. The term "fairing" isn't standard in e-commerce; however, in this context, it appears to be a part of a broader categorization system. Hence, "fairing_is_other" would indicate that the item or order has been classified as 'other' due to it not falling into the main predefined categories.
This dimension might be useful for identifying and analyzing portions of sales or orders that come from unconventional or niche channels, providing insights into lesser-tracked areas of commerce within the Shopify ecosystem.
fairing_other_response
Type:
string
Description: The dimension "fairing_other_response" in Shopify likely relates to data collected or processed by Shopify's "Fairing" feature, which is designed to gather feedback and insights from customers. This particular dimension would represent responses or data points that do not fit into predefined categories within the Fairing system. It serves as a catch-all for any miscellaneous or unexpected responses gathered during customer interactions. In the context of e-commerce, analyzing this dimension helps businesses understand a broader range of customer feedback that might not be captured by standard survey questions.
fairing_is_clarification_question
Type:
boolean
Description: The dimension "fairing_is_clarification_question" does not directly correspond to a commonly recognized field or parameter within Shopify's Admin REST API or typical e-commerce terminology. However, based on the phrasing, it sounds like a custom attribute or tag that might be used internally for categorization or analysis.
The term "fairing" could relate to a specific product, initiative, or process within a merchant's Shopify setup, possibly referring to something like a promotional campaign, a shipping customization, or a special sales program. "Is_clarification_question" suggests this dimension might be used to denote whether a particular order or interaction required additional customer service attention for clarification purposes.
In practice, this dimension could be used by a Shopify merchant to track and analyze orders or customer interactions that pertain to a specific inquiry type or operational category. For precise understanding, it would be crucial to consult the specific implementation details or company documentation regarding this custom dimension, as it does not appear to be a standard field in Shopify's API or typical e-commerce analytics.
fairing_coupon_code
Type:
string
Description: The "fairing_coupon_code" dimension in the context of Shopify's e-commerce data likely represents a specific promotional code applied to an order. In e-commerce, a coupon code is a string of characters that shoppers can enter at checkout to receive a discount or offer on their purchase. This dimension would capture instances where this particular coupon code was used within order data, allowing for analysis on how such codes are influencing sales, customer acquisition, or retention. It can be useful for tracking the performance and effectiveness of marketing campaigns related to the coupon offers.
fairing_coupon_type
Type:
string
Description: The dimension "fairing_coupon_type" likely refers to a classification or categorization of coupon types used in promotions within the Shopify platform. In the context of e-commerce, coupons are promotional tools that provide discounts or special offers to encourage customer purchases. The "coupon type" dimension would typically describe the nature or method of the discount applied, such as percentage off, fixed amount off, buy one get one free, or free shipping. This classification helps merchants analyze the effectiveness of different promotional strategies and understand customer preferences in terms of discounts offered.
fairing_landing_page_path
Type:
string
Description: In the context of Shopify and e-commerce analysis, the dimension "fairing_landing_page_path" typically refers to the specific URL path of the landing page on a Shopify store where a customer first arrives or lands. This path can provide insights into which pages are attracting visitors initially and are part of their customer journey leading up to a purchase or interaction with the site.
When used in analytics or reporting, this dimension helps merchants understand the entry points to their site and assess the effectiveness of marketing campaigns, SEO, or external referrals. By analyzing the "fairing_landing_page_path," businesses can optimize landing pages to improve user engagement and conversion rates.
fairing_referring_site
Type:
string
Description: The "fairing_referring_site" dimension in Shopify e-commerce data analysis likely refers to the source URL or domain that directed traffic to your Shopify store before a purchase was made. This dimension helps identify where customers originated from, such as search engines, social media platforms, or other websites that referred them to your store. By understanding which sites are driving traffic and resulting in sales, merchants can better tailor their marketing and partnership strategies. This dimension is particularly useful for analyzing the effectiveness of external referrals and optimizing online presence.
fairing_utm_campaign
Type:
string
Description: The dimension key "fairing_utm_campaign" in the context of Shopify e-commerce data analysis represents a specific parameter used in UTM (Urchin Tracking Module) tracking to identify the marketing campaign that led a customer to the online store. This value is part of the URL parameters in links used in marketing efforts such as email, social media, online ads, etc. The "utm_campaign" parameter helps merchants track the effectiveness of different marketing campaigns and understand which specific campaign drives traffic, conversions, or sales on the Shopify platform.
fairing_utm_content
Type:
string
Description: The dimension key "fairing_utm_content" likely represents a parameter used in tracking and analyzing marketing campaigns related to Shopify orders. In the context of e-commerce and digital marketing, UTM parameters are tags added to the end of a URL to track the performance of marketing content and campaigns.
Specifically, "utm_content" is used to differentiate between variations of similar content or links within the same campaign. It helps to identify what specific aspect of the content led a customer to visit the website or make a purchase. This could include testing different call-to-action messages, link layouts, or even identifying specific links within a common piece of content like an email or a webpage.
In summary, "fairing_utm_content" is used in Shopify to capture and analyze which version or element of your online marketing content contributed to customer actions, enabling more precise attribution and optimization of marketing strategies.
fairing_utm_medium
Type:
string
Description: The dimension key "fairing_utm_medium" is used to track and identify the medium through which visitors to a Shopify store have discovered or accessed the site. In e-commerce data analysis, "utm_medium" is a parameter from the UTM (Urchin Tracking Module) tagging system often used in digital marketing. It specifies the medium or channel, such as email, social, CPC (cost-per-click), or organic search, that led a visitor to the store. This dimension helps merchants understand which channels are driving traffic or sales, enabling them to optimize marketing strategies accordingly. In the context of Shopify and its API, "fairing" is a specific tool or feature within Shopify that might be utilizing these UTM parameters for enhanced tracking and analytics.
fairing_utm_source
Type:
string
Description: The dimension key "fairing_utm_source" in Shopify e-commerce data analysis typically represents the source or origin of traffic that led a customer to the store. In the context of UTM parameters, which are used in URLs to track marketing campaigns, "utm_source" identifies the platform or specific source such as a search engine (e.g., Google), a newsletter, a social network (e.g., Facebook), or any other referring site. This helps store owners and analysts understand where their visitors are coming from and assess the effectiveness of different marketing channels.
In Shopify's setup, "fairing_utm_source" would track this information as part of the data collected, helping merchants analyze which sources drive the most traffic or sales through their store.
fairing_utm_term
Type:
string
Description: The dimension "fairing_utm_term" in Shopify e-commerce data analysis refers to a tracking parameter typically used in online marketing campaigns. It is part of the UTM (Urchin Tracking Module) parameters, which are used to track the effectiveness of online marketing efforts. Specifically, "utm_term" is used to identify paid search keywords.
In the context of Shopify, "fairing_utm_term" would capture the specific keyword from a paid search ad that led a customer to the store, allowing merchants to analyze which keywords are driving traffic and sales. This information is crucial for optimizing search engine advertising campaigns to improve conversion rates and return on investment (ROI).
fairing_channel
Type:
string
Description: The dimension key "fairing_channel" in Shopify refers to the sales channel through which an order was placed. Sales channels in Shopify are the platforms or mediums where products are sold, such as an online store, a mobile app, a physical point of sale, or third-party marketplaces like Amazon or eBay. The "fairing_channel" captures this information to help merchants analyze the performance of different sales channels, understand where their orders are coming from, and make informed decisions about channel strategies. This dimension can be important for understanding customer demographics, optimizing marketing efforts, and improving sales processes across different platforms.
product_weight_in_grams
Type:
integer
Description: The dimension key "product_weight_in_grams" represents the weight of a product as stored in Shopify, measured in grams. This data point is crucial for calculating shipping costs, understanding inventory management, and providing accurate product descriptions to customers. In the context of Shopify's platform, this measurement is often used in conjunction with shipping rules and integrations with shipping carriers to determine the weight-based aspects of product logistics.
market_id
Type:
string
Description: The "market_id" in Shopify represents a unique identifier for a specific market associated with an order or a store. In the context of Shopify's multi-market features, a market typically refers to a geographic region, a specific currency, or a particular language setting in which a store operates. This dimension allows merchants to analyze and differentiate data based on various markets where they sell their products, enabling more targeted market analysis and strategy development.
market_name
Type:
string
Description: The "market_name" dimension in Shopify e-commerce data analysis refers to the name of the marketplace or sales channel where the order was placed. This can include various sales channels that a Shopify store might be utilizing, such as online storefronts, physical retail locations, mobile applications, social media platforms, or third-party marketplaces. The dimension helps merchants understand the origin of their sales, allowing them to analyze performance across different channels and make informed decisions regarding marketing and inventory strategies.
market_handle
Type:
string
Description: The "market_handle" dimension in Shopify typically refers to a unique identifier or handle for a specific market or sales channel associated with an order or product. In the context of e-commerce, a market or sales channel could be a specific storefront, platform, region, or method by which products are sold (e.g., online store, point of sale, wholesale). This dimension allows businesses to segment and analyze data based on the source or environment in which transactions occur, providing insights into performance across different sales channels.
customer_first_order_date
Type:
date
Description: The dimension "customer_first_order_date" refers to the date when a customer made their first purchase on the Shopify store. This data point is used to track when a customer began their relationship with the store by making their initial order. It helps store owners analyze customer acquisition patterns, understand customer lifetime value, and segment customers based on the duration of their loyalty.
purchase_type
Type:
string
Description: The dimension "purchase_type" in the context of Shopify's e-commerce data analysis typically refers to the classification of a transaction based on how the purchase was made. This can include distinctions like "online" for purchases made through an e-commerce platform, "in-store" for physical store purchases using Shopify POS, or other types of specific transaction methods. This dimension helps businesses analyze and differentiate between various sales channels or methods through which customers place orders. It provides insights into customer purchasing behavior and helps in strategic decision-making regarding sales channels.
is_refund
Type:
boolean
Description: The "is_refund" dimension in the context of Shopify's e-commerce data analysis typically indicates whether a particular transaction or order line item involves a refund. When this dimension is true, it signifies that the transaction is a refund, meaning money has been returned to the customer for that portion of the order. This can help merchants identify and analyze refunds separately from sales, allowing for better financial tracking and customer service assessments.
first_order_sales_channel
Type:
string
Description: The "first_order_sales_channel" dimension in Shopify e-commerce data analysis represents the sales channel through which a customer made their first purchase on your store. Essentially, this dimension identifies the source or platform (such as online store, POS, mobile app, social media platform, etc.) where the customer's initial order occurred. This information is valuable for understanding customer acquisition patterns and the effectiveness of different sales channels in attracting new customers.
first_order_sales_channel_name
Type:
string
Description: The dimension "first_order_sales_channel_name" represents the name of the sales channel through which a customer made their first purchase on a Shopify store. This could include various sales platforms integrated with Shopify, such as the online store, point of sale, mobile app, Facebook shop, or other third-party sales channels. This dimension is useful for analyzing and understanding where new customers are initially engaging with the store, allowing businesses to assess the effectiveness of different sales channels in attracting first-time buyers.
shipping_country
Type:
string
Description: The "shipping_country" dimension in Shopify refers to the country to which an order is being shipped. It represents the destination country specified in the shipping address associated with a customer's order. This dimension is vital for analyzing sales distribution across different countries, understanding international shipping needs, and tailoring marketing strategies to various geographic regions. The value of "shipping_country" is typically formatted as a two-letter ISO 3166-1 alpha-2 country code.
billing_country
Type:
string
Description: The "billing_country" dimension in Shopify represents the country associated with the billing address provided by the customer during the checkout process. This dimension indicates the country to which the billing address belongs, usually corresponding to the location of the customer's payment method, such as a credit card. It is a vital piece of information used for understanding customer demographics, regional sales reporting, and potentially for assessing tax liabilities and compliance with international shipping regulations.
shipping_city
Type:
string
Description: The "shipping_city" dimension in Shopify represents the city name to which an order is being shipped. This is extracted from the shipping address provided by the customer during the checkout process. It is a crucial component in order fulfillment and logistics, helping businesses to analyze shipping patterns and optimize delivery services based on geographical data.
shipping_country_code
Type:
string
Description: The dimension "shipping_country_code" in Shopify e-commerce data analysis represents the ISO 3166-1 alpha-2 country code for the destination country to which a customer's order is being shipped. This two-letter code is used to identify the specific country where the order's shipping address is located. For example, "US" would indicate that the shipment is going to the United States, while "CA" would represent Canada. This dimension is useful for analyzing and segmenting orders based on their shipping destinations.
shipping_province
Type:
string
Description: The "shipping_province" dimension in Shopify refers to the specific province or state to which an order is being shipped. This dimension is part of the shipping address information provided by the customer during the checkout process. It helps in analyzing order distribution based on geographic regions, calculating shipping costs, and understanding sales trends within specific areas. This dimension is particularly important for merchants who operate in regions with province-specific taxation or shipping regulations.
shipping_province_code
Type:
string
Description: The "shipping_province_code" dimension in Shopify represents the specific code or abbreviation of the province or state to which an order is being shipped. This dimension is used to identify the regional area within a country that is the destination for the shipment, helping with logistical planning, tax calculations, and geographic sales analysis.
shipping_zip
Type:
string
Description: The "shipping_zip" dimension in Shopify e-commerce data represents the postal or ZIP code of the shipping address associated with a specific order. It indicates the geographic area to which the order is being shipped and is a component of the broader shipping address information. This dimension is often used in data analysis to understand regional shipping patterns, calculate shipping costs, assess delivery zones, or conduct targeted marketing efforts based on geographic location.
billing_city
Type:
string
Description: The "billing_city" dimension in Shopify refers to the city specified in the billing address of an order. This information is captured when a customer makes a purchase and provides their payment details. It represents the city where the billing address is located, which is typically the address associated with the payment method used for the transaction. This dimension is useful for analyzing geographic trends in sales and understanding the distribution of customers by city location.
billing_country_code
Type:
string
Description: The "billing_country_code" dimension in Shopify represents the two-letter ISO 3166-1 alpha-2 country code for the country associated with the billing address provided by the customer during the checkout process. This code indicates the country where the billing information, such as the customer's payment details, is registered. This dimension is commonly used in e-commerce data analysis to segment orders or examine purchasing trends based on the geographical location of the billing address.
billing_province
Type:
string
Description: The "billing_province" dimension in Shopify refers to the state, region, or province associated with the billing address of an order. This dimension captures the geographic administrative area where the billing information of the customer is located. It is a part of the billing address details provided by the customer during the checkout process. Understanding the "billing_province" can be useful for analyzing regional sales trends, tax calculations, and customer demographics in e-commerce data.
billing_province_code
Type:
string
Description: The dimension "billing_province_code" in Shopify refers to the standardized code representing the province or region of the billing address associated with an order. This code is typically a short form or abbreviation used to identify the geographic area within the billing country. For example, in Canada, it would be the two-letter code for the province such as "ON" for Ontario. This dimension is useful in e-commerce data analysis for identifying and segmenting orders based on the billing region, which can help in understanding customer demographics and regional sales patterns.
billing_zip
Type:
string
Description: In the context of Shopify and e-commerce data analysis, the dimension key "billing_zip" represents the postal or ZIP code associated with a customer's billing address for an order. This is the ZIP code where the customer receives their credit card statements or bills, which is collected during the checkout process. It is important for verifying the customer's billing information and can be used for analysis related to the geographical distribution of customers, as well as for fraud prevention and payment processing purposes.
financial_status
Type:
string
Description: The "financial_status" dimension in Shopify's context refers to the current state of an order in terms of its payment processing. It indicates whether the payment for an order has been successfully completed, is pending, has failed, or has been refunded, among other potential statuses. This dimension is crucial for understanding the financial progress and completion status of an order. Common statuses include "paid", "pending", "authorized", "partially_paid", "refunded", and "voided". Each status helps merchants track and manage the financial lifecycle of orders.
note
Type:
string
Description: In the context of Shopify's Admin REST API and e-commerce terminology, the dimension "note" refers to an optional field associated with an order that can be used by merchants to add internal comments or additional information about that order. This field is not visible to customers and is typically used by store staff for various purposes such as recording special instructions, noting customer preferences, or documenting other relevant information that assists in processing the order internally.
app_id
Type:
string
Description: The dimension key "app_id" in the context of Shopify's Admin REST API typically represents the unique identifier of an application that is integrated or used within a Shopify store. This ID helps track and attribute certain activities or data points back to the specific app responsible for them. For example, if an app processes an order or contributes to a sales channel, the "app_id" dimension would be used to identify which app handled or influenced that part of the transaction. This is important for merchants to analyze the performance and impact of different apps on their store's activities.
order_number
Type:
string
Description: The "order_number" dimension in Shopify represents a unique identifier assigned to each order in a sequential manner. This number is used to track and reference individual orders within the Shopify platform. It typically begins with a starting number (usually 1001 for new stores) and increments by one for each subsequent order. It's important to note that the "order_number" is distinct from the "id" or "order_id," which is a globally unique identifier (GUID) used internally by Shopify. The "order_number" is often used in customer communication and reports as it is more user-friendly and easier to reference when compared to the internal IDs.
fulfillment_status
Type:
string
Description: The "fulfillment_status" dimension in Shopify refers to the current state of an order's fulfillment process. It indicates whether the items in an order have been shipped or delivered to the customer. Common statuses include:
unfulfilled: No items in the order have been fulfilled.
partial: Some items in the order have been fulfilled, while others have not.
fulfilled: All items in the order have been fulfilled and shipped to the customer.
This dimension is used to track and manage the shipping of products, providing vital information on order processing and delivery progress.
processing_method
Type:
string
Description: The "processing_method" dimension in Shopify's context refers to the method by which a payment was processed for an order. This dimension indicates the mechanism through which the transaction was completed, such as whether it was handled through a manual payment, an automatic capture of funds, or other specific methods associated with payment gateways integrated into the store. Understanding this dimension helps in analyzing payment trends and processing efficiency within the e-commerce store.
referring_site
Type:
string
Description: The "referring_site" dimension in Shopify e-commerce data analysis represents the URL of the website that directed a customer to the Shopify store, leading to a transaction. This field helps in tracking the source of incoming traffic that results in sales, providing insights into the effectiveness of external websites or marketing channels in driving purchases. This can include search engines, social media platforms, affiliate links, or other websites. Understanding the referring sites can assist businesses in optimizing their marketing strategies and partnerships.
referring_source
Type:
string
Description: The "referring_source" dimension in Shopify e-commerce data analysis represents the origin or medium through which a customer was directed to your online store before making a purchase. This dimension helps identify how customers found your store, whether it was through search engines, social media, direct links, ads, or other referral channels. Understanding the "referring_source" allows you to evaluate the effectiveness of your marketing channels and optimize your strategies for driving traffic to your store.
landing_site_ref
Type:
string
Description: The "landing_site_ref" dimension in Shopify represents the reference information or the URL of the site from which a customer was referred or directed before making a visit or purchase on the Shopify store. It is essentially the referral source, helping store owners understand the origin of their incoming traffic, often used to analyze the effectiveness of marketing campaigns or track how external links drive traffic to their store.
presentment_currency
Type:
string
Description: The "presentment_currency" dimension in Shopify represents the currency in which prices are shown to customers on the storefront. It is particularly relevant in international stores that display prices in local currencies based on the buyer's location or preference. This currency setting helps customers understand product prices in a familiar currency and can differ from the shop's base currency, which is the primary currency set for transactions and reporting in the Shopify admin.
reference
Type:
string
Description: In the context of Shopify's Admin REST API and e-commerce terminology, the "reference" dimension typically represents a unique identifier used to correlate or track specific transactions, orders, or interactions. While it is not explicitly detailed in the API documentation you've linked, "reference" often serves as a custom field that a merchant or external system can use to assign their own meaningful identifier or code to an order or customer interaction. This could be a purchase order number, a transaction code provided by a payment processor, or any other alphanumeric string that helps in associating Shopify data with other business processes or systems.
source_identifier
Type:
string
Description: The dimension "source_identifier" in Shopify typically refers to a unique identifier associated with the source of an order. This can represent different sales channels or platforms from which the order originated, such as a specific online store, a third-party sales channel, or an internal sales tool. In the context of Shopify's ecosystem, it helps merchants and analysts track and distinguish the origins of orders for better sales channel management and performance analysis.
For more detailed information, you can refer to Shopify's API documentation linked in your question, specifically in the contexts where this dimension is applied, such as order reporting and analytics.
payment_gateway_names
Type:
string
Description: The "payment_gateway_names" dimension in Shopify represents the name(s) of the payment gateway(s) used to process transactions for an order. In the context of Shopify's Admin REST API and e-commerce data analysis, this dimension provides insights into which payment service providers are being utilized for processing payments, such as PayPal, Stripe, or Shopify Payments. It helps in understanding the distribution of payment preferences among customers and can be used for reporting and analytics to optimize payment options offered in the store.
landing_site_base_url
Type:
string
Description: The dimension "landing_site_base_url" in the context of Shopify's e-commerce data represents the base URL of the landing page where a customer first arrives before making a purchase. In essence, it captures the initial web address that directs a visitor to an online store, which can be crucial for understanding traffic sources and marketing effectiveness. This URL often comes from external sources such as advertisements, referral links, or email campaigns. Analyzing this dimension helps store owners determine which channels are successfully driving traffic to their site.
order_status_url
Type:
string
Description: The "order_status_url" dimension in Shopify represents a URL that leads to a customer-facing webpage where they can view the current status of their order. This page typically provides information such as whether the order has been processed, shipped, or delivered. The URL is unique for each order and allows customers to track their order updates without needing to log into their Shopify account. This dimension is especially useful for providing transparency and enhancing the customer experience by making order tracking accessible and straightforward.
pos_location_name
Type:
string
Description: The "pos_location_name" dimension in Shopify typically represents the name of the physical location or retail store where a point of sale (POS) transaction occurs. In the context of e-commerce data analysis, this dimension is used to identify and differentiate sales based on the specific physical location where the order was processed. This is particularly useful for merchants who operate multiple physical stores or outlets, allowing them to analyze and compare sales performance across different locations.
first_order_ga_source
Type:
string
Description: The dimension "first_order_ga_source" in the context of Shopify and e-commerce data analysis typically represents the source from which a customer came when they made their first purchase on the store. It is linked to Google Analytics (GA) and reflects the original traffic source or medium that led the customer to the store for their initial order. This can include sources such as direct traffic, organic search, paid search, social media, referrals, email, and others that Google Analytics categorizes. This dimension helps merchants understand where their first-time customers are originating, aiding in marketing and attribution analysis.
first_order_ga_campaign
Type:
string
Description: The dimension "first_order_ga_campaign" in the context of Shopify e-commerce data analysis likely refers to the Google Analytics campaign associated with a customer's first order. This dimension would capture the specific marketing campaign from Google Analytics that led to a customer's initial purchase on a Shopify store. It helps store owners understand which marketing efforts are effective in acquiring new customers by linking the first purchase to the campaign that influenced the customer's decision.
first_order_ga_medium
Type:
string
Description: The dimension "first_order_ga_medium" in Shopify e-commerce data analysis represents the marketing medium associated with a customer's first order. This is typically used in conjunction with Google Analytics tracking, where "ga_medium" refers to the general category of traffic source or marketing channel that brought the customer to the store for their initial purchase. Examples of mediums include "organic" (for organic search), "cpc" (cost per click for paid search), "email" (from email campaigns), and "referral" (from referring sites). This dimension helps in understanding and analyzing which marketing channels are effectively driving first-time purchases.
product_title
Type:
string
Description: The dimension key "product_title" in Shopify represents the name or title of a product as it appears in the Shopify store. This is the human-readable name that merchants assign to each product to describe it to potential buyers. It is a key attribute used for identifying, categorizing, and displaying products across the Shopify ecosystem, including orders, reports, and the storefront. The "product_title" is significant for customer-facing interactions and helps in distinguishing products in the merchant's inventory.
product_id
Type:
string
Description: The "product_id" dimension in Shopify represents the unique identifier for a specific product within a store. This identifier is used to distinguish each product in the store's database, facilitating product management, tracking inventory levels, and analyzing sales performance. In the context of Shopify's Admin REST API, "product_id" is used to retrieve or manipulate data related to a particular product, such as fetching product details, updating information, or generating sales reports.
collection_title
Type:
string
Description: The "collection_title" dimension in Shopify refers to the name of a collection within a Shopify store. A collection is a group of products that are organized together, typically for marketing or navigational purposes. This can include groupings like "Summer Sale," "New Arrivals," or "Best Sellers." The "collection_title" helps store owners and analysts categorize and analyze sales and performance data specific to each collection. By examining this dimension, businesses can gain insights into how various collections are performing and make informed decisions on merchandising and promotions.
selling_plan_id
Type:
string
Description: The dimension key "selling_plan_id" in Shopify represents the unique identifier for a selling plan associated with an order, product, or line item. Selling plans are part of Shopify's subscription or installment offerings, allowing merchants to offer products on a recurring basis or as part of a payment plan. This identifier links the order or item to a specific plan that dictates the terms and frequency of purchase, such as weekly, monthly, or custom intervals. It is used to manage and track the specifics of such plans across Shopify's platform.
is_gift_card
Type:
boolean
Description: The dimension key "is_gift_card" in Shopify's e-commerce data analysis represents a boolean attribute indicating whether a particular product or item in an order is a gift card. It is used to identify transactions involving gift cards, which are products that can be purchased and later redeemed as store credit. This dimension is particularly useful for distinguishing gift card transactions from the sales of other physical or digital products, allowing retailers to analyze and manage gift card usage, sales, and redemptions separately within their order data.
customer_first_order_timestamp
Type:
string
Description: The "customer_first_order_timestamp" dimension in Shopify e-commerce data analysis represents the date and time when a customer placed their first order on the Shopify store. This timestamp marks the initial transaction time registered in the system for a customer, helping merchants to identify when a customer began their purchasing journey. It is useful for analyzing customer acquisition timelines, understanding lifetime value, and segmenting customers based on their tenure with the store.
customer_total_spent
Type:
integer
Description: The dimension "customer_total_spent" in the context of Shopify e-commerce data analysis likely represents the cumulative total amount of money a customer has spent at a store over their lifetime. This metric aggregates all orders placed by the customer, providing valuable insights into customer value and purchasing behavior. It helps businesses understand the overall contribution of a customer to the store's revenue.
order_tag
Type:
string
Description: The dimension "order_tag" in Shopify represents a label or keyword assigned to an order within the Shopify platform. Order tags are used to categorize, organize, and manage orders more effectively. Merchants can apply one or multiple tags to each order to denote special characteristics, conditions, or handling instructions. For example, tags can be used to indicate that an order is a priority, requires gift wrapping, or belongs to a specific marketing campaign. These tags are highly customizable and serve as an efficient means for filtering and searching orders in the Shopify admin dashboard.
order_tags_in_order
Type:
string
Description: The dimension "order_tags_in_order" in Shopify represents the tags associated with a particular order. In Shopify, tags are used to categorize and organize orders for better management and analysis. These tags can be applied manually by a store owner or automatically through apps and workflows based on certain criteria. The "order_tags_in_order" dimension helps in filtering and analyzing order data based on these tags, allowing store owners to identify patterns or group orders with similar characteristics. This dimension is particularly useful for segmenting orders for reporting, fulfillment, and customer service purposes.
customer_tag
Type:
string
Description: The dimension key "customer_tag" in Shopify represents labels or keywords assigned to customers that help categorize them based on certain characteristics or behaviors. These tags allow merchants to segment their customer base for targeted marketing, personalized experiences, and better customer management. For example, a customer might have tags like "VIP," "Newsletter Subscriber," or "Wholesale Client." The "customer_tag" is useful for filtering and organizing customers within the Shopify platform, enabling merchants to tailor their interactions and offerings accordingly.
order_discount_code
Type:
string
Description: The "order_discount_code" dimension in Shopify e-commerce data analysis represents the code or identifier used for a discount applied to an order. This code typically corresponds to promotional discounts, coupons, or special offers that customers can enter during the checkout process to receive a reduction in price. The dimension captures the specific discount code used for a given order, allowing businesses to analyze the effectiveness and usage of various discount campaigns and promotions.
order_discount_code_amount
Type:
string
Description: The dimension "order_discount_code_amount" in Shopify refers to the total amount of discounts that have been applied to an order as a result of discount codes. Discount codes are promotional codes that customers can enter at checkout to receive a reduction in the order price. This particular dimension captures the cumulative value of all such reductions applied to the order, reflecting how much the order total has been decreased due to the use of discount codes.
order_discount_code_type
Type:
string
Description: The dimension "order_discount_code_type" in Shopify refers to the classification of discount codes applied to an order. In the context of Shopify's e-commerce platform, discount codes are promotional codes that customers can enter at checkout to receive deductions on their purchase total. These discount codes can be of various types, such as:
Percentage Discount: The discount code reduces the order total by a certain percentage.
Fixed Amount Discount: The discount code reduces the order total by a specific flat amount.
Free Shipping: The discount code provides free shipping for the order.
Buy X Get Y: The discount code triggers an offer such as buying a certain quantity of items to get additional items free or at a discounted rate.
The "order_discount_code_type" dimension helps in identifying the type of discount applied, allowing merchants and analysts to assess the effectiveness and impact of different types of promotions on sales and customer behavior.
is_cancelled
Type:
boolean
Description: The "is_cancelled" dimension in Shopify's context typically refers to whether an order has been canceled or not. This dimension would indicate a boolean value:
true
if the order has been canceled andfalse
if it remains active or unfulfilled. In e-commerce, tracking whether an order is canceled is crucial for understanding order status, managing inventory, and analyzing sales metrics. When referencing the Shopify Admin REST API, this dimension helps in filtering or identifying orders that have been canceled during the processing lifecycle.
store_currency
Type:
string
Description: The dimension "store_currency" in Shopify represents the currency that a store is set up to use for its operations, transactions, and financial reporting. This currency is used as the default currency for displaying product prices, processing orders, and generating financial reports within the Shopify store. It is defined in the store's settings and ensures consistency for financial data analysis and customer transactions.
processed_timestamp
Type:
string
Description: The "processed_timestamp" dimension in the context of Shopify e-commerce data analysis refers to the specific date and time when an order is processed. This timestamp indicates when the order has transitioned from pending or unfulfilled to a stage where it is confirmed for fulfillment. It is crucial for understanding the timeline and efficiency of order processing within the store’s operations. This dimension helps in tracking operational performance and can be used to analyze how quickly orders are being processed after they are placed. The "processed_timestamp" is typically presented in ISO 8601 format, providing a precise and standardized time reference.
processed_date
Type:
date
Description: The "processed_date" dimension in Shopify refers to the date and time when an order was processed. In the context of order management and e-commerce operations, this typically means the date when the order has been prepared for fulfillment, such as being packaged, labeled, or otherwise confirmed for shipping to the customer. This timestamp is crucial for tracking fulfillment operations and for understanding the efficiency of order processing workflows. In data analysis, this information can be used to evaluate order processing times, ensure timely fulfillment, and improve overall customer satisfaction by analyzing the gap between order placement and processing.
updated_timestamp
Type:
string
Description: The "updated_timestamp" dimension in the context of Shopify's Admin REST API typically represents the exact date and time when the resource, such as an order, was last modified. This timestamp indicates the most recent update made to the record, whether that update involved a change in order status, a modification of the order details, or any other update action performed. It is essential for tracking the latest activity on an order and is crucial for tasks like synchronization, data consistency, and audit trails in e-commerce operations.
updated_date
Type:
date
Description: The "updated_date" dimension in Shopify e-commerce data typically represents the date and time when a specific record, such as an order, product, or customer, was last modified or updated in the Shopify system. This includes any changes made to the record's details, such as status updates, edits to product descriptions, changes in customer information, or any other modifications. The "updated_date" helps in tracking the most recent changes to the record and can be useful for analyzing trends, syncing data, and maintaining accurate records over time.
order_id
Type:
string
Description: The "order_id" dimension in Shopify refers to the unique identifier assigned to each individual order placed through a Shopify store. This ID is a distinct numerical value that allows merchants and systems to track, manage, and reference specific orders. It is crucial for order management, enabling actions such as order retrieval, fulfillment, and analysis. The "order_id" is utilized in various API calls to access detailed information about an order, including customer details, products purchased, payment, and shipping information.
taxes_included
Type:
boolean
Description: The "taxes_included" dimension in Shopify represents a Boolean value indicating whether the prices of items in an order include applicable taxes. When this dimension is set to "true," it means that the tax amounts are already included in the item prices shown to the customer. Conversely, if it is "false," taxes are calculated and added separately at checkout. This setting can affect how prices are displayed to customers and how tax calculations are handled during the ordering process.
cancel_reason
Type:
string
Description: The "cancel_reason" dimension in Shopify represents the reason why an order was canceled in the system. It provides context for cancellations, helping merchants understand the circumstances under which orders do not proceed to fulfillment. Common reasons include:
Customer - The customer requested the cancellation.
Fraud - The order was identified as fraudulent.
Inventory - The items in the order are out of stock.
Other - Any other reason not specifically categorized.
This dimension is useful for analyzing cancellation trends and improving operations related to order processing and customer satisfaction.
checkout_token
Type:
string
Description: The "checkout_token" in Shopify represents a unique identifier for a checkout session. When a customer initiates the checkout process on a Shopify store, a token is generated to track this specific checkout session. This token ensures that all actions and data—such as items in the cart, customer information, and shipping details—are consistently associated with the individual checkout as the customer progresses towards completing their purchase. In the context of data analysis, the "checkout_token" allows you to analyze and track specific checkout sessions, which can be useful for understanding conversion rates, identifying abandoned checkouts, and personalizing the checkout experience.
customer_locale
Type:
string
Description: The "customer_locale" dimension in Shopify represents the language and regional settings that the customer used when placing an order. This locale setting typically includes information about the customer's language preference and geographical location, formatted in a standard locale code (e.g., "en-US" for English - United States). It helps businesses understand and analyze the diversity of their customer base in terms of language and regional preferences, allowing them to tailor their marketing strategies and communications accordingly.
device_id
Type:
string
Description: In the context of Shopify's e-commerce data analysis, "device_id" typically refers to a unique identifier associated with the device used by a customer to place an order or interact with the online store. This dimension helps track and analyze user behavior across different devices, such as smartphones, tablets, or computers. By understanding device usage, merchants can optimize their store's performance on various platforms and tailor their marketing strategies to target users based on their preferred device types. The "device_id" can play a crucial role in personalizing the shopping experience and improving conversion rates by providing insights into the most commonly used devices among the store's customers.
channel
Type:
string
Description: In the context of Shopify and e-commerce data analysis, the "channel" dimension refers to the various platforms or pathways through which sales or interactions occur. This could include different sales channels like the online store, point of sale (POS), mobile apps, third-party marketplaces (such as Amazon or eBay), and social media platforms. In Shopify's Admin REST API, the "channel" dimension helps businesses track and analyze where their sales are originating, enabling them to better understand customer behavior and optimize their sales strategies across different platforms.
campaign
Type:
string
Description: In the context of e-commerce data analysis, the "campaign" dimension typically refers to a marketing or sales initiative designed to promote products and drive sales. This dimension is used to track and analyze the performance of specific campaigns, enabling merchants to assess the effectiveness of their marketing efforts.
In Shopify, while there isn't a direct reference to a "campaign" dimension within the Admin REST API specifically for orders, this term can often be associated with marketing or referral data that tracks how customers are directed to the store (e.g., via UTM parameters, referral codes, or specific promotions). This helps merchants evaluate the source of their traffic and determine which marketing strategies are contributing to conversions and sales.
campaign_id
Type:
string
Description: The dimension key "campaign_id" in the context of Shopify and common e-commerce terminology typically represents an identifier associated with a specific marketing or advertising campaign. This ID is used to track and attribute orders, sales, or customer interactions to particular promotional efforts. By using "campaign_id," businesses can analyze the performance of various marketing campaigns, understand which initiatives are driving sales, and optimize their marketing strategy accordingly. It helps in linking the sales data back to specific campaigns run through different advertising platforms or marketing channels.
is_paid_channel
Type:
boolean
Description: The dimension "is_paid_channel" typically indicates whether a sale or order originates from a paid marketing channel. In the context of Shopify and e-commerce, this might reflect if the traffic leading to a sale was generated through paid advertising efforts, such as Google Ads, Facebook Ads, or other paid digital marketing campaigns. This dimension helps businesses analyze the impact and ROI of their paid marketing activities by distinguishing between orders from paid channels and those from organic or unpaid sources.
first_click_attribution_window_in_days
Type:
integer
Description: The dimension "first_click_attribution_window_in_days" in Shopify's e-commerce data analysis refers to the time frame, measured in days, during which the initial interaction or click from a customer on a marketing campaign is attributed to a subsequent purchase. This means that if a customer first clicks on an advertisement or promotional link, any purchase they make within this specified number of days will be attributed to that initial click, for the purposes of analyzing the effectiveness of the marketing campaign. This dimension helps businesses understand the influence of their marketing efforts over a period of time and how long it typically takes for customers to make a purchase after their first interaction.
variant_id
Type:
string
Description: The "variant_id" in Shopify represents the unique identifier for a specific variant of a product. In e-commerce and Shopify's context, products can have multiple variants, which are different versions of the same product, distinguished by attributes like size, color, or material. Each variant is considered a distinct item with its own inventory level, price, and SKU (Stock Keeping Unit). The "variant_id" is crucial for tracking and managing these individual product variants in the Shopify system, allowing for precise inventory management, order processing, and data analysis.
sku
Type:
string
Description: In the context of Shopify and e-commerce data analysis, the dimension key "sku" stands for "Stock Keeping Unit." It is an alphanumeric code used to uniquely identify a specific product or variant in your inventory. The SKU is crucial for inventory management, allowing merchants to track products, manage stock levels, and streamline operations. Each SKU is unique to a variant of a product, which means even different sizes or colors of the same product will typically have different SKUs. This helps ensure that the right product is tracked and sold, reducing errors and improving order fulfillment efficiency.
variant_title
Type:
string
Description: The "variant_title" dimension in Shopify refers to the title of a specific product variant. In e-commerce, a product variant is a version of a product that has different attributes, such as size, color, or material. The "variant_title" provides a concise description of these attributes for a particular product variant. For example, if a product is a t-shirt available in different sizes and colors, the "variant_title" might specify "Large / Red" to indicate the specific variant. This dimension is useful for distinguishing between different versions of the same product in data analysis and reporting.
product_type
Type:
string
Description: The "product_type" dimension in Shopify represents a categorization attribute that describes the category to which a product belongs. It is used to group and organize products within the store, making it easier to manage inventory, analyze sales data, and enhance the shopping experience. This categorization can be based on characteristics such as the product's intended use, design, or target market. Examples of product types might include "Apparel," "Electronics," "Home Goods," etc. Merchants can utilize this attribute to filter products, create collections, and run specific analysis on product categories.
product_status
Type:
string
Description: The "product_status" dimension in Shopify's context represents the current state or condition of a product in the Shopify store's inventory. It typically indicates whether a product is available for purchase or not, and can include various statuses such as:
Active: The product is available and visible to customers. It can be purchased through the online store or other sales channels.
Draft: The product is not yet available for purchase. It might be a new product that is still being set up or edited.
Archived: The product is no longer active and is removed from sales channels but is retained in the store's records for future reference or reporting.
Understanding "product_status" is crucial for managing inventory, sales, and marketing strategies within a Shopify store.
collection_id
Type:
string
Description: The "collection_id" in Shopify refers to the unique identifier for a collection, which is a grouping of products in a Shopify store. Collections are used to organize products into categories, making it easier for customers to find items. These collections can be based on various attributes, such as product type, vendor, price range, or custom criteria set by the store owner. The "collection_id" allows for tracking and referencing specific collections within Shopify's Admin REST API and facilitates the analysis of product grouping and categorization in e-commerce data.
collection_handle
Type:
string
Description: The "collection_handle" dimension in Shopify refers to a unique identifier for a specific collection within a Shopify store. Collections are groups of products organized together under a common theme or category, making it easier for customers to browse and find products. The "handle" is a URL-friendly version of the collection's name, typically in lowercase and with spaces replaced by hyphens. This handle is used in the store's URLs and the Shopify API to reliably reference a collection across different parts of the Shopify platform.
collection_template_suffix
Type:
string
Description: The "collection_template_suffix" in Shopify refers to the template suffix used to render a specific collection page within a Shopify store. In Shopify, merchants can create custom templates to modify the appearance and functionality of collection pages. By using a template suffix, Shopify allows the assignment of different templates to different collections, enabling the merchant to customize how each collection is displayed to customers. The "collection_template_suffix" is the part of the template file name that appears after "collection." (e.g., "collection.special" where "special" is the suffix). This dimension is useful in e-commerce data analysis for understanding how different collections are presented to customers and potentially analyzing the impact of different page layouts or designs on customer engagement or sales.
vendor
Type:
string
Description: The "vendor" dimension in Shopify represents the manufacturer, wholesaler, or distributor of a product. This dimension is used to categorize and organize products based on their source or brand, which can be particularly useful in analyzing sales data, managing inventory, and assessing the performance of different suppliers. In Shopify's product catalog, each product can have a vendor attribute, allowing merchants to easily filter and report on inventory or orders by vendor.
product_image
Type:
string
Description: The "product_image" dimension in the context of Shopify's Admin REST API refers to the visual representation of a product that is used in an online store. It typically includes the URL or path to the image file that visually depicts the product, which can be used on product detail pages, in listings, and wherever a product might be displayed within the storefront or back-end. These images help attract and inform customers, providing a crucial aspect of the browsing and selection experience in e-commerce. This dimension is essential for showcasing the product's aesthetic and functional attributes, potentially influencing purchasing decisions.
fulfillment_location_id
Type:
string
Description: The dimension "fulfillment_location_id" in Shopify represents the unique identifier for the location from which an order is fulfilled. This ID is linked to a specific physical location, such as a warehouse or a store, where inventory is stored and managed. During the fulfillment process, this ID helps in tracking which location is responsible for fulfilling a particular order, aiding in inventory management, logistics, and reporting.
fulfillment_location_name
Type:
string
Description: The dimension "fulfillment_location_name" in Shopify refers to the name of the location from which an order is fulfilled. This can represent the warehouse, store, or any other physical facility where the items in an order are picked, packed, and shipped to the customer. It helps in tracking and managing inventory across different locations and assists in order fulfillment processes by identifying the specific place responsible for dispatching the goods.
customer_first_order_month
Type:
date
Description: The "customer_first_order_month" dimension represents the month in which a customer made their first purchase on a Shopify store. This dimension is derived by examining a customer's order history and identifying the specific month and year of their initial transaction. It can be used in e-commerce data analysis to understand customer acquisition trends, cohort analysis, and to evaluate marketing campaign effectiveness over time. By analyzing this dimension, businesses can gain insights into the timing of customer onboarding and tailor their strategies accordingly.
customer_order_number
Type:
integer
Description: The "customer_order_number" dimension represents the sequential number assigned to an order by a specific customer within Shopify. It is a unique identifier for each order placed by a customer, often used to track and reference individual orders in customer service and reporting. This number is typically sequential for each customer, starting from their first purchase, and helps distinguish one customer's orders from another's, providing easier order management and organization for merchants.
utm_source
Type:
string
Description: The "utm_source" dimension in Shopify data analysis represents the specific source or channel where the traffic originated before arriving at your Shopify store. This is part of the UTM parameters used in tracking the performance of marketing campaigns. Typically, "utm_source" is used to identify the platform or entity, such as a search engine (Google), social network (Facebook), or newsletter (Email), that directed a user to your site. Utilizing "utm_source" helps merchants analyze and compare the effectiveness of different traffic sources in generating visits, conversions, or sales within the Shopify platform.
utm_campaign
Type:
string
Description: The "utm_campaign" dimension in Shopify's context typically refers to a tracking parameter used within URLs to identify the specific marketing campaign that brought a visitor to an online store. This parameter is a part of the UTM (Urchin Tracking Module) system, which is used for tracking the effectiveness of online marketing campaigns across different traffic sources.
In e-commerce data analysis, "utm_campaign" helps store owners and marketers understand which marketing initiatives are generating traffic and conversions. When a user clicks on a link with UTM parameters included, such as in an email, a social media post, or an online ad, the "utm_campaign" value specifies the name or code of the marketing campaign responsible for that visit or sale. This information is crucial for assessing campaign performance and optimizing marketing strategies.
utm_adset
Type:
string
Description: The "utm_adset" dimension in the context of e-commerce data analysis on Shopify refers to a specific parameter used in tracking and analytics that identifies the advertising set associated with a particular visitor or transaction. In digital marketing, an "ad set" is a grouping of ads that share the same budget, audience targeting, and delivery criteria within an advertising campaign. This UTM parameter is part of the URL that is used to track the performance of different ad sets across various platforms like Facebook, Google Ads, and others.
In the context of Shopify's data analysis, "utm_adset" helps merchants understand which specific ad set led users to their store and subsequently contributed to sales or interactions. This dimension is crucial for marketers to analyze the effectiveness and return on investment (ROI) of different ad sets within their campaigns, allowing optimizations for better targeting and budget allocation.
utm_ad
Type:
string
Description: The "utm_ad" dimension in the context of Shopify and common e-commerce terminology typically refers to a parameter used in UTM (Urchin Tracking Module) tracking codes. Specifically, "utm_ad" is likely a custom parameter that represents the specific advertisement or promotional content that led a visitor to your website. This parameter can be used to identify the individual ad within a campaign that contributed to the traffic or conversions, helping merchants analyze which specific ads are performing best. In the Shopify ecosystem, tracking such parameters can aid in evaluating the effectiveness of different advertising strategies and optimizing marketing efforts.
utm_medium
Type:
string
Description: The "utm_medium" dimension in Shopify's context refers to a UTM parameter that helps track the medium through which website traffic arrives at the store, particularly related to marketing campaigns. It is a key component of UTM tracking codes, which are used to gauge the effectiveness of online marketing efforts. In e-commerce data analysis, "utm_medium" specifies the marketing or advertising medium, such as email, social, CPC (cost-per-click), or any other channel that directs traffic to the store. By analyzing "utm_medium," merchants can understand which marketing channels are most effective in driving traffic and conversions on their Shopify store.
utm_content
Type:
string
Description: The "utm_content" dimension in Shopify's context refers to a parameter typically used in marketing and advertising tracking. It is part of the UTM (Urchin Tracking Module) parameters that are appended to URLs for tracking purposes. Specifically, "utm_content" is often used to differentiate variations of the same ad or link. This can include identifying specific elements such as different ads within a campaign, versions of an email, or various banners on a website.
In e-commerce data analysis within Shopify, "utm_content" helps merchants track the effectiveness of these specific elements by capturing and reporting the data on interactions or conversions that occur from these different variants. By analyzing the "utm_content" data, merchants can understand which content segments perform best and optimize their marketing strategies accordingly.
utm_term
Type:
string
Description: The "utm_term" dimension in Shopify's e-commerce data represents the keyword or term that a visitor used in a search engine, which led them to a marketing campaign or directly to the store. This is often used in pay-per-click (PPC) campaigns to track the specific search terms that drove traffic to the website. In essence, "utm_term" helps store owners understand which keywords are effectively attracting visitors to their online store, aiding in the analysis and optimization of marketing strategies.
utm_campaign_id
Type:
string
Description: The "utm_campaign_id" is a dimension used in e-commerce data analysis to track the specific marketing campaign that led customers to visit a Shopify store or make a purchase. It's part of the UTM (Urchin Tracking Module) parameters, which are tags added to the URL of marketing materials like emails, ads, or social media posts. The "utm_campaign_id" specifically identifies the unique ID of the campaign, allowing Shopify store owners to analyze the effectiveness of their marketing efforts and understand which campaigns are driving traffic and conversions. This can help in optimizing marketing strategies and allocating resources effectively.
utm_adset_id
Type:
string
Description: The dimension key "utm_adset_id" in e-commerce data analysis refers to a specific identifier used to track the performance of an ad set through UTM (Urchin Tracking Module) parameters. When used in the context of Shopify's data, it indicates the unique identifier for the advertisement set associated with a particular marketing campaign. This dimension allows retailers to monitor which ad sets drive traffic to their Shopify store, helping them analyze the effectiveness and ROI (Return on Investment) of different ad strategies. It is typically appended to URLs as part of the UTM parameters to facilitate detailed tracking in web analytics.
utm_ad_id
Type:
string
Description: The dimension "utm_ad_id" in Shopify represents a unique identifier associated with a specific advertisement or marketing campaign. It is typically used to track and analyze the effectiveness of marketing efforts by linking user activity or conversions back to the particular ad that attracted the customer's attention. In the context of Shopify and e-commerce, this identifier helps merchants understand which ads are driving traffic and sales, allowing for more informed marketing decisions and optimizations. The "utm_ad_id" is commonly used in conjunction with other UTM parameters to provide a comprehensive picture of campaign performance across various channels.
store
Type:
string
Description: The "store" dimension in Shopify typically represents the specific online shop or storefront on the Shopify platform. Each store is essentially a unique entity within Shopify, identified by a unique store name or store ID. It encompasses all the settings, products, orders, and other data specific to that particular business or merchant using Shopify's services. In e-commerce analysis, this dimension is used to segment and analyze data at the level of individual storefronts, allowing merchants or analysts to assess performance, sales, and other metrics within each separate Shopify store.
customer_id
Type:
string
Description: The "customer_id" dimension represents a unique identifier for a customer in the Shopify platform. This ID is used to distinguish individual customers across various data records and transactions. In the context of Shopify's Admin REST API, the "customer_id" is associated with customer accounts and orders, allowing you to link specific orders, actions, and marketing insights to the respective customer who made a purchase or engaged with the store. This is crucial for customer relationship management, enabling merchants to track purchase history, segment customers, and personalize marketing strategies.
timezone
Type:
string
Description: The "timezone" dimension in Shopify's context represents the time zone setting of the store as configured in the Shopify admin. This dimension is crucial for understanding the timing of order-related activities and sales performance since it dictates how dates and times are displayed and processed in reports and analyses. It ensures that all time-dependent data, such as order timestamps and customer interactions, are accurately aligned with the store's local time zone rather than defaulting to a standard time like UTC. This dimension is especially important for businesses operating across multiple time zones, allowing them to effectively plan and analyze their operations based on their specific local time settings.
klaviyo_acquisition_channel
Type:
string
Description: The dimension "klaviyo_acquisition_channel" refers to the specific channel or source through which a customer was acquired, as identified and tracked by Klaviyo, a popular email marketing and customer engagement platform often integrated with Shopify. This dimension helps merchants understand the origin or path through which new or existing customers engaged with their store, potentially through campaigns like email marketing, social media, ads, or other channels Klaviyo can track. Understanding this dimension allows businesses to analyze and optimize their marketing strategies to improve customer acquisition and retention.
customer_lifetime_duration
Type:
string
Description: The dimension key "customer_lifetime_duration" in the context of Shopify and e-commerce data analysis typically refers to the total time span from when a customer places their first order to their most recent order. It is a measure of how long a customer has been active on the store, providing insight into customer loyalty and engagement over time. This metric can be used to analyze customer behavior, retention, and the effectiveness of marketing strategies designed to prolong customer relationships.
customer_email
Type:
string
Description: The "customer_email" dimension in Shopify represents the email address associated with a customer who has placed an order. This dimension is used to identify and track individual customers, enabling retailers to analyze customer behavior, send order confirmations, and facilitate communications. In the context of Shopify's data, the "customer_email" serves as a unique identifier for customer interactions and order processing within the e-commerce platform.
customer_name
Type:
string
Description: The "customer_name" dimension in Shopify e-commerce analysis represents the full name of the customer associated with a particular order. This is typically a combination of the first and last names of the customer who placed the order. It's used to identify and analyze customer-related data within the context of orders, allowing businesses to track purchasing behavior and patterns linked to individual customers.
customer_email_marketing_consent_state
Type:
string
Description: The dimension "customer_email_marketing_consent_state" represents the current status of a customer's consent to receive marketing emails. This value indicates whether a customer has opted in or out of email marketing communications. It is used to manage and track customer preferences regarding promotional emails and ensure compliance with privacy regulations. Common states include "subscribed" (indicating consent has been given), "unsubscribed" (indicating consent has been withdrawn), or "not_subscribed" (indicating that the customer has never opted in). This dimension is essential for segmenting customers and targeting marketing campaigns effectively.
customer_email_marketing_consent_opt_in_level
Type:
string
Description: The "customer_email_marketing_consent_opt_in_level" dimension represents the level or status of consent given by a customer for receiving marketing communications via email. In the context of e-commerce and Shopify, this typically indicates how a customer's permission to receive marketing emails is recorded or classified, such as:
Subscribed: The customer has explicitly opted in to receive marketing emails.
Unsubscribed: The customer has opted out or has not subscribed to receive marketing emails.
Pending: The customer's consent is in a pending state, possibly due to an incomplete opt-in process.
This dimension is crucial for understanding and managing customer engagement strategies, ensuring compliance with email marketing regulations, and tailoring marketing efforts based on customer preferences.
company_billing_address
Type:
string
Description: The dimension "company_billing_address" in Shopify's e-commerce data analysis represents the billing address associated with a company's order. This typically includes details such as the company's name, street address, city, state or province, postal code, and country where the billing information is sent or registered. It is used to identify and verify the company responsible for the payment of the order. This dimension is crucial for processing payments, fraud prevention, and financial reporting in e-commerce.
company_shipping_address
Type:
string
Description: The "company_shipping_address" dimension in a Shopify context typically represents the shipping address associated with a company for an order placed on a Shopify store. This dimension would detail the address where goods are intended to be delivered, including information such as the company name, street address, city, state or province, postal code, and country. It is a part of the order data used in analyzing and managing shipments within an e-commerce business. This dimension is crucial for logistics and fulfillment processes, ensuring that orders are shipped to the correct location specified by the customer.
days_since_first_order
Type:
integer
Description: The "days_since_first_order" dimension in Shopify represents the number of days that have passed since a customer placed their first order on a Shopify store. This metric is typically used to analyze customer purchasing behavior over time, allowing merchants to understand how recently a customer made their initial purchase and to segment customers based on their engagement and loyalty. By tracking this dimension, store owners can tailor marketing strategies and offerings to re-engage customers who have not made a purchase for a significant period or to reward loyal customers who have been with the store for a longer duration.
months_since_first_order
Type:
integer
Description: The dimension "months_since_first_order" typically represents the number of months that have passed since a customer placed their first order on the Shopify store. This dimension is used in e-commerce data analysis to track customer longevity and engagement with the store over time. It helps businesses understand customer retention patterns and allows for segmenting customers based on how long they have been purchasing from the store. This metric is valuable for analyzing customer loyalty and targeting marketing efforts accordingly.
customer_lifespan_in_days
Type:
integer
Description: The dimension "customer_lifespan_in_days" represents the number of days between the first purchase and the latest purchase made by a customer on a Shopify store. It measures how long a customer has been active or engaged with the store, from their initial transaction to their most recent one. This metric helps businesses understand customer engagement and retention over time.
adset_name
Type:
string
Description: The "adset_name" dimension in e-commerce and advertising analysis typically refers to the name assigned to a specific ad set within an advertising campaign. In platforms like Facebook Ads or Google Ads, an ad set is a group of advertisements that share the same audience targeting, budget, schedule, and bidding strategy. The "adset_name" helps marketers and analysts identify and report on the performance of that particular group of ads, including metrics such as impressions, clicks, conversions, and revenue attributed to those ads. In the context of Shopify, while the platform itself may not natively manage ad campaign details, "adset_name" could be used in data integrations or reporting tools to align Shopify's sales data with advertising performance data from external sources.
adset_id
Type:
string
Description: The dimension key "adset_id" represents the unique identifier for an ad set in advertising data associated with an e-commerce platform like Shopify. In the context of e-commerce and digital marketing, an "ad set" is part of a marketing campaign structure commonly used on platforms like Facebook Ads, where a campaign contains multiple ad sets, and each ad set contains specific targeting, budget, schedule, and bidding information. The "adset_id" is used to track and analyze the performance of specific ad sets within broader marketing campaigns. In Shopify, this data could be used to understand which ad sets are driving traffic and sales to the store.
ad_name
Type:
string
Description: The "ad_name" dimension typically represents the name or identifier of a specific advertisement or marketing campaign that led to a customer interaction, such as a visit to a Shopify store or a purchase. This dimension is crucial for tracking the effectiveness of different advertising efforts across platforms. It allows merchants to attribute sales or traffic to specific ads or campaigns, enabling them to analyze and optimize their marketing strategies. This information usually comes from tracking pixels or parameters appended to URLs, and it helps in evaluating the return on investment for various advertising channels used by the store.
first_event_time
Type:
N/A
Description: No description available.
last_event_time
Type:
N/A
Description: No description available.
market_id
Type:
string
Description: The "market_id" in Shopify represents a unique identifier for a specific market associated with an order or a store. In the context of Shopify's multi-market features, a market typically refers to a geographic region, a specific currency, or a particular language setting in which a store operates. This dimension allows merchants to analyze and differentiate data based on various markets where they sell their products, enabling more targeted market analysis and strategy development.
market_name
Type:
string
Description: The "market_name" dimension in Shopify e-commerce data analysis refers to the name of the marketplace or sales channel where the order was placed. This can include various sales channels that a Shopify store might be utilizing, such as online storefronts, physical retail locations, mobile applications, social media platforms, or third-party marketplaces. The dimension helps merchants understand the origin of their sales, allowing them to analyze performance across different channels and make informed decisions regarding marketing and inventory strategies.
market_handle
Type:
string
Description: The "market_handle" dimension in Shopify typically refers to a unique identifier or handle for a specific market or sales channel associated with an order or product. In the context of e-commerce, a market or sales channel could be a specific storefront, platform, region, or method by which products are sold (e.g., online store, point of sale, wholesale). This dimension allows businesses to segment and analyze data based on the source or environment in which transactions occur, providing insights into performance across different sales channels.
account_id
Type:
string
Description: The "account_id" dimension in Shopify's e-commerce data analysis typically represents a unique identifier for a specific account within the Shopify platform. In the context of Shopify's Admin REST API, it is often used to identify and differentiate between different accounts, such as merchant accounts or customer accounts, depending on the specific use case. This identifier is important for organizing and managing data related to orders, customers, and other entities within the Shopify ecosystem. It helps in attributing actions, transactions, or entities to the correct account in e-commerce analysis and operations.
account_name
Type:
string
Description: The "account_name" dimension in the context of Shopify's e-commerce data analysis typically represents the name associated with a Shopify account or store. This dimension is used to identify and differentiate between various Shopify accounts or merchants within data reports and analyses. It helps in organizing and filtering data based on the specific Shopify store or account being analyzed, allowing users to perform store-specific analytics and gain insights into the performance and operations of individual stores.
store
Type:
string
Description: The "store" dimension in Shopify typically represents the specific online shop or storefront on the Shopify platform. Each store is essentially a unique entity within Shopify, identified by a unique store name or store ID. It encompasses all the settings, products, orders, and other data specific to that particular business or merchant using Shopify's services. In e-commerce analysis, this dimension is used to segment and analyze data at the level of individual storefronts, allowing merchants or analysts to assess performance, sales, and other metrics within each separate Shopify store.
customer_id
Type:
string
Description: The "customer_id" dimension represents a unique identifier for a customer in the Shopify platform. This ID is used to distinguish individual customers across various data records and transactions. In the context of Shopify's Admin REST API, the "customer_id" is associated with customer accounts and orders, allowing you to link specific orders, actions, and marketing insights to the respective customer who made a purchase or engaged with the store. This is crucial for customer relationship management, enabling merchants to track purchase history, segment customers, and personalize marketing strategies.
timezone
Type:
string
Description: The "timezone" dimension in Shopify's context represents the time zone setting of the store as configured in the Shopify admin. This dimension is crucial for understanding the timing of order-related activities and sales performance since it dictates how dates and times are displayed and processed in reports and analyses. It ensures that all time-dependent data, such as order timestamps and customer interactions, are accurately aligned with the store's local time zone rather than defaulting to a standard time like UTC. This dimension is especially important for businesses operating across multiple time zones, allowing them to effectively plan and analyze their operations based on their specific local time settings.
klaviyo_acquisition_channel
Type:
string
Description: The dimension "klaviyo_acquisition_channel" refers to the specific channel or source through which a customer was acquired, as identified and tracked by Klaviyo, a popular email marketing and customer engagement platform often integrated with Shopify. This dimension helps merchants understand the origin or path through which new or existing customers engaged with their store, potentially through campaigns like email marketing, social media, ads, or other channels Klaviyo can track. Understanding this dimension allows businesses to analyze and optimize their marketing strategies to improve customer acquisition and retention.
customer_first_order_timestamp
Type:
string
Description: The "customer_first_order_timestamp" dimension in Shopify e-commerce data analysis represents the date and time when a customer placed their first order on the Shopify store. This timestamp marks the initial transaction time registered in the system for a customer, helping merchants to identify when a customer began their purchasing journey. It is useful for analyzing customer acquisition timelines, understanding lifetime value, and segmenting customers based on their tenure with the store.
customer_lifetime_duration
Type:
string
Description: The dimension key "customer_lifetime_duration" in the context of Shopify and e-commerce data analysis typically refers to the total time span from when a customer places their first order to their most recent order. It is a measure of how long a customer has been active on the store, providing insight into customer loyalty and engagement over time. This metric can be used to analyze customer behavior, retention, and the effectiveness of marketing strategies designed to prolong customer relationships.
customer_email
Type:
string
Description: The "customer_email" dimension in Shopify represents the email address associated with a customer who has placed an order. This dimension is used to identify and track individual customers, enabling retailers to analyze customer behavior, send order confirmations, and facilitate communications. In the context of Shopify's data, the "customer_email" serves as a unique identifier for customer interactions and order processing within the e-commerce platform.
customer_name
Type:
string
Description: The "customer_name" dimension in Shopify e-commerce analysis represents the full name of the customer associated with a particular order. This is typically a combination of the first and last names of the customer who placed the order. It's used to identify and analyze customer-related data within the context of orders, allowing businesses to track purchasing behavior and patterns linked to individual customers.
customer_email_marketing_consent_state
Type:
string
Description: The dimension "customer_email_marketing_consent_state" represents the current status of a customer's consent to receive marketing emails. This value indicates whether a customer has opted in or out of email marketing communications. It is used to manage and track customer preferences regarding promotional emails and ensure compliance with privacy regulations. Common states include "subscribed" (indicating consent has been given), "unsubscribed" (indicating consent has been withdrawn), or "not_subscribed" (indicating that the customer has never opted in). This dimension is essential for segmenting customers and targeting marketing campaigns effectively.
customer_email_marketing_consent_opt_in_level
Type:
string
Description: The "customer_email_marketing_consent_opt_in_level" dimension represents the level or status of consent given by a customer for receiving marketing communications via email. In the context of e-commerce and Shopify, this typically indicates how a customer's permission to receive marketing emails is recorded or classified, such as:
Subscribed: The customer has explicitly opted in to receive marketing emails.
Unsubscribed: The customer has opted out or has not subscribed to receive marketing emails.
Pending: The customer's consent is in a pending state, possibly due to an incomplete opt-in process.
This dimension is crucial for understanding and managing customer engagement strategies, ensuring compliance with email marketing regulations, and tailoring marketing efforts based on customer preferences.
customer_total_spent
Type:
integer
Description: The dimension "customer_total_spent" in the context of Shopify e-commerce data analysis likely represents the cumulative total amount of money a customer has spent at a store over their lifetime. This metric aggregates all orders placed by the customer, providing valuable insights into customer value and purchasing behavior. It helps businesses understand the overall contribution of a customer to the store's revenue.
cancelled_timestamp
Type:
string
Description: The dimension "cancelled_timestamp" in Shopify represents the exact date and time when an order was cancelled. This timestamp indicates when the cancellation action was finalized in the Shopify system, providing insights into the timeline of an order's lifecycle. This can be useful for tracking order management efficiency, understanding customer behavior, or analyzing cancellation trends over time.
cancelled_date
Type:
date
Description: The "cancelled_date" dimension in the context of Shopify and e-commerce data analysis represents the specific date and time when an order was officially canceled in the Shopify platform. This timestamp indicates when the cancellation action was performed, which can help businesses track and analyze order cancellations over time, understand customer behavior, and assess any operational or logistical issues that may lead to cancellations. This data is crucial for reporting and analysis, allowing merchants to optimize their processes and improve customer satisfaction.
customer_first_order_skus
Type:
string
Description: The dimension "customer_first_order_skus" represents the Stock Keeping Units (SKUs) associated with the first order placed by a customer. In Shopify, an SKU is a unique identifier for each distinct product and its variations, such as size or color. This dimension is valuable for analyzing purchasing behavior and trends by identifying which specific products initiated a customer's shopping journey with a store. It helps in understanding initial customer preferences and can be crucial for targeting marketing and retention strategies.
customer_first_order_product_titles
Type:
string
Description: The dimension key "customer_first_order_product_titles" represents the titles of the products that a customer purchased in their first order with the store. This information is typically used to understand what products first attracted and converted a customer, which can be important for marketing and analytics purposes. By analyzing this data, merchants can identify which products are most effective at drawing in new customers.
customer_first_order_month
Type:
date
Description: The "customer_first_order_month" dimension represents the month in which a customer made their first purchase on a Shopify store. This dimension is derived by examining a customer's order history and identifying the specific month and year of their initial transaction. It can be used in e-commerce data analysis to understand customer acquisition trends, cohort analysis, and to evaluate marketing campaign effectiveness over time. By analyzing this dimension, businesses can gain insights into the timing of customer onboarding and tailor their strategies accordingly.
customer_first_order_date
Type:
date
Description: The dimension "customer_first_order_date" refers to the date when a customer made their first purchase on the Shopify store. This data point is used to track when a customer began their relationship with the store by making their initial order. It helps store owners analyze customer acquisition patterns, understand customer lifetime value, and segment customers based on the duration of their loyalty.
sales_channel
Type:
string
Description: In the context of Shopify's Admin REST API and e-commerce data analysis, the "sales_channel" dimension represents the platform or method through which an order or transaction is made. This could include online stores, physical retail locations, mobile apps, social media platforms, marketplaces, or any other integrated sales channel that a merchant uses to sell their products. The "sales_channel" helps in categorizing and analyzing sales data based on where the sales originate, allowing merchants to assess the performance of different sales channels and make informed strategic decisions.
sales_channel_name
Type:
string
Description: The "sales_channel_name" dimension represents the specific platform or medium through which an order was placed or a sale was processed within a Shopify store. This can include various sales channels such as the online store, point of sale (POS), mobile app, social media platforms like Facebook or Instagram, and other third-party marketplaces that are integrated with Shopify. By analyzing this dimension, merchants can gain insights into which channels are performing best and strategize accordingly to optimize their sales efforts across different platforms.
order_tag
Type:
string
Description: The dimension "order_tag" in Shopify represents a label or keyword assigned to an order within the Shopify platform. Order tags are used to categorize, organize, and manage orders more effectively. Merchants can apply one or multiple tags to each order to denote special characteristics, conditions, or handling instructions. For example, tags can be used to indicate that an order is a priority, requires gift wrapping, or belongs to a specific marketing campaign. These tags are highly customizable and serve as an efficient means for filtering and searching orders in the Shopify admin dashboard.
order_tags_in_order
Type:
string
Description: The dimension "order_tags_in_order" in Shopify represents the tags associated with a particular order. In Shopify, tags are used to categorize and organize orders for better management and analysis. These tags can be applied manually by a store owner or automatically through apps and workflows based on certain criteria. The "order_tags_in_order" dimension helps in filtering and analyzing order data based on these tags, allowing store owners to identify patterns or group orders with similar characteristics. This dimension is particularly useful for segmenting orders for reporting, fulfillment, and customer service purposes.
billing_country
Type:
string
Description: The "billing_country" dimension in Shopify represents the country associated with the billing address provided by the customer during the checkout process. This dimension indicates the country to which the billing address belongs, usually corresponding to the location of the customer's payment method, such as a credit card. It is a vital piece of information used for understanding customer demographics, regional sales reporting, and potentially for assessing tax liabilities and compliance with international shipping regulations.
customer_tag
Type:
string
Description: The dimension key "customer_tag" in Shopify represents labels or keywords assigned to customers that help categorize them based on certain characteristics or behaviors. These tags allow merchants to segment their customer base for targeted marketing, personalized experiences, and better customer management. For example, a customer might have tags like "VIP," "Newsletter Subscriber," or "Wholesale Client." The "customer_tag" is useful for filtering and organizing customers within the Shopify platform, enabling merchants to tailor their interactions and offerings accordingly.
order_discount_code
Type:
string
Description: The "order_discount_code" dimension in Shopify e-commerce data analysis represents the code or identifier used for a discount applied to an order. This code typically corresponds to promotional discounts, coupons, or special offers that customers can enter during the checkout process to receive a reduction in price. The dimension captures the specific discount code used for a given order, allowing businesses to analyze the effectiveness and usage of various discount campaigns and promotions.
order_discount_code_amount
Type:
string
Description: The dimension "order_discount_code_amount" in Shopify refers to the total amount of discounts that have been applied to an order as a result of discount codes. Discount codes are promotional codes that customers can enter at checkout to receive a reduction in the order price. This particular dimension captures the cumulative value of all such reductions applied to the order, reflecting how much the order total has been decreased due to the use of discount codes.
order_discount_code_type
Type:
string
Description: The dimension "order_discount_code_type" in Shopify refers to the classification of discount codes applied to an order. In the context of Shopify's e-commerce platform, discount codes are promotional codes that customers can enter at checkout to receive deductions on their purchase total. These discount codes can be of various types, such as:
Percentage Discount: The discount code reduces the order total by a certain percentage.
Fixed Amount Discount: The discount code reduces the order total by a specific flat amount.
Free Shipping: The discount code provides free shipping for the order.
Buy X Get Y: The discount code triggers an offer such as buying a certain quantity of items to get additional items free or at a discounted rate.
The "order_discount_code_type" dimension helps in identifying the type of discount applied, allowing merchants and analysts to assess the effectiveness and impact of different types of promotions on sales and customer behavior.
is_cancelled
Type:
boolean
Description: The "is_cancelled" dimension in Shopify's context typically refers to whether an order has been canceled or not. This dimension would indicate a boolean value:
true
if the order has been canceled andfalse
if it remains active or unfulfilled. In e-commerce, tracking whether an order is canceled is crucial for understanding order status, managing inventory, and analyzing sales metrics. When referencing the Shopify Admin REST API, this dimension helps in filtering or identifying orders that have been canceled during the processing lifecycle.
shipping_country
Type:
string
Description: The "shipping_country" dimension in Shopify refers to the country to which an order is being shipped. It represents the destination country specified in the shipping address associated with a customer's order. This dimension is vital for analyzing sales distribution across different countries, understanding international shipping needs, and tailoring marketing strategies to various geographic regions. The value of "shipping_country" is typically formatted as a two-letter ISO 3166-1 alpha-2 country code.
purchase_type
Type:
string
Description: The dimension "purchase_type" in the context of Shopify's e-commerce data analysis typically refers to the classification of a transaction based on how the purchase was made. This can include distinctions like "online" for purchases made through an e-commerce platform, "in-store" for physical store purchases using Shopify POS, or other types of specific transaction methods. This dimension helps businesses analyze and differentiate between various sales channels or methods through which customers place orders. It provides insights into customer purchasing behavior and helps in strategic decision-making regarding sales channels.
store_currency
Type:
string
Description: The dimension "store_currency" in Shopify represents the currency that a store is set up to use for its operations, transactions, and financial reporting. This currency is used as the default currency for displaying product prices, processing orders, and generating financial reports within the Shopify store. It is defined in the store's settings and ensures consistency for financial data analysis and customer transactions.
processing_method
Type:
string
Description: The "processing_method" dimension in Shopify's context refers to the method by which a payment was processed for an order. This dimension indicates the mechanism through which the transaction was completed, such as whether it was handled through a manual payment, an automatic capture of funds, or other specific methods associated with payment gateways integrated into the store. Understanding this dimension helps in analyzing payment trends and processing efficiency within the e-commerce store.
payment_gateway_names
Type:
string
Description: The "payment_gateway_names" dimension in Shopify represents the name(s) of the payment gateway(s) used to process transactions for an order. In the context of Shopify's Admin REST API and e-commerce data analysis, this dimension provides insights into which payment service providers are being utilized for processing payments, such as PayPal, Stripe, or Shopify Payments. It helps in understanding the distribution of payment preferences among customers and can be used for reporting and analytics to optimize payment options offered in the store.
referring_site
Type:
string
Description: The "referring_site" dimension in Shopify e-commerce data analysis represents the URL of the website that directed a customer to the Shopify store, leading to a transaction. This field helps in tracking the source of incoming traffic that results in sales, providing insights into the effectiveness of external websites or marketing channels in driving purchases. This can include search engines, social media platforms, affiliate links, or other websites. Understanding the referring sites can assist businesses in optimizing their marketing strategies and partnerships.
referring_source
Type:
string
Description: The "referring_source" dimension in Shopify e-commerce data analysis represents the origin or medium through which a customer was directed to your online store before making a purchase. This dimension helps identify how customers found your store, whether it was through search engines, social media, direct links, ads, or other referral channels. Understanding the "referring_source" allows you to evaluate the effectiveness of your marketing channels and optimize your strategies for driving traffic to your store.
processed_timestamp
Type:
string
Description: The "processed_timestamp" dimension in the context of Shopify e-commerce data analysis refers to the specific date and time when an order is processed. This timestamp indicates when the order has transitioned from pending or unfulfilled to a stage where it is confirmed for fulfillment. It is crucial for understanding the timeline and efficiency of order processing within the store’s operations. This dimension helps in tracking operational performance and can be used to analyze how quickly orders are being processed after they are placed. The "processed_timestamp" is typically presented in ISO 8601 format, providing a precise and standardized time reference.
processed_date
Type:
date
Description: The "processed_date" dimension in Shopify refers to the date and time when an order was processed. In the context of order management and e-commerce operations, this typically means the date when the order has been prepared for fulfillment, such as being packaged, labeled, or otherwise confirmed for shipping to the customer. This timestamp is crucial for tracking fulfillment operations and for understanding the efficiency of order processing workflows. In data analysis, this information can be used to evaluate order processing times, ensure timely fulfillment, and improve overall customer satisfaction by analyzing the gap between order placement and processing.
updated_timestamp
Type:
string
Description: The "updated_timestamp" dimension in the context of Shopify's Admin REST API typically represents the exact date and time when the resource, such as an order, was last modified. This timestamp indicates the most recent update made to the record, whether that update involved a change in order status, a modification of the order details, or any other update action performed. It is essential for tracking the latest activity on an order and is crucial for tasks like synchronization, data consistency, and audit trails in e-commerce operations.
updated_date
Type:
date
Description: The "updated_date" dimension in Shopify e-commerce data typically represents the date and time when a specific record, such as an order, product, or customer, was last modified or updated in the Shopify system. This includes any changes made to the record's details, such as status updates, edits to product descriptions, changes in customer information, or any other modifications. The "updated_date" helps in tracking the most recent changes to the record and can be useful for analyzing trends, syncing data, and maintaining accurate records over time.
customer_order_number
Type:
integer
Description: The "customer_order_number" dimension represents the sequential number assigned to an order by a specific customer within Shopify. It is a unique identifier for each order placed by a customer, often used to track and reference individual orders in customer service and reporting. This number is typically sequential for each customer, starting from their first purchase, and helps distinguish one customer's orders from another's, providing easier order management and organization for merchants.
customer_order_segment
Type:
string
Description: The "customer_order_segment" dimension in the context of Shopify e-commerce data analysis likely refers to the categorization or grouping of customers based on their purchasing behavior or order characteristics. This might include segmenting customers into different groups based on criteria such as the frequency of purchases, order value, recency of their last purchase, or other buying patterns. Utilizing this dimension allows businesses to analyze and understand the different segments of their customer base, tailor marketing strategies, and improve customer engagement by identifying key segments like loyal customers, high-spending customers, or new customers. While this specific term is not explicitly detailed in the Shopify API documentation, it aligns with common e-commerce practices of using customer segmentation for actionable insights.
order_id
Type:
string
Description: The "order_id" dimension in Shopify refers to the unique identifier assigned to each individual order placed through a Shopify store. This ID is a distinct numerical value that allows merchants and systems to track, manage, and reference specific orders. It is crucial for order management, enabling actions such as order retrieval, fulfillment, and analysis. The "order_id" is utilized in various API calls to access detailed information about an order, including customer details, products purchased, payment, and shipping information.
order_number
Type:
string
Description: The "order_number" dimension in Shopify represents a unique identifier assigned to each order in a sequential manner. This number is used to track and reference individual orders within the Shopify platform. It typically begins with a starting number (usually 1001 for new stores) and increments by one for each subsequent order. It's important to note that the "order_number" is distinct from the "id" or "order_id," which is a globally unique identifier (GUID) used internally by Shopify. The "order_number" is often used in customer communication and reports as it is more user-friendly and easier to reference when compared to the internal IDs.
pos_location_name
Type:
string
Description: The "pos_location_name" dimension in Shopify typically represents the name of the physical location or retail store where a point of sale (POS) transaction occurs. In the context of e-commerce data analysis, this dimension is used to identify and differentiate sales based on the specific physical location where the order was processed. This is particularly useful for merchants who operate multiple physical stores or outlets, allowing them to analyze and compare sales performance across different locations.
financial_status
Type:
string
Description: The "financial_status" dimension in Shopify's context refers to the current state of an order in terms of its payment processing. It indicates whether the payment for an order has been successfully completed, is pending, has failed, or has been refunded, among other potential statuses. This dimension is crucial for understanding the financial progress and completion status of an order. Common statuses include "paid", "pending", "authorized", "partially_paid", "refunded", and "voided". Each status helps merchants track and manage the financial lifecycle of orders.
fulfillment_status
Type:
string
Description: The "fulfillment_status" dimension in Shopify refers to the current state of an order's fulfillment process. It indicates whether the items in an order have been shipped or delivered to the customer. Common statuses include:
unfulfilled: No items in the order have been fulfilled.
partial: Some items in the order have been fulfilled, while others have not.
fulfilled: All items in the order have been fulfilled and shipped to the customer.
This dimension is used to track and manage the shipping of products, providing vital information on order processing and delivery progress.
shipping_city
Type:
string
Description: The "shipping_city" dimension in Shopify represents the city name to which an order is being shipped. This is extracted from the shipping address provided by the customer during the checkout process. It is a crucial component in order fulfillment and logistics, helping businesses to analyze shipping patterns and optimize delivery services based on geographical data.
shipping_country_code
Type:
string
Description: The dimension "shipping_country_code" in Shopify e-commerce data analysis represents the ISO 3166-1 alpha-2 country code for the destination country to which a customer's order is being shipped. This two-letter code is used to identify the specific country where the order's shipping address is located. For example, "US" would indicate that the shipment is going to the United States, while "CA" would represent Canada. This dimension is useful for analyzing and segmenting orders based on their shipping destinations.
shipping_province
Type:
string
Description: The "shipping_province" dimension in Shopify refers to the specific province or state to which an order is being shipped. This dimension is part of the shipping address information provided by the customer during the checkout process. It helps in analyzing order distribution based on geographic regions, calculating shipping costs, and understanding sales trends within specific areas. This dimension is particularly important for merchants who operate in regions with province-specific taxation or shipping regulations.
shipping_province_code
Type:
string
Description: The "shipping_province_code" dimension in Shopify represents the specific code or abbreviation of the province or state to which an order is being shipped. This dimension is used to identify the regional area within a country that is the destination for the shipment, helping with logistical planning, tax calculations, and geographic sales analysis.
shipping_zip
Type:
string
Description: The "shipping_zip" dimension in Shopify e-commerce data represents the postal or ZIP code of the shipping address associated with a specific order. It indicates the geographic area to which the order is being shipped and is a component of the broader shipping address information. This dimension is often used in data analysis to understand regional shipping patterns, calculate shipping costs, assess delivery zones, or conduct targeted marketing efforts based on geographic location.
billing_city
Type:
string
Description: The "billing_city" dimension in Shopify refers to the city specified in the billing address of an order. This information is captured when a customer makes a purchase and provides their payment details. It represents the city where the billing address is located, which is typically the address associated with the payment method used for the transaction. This dimension is useful for analyzing geographic trends in sales and understanding the distribution of customers by city location.
billing_country_code
Type:
string
Description: The "billing_country_code" dimension in Shopify represents the two-letter ISO 3166-1 alpha-2 country code for the country associated with the billing address provided by the customer during the checkout process. This code indicates the country where the billing information, such as the customer's payment details, is registered. This dimension is commonly used in e-commerce data analysis to segment orders or examine purchasing trends based on the geographical location of the billing address.
billing_province
Type:
string
Description: The "billing_province" dimension in Shopify refers to the state, region, or province associated with the billing address of an order. This dimension captures the geographic administrative area where the billing information of the customer is located. It is a part of the billing address details provided by the customer during the checkout process. Understanding the "billing_province" can be useful for analyzing regional sales trends, tax calculations, and customer demographics in e-commerce data.
billing_province_code
Type:
string
Description: The dimension "billing_province_code" in Shopify refers to the standardized code representing the province or region of the billing address associated with an order. This code is typically a short form or abbreviation used to identify the geographic area within the billing country. For example, in Canada, it would be the two-letter code for the province such as "ON" for Ontario. This dimension is useful in e-commerce data analysis for identifying and segmenting orders based on the billing region, which can help in understanding customer demographics and regional sales patterns.
billing_zip
Type:
string
Description: In the context of Shopify and e-commerce data analysis, the dimension key "billing_zip" represents the postal or ZIP code associated with a customer's billing address for an order. This is the ZIP code where the customer receives their credit card statements or bills, which is collected during the checkout process. It is important for verifying the customer's billing information and can be used for analysis related to the geographical distribution of customers, as well as for fraud prevention and payment processing purposes.
taxes_included
Type:
boolean
Description: The "taxes_included" dimension in Shopify represents a Boolean value indicating whether the prices of items in an order include applicable taxes. When this dimension is set to "true," it means that the tax amounts are already included in the item prices shown to the customer. Conversely, if it is "false," taxes are calculated and added separately at checkout. This setting can affect how prices are displayed to customers and how tax calculations are handled during the ordering process.
note
Type:
string
Description: In the context of Shopify's Admin REST API and e-commerce terminology, the dimension "note" refers to an optional field associated with an order that can be used by merchants to add internal comments or additional information about that order. This field is not visible to customers and is typically used by store staff for various purposes such as recording special instructions, noting customer preferences, or documenting other relevant information that assists in processing the order internally.
app_id
Type:
string
Description: The dimension key "app_id" in the context of Shopify's Admin REST API typically represents the unique identifier of an application that is integrated or used within a Shopify store. This ID helps track and attribute certain activities or data points back to the specific app responsible for them. For example, if an app processes an order or contributes to a sales channel, the "app_id" dimension would be used to identify which app handled or influenced that part of the transaction. This is important for merchants to analyze the performance and impact of different apps on their store's activities.
cancel_reason
Type:
string
Description: The "cancel_reason" dimension in Shopify represents the reason why an order was canceled in the system. It provides context for cancellations, helping merchants understand the circumstances under which orders do not proceed to fulfillment. Common reasons include:
Customer - The customer requested the cancellation.
Fraud - The order was identified as fraudulent.
Inventory - The items in the order are out of stock.
Other - Any other reason not specifically categorized.
This dimension is useful for analyzing cancellation trends and improving operations related to order processing and customer satisfaction.
checkout_token
Type:
string
Description: The "checkout_token" in Shopify represents a unique identifier for a checkout session. When a customer initiates the checkout process on a Shopify store, a token is generated to track this specific checkout session. This token ensures that all actions and data—such as items in the cart, customer information, and shipping details—are consistently associated with the individual checkout as the customer progresses towards completing their purchase. In the context of data analysis, the "checkout_token" allows you to analyze and track specific checkout sessions, which can be useful for understanding conversion rates, identifying abandoned checkouts, and personalizing the checkout experience.
customer_locale
Type:
string
Description: The "customer_locale" dimension in Shopify represents the language and regional settings that the customer used when placing an order. This locale setting typically includes information about the customer's language preference and geographical location, formatted in a standard locale code (e.g., "en-US" for English - United States). It helps businesses understand and analyze the diversity of their customer base in terms of language and regional preferences, allowing them to tailor their marketing strategies and communications accordingly.
device_id
Type:
string
Description: In the context of Shopify's e-commerce data analysis, "device_id" typically refers to a unique identifier associated with the device used by a customer to place an order or interact with the online store. This dimension helps track and analyze user behavior across different devices, such as smartphones, tablets, or computers. By understanding device usage, merchants can optimize their store's performance on various platforms and tailor their marketing strategies to target users based on their preferred device types. The "device_id" can play a crucial role in personalizing the shopping experience and improving conversion rates by providing insights into the most commonly used devices among the store's customers.
landing_site_ref
Type:
string
Description: The "landing_site_ref" dimension in Shopify represents the reference information or the URL of the site from which a customer was referred or directed before making a visit or purchase on the Shopify store. It is essentially the referral source, helping store owners understand the origin of their incoming traffic, often used to analyze the effectiveness of marketing campaigns or track how external links drive traffic to their store.
presentment_currency
Type:
string
Description: The "presentment_currency" dimension in Shopify represents the currency in which prices are shown to customers on the storefront. It is particularly relevant in international stores that display prices in local currencies based on the buyer's location or preference. This currency setting helps customers understand product prices in a familiar currency and can differ from the shop's base currency, which is the primary currency set for transactions and reporting in the Shopify admin.
reference
Type:
string
Description: In the context of Shopify's Admin REST API and e-commerce terminology, the "reference" dimension typically represents a unique identifier used to correlate or track specific transactions, orders, or interactions. While it is not explicitly detailed in the API documentation you've linked, "reference" often serves as a custom field that a merchant or external system can use to assign their own meaningful identifier or code to an order or customer interaction. This could be a purchase order number, a transaction code provided by a payment processor, or any other alphanumeric string that helps in associating Shopify data with other business processes or systems.
source_identifier
Type:
string
Description: The dimension "source_identifier" in Shopify typically refers to a unique identifier associated with the source of an order. This can represent different sales channels or platforms from which the order originated, such as a specific online store, a third-party sales channel, or an internal sales tool. In the context of Shopify's ecosystem, it helps merchants and analysts track and distinguish the origins of orders for better sales channel management and performance analysis.
For more detailed information, you can refer to Shopify's API documentation linked in your question, specifically in the contexts where this dimension is applied, such as order reporting and analytics.
landing_site_base_url
Type:
string
Description: The dimension "landing_site_base_url" in the context of Shopify's e-commerce data represents the base URL of the landing page where a customer first arrives before making a purchase. In essence, it captures the initial web address that directs a visitor to an online store, which can be crucial for understanding traffic sources and marketing effectiveness. This URL often comes from external sources such as advertisements, referral links, or email campaigns. Analyzing this dimension helps store owners determine which channels are successfully driving traffic to their site.
order_status_url
Type:
string
Description: The "order_status_url" dimension in Shopify represents a URL that leads to a customer-facing webpage where they can view the current status of their order. This page typically provides information such as whether the order has been processed, shipped, or delivered. The URL is unique for each order and allows customers to track their order updates without needing to log into their Shopify account. This dimension is especially useful for providing transparency and enhancing the customer experience by making order tracking accessible and straightforward.
ga_campaign
Type:
string
Description: The dimension "ga_campaign" in e-commerce data analysis represents the campaign name associated with Google Analytics tracking. It is used to identify and attribute the traffic coming to a Shopify store from specific marketing campaigns. When a URL includes UTM parameters, such as "utm_campaign", Google Analytics can track which marketing efforts are driving users to the site. In the context of Shopify, "ga_campaign" helps store owners understand which campaigns are leading to orders and conversions, allowing them to assess the effectiveness of their marketing strategies.
ga_medium
Type:
string
Description: The dimension key "ga_medium" in the context of Shopify e-commerce data analysis generally refers to the medium through which customers arrived at your online store, often related to Google's analytics parameters. It is a part of UTM parameters used in campaign tagging. The "medium" dimension helps in identifying the type of channel or pathway utilized in driving traffic. Common examples include "organic," "cpc" (cost-per-click), "email," "referral," and "social." This information is essential for understanding the performance of different marketing channels and optimizing marketing strategies accordingly. Although "ga_medium" is not directly specified in the Shopify Admin REST API for orders, it can be integrated into analytics for tracking and performance purposes.
ga_source
Type:
string
Description: The dimension "ga_source" typically represents the origin or source of traffic that leads a user to an e-commerce site, often in the context of Google Analytics data integrated with Shopify. This dimension identifies where a user came from before visiting or making a purchase on your Shopify store. Common sources include search engines (like Google), social media platforms (like Facebook), referral sites, or direct traffic. This allows merchants to analyze the effectiveness of various marketing channels and optimize their strategies accordingly.
ga_source_raw
Type:
string
Description: The "ga_source_raw" dimension in Shopify's e-commerce data analysis represents the original source from which a buyer originated when visiting your online store. This could include various channels such as direct traffic, search engines, social media platforms, referral links, or email campaigns. This dimension is useful for understanding the effectiveness of different traffic sources in driving visitors to your store, allowing you to analyze and optimize your marketing strategies accordingly.
ga_channel_grouping
Type:
string
Description: The "ga_channel_grouping" dimension is typically related to Google Analytics and represents the categorization of your incoming website traffic based on the channel through which users arrived at your store. In the context of Shopify and e-commerce data analysis, this dimension helps you understand the sources of your website visitors, such as Organic Search, Direct, Paid Search, Social, Referral, Email, or other custom campaign channels.
Each channel grouping provides insights into the effectiveness of different marketing efforts and traffic sources, allowing you to analyze user behavior and sales performance from each channel. This categorization is crucial for assessing the ROI of your marketing campaigns and making informed decisions about where to allocate resources to maximize online sales and customer engagement.
client_details_user_agent
Type:
string
Description: The "client_details_user_agent" dimension in Shopify represents the user agent string sent by the browser or device that a customer used to access your Shopify store. This string includes information about the customer's browser type and version, operating system, and device details. It is used to help identify the software and device configuration of the visitor, which can be useful for understanding customer behavior, troubleshooting issues, or optimizing the user experience across different platforms and devices.
shipping_method
Type:
string
Description: The "shipping_method" dimension in Shopify represents the type of delivery service chosen by a customer for an order. This includes information such as the name or type of shipping service (e.g., standard shipping, express delivery), which is generally specified during the checkout process. This dimension helps in analyzing logistics and shipping preferences, allowing merchants to understand customer choices related to the speed and cost of delivery.
order_processed_date
Type:
date
Description: The dimension "order_processed_date" in Shopify's data analysis likely represents the date on which an order has been completed in terms of processing. This includes all necessary steps from payment confirmation, inventory checks, and fulfillment preparation before transitioning to shipment. While the specific term may not be directly found in the Shopify Admin REST API, in common e-commerce contexts, it refers to the point at which the order is fully processed and ready for delivery, symbolizing the backend completion of an order's handling.
order_processed_timestamp
Type:
datetime
Description: [{'type': 'header', 'text': 'Order Processed Timestamp'}, {'type': 'paragraph', 'text': 'Shown in the timezone of the store on which the order was placed.'}]
product_type
Type:
string
Description: The "product_type" dimension in Shopify represents a categorization attribute that describes the category to which a product belongs. It is used to group and organize products within the store, making it easier to manage inventory, analyze sales data, and enhance the shopping experience. This categorization can be based on characteristics such as the product's intended use, design, or target market. Examples of product types might include "Apparel," "Electronics," "Home Goods," etc. Merchants can utilize this attribute to filter products, create collections, and run specific analysis on product categories.
store
Type:
string
Description: The "store" dimension in Shopify typically represents the specific online shop or storefront on the Shopify platform. Each store is essentially a unique entity within Shopify, identified by a unique store name or store ID. It encompasses all the settings, products, orders, and other data specific to that particular business or merchant using Shopify's services. In e-commerce analysis, this dimension is used to segment and analyze data at the level of individual storefronts, allowing merchants or analysts to assess performance, sales, and other metrics within each separate Shopify store.
timezone
Type:
string
Description: The "timezone" dimension in Shopify's context represents the time zone setting of the store as configured in the Shopify admin. This dimension is crucial for understanding the timing of order-related activities and sales performance since it dictates how dates and times are displayed and processed in reports and analyses. It ensures that all time-dependent data, such as order timestamps and customer interactions, are accurately aligned with the store's local time zone rather than defaulting to a standard time like UTC. This dimension is especially important for businesses operating across multiple time zones, allowing them to effectively plan and analyze their operations based on their specific local time settings.
product_id
Type:
string
Description: The "product_id" dimension in Shopify represents the unique identifier for a specific product within a store. This identifier is used to distinguish each product in the store's database, facilitating product management, tracking inventory levels, and analyzing sales performance. In the context of Shopify's Admin REST API, "product_id" is used to retrieve or manipulate data related to a particular product, such as fetching product details, updating information, or generating sales reports.
product_title
Type:
string
Description: The dimension key "product_title" in Shopify represents the name or title of a product as it appears in the Shopify store. This is the human-readable name that merchants assign to each product to describe it to potential buyers. It is a key attribute used for identifying, categorizing, and displaying products across the Shopify ecosystem, including orders, reports, and the storefront. The "product_title" is significant for customer-facing interactions and helps in distinguishing products in the merchant's inventory.
product_image
Type:
string
Description: The "product_image" dimension in the context of Shopify's Admin REST API refers to the visual representation of a product that is used in an online store. It typically includes the URL or path to the image file that visually depicts the product, which can be used on product detail pages, in listings, and wherever a product might be displayed within the storefront or back-end. These images help attract and inform customers, providing a crucial aspect of the browsing and selection experience in e-commerce. This dimension is essential for showcasing the product's aesthetic and functional attributes, potentially influencing purchasing decisions.
product_handle
Type:
string
Description: The "product_handle" in Shopify refers to a unique string identifier for a product, which is used in the URL path to access a product's page on a Shopify store. It is a URL-friendly version of the product's title, typically consisting of lowercase letters, numbers, and hyphens. For example, if a product is titled "Men's Blue T-Shirt," the product handle might be "mens-blue-t-shirt". This handle is crucial for SEO purposes and is used within Shopify's admin and APIs to identify and access specific products.
processed_date
Type:
date
Description: The "processed_date" dimension in Shopify refers to the date and time when an order was processed. In the context of order management and e-commerce operations, this typically means the date when the order has been prepared for fulfillment, such as being packaged, labeled, or otherwise confirmed for shipping to the customer. This timestamp is crucial for tracking fulfillment operations and for understanding the efficiency of order processing workflows. In data analysis, this information can be used to evaluate order processing times, ensure timely fulfillment, and improve overall customer satisfaction by analyzing the gap between order placement and processing.
store
Type:
string
Description: The "store" dimension in Shopify typically represents the specific online shop or storefront on the Shopify platform. Each store is essentially a unique entity within Shopify, identified by a unique store name or store ID. It encompasses all the settings, products, orders, and other data specific to that particular business or merchant using Shopify's services. In e-commerce analysis, this dimension is used to segment and analyze data at the level of individual storefronts, allowing merchants or analysts to assess performance, sales, and other metrics within each separate Shopify store.
customer_id
Type:
string
Description: The "customer_id" dimension represents a unique identifier for a customer in the Shopify platform. This ID is used to distinguish individual customers across various data records and transactions. In the context of Shopify's Admin REST API, the "customer_id" is associated with customer accounts and orders, allowing you to link specific orders, actions, and marketing insights to the respective customer who made a purchase or engaged with the store. This is crucial for customer relationship management, enabling merchants to track purchase history, segment customers, and personalize marketing strategies.
timezone
Type:
string
Description: The "timezone" dimension in Shopify's context represents the time zone setting of the store as configured in the Shopify admin. This dimension is crucial for understanding the timing of order-related activities and sales performance since it dictates how dates and times are displayed and processed in reports and analyses. It ensures that all time-dependent data, such as order timestamps and customer interactions, are accurately aligned with the store's local time zone rather than defaulting to a standard time like UTC. This dimension is especially important for businesses operating across multiple time zones, allowing them to effectively plan and analyze their operations based on their specific local time settings.
klaviyo_acquisition_channel
Type:
string
Description: The dimension "klaviyo_acquisition_channel" refers to the specific channel or source through which a customer was acquired, as identified and tracked by Klaviyo, a popular email marketing and customer engagement platform often integrated with Shopify. This dimension helps merchants understand the origin or path through which new or existing customers engaged with their store, potentially through campaigns like email marketing, social media, ads, or other channels Klaviyo can track. Understanding this dimension allows businesses to analyze and optimize their marketing strategies to improve customer acquisition and retention.
is_gift_card
Type:
boolean
Description: The dimension key "is_gift_card" in Shopify's e-commerce data analysis represents a boolean attribute indicating whether a particular product or item in an order is a gift card. It is used to identify transactions involving gift cards, which are products that can be purchased and later redeemed as store credit. This dimension is particularly useful for distinguishing gift card transactions from the sales of other physical or digital products, allowing retailers to analyze and manage gift card usage, sales, and redemptions separately within their order data.
customer_first_order_timestamp
Type:
string
Description: The "customer_first_order_timestamp" dimension in Shopify e-commerce data analysis represents the date and time when a customer placed their first order on the Shopify store. This timestamp marks the initial transaction time registered in the system for a customer, helping merchants to identify when a customer began their purchasing journey. It is useful for analyzing customer acquisition timelines, understanding lifetime value, and segmenting customers based on their tenure with the store.
type_of_product_in_order
Type:
string
Description: The dimension "type_of_product_in_order" likely refers to the categorization or classification of products included within an order on a Shopify store. In e-commerce and within Shopify's context, this dimension would typically be used to identify the different categories or types of products (e.g., clothing, electronics, accessories) that are part of a customer's purchase order. This helps in analyzing which product types are frequently ordered, thus enabling a store owner to understand customer preferences and trends. Keep in mind that the exact implementation or presence of this dimension may require custom logic, as Shopify's standard data does not inherently categorize products without additional setup such as tags or custom product types.
customer_lifetime_duration
Type:
string
Description: The dimension key "customer_lifetime_duration" in the context of Shopify and e-commerce data analysis typically refers to the total time span from when a customer places their first order to their most recent order. It is a measure of how long a customer has been active on the store, providing insight into customer loyalty and engagement over time. This metric can be used to analyze customer behavior, retention, and the effectiveness of marketing strategies designed to prolong customer relationships.
customer_email
Type:
string
Description: The "customer_email" dimension in Shopify represents the email address associated with a customer who has placed an order. This dimension is used to identify and track individual customers, enabling retailers to analyze customer behavior, send order confirmations, and facilitate communications. In the context of Shopify's data, the "customer_email" serves as a unique identifier for customer interactions and order processing within the e-commerce platform.
customer_name
Type:
string
Description: The "customer_name" dimension in Shopify e-commerce analysis represents the full name of the customer associated with a particular order. This is typically a combination of the first and last names of the customer who placed the order. It's used to identify and analyze customer-related data within the context of orders, allowing businesses to track purchasing behavior and patterns linked to individual customers.
customer_email_marketing_consent_state
Type:
string
Description: The dimension "customer_email_marketing_consent_state" represents the current status of a customer's consent to receive marketing emails. This value indicates whether a customer has opted in or out of email marketing communications. It is used to manage and track customer preferences regarding promotional emails and ensure compliance with privacy regulations. Common states include "subscribed" (indicating consent has been given), "unsubscribed" (indicating consent has been withdrawn), or "not_subscribed" (indicating that the customer has never opted in). This dimension is essential for segmenting customers and targeting marketing campaigns effectively.
customer_email_marketing_consent_opt_in_level
Type:
string
Description: The "customer_email_marketing_consent_opt_in_level" dimension represents the level or status of consent given by a customer for receiving marketing communications via email. In the context of e-commerce and Shopify, this typically indicates how a customer's permission to receive marketing emails is recorded or classified, such as:
Subscribed: The customer has explicitly opted in to receive marketing emails.
Unsubscribed: The customer has opted out or has not subscribed to receive marketing emails.
Pending: The customer's consent is in a pending state, possibly due to an incomplete opt-in process.
This dimension is crucial for understanding and managing customer engagement strategies, ensuring compliance with email marketing regulations, and tailoring marketing efforts based on customer preferences.
company_billing_address
Type:
string
Description: The dimension "company_billing_address" in Shopify's e-commerce data analysis represents the billing address associated with a company's order. This typically includes details such as the company's name, street address, city, state or province, postal code, and country where the billing information is sent or registered. It is used to identify and verify the company responsible for the payment of the order. This dimension is crucial for processing payments, fraud prevention, and financial reporting in e-commerce.
company_shipping_address
Type:
string
Description: The "company_shipping_address" dimension in a Shopify context typically represents the shipping address associated with a company for an order placed on a Shopify store. This dimension would detail the address where goods are intended to be delivered, including information such as the company name, street address, city, state or province, postal code, and country. It is a part of the order data used in analyzing and managing shipments within an e-commerce business. This dimension is crucial for logistics and fulfillment processes, ensuring that orders are shipped to the correct location specified by the customer.
customer_total_spent
Type:
integer
Description: The dimension "customer_total_spent" in the context of Shopify e-commerce data analysis likely represents the cumulative total amount of money a customer has spent at a store over their lifetime. This metric aggregates all orders placed by the customer, providing valuable insights into customer value and purchasing behavior. It helps businesses understand the overall contribution of a customer to the store's revenue.
expenses_type
Type:
string
Description: The dimension "expenses_type" in the context of Shopify and e-commerce data analysis refers to the categorization of different types of expenses associated with running an online store. This could include cost categories like product costs, shipping expenses, payment processing fees, refunds, discounts, marketing expenses, operational costs, and more. By analyzing this dimension, businesses can better understand where their money is going and how to optimize their expenses for improved profitability and efficiency. It helps in tracking and managing various financial outflows in the e-commerce operations.
product_tag
Type:
string
Description: The "product_tag" dimension in Shopify represents the labels or keywords assigned to a product to help categorize and filter it within a store's inventory. These tags are user-defined and can be used to describe product characteristics, such as style, season, or any other relevant attributes. The purpose of product tags is to enhance the organization of products, facilitate search and navigation for customers, and enable easier merchandising and marketing strategies within the Shopify platform.
cancelled_timestamp
Type:
string
Description: The dimension "cancelled_timestamp" in Shopify represents the exact date and time when an order was cancelled. This timestamp indicates when the cancellation action was finalized in the Shopify system, providing insights into the timeline of an order's lifecycle. This can be useful for tracking order management efficiency, understanding customer behavior, or analyzing cancellation trends over time.
cancelled_date
Type:
date
Description: The "cancelled_date" dimension in the context of Shopify and e-commerce data analysis represents the specific date and time when an order was officially canceled in the Shopify platform. This timestamp indicates when the cancellation action was performed, which can help businesses track and analyze order cancellations over time, understand customer behavior, and assess any operational or logistical issues that may lead to cancellations. This data is crucial for reporting and analysis, allowing merchants to optimize their processes and improve customer satisfaction.
variant_id
Type:
string
Description: The "variant_id" in Shopify represents the unique identifier for a specific variant of a product. In e-commerce and Shopify's context, products can have multiple variants, which are different versions of the same product, distinguished by attributes like size, color, or material. Each variant is considered a distinct item with its own inventory level, price, and SKU (Stock Keeping Unit). The "variant_id" is crucial for tracking and managing these individual product variants in the Shopify system, allowing for precise inventory management, order processing, and data analysis.
sku
Type:
string
Description: In the context of Shopify and e-commerce data analysis, the dimension key "sku" stands for "Stock Keeping Unit." It is an alphanumeric code used to uniquely identify a specific product or variant in your inventory. The SKU is crucial for inventory management, allowing merchants to track products, manage stock levels, and streamline operations. Each SKU is unique to a variant of a product, which means even different sizes or colors of the same product will typically have different SKUs. This helps ensure that the right product is tracked and sold, reducing errors and improving order fulfillment efficiency.
customer_first_order_skus
Type:
string
Description: The dimension "customer_first_order_skus" represents the Stock Keeping Units (SKUs) associated with the first order placed by a customer. In Shopify, an SKU is a unique identifier for each distinct product and its variations, such as size or color. This dimension is valuable for analyzing purchasing behavior and trends by identifying which specific products initiated a customer's shopping journey with a store. It helps in understanding initial customer preferences and can be crucial for targeting marketing and retention strategies.
skus_in_order
Type:
string
Description: The dimension "skus_in_order" refers to the total number of distinct Stock Keeping Units (SKUs) present within a single order. In the context of Shopify's e-commerce data, a SKU is a unique identifier for each distinct product or item variant sold through the platform. Therefore, "skus_in_order" counts how many different product variants have been purchased in a particular order, regardless of the quantity of each variant. This metric is useful for understanding the diversity of products within an order and can help in analyzing purchase patterns and inventory distribution.
product_titles_in_order
Type:
string
Description: The dimension "product_titles_in_order" in Shopify e-commerce data analysis represents a list of the titles of all products included in a specific order. Each product in the order is identified by its title, providing a human-readable way to understand which products were purchased as part of that order. This dimension helps merchants analyze sales trends by reviewing the actual names of products sold in each transaction. This can be particularly useful for reporting and insights into popular products and customer purchasing behavior.
vendors_in_order
Type:
string
Description: The "vendors_in_order" dimension represents the list of distinct suppliers or brands associated with the products included in a specific order. In the context of Shopify, a vendor is typically the entity that manufactures, sells, or supplies a particular product listed in the store. This dimension helps in analyzing an order by identifying the different vendors whose products have been purchased, which can be useful for inventory management, order fulfillment, and vendor performance analysis.
product_types_in_order
Type:
string
Description: The dimension "product_types_in_order" represents a list or set of distinct product types present in a particular order. Each product type corresponds to a specific category or classification assigned to products within a Shopify store. This dimension helps identify and analyze the variety of product categories included in a single order. It is useful for understanding customer purchasing patterns and for inventory and sales analysis by categorizing items under various product types defined in the store.
product_tags
Type:
string
Description: The "product_tags" dimension in Shopify represents a set of descriptive labels or keywords assigned to a product. These tags are used to categorize and organize products within a Shopify store, making it easier for both store owners and customers to search for and filter products. Tags can denote various attributes like season, material, style, or any other classification relevant to the product. They enhance the browsing and searching experience by allowing products to be grouped or queried based on these associated tags.
customer_first_order_product_titles
Type:
string
Description: The dimension key "customer_first_order_product_titles" represents the titles of the products that a customer purchased in their first order with the store. This information is typically used to understand what products first attracted and converted a customer, which can be important for marketing and analytics purposes. By analyzing this data, merchants can identify which products are most effective at drawing in new customers.
customer_first_order_vendors
Type:
string
Description: The dimension "customer_first_order_vendors" in the context of Shopify e-commerce data analysis refers to the list of vendors associated with the products purchased in a customer's first order on the platform. This dimension helps in understanding which vendors initially attracted customers, providing insights into vendor performance in acquiring new customers. When analyzing customer purchase behavior, this dimension can reveal trends or patterns about the vendors that are effective in generating customers' first-time purchases.
customer_first_order_product_types
Type:
string
Description: The dimension "customer_first_order_product_types" refers to the types or categories of products that a customer purchased in their very first order with a store on the Shopify platform. This dimension helps businesses analyze customer behavior by understanding what types of products tend to attract new customers. By examining this data, merchants can identify trends or patterns in product categories that successfully convert first-time visitors into buyers. This information can be useful for marketing, inventory management, and strategic planning to optimize the onboarding of new customers and drive future sales.
product_id
Type:
string
Description: The "product_id" dimension in Shopify represents the unique identifier for a specific product within a store. This identifier is used to distinguish each product in the store's database, facilitating product management, tracking inventory levels, and analyzing sales performance. In the context of Shopify's Admin REST API, "product_id" is used to retrieve or manipulate data related to a particular product, such as fetching product details, updating information, or generating sales reports.
variant_title
Type:
string
Description: The "variant_title" dimension in Shopify refers to the title of a specific product variant. In e-commerce, a product variant is a version of a product that has different attributes, such as size, color, or material. The "variant_title" provides a concise description of these attributes for a particular product variant. For example, if a product is a t-shirt available in different sizes and colors, the "variant_title" might specify "Large / Red" to indicate the specific variant. This dimension is useful for distinguishing between different versions of the same product in data analysis and reporting.
product_title
Type:
string
Description: The dimension key "product_title" in Shopify represents the name or title of a product as it appears in the Shopify store. This is the human-readable name that merchants assign to each product to describe it to potential buyers. It is a key attribute used for identifying, categorizing, and displaying products across the Shopify ecosystem, including orders, reports, and the storefront. The "product_title" is significant for customer-facing interactions and helps in distinguishing products in the merchant's inventory.
product_option_1
Type:
string
Description: The "product_option_1" dimension in Shopify refers to the first variant option for a product. In e-commerce, products can have multiple variants, distinguished by different options such as size, color, or material. The "product_option_1" specifically represents the primary option category for a product variant. For example, if a store sells a t-shirt available in different colors, "product_option_1" might be used to specify the color attribute (e.g., "Red", "Blue", "Green") for each variant of the t-shirt. This dimension helps in organizing and analyzing products based on their variant attributes in Shopify's e-commerce platform.
product_option_2
Type:
string
Description: The dimension key "product_option_2" in Shopify data refers to the second customizable attribute of a product variant. In the context of e-commerce and Shopify's data model, products can have different variants based on options like size, color, material, etc. Each product can have up to three options per variant.
For example, if a store sells t-shirts, the product options could be:
Option 1: Size (e.g., Small, Medium, Large)
Option 2: Color (e.g., Red, Blue, Green)
Option 3: Material (e.g., Cotton, Polyester)
In this case, "product_option_2" would specifically represent the "Color" of the t-shirt. It is a descriptive field that helps in categorizing and distinguishing between different variants of the same base product, improving inventory management and customer selection during the purchasing process.
product_option_3
Type:
string
Description: The dimension key "product_option_3" in Shopify e-commerce data analysis represents the third option value for a product variant. In Shopify, products can have multiple variants, which are combinations of different options. For each variant, a product can have up to three options, such as size, color, and material. "product_option_3" specifically refers to the value of the third option (if it exists) for a given product variant. For instance, if a t-shirt comes in various sizes, colors, and sleeve lengths, "product_option_3" would indicate the sleeve length for that specific variant.
product_handle
Type:
string
Description: The "product_handle" in Shopify refers to a unique string identifier for a product, which is used in the URL path to access a product's page on a Shopify store. It is a URL-friendly version of the product's title, typically consisting of lowercase letters, numbers, and hyphens. For example, if a product is titled "Men's Blue T-Shirt," the product handle might be "mens-blue-t-shirt". This handle is crucial for SEO purposes and is used within Shopify's admin and APIs to identify and access specific products.
product_type
Type:
string
Description: The "product_type" dimension in Shopify represents a categorization attribute that describes the category to which a product belongs. It is used to group and organize products within the store, making it easier to manage inventory, analyze sales data, and enhance the shopping experience. This categorization can be based on characteristics such as the product's intended use, design, or target market. Examples of product types might include "Apparel," "Electronics," "Home Goods," etc. Merchants can utilize this attribute to filter products, create collections, and run specific analysis on product categories.
product_status
Type:
string
Description: The "product_status" dimension in Shopify's context represents the current state or condition of a product in the Shopify store's inventory. It typically indicates whether a product is available for purchase or not, and can include various statuses such as:
Active: The product is available and visible to customers. It can be purchased through the online store or other sales channels.
Draft: The product is not yet available for purchase. It might be a new product that is still being set up or edited.
Archived: The product is no longer active and is removed from sales channels but is retained in the store's records for future reference or reporting.
Understanding "product_status" is crucial for managing inventory, sales, and marketing strategies within a Shopify store.
collection_title
Type:
string
Description: The "collection_title" dimension in Shopify refers to the name of a collection within a Shopify store. A collection is a group of products that are organized together, typically for marketing or navigational purposes. This can include groupings like "Summer Sale," "New Arrivals," or "Best Sellers." The "collection_title" helps store owners and analysts categorize and analyze sales and performance data specific to each collection. By examining this dimension, businesses can gain insights into how various collections are performing and make informed decisions on merchandising and promotions.
collection_id
Type:
string
Description: The "collection_id" in Shopify refers to the unique identifier for a collection, which is a grouping of products in a Shopify store. Collections are used to organize products into categories, making it easier for customers to find items. These collections can be based on various attributes, such as product type, vendor, price range, or custom criteria set by the store owner. The "collection_id" allows for tracking and referencing specific collections within Shopify's Admin REST API and facilitates the analysis of product grouping and categorization in e-commerce data.
collection_handle
Type:
string
Description: The "collection_handle" dimension in Shopify refers to a unique identifier for a specific collection within a Shopify store. Collections are groups of products organized together under a common theme or category, making it easier for customers to browse and find products. The "handle" is a URL-friendly version of the collection's name, typically in lowercase and with spaces replaced by hyphens. This handle is used in the store's URLs and the Shopify API to reliably reference a collection across different parts of the Shopify platform.
collection_template_suffix
Type:
string
Description: The "collection_template_suffix" in Shopify refers to the template suffix used to render a specific collection page within a Shopify store. In Shopify, merchants can create custom templates to modify the appearance and functionality of collection pages. By using a template suffix, Shopify allows the assignment of different templates to different collections, enabling the merchant to customize how each collection is displayed to customers. The "collection_template_suffix" is the part of the template file name that appears after "collection." (e.g., "collection.special" where "special" is the suffix). This dimension is useful in e-commerce data analysis for understanding how different collections are presented to customers and potentially analyzing the impact of different page layouts or designs on customer engagement or sales.
url
Type:
string
Description: In the context of Shopify's e-commerce data analysis and using common e-commerce terminology, the dimension key "url" typically represents a web address or link associated with a specific entity or action within the Shopify platform. This might include:
Product URL: The web link to a specific product page on the online store, enabling direct access to the product's detailed information and purchase options.
Order URL: A unique link that merchants can use to view order details in the Shopify admin interface.
Collection URL: The link directing users to a collection page where multiple products are grouped together based on specific attributes like category, type, etc.
Customer URL: A link to view a specific customer's details within the Shopify admin.
In a broader sense, when analyzing Shopify data, the "url" dimension could be utilized to associate user interactions with specific pages, track referral paths, manage SEO attributes, or offer direct navigation to key resources in Shopify's ecosystem.
inventory_management
Type:
string
Description: The "inventory_management" dimension in Shopify refers to how inventory levels for a product variant are tracked and managed. Specifically, it indicates whether Shopify or another external system is responsible for managing the inventory of a product variant. If "inventory_management" is set to Shopify, it means that Shopify will automatically update the inventory count as orders are placed and items are fulfilled. If it's set to an external system, that system will handle inventory updates and Shopify will not modify these counts automatically. This dimension is crucial for understanding and analyzing how inventory is controlled across different sales channels and fulfillment processes.
product_image
Type:
string
Description: The "product_image" dimension in the context of Shopify's Admin REST API refers to the visual representation of a product that is used in an online store. It typically includes the URL or path to the image file that visually depicts the product, which can be used on product detail pages, in listings, and wherever a product might be displayed within the storefront or back-end. These images help attract and inform customers, providing a crucial aspect of the browsing and selection experience in e-commerce. This dimension is essential for showcasing the product's aesthetic and functional attributes, potentially influencing purchasing decisions.
vendor
Type:
string
Description: The "vendor" dimension in Shopify represents the manufacturer, wholesaler, or distributor of a product. This dimension is used to categorize and organize products based on their source or brand, which can be particularly useful in analyzing sales data, managing inventory, and assessing the performance of different suppliers. In Shopify's product catalog, each product can have a vendor attribute, allowing merchants to easily filter and report on inventory or orders by vendor.
customer_first_order_month
Type:
date
Description: The "customer_first_order_month" dimension represents the month in which a customer made their first purchase on a Shopify store. This dimension is derived by examining a customer's order history and identifying the specific month and year of their initial transaction. It can be used in e-commerce data analysis to understand customer acquisition trends, cohort analysis, and to evaluate marketing campaign effectiveness over time. By analyzing this dimension, businesses can gain insights into the timing of customer onboarding and tailor their strategies accordingly.
customer_first_order_date
Type:
date
Description: The dimension "customer_first_order_date" refers to the date when a customer made their first purchase on the Shopify store. This data point is used to track when a customer began their relationship with the store by making their initial order. It helps store owners analyze customer acquisition patterns, understand customer lifetime value, and segment customers based on the duration of their loyalty.
sales_channel
Type:
string
Description: In the context of Shopify's Admin REST API and e-commerce data analysis, the "sales_channel" dimension represents the platform or method through which an order or transaction is made. This could include online stores, physical retail locations, mobile apps, social media platforms, marketplaces, or any other integrated sales channel that a merchant uses to sell their products. The "sales_channel" helps in categorizing and analyzing sales data based on where the sales originate, allowing merchants to assess the performance of different sales channels and make informed strategic decisions.
sales_channel_name
Type:
string
Description: The "sales_channel_name" dimension represents the specific platform or medium through which an order was placed or a sale was processed within a Shopify store. This can include various sales channels such as the online store, point of sale (POS), mobile app, social media platforms like Facebook or Instagram, and other third-party marketplaces that are integrated with Shopify. By analyzing this dimension, merchants can gain insights into which channels are performing best and strategize accordingly to optimize their sales efforts across different platforms.
order_tag
Type:
string
Description: The dimension "order_tag" in Shopify represents a label or keyword assigned to an order within the Shopify platform. Order tags are used to categorize, organize, and manage orders more effectively. Merchants can apply one or multiple tags to each order to denote special characteristics, conditions, or handling instructions. For example, tags can be used to indicate that an order is a priority, requires gift wrapping, or belongs to a specific marketing campaign. These tags are highly customizable and serve as an efficient means for filtering and searching orders in the Shopify admin dashboard.
order_tags_in_order
Type:
string
Description: The dimension "order_tags_in_order" in Shopify represents the tags associated with a particular order. In Shopify, tags are used to categorize and organize orders for better management and analysis. These tags can be applied manually by a store owner or automatically through apps and workflows based on certain criteria. The "order_tags_in_order" dimension helps in filtering and analyzing order data based on these tags, allowing store owners to identify patterns or group orders with similar characteristics. This dimension is particularly useful for segmenting orders for reporting, fulfillment, and customer service purposes.
billing_country
Type:
string
Description: The "billing_country" dimension in Shopify represents the country associated with the billing address provided by the customer during the checkout process. This dimension indicates the country to which the billing address belongs, usually corresponding to the location of the customer's payment method, such as a credit card. It is a vital piece of information used for understanding customer demographics, regional sales reporting, and potentially for assessing tax liabilities and compliance with international shipping regulations.
customer_tag
Type:
string
Description: The dimension key "customer_tag" in Shopify represents labels or keywords assigned to customers that help categorize them based on certain characteristics or behaviors. These tags allow merchants to segment their customer base for targeted marketing, personalized experiences, and better customer management. For example, a customer might have tags like "VIP," "Newsletter Subscriber," or "Wholesale Client." The "customer_tag" is useful for filtering and organizing customers within the Shopify platform, enabling merchants to tailor their interactions and offerings accordingly.
order_discount_code
Type:
string
Description: The "order_discount_code" dimension in Shopify e-commerce data analysis represents the code or identifier used for a discount applied to an order. This code typically corresponds to promotional discounts, coupons, or special offers that customers can enter during the checkout process to receive a reduction in price. The dimension captures the specific discount code used for a given order, allowing businesses to analyze the effectiveness and usage of various discount campaigns and promotions.
order_discount_code_amount
Type:
string
Description: The dimension "order_discount_code_amount" in Shopify refers to the total amount of discounts that have been applied to an order as a result of discount codes. Discount codes are promotional codes that customers can enter at checkout to receive a reduction in the order price. This particular dimension captures the cumulative value of all such reductions applied to the order, reflecting how much the order total has been decreased due to the use of discount codes.
order_discount_code_type
Type:
string
Description: The dimension "order_discount_code_type" in Shopify refers to the classification of discount codes applied to an order. In the context of Shopify's e-commerce platform, discount codes are promotional codes that customers can enter at checkout to receive deductions on their purchase total. These discount codes can be of various types, such as:
Percentage Discount: The discount code reduces the order total by a certain percentage.
Fixed Amount Discount: The discount code reduces the order total by a specific flat amount.
Free Shipping: The discount code provides free shipping for the order.
Buy X Get Y: The discount code triggers an offer such as buying a certain quantity of items to get additional items free or at a discounted rate.
The "order_discount_code_type" dimension helps in identifying the type of discount applied, allowing merchants and analysts to assess the effectiveness and impact of different types of promotions on sales and customer behavior.
is_cancelled
Type:
boolean
Description: The "is_cancelled" dimension in Shopify's context typically refers to whether an order has been canceled or not. This dimension would indicate a boolean value:
true
if the order has been canceled andfalse
if it remains active or unfulfilled. In e-commerce, tracking whether an order is canceled is crucial for understanding order status, managing inventory, and analyzing sales metrics. When referencing the Shopify Admin REST API, this dimension helps in filtering or identifying orders that have been canceled during the processing lifecycle.
shipping_country
Type:
string
Description: The "shipping_country" dimension in Shopify refers to the country to which an order is being shipped. It represents the destination country specified in the shipping address associated with a customer's order. This dimension is vital for analyzing sales distribution across different countries, understanding international shipping needs, and tailoring marketing strategies to various geographic regions. The value of "shipping_country" is typically formatted as a two-letter ISO 3166-1 alpha-2 country code.
purchase_type
Type:
string
Description: The dimension "purchase_type" in the context of Shopify's e-commerce data analysis typically refers to the classification of a transaction based on how the purchase was made. This can include distinctions like "online" for purchases made through an e-commerce platform, "in-store" for physical store purchases using Shopify POS, or other types of specific transaction methods. This dimension helps businesses analyze and differentiate between various sales channels or methods through which customers place orders. It provides insights into customer purchasing behavior and helps in strategic decision-making regarding sales channels.
store_currency
Type:
string
Description: The dimension "store_currency" in Shopify represents the currency that a store is set up to use for its operations, transactions, and financial reporting. This currency is used as the default currency for displaying product prices, processing orders, and generating financial reports within the Shopify store. It is defined in the store's settings and ensures consistency for financial data analysis and customer transactions.
processing_method
Type:
string
Description: The "processing_method" dimension in Shopify's context refers to the method by which a payment was processed for an order. This dimension indicates the mechanism through which the transaction was completed, such as whether it was handled through a manual payment, an automatic capture of funds, or other specific methods associated with payment gateways integrated into the store. Understanding this dimension helps in analyzing payment trends and processing efficiency within the e-commerce store.
payment_gateway_names
Type:
string
Description: The "payment_gateway_names" dimension in Shopify represents the name(s) of the payment gateway(s) used to process transactions for an order. In the context of Shopify's Admin REST API and e-commerce data analysis, this dimension provides insights into which payment service providers are being utilized for processing payments, such as PayPal, Stripe, or Shopify Payments. It helps in understanding the distribution of payment preferences among customers and can be used for reporting and analytics to optimize payment options offered in the store.
referring_site
Type:
string
Description: The "referring_site" dimension in Shopify e-commerce data analysis represents the URL of the website that directed a customer to the Shopify store, leading to a transaction. This field helps in tracking the source of incoming traffic that results in sales, providing insights into the effectiveness of external websites or marketing channels in driving purchases. This can include search engines, social media platforms, affiliate links, or other websites. Understanding the referring sites can assist businesses in optimizing their marketing strategies and partnerships.
referring_source
Type:
string
Description: The "referring_source" dimension in Shopify e-commerce data analysis represents the origin or medium through which a customer was directed to your online store before making a purchase. This dimension helps identify how customers found your store, whether it was through search engines, social media, direct links, ads, or other referral channels. Understanding the "referring_source" allows you to evaluate the effectiveness of your marketing channels and optimize your strategies for driving traffic to your store.
processed_timestamp
Type:
string
Description: The "processed_timestamp" dimension in the context of Shopify e-commerce data analysis refers to the specific date and time when an order is processed. This timestamp indicates when the order has transitioned from pending or unfulfilled to a stage where it is confirmed for fulfillment. It is crucial for understanding the timeline and efficiency of order processing within the store’s operations. This dimension helps in tracking operational performance and can be used to analyze how quickly orders are being processed after they are placed. The "processed_timestamp" is typically presented in ISO 8601 format, providing a precise and standardized time reference.
processed_date
Type:
date
Description: The "processed_date" dimension in Shopify refers to the date and time when an order was processed. In the context of order management and e-commerce operations, this typically means the date when the order has been prepared for fulfillment, such as being packaged, labeled, or otherwise confirmed for shipping to the customer. This timestamp is crucial for tracking fulfillment operations and for understanding the efficiency of order processing workflows. In data analysis, this information can be used to evaluate order processing times, ensure timely fulfillment, and improve overall customer satisfaction by analyzing the gap between order placement and processing.
updated_timestamp
Type:
string
Description: The "updated_timestamp" dimension in the context of Shopify's Admin REST API typically represents the exact date and time when the resource, such as an order, was last modified. This timestamp indicates the most recent update made to the record, whether that update involved a change in order status, a modification of the order details, or any other update action performed. It is essential for tracking the latest activity on an order and is crucial for tasks like synchronization, data consistency, and audit trails in e-commerce operations.
updated_date
Type:
date
Description: The "updated_date" dimension in Shopify e-commerce data typically represents the date and time when a specific record, such as an order, product, or customer, was last modified or updated in the Shopify system. This includes any changes made to the record's details, such as status updates, edits to product descriptions, changes in customer information, or any other modifications. The "updated_date" helps in tracking the most recent changes to the record and can be useful for analyzing trends, syncing data, and maintaining accurate records over time.
customer_order_number
Type:
integer
Description: The "customer_order_number" dimension represents the sequential number assigned to an order by a specific customer within Shopify. It is a unique identifier for each order placed by a customer, often used to track and reference individual orders in customer service and reporting. This number is typically sequential for each customer, starting from their first purchase, and helps distinguish one customer's orders from another's, providing easier order management and organization for merchants.
customer_order_segment
Type:
string
Description: The "customer_order_segment" dimension in the context of Shopify e-commerce data analysis likely refers to the categorization or grouping of customers based on their purchasing behavior or order characteristics. This might include segmenting customers into different groups based on criteria such as the frequency of purchases, order value, recency of their last purchase, or other buying patterns. Utilizing this dimension allows businesses to analyze and understand the different segments of their customer base, tailor marketing strategies, and improve customer engagement by identifying key segments like loyal customers, high-spending customers, or new customers. While this specific term is not explicitly detailed in the Shopify API documentation, it aligns with common e-commerce practices of using customer segmentation for actionable insights.
order_id
Type:
string
Description: The "order_id" dimension in Shopify refers to the unique identifier assigned to each individual order placed through a Shopify store. This ID is a distinct numerical value that allows merchants and systems to track, manage, and reference specific orders. It is crucial for order management, enabling actions such as order retrieval, fulfillment, and analysis. The "order_id" is utilized in various API calls to access detailed information about an order, including customer details, products purchased, payment, and shipping information.
order_number
Type:
string
Description: The "order_number" dimension in Shopify represents a unique identifier assigned to each order in a sequential manner. This number is used to track and reference individual orders within the Shopify platform. It typically begins with a starting number (usually 1001 for new stores) and increments by one for each subsequent order. It's important to note that the "order_number" is distinct from the "id" or "order_id," which is a globally unique identifier (GUID) used internally by Shopify. The "order_number" is often used in customer communication and reports as it is more user-friendly and easier to reference when compared to the internal IDs.
order_name
Type:
string
Description: The "order_name" dimension in Shopify refers to the unique identifier assigned to an order, which is typically in the format "#{order_number}". It is a human-readable string that helps both merchants and customers to easily reference and track specific orders within the Shopify platform. This identifier is often a combination of a prefix and a sequential order number, and it remains consistent across various Shopify interfaces and reports, making it an essential element for organizing and analyzing e-commerce sales data.
refund_id
Type:
string
Description: The "refund_id" in Shopify represents a unique identifier for a refund transaction associated with an order. When a refund is processed on an order, it is assigned a specific "refund_id" to distinguish it from other refunds or transactions. This ID is used to track and manage the refund details within the Shopify system, such as the refunded amount, items refunded, and date of the refund. It is a critical dimension for analyzing refund activities related to customer orders in e-commerce data analysis.
is_refund
Type:
boolean
Description: The "is_refund" dimension in the context of Shopify's e-commerce data analysis typically indicates whether a particular transaction or order line item involves a refund. When this dimension is true, it signifies that the transaction is a refund, meaning money has been returned to the customer for that portion of the order. This can help merchants identify and analyze refunds separately from sales, allowing for better financial tracking and customer service assessments.
pos_location_name
Type:
string
Description: The "pos_location_name" dimension in Shopify typically represents the name of the physical location or retail store where a point of sale (POS) transaction occurs. In the context of e-commerce data analysis, this dimension is used to identify and differentiate sales based on the specific physical location where the order was processed. This is particularly useful for merchants who operate multiple physical stores or outlets, allowing them to analyze and compare sales performance across different locations.
financial_status
Type:
string
Description: The "financial_status" dimension in Shopify's context refers to the current state of an order in terms of its payment processing. It indicates whether the payment for an order has been successfully completed, is pending, has failed, or has been refunded, among other potential statuses. This dimension is crucial for understanding the financial progress and completion status of an order. Common statuses include "paid", "pending", "authorized", "partially_paid", "refunded", and "voided". Each status helps merchants track and manage the financial lifecycle of orders.
fulfillment_status
Type:
string
Description: The "fulfillment_status" dimension in Shopify refers to the current state of an order's fulfillment process. It indicates whether the items in an order have been shipped or delivered to the customer. Common statuses include:
unfulfilled: No items in the order have been fulfilled.
partial: Some items in the order have been fulfilled, while others have not.
fulfilled: All items in the order have been fulfilled and shipped to the customer.
This dimension is used to track and manage the shipping of products, providing vital information on order processing and delivery progress.
shipping_city
Type:
string
Description: The "shipping_city" dimension in Shopify represents the city name to which an order is being shipped. This is extracted from the shipping address provided by the customer during the checkout process. It is a crucial component in order fulfillment and logistics, helping businesses to analyze shipping patterns and optimize delivery services based on geographical data.
shipping_country_code
Type:
string
Description: The dimension "shipping_country_code" in Shopify e-commerce data analysis represents the ISO 3166-1 alpha-2 country code for the destination country to which a customer's order is being shipped. This two-letter code is used to identify the specific country where the order's shipping address is located. For example, "US" would indicate that the shipment is going to the United States, while "CA" would represent Canada. This dimension is useful for analyzing and segmenting orders based on their shipping destinations.
shipping_province
Type:
string
Description: The "shipping_province" dimension in Shopify refers to the specific province or state to which an order is being shipped. This dimension is part of the shipping address information provided by the customer during the checkout process. It helps in analyzing order distribution based on geographic regions, calculating shipping costs, and understanding sales trends within specific areas. This dimension is particularly important for merchants who operate in regions with province-specific taxation or shipping regulations.
shipping_province_code
Type:
string
Description: The "shipping_province_code" dimension in Shopify represents the specific code or abbreviation of the province or state to which an order is being shipped. This dimension is used to identify the regional area within a country that is the destination for the shipment, helping with logistical planning, tax calculations, and geographic sales analysis.
shipping_zip
Type:
string
Description: The "shipping_zip" dimension in Shopify e-commerce data represents the postal or ZIP code of the shipping address associated with a specific order. It indicates the geographic area to which the order is being shipped and is a component of the broader shipping address information. This dimension is often used in data analysis to understand regional shipping patterns, calculate shipping costs, assess delivery zones, or conduct targeted marketing efforts based on geographic location.
billing_city
Type:
string
Description: The "billing_city" dimension in Shopify refers to the city specified in the billing address of an order. This information is captured when a customer makes a purchase and provides their payment details. It represents the city where the billing address is located, which is typically the address associated with the payment method used for the transaction. This dimension is useful for analyzing geographic trends in sales and understanding the distribution of customers by city location.
billing_country_code
Type:
string
Description: The "billing_country_code" dimension in Shopify represents the two-letter ISO 3166-1 alpha-2 country code for the country associated with the billing address provided by the customer during the checkout process. This code indicates the country where the billing information, such as the customer's payment details, is registered. This dimension is commonly used in e-commerce data analysis to segment orders or examine purchasing trends based on the geographical location of the billing address.
billing_province
Type:
string
Description: The "billing_province" dimension in Shopify refers to the state, region, or province associated with the billing address of an order. This dimension captures the geographic administrative area where the billing information of the customer is located. It is a part of the billing address details provided by the customer during the checkout process. Understanding the "billing_province" can be useful for analyzing regional sales trends, tax calculations, and customer demographics in e-commerce data.
billing_province_code
Type:
string
Description: The dimension "billing_province_code" in Shopify refers to the standardized code representing the province or region of the billing address associated with an order. This code is typically a short form or abbreviation used to identify the geographic area within the billing country. For example, in Canada, it would be the two-letter code for the province such as "ON" for Ontario. This dimension is useful in e-commerce data analysis for identifying and segmenting orders based on the billing region, which can help in understanding customer demographics and regional sales patterns.
billing_zip
Type:
string
Description: In the context of Shopify and e-commerce data analysis, the dimension key "billing_zip" represents the postal or ZIP code associated with a customer's billing address for an order. This is the ZIP code where the customer receives their credit card statements or bills, which is collected during the checkout process. It is important for verifying the customer's billing information and can be used for analysis related to the geographical distribution of customers, as well as for fraud prevention and payment processing purposes.
taxes_included
Type:
boolean
Description: The "taxes_included" dimension in Shopify represents a Boolean value indicating whether the prices of items in an order include applicable taxes. When this dimension is set to "true," it means that the tax amounts are already included in the item prices shown to the customer. Conversely, if it is "false," taxes are calculated and added separately at checkout. This setting can affect how prices are displayed to customers and how tax calculations are handled during the ordering process.
note
Type:
string
Description: In the context of Shopify's Admin REST API and e-commerce terminology, the dimension "note" refers to an optional field associated with an order that can be used by merchants to add internal comments or additional information about that order. This field is not visible to customers and is typically used by store staff for various purposes such as recording special instructions, noting customer preferences, or documenting other relevant information that assists in processing the order internally.
note_attributes
Type:
string
Description: In the context of Shopify and e-commerce data analysis, the dimension "note_attributes" refers to custom fields that are added to an order, allowing merchants to include additional information or special instructions associated with that order. These attributes can be used to collect and store any extra data that may not fit into standard order properties. For example, note_attributes could include custom requests for product modifications, gift messages, or delivery instructions. This dimension is particularly useful for merchants who need to capture specific, non-standardized data on their orders, enabling a more tailored and personalized customer experience.
app_id
Type:
string
Description: The dimension key "app_id" in the context of Shopify's Admin REST API typically represents the unique identifier of an application that is integrated or used within a Shopify store. This ID helps track and attribute certain activities or data points back to the specific app responsible for them. For example, if an app processes an order or contributes to a sales channel, the "app_id" dimension would be used to identify which app handled or influenced that part of the transaction. This is important for merchants to analyze the performance and impact of different apps on their store's activities.
cancel_reason
Type:
string
Description: The "cancel_reason" dimension in Shopify represents the reason why an order was canceled in the system. It provides context for cancellations, helping merchants understand the circumstances under which orders do not proceed to fulfillment. Common reasons include:
Customer - The customer requested the cancellation.
Fraud - The order was identified as fraudulent.
Inventory - The items in the order are out of stock.
Other - Any other reason not specifically categorized.
This dimension is useful for analyzing cancellation trends and improving operations related to order processing and customer satisfaction.
checkout_token
Type:
string
Description: The "checkout_token" in Shopify represents a unique identifier for a checkout session. When a customer initiates the checkout process on a Shopify store, a token is generated to track this specific checkout session. This token ensures that all actions and data—such as items in the cart, customer information, and shipping details—are consistently associated with the individual checkout as the customer progresses towards completing their purchase. In the context of data analysis, the "checkout_token" allows you to analyze and track specific checkout sessions, which can be useful for understanding conversion rates, identifying abandoned checkouts, and personalizing the checkout experience.
customer_locale
Type:
string
Description: The "customer_locale" dimension in Shopify represents the language and regional settings that the customer used when placing an order. This locale setting typically includes information about the customer's language preference and geographical location, formatted in a standard locale code (e.g., "en-US" for English - United States). It helps businesses understand and analyze the diversity of their customer base in terms of language and regional preferences, allowing them to tailor their marketing strategies and communications accordingly.
device_id
Type:
string
Description: In the context of Shopify's e-commerce data analysis, "device_id" typically refers to a unique identifier associated with the device used by a customer to place an order or interact with the online store. This dimension helps track and analyze user behavior across different devices, such as smartphones, tablets, or computers. By understanding device usage, merchants can optimize their store's performance on various platforms and tailor their marketing strategies to target users based on their preferred device types. The "device_id" can play a crucial role in personalizing the shopping experience and improving conversion rates by providing insights into the most commonly used devices among the store's customers.
landing_site_ref
Type:
string
Description: The "landing_site_ref" dimension in Shopify represents the reference information or the URL of the site from which a customer was referred or directed before making a visit or purchase on the Shopify store. It is essentially the referral source, helping store owners understand the origin of their incoming traffic, often used to analyze the effectiveness of marketing campaigns or track how external links drive traffic to their store.
presentment_currency
Type:
string
Description: The "presentment_currency" dimension in Shopify represents the currency in which prices are shown to customers on the storefront. It is particularly relevant in international stores that display prices in local currencies based on the buyer's location or preference. This currency setting helps customers understand product prices in a familiar currency and can differ from the shop's base currency, which is the primary currency set for transactions and reporting in the Shopify admin.
reference
Type:
string
Description: In the context of Shopify's Admin REST API and e-commerce terminology, the "reference" dimension typically represents a unique identifier used to correlate or track specific transactions, orders, or interactions. While it is not explicitly detailed in the API documentation you've linked, "reference" often serves as a custom field that a merchant or external system can use to assign their own meaningful identifier or code to an order or customer interaction. This could be a purchase order number, a transaction code provided by a payment processor, or any other alphanumeric string that helps in associating Shopify data with other business processes or systems.
source_identifier
Type:
string
Description: The dimension "source_identifier" in Shopify typically refers to a unique identifier associated with the source of an order. This can represent different sales channels or platforms from which the order originated, such as a specific online store, a third-party sales channel, or an internal sales tool. In the context of Shopify's ecosystem, it helps merchants and analysts track and distinguish the origins of orders for better sales channel management and performance analysis.
For more detailed information, you can refer to Shopify's API documentation linked in your question, specifically in the contexts where this dimension is applied, such as order reporting and analytics.
landing_site_base_url
Type:
string
Description: The dimension "landing_site_base_url" in the context of Shopify's e-commerce data represents the base URL of the landing page where a customer first arrives before making a purchase. In essence, it captures the initial web address that directs a visitor to an online store, which can be crucial for understanding traffic sources and marketing effectiveness. This URL often comes from external sources such as advertisements, referral links, or email campaigns. Analyzing this dimension helps store owners determine which channels are successfully driving traffic to their site.
order_status_url
Type:
string
Description: The "order_status_url" dimension in Shopify represents a URL that leads to a customer-facing webpage where they can view the current status of their order. This page typically provides information such as whether the order has been processed, shipped, or delivered. The URL is unique for each order and allows customers to track their order updates without needing to log into their Shopify account. This dimension is especially useful for providing transparency and enhancing the customer experience by making order tracking accessible and straightforward.
ga_campaign
Type:
string
Description: The dimension "ga_campaign" in e-commerce data analysis represents the campaign name associated with Google Analytics tracking. It is used to identify and attribute the traffic coming to a Shopify store from specific marketing campaigns. When a URL includes UTM parameters, such as "utm_campaign", Google Analytics can track which marketing efforts are driving users to the site. In the context of Shopify, "ga_campaign" helps store owners understand which campaigns are leading to orders and conversions, allowing them to assess the effectiveness of their marketing strategies.
ga_medium
Type:
string
Description: The dimension key "ga_medium" in the context of Shopify e-commerce data analysis generally refers to the medium through which customers arrived at your online store, often related to Google's analytics parameters. It is a part of UTM parameters used in campaign tagging. The "medium" dimension helps in identifying the type of channel or pathway utilized in driving traffic. Common examples include "organic," "cpc" (cost-per-click), "email," "referral," and "social." This information is essential for understanding the performance of different marketing channels and optimizing marketing strategies accordingly. Although "ga_medium" is not directly specified in the Shopify Admin REST API for orders, it can be integrated into analytics for tracking and performance purposes.
ga_source
Type:
string
Description: The dimension "ga_source" typically represents the origin or source of traffic that leads a user to an e-commerce site, often in the context of Google Analytics data integrated with Shopify. This dimension identifies where a user came from before visiting or making a purchase on your Shopify store. Common sources include search engines (like Google), social media platforms (like Facebook), referral sites, or direct traffic. This allows merchants to analyze the effectiveness of various marketing channels and optimize their strategies accordingly.
ga_source_raw
Type:
string
Description: The "ga_source_raw" dimension in Shopify's e-commerce data analysis represents the original source from which a buyer originated when visiting your online store. This could include various channels such as direct traffic, search engines, social media platforms, referral links, or email campaigns. This dimension is useful for understanding the effectiveness of different traffic sources in driving visitors to your store, allowing you to analyze and optimize your marketing strategies accordingly.
ga_channel_grouping
Type:
string
Description: The "ga_channel_grouping" dimension is typically related to Google Analytics and represents the categorization of your incoming website traffic based on the channel through which users arrived at your store. In the context of Shopify and e-commerce data analysis, this dimension helps you understand the sources of your website visitors, such as Organic Search, Direct, Paid Search, Social, Referral, Email, or other custom campaign channels.
Each channel grouping provides insights into the effectiveness of different marketing efforts and traffic sources, allowing you to analyze user behavior and sales performance from each channel. This categorization is crucial for assessing the ROI of your marketing campaigns and making informed decisions about where to allocate resources to maximize online sales and customer engagement.
is_order_edit
Type:
string
Description: The dimension "is_order_edit" in the context of Shopify's Admin REST API likely represents whether an order has been edited after its initial creation. It would be a boolean value where "true" indicates that the order has undergone changes (such as updates to products, quantities, or customer details) after being placed, and "false" signifies that the order remains in its original state without any modifications. This dimension helps merchants and analysts track and assess the frequency and impact of order modifications on their e-commerce operations.
client_details_user_agent
Type:
string
Description: The "client_details_user_agent" dimension in Shopify represents the user agent string sent by the browser or device that a customer used to access your Shopify store. This string includes information about the customer's browser type and version, operating system, and device details. It is used to help identify the software and device configuration of the visitor, which can be useful for understanding customer behavior, troubleshooting issues, or optimizing the user experience across different platforms and devices.
order_line_properties
Type:
string
Description: The "order_line_properties" dimension in Shopify represents a set of custom information or metadata that can be associated with individual items within an order. These properties are typically used to store additional details that are not covered by the standard product attributes. For example, "order_line_properties" might include custom engraving messages, gift wrap instructions, or other personalized options selected by the customer during checkout. These properties are key-value pairs and provide merchants with flexibility to capture specific information related to each product variant within an order.
shipping_method
Type:
string
Description: The "shipping_method" dimension in Shopify represents the type of delivery service chosen by a customer for an order. This includes information such as the name or type of shipping service (e.g., standard shipping, express delivery), which is generally specified during the checkout process. This dimension helps in analyzing logistics and shipping preferences, allowing merchants to understand customer choices related to the speed and cost of delivery.
order_processed_date
Type:
date
Description: The dimension "order_processed_date" in Shopify's data analysis likely represents the date on which an order has been completed in terms of processing. This includes all necessary steps from payment confirmation, inventory checks, and fulfillment preparation before transitioning to shipment. While the specific term may not be directly found in the Shopify Admin REST API, in common e-commerce contexts, it refers to the point at which the order is fully processed and ready for delivery, symbolizing the backend completion of an order's handling.
order_processed_timestamp
Type:
datetime
Description: [{'type': 'header', 'text': 'Order Processed Timestamp'}, {'type': 'paragraph', 'text': 'Shown in the timezone of the store on which the order was placed.'}]
selling_plan_id
Type:
string
Description: The dimension key "selling_plan_id" in Shopify represents the unique identifier for a selling plan associated with an order, product, or line item. Selling plans are part of Shopify's subscription or installment offerings, allowing merchants to offer products on a recurring basis or as part of a payment plan. This identifier links the order or item to a specific plan that dictates the terms and frequency of purchase, such as weekly, monthly, or custom intervals. It is used to manage and track the specifics of such plans across Shopify's platform.
selling_plan_name
Type:
string
Description: The "selling_plan_name" dimension in Shopify refers to the name of the specific selling plan associated with a product or an order. Selling plans are used in Shopify to define subscription or recurring purchase options for products. For example, a selling plan might be a monthly subscription for a product, and the "selling_plan_name" would identify the specific plan name set by the merchant, such as "Monthly Subscription" or "Weekly Delivery Plan." This dimension allows merchants and analysts to segment and analyze orders or sales data based on the different subscription offerings available within their store.
fulfillment_location_id
Type:
string
Description: The dimension "fulfillment_location_id" in Shopify represents the unique identifier for the location from which an order is fulfilled. This ID is linked to a specific physical location, such as a warehouse or a store, where inventory is stored and managed. During the fulfillment process, this ID helps in tracking which location is responsible for fulfilling a particular order, aiding in inventory management, logistics, and reporting.
fulfillment_location_name
Type:
string
Description: The dimension "fulfillment_location_name" in Shopify refers to the name of the location from which an order is fulfilled. This can represent the warehouse, store, or any other physical facility where the items in an order are picked, packed, and shipped to the customer. It helps in tracking and managing inventory across different locations and assists in order fulfillment processes by identifying the specific place responsible for dispatching the goods.
line_type
Type:
string
Description: In the context of Shopify's e-commerce data analysis, the dimension "line_type" typically refers to the categorization of each line item within an order. This dimension helps distinguish between different kinds of items or services included in an order. Specifically, in Shopify, "line_type" can differentiate between:
Product: This indicates a standard item sold and shipped to a customer. It is the typical line item representing goods being purchased.
Shipping line: Represents shipping charges associated with the order. This helps in analyzing the cost impact of shipping without conflating it with the revenue from product sales.
Discount: Covers discount codes or price reductions applied to the order, which is important for analyzing promotional impacts.
Tax line: Represents tax charges applied to an order, useful for tracking tax-related costs and governmental obligations.
Understanding "line_type" is crucial for parsing order data correctly, enabling businesses to analyze sales performance, manage inventory, and evaluate the effectiveness of promotions or burden of additional charges.
To see detailed information on "line_type" via Shopify's Admin REST API, you can refer to the endpoint related to orders, which will provide you with the specific types of line items and their attributes for further analysis.
cost_type
Type:
string
Description: The "cost_type" dimension in the context of Shopify e-commerce data analysis typically refers to the classification of different types of costs associated with an order. This can include various expenses such as:
Product Costs: Direct costs related to the production or acquisition of the goods sold.
Shipping Costs: Expenses incurred for delivering the product to the customer.
Transaction/Payment Fees: Costs associated with processing customer payment methods.
Handling Fees: Fees related to preparing the product for shipment.
Duty and Import Taxes: Additional charges for international orders.
This categorization helps businesses analyze and manage their expenditures by understanding which parts of the order fulfillment process are more costly, allowing for better financial planning and pricing strategies.
fairing_question_id
Type:
string
Description: The dimension key "fairing_question_id" in Shopify's context typically refers to an identifier associated with a specific question from Fairing, a tool used for post-purchase surveys or other types of customer feedback. When an order is placed, Fairing can present a survey to the customer, and each possible question within this survey is assigned a unique identifier, known as the "fairing_question_id". This ID allows you to track responses to specific questions on orders, providing insights into customer preferences, behaviors, or feedback directly related to the purchase journey.
fairing_question
Type:
string
Description: The dimension "fairing_question" likely refers to a custom or internal attribute used within Shopify or a specific application or integration to track or manage specific questions or survey responses related to a customer's order or shopping experience. The term "fairing" might not directly correspond to a standard Shopify attribute but could be associated with third-party apps or custom fields used for collecting feedback or data relevant to customer interactions and order processing. This dimension would be useful for analyzing customer feedback patterns and improving customer service or product offerings based on the responses collected.
fairing_question_type
Type:
string
Description: The dimension key "fairing_question_type" in the context of Shopify's e-commerce data analysis likely refers to the categorization of survey or feedback questions presented to customers during their shopping experience. Specifically, this could be linked to the Fairing app (formerly EnquireLabs Post Purchase Surveys), which is used to gather insights from customers via surveys at different touchpoints, such as post-purchase or during checkout. The "question type" dimension would denote the type or nature of questions being asked, such as multiple-choice, open-ended, or rating scale questions. This categorization helps businesses analyze and report on customer feedback efficiently.
fairing_response_id
Type:
string
Description: The dimension key "fairing_response_id" in the context of Shopify analytics likely refers to an identifier for responses or data processed by a Shopify Fairing. Fairings in Shopify are features or functionalities that collect and process data, often used for enhancing customer engagement or operational workflows. The "fairing_response_id" would be a unique identifier associated with a specific response or instance of data processed by such a feature, enabling detailed tracking and analysis in e-commerce data.
fairing_response
Type:
string
Description: The dimension key "fairing_response" does not directly appear in Shopify's Admin REST API documentation or common e-commerce terminology specifically related to standard dimensions or metrics. However, based on the context of Shopify and e-commerce, it is likely that "fairing_response" refers to a system or component within Shopify that deals with responses or data related to integrations, extensions, or enhancements.
In general, "fairing" in tech might refer to a service or module that aids in extensions or communication with external systems. Therefore, if "fairing_response" is used in the context of Shopify data analysis, it might represent responses or data captured as part of an integration process, potentially relating to third-party apps, AI enhancements, or similar.
For precise usage, the specific context in which "fairing_response" appears should be reviewed, possibly in custom reports or scripts involving Shopify's APIs, to better understand the exact nature of this dimension.
fairing_response_position
Type:
string
Description: The dimension "fairing_response_position" is not a standard term within Shopify's Admin REST API or commonly used e-commerce terminology. However, a fairing in e-commerce can typically refer to a system or feature that gathers customer feedback or responses, such as surveys or form submissions on a website.
Based on this understanding, "fairing_response_position" could represent the position or order in which a specific response or interaction occurred within a series of responses from a customer feedback mechanism. This could be useful in analyzing the sequence of interactions or understanding at what point in a user journey specific feedback was provided.
For more precise information, you might want to consult further Shopify documentation or specific implementation guides related to any custom surveys, feedback tools, or apps you are using that integrate with Shopify.
fairing_is_other
Type:
boolean
Description: The dimension key "fairing_is_other" in the context of Shopify's Admin REST API and common e-commerce terminology likely refers to categorizing orders or items that do not fit into the predefined segments of standard analysis or sales channels provided by Shopify.
In e-commerce data analysis, segments or classifications might include various channels like physical retail, online storefront, marketplaces, etc. The term "fairing" isn't standard in e-commerce; however, in this context, it appears to be a part of a broader categorization system. Hence, "fairing_is_other" would indicate that the item or order has been classified as 'other' due to it not falling into the main predefined categories.
This dimension might be useful for identifying and analyzing portions of sales or orders that come from unconventional or niche channels, providing insights into lesser-tracked areas of commerce within the Shopify ecosystem.
fairing_other_response
Type:
string
Description: The dimension "fairing_other_response" in Shopify likely relates to data collected or processed by Shopify's "Fairing" feature, which is designed to gather feedback and insights from customers. This particular dimension would represent responses or data points that do not fit into predefined categories within the Fairing system. It serves as a catch-all for any miscellaneous or unexpected responses gathered during customer interactions. In the context of e-commerce, analyzing this dimension helps businesses understand a broader range of customer feedback that might not be captured by standard survey questions.
fairing_is_clarification_question
Type:
boolean
Description: The dimension "fairing_is_clarification_question" does not directly correspond to a commonly recognized field or parameter within Shopify's Admin REST API or typical e-commerce terminology. However, based on the phrasing, it sounds like a custom attribute or tag that might be used internally for categorization or analysis.
The term "fairing" could relate to a specific product, initiative, or process within a merchant's Shopify setup, possibly referring to something like a promotional campaign, a shipping customization, or a special sales program. "Is_clarification_question" suggests this dimension might be used to denote whether a particular order or interaction required additional customer service attention for clarification purposes.
In practice, this dimension could be used by a Shopify merchant to track and analyze orders or customer interactions that pertain to a specific inquiry type or operational category. For precise understanding, it would be crucial to consult the specific implementation details or company documentation regarding this custom dimension, as it does not appear to be a standard field in Shopify's API or typical e-commerce analytics.
fairing_coupon_code
Type:
string
Description: The "fairing_coupon_code" dimension in the context of Shopify's e-commerce data likely represents a specific promotional code applied to an order. In e-commerce, a coupon code is a string of characters that shoppers can enter at checkout to receive a discount or offer on their purchase. This dimension would capture instances where this particular coupon code was used within order data, allowing for analysis on how such codes are influencing sales, customer acquisition, or retention. It can be useful for tracking the performance and effectiveness of marketing campaigns related to the coupon offers.
fairing_coupon_type
Type:
string
Description: The dimension "fairing_coupon_type" likely refers to a classification or categorization of coupon types used in promotions within the Shopify platform. In the context of e-commerce, coupons are promotional tools that provide discounts or special offers to encourage customer purchases. The "coupon type" dimension would typically describe the nature or method of the discount applied, such as percentage off, fixed amount off, buy one get one free, or free shipping. This classification helps merchants analyze the effectiveness of different promotional strategies and understand customer preferences in terms of discounts offered.
fairing_landing_page_path
Type:
string
Description: In the context of Shopify and e-commerce analysis, the dimension "fairing_landing_page_path" typically refers to the specific URL path of the landing page on a Shopify store where a customer first arrives or lands. This path can provide insights into which pages are attracting visitors initially and are part of their customer journey leading up to a purchase or interaction with the site.
When used in analytics or reporting, this dimension helps merchants understand the entry points to their site and assess the effectiveness of marketing campaigns, SEO, or external referrals. By analyzing the "fairing_landing_page_path," businesses can optimize landing pages to improve user engagement and conversion rates.
fairing_referring_site
Type:
string
Description: The "fairing_referring_site" dimension in Shopify e-commerce data analysis likely refers to the source URL or domain that directed traffic to your Shopify store before a purchase was made. This dimension helps identify where customers originated from, such as search engines, social media platforms, or other websites that referred them to your store. By understanding which sites are driving traffic and resulting in sales, merchants can better tailor their marketing and partnership strategies. This dimension is particularly useful for analyzing the effectiveness of external referrals and optimizing online presence.
fairing_utm_campaign
Type:
string
Description: The dimension key "fairing_utm_campaign" in the context of Shopify e-commerce data analysis represents a specific parameter used in UTM (Urchin Tracking Module) tracking to identify the marketing campaign that led a customer to the online store. This value is part of the URL parameters in links used in marketing efforts such as email, social media, online ads, etc. The "utm_campaign" parameter helps merchants track the effectiveness of different marketing campaigns and understand which specific campaign drives traffic, conversions, or sales on the Shopify platform.
fairing_utm_content
Type:
string
Description: The dimension key "fairing_utm_content" likely represents a parameter used in tracking and analyzing marketing campaigns related to Shopify orders. In the context of e-commerce and digital marketing, UTM parameters are tags added to the end of a URL to track the performance of marketing content and campaigns.
Specifically, "utm_content" is used to differentiate between variations of similar content or links within the same campaign. It helps to identify what specific aspect of the content led a customer to visit the website or make a purchase. This could include testing different call-to-action messages, link layouts, or even identifying specific links within a common piece of content like an email or a webpage.
In summary, "fairing_utm_content" is used in Shopify to capture and analyze which version or element of your online marketing content contributed to customer actions, enabling more precise attribution and optimization of marketing strategies.
fairing_utm_medium
Type:
string
Description: The dimension key "fairing_utm_medium" is used to track and identify the medium through which visitors to a Shopify store have discovered or accessed the site. In e-commerce data analysis, "utm_medium" is a parameter from the UTM (Urchin Tracking Module) tagging system often used in digital marketing. It specifies the medium or channel, such as email, social, CPC (cost-per-click), or organic search, that led a visitor to the store. This dimension helps merchants understand which channels are driving traffic or sales, enabling them to optimize marketing strategies accordingly. In the context of Shopify and its API, "fairing" is a specific tool or feature within Shopify that might be utilizing these UTM parameters for enhanced tracking and analytics.
fairing_utm_source
Type:
string
Description: The dimension key "fairing_utm_source" in Shopify e-commerce data analysis typically represents the source or origin of traffic that led a customer to the store. In the context of UTM parameters, which are used in URLs to track marketing campaigns, "utm_source" identifies the platform or specific source such as a search engine (e.g., Google), a newsletter, a social network (e.g., Facebook), or any other referring site. This helps store owners and analysts understand where their visitors are coming from and assess the effectiveness of different marketing channels.
In Shopify's setup, "fairing_utm_source" would track this information as part of the data collected, helping merchants analyze which sources drive the most traffic or sales through their store.
fairing_utm_term
Type:
string
Description: The dimension "fairing_utm_term" in Shopify e-commerce data analysis refers to a tracking parameter typically used in online marketing campaigns. It is part of the UTM (Urchin Tracking Module) parameters, which are used to track the effectiveness of online marketing efforts. Specifically, "utm_term" is used to identify paid search keywords.
In the context of Shopify, "fairing_utm_term" would capture the specific keyword from a paid search ad that led a customer to the store, allowing merchants to analyze which keywords are driving traffic and sales. This information is crucial for optimizing search engine advertising campaigns to improve conversion rates and return on investment (ROI).
fairing_channel
Type:
string
Description: The dimension key "fairing_channel" in Shopify refers to the sales channel through which an order was placed. Sales channels in Shopify are the platforms or mediums where products are sold, such as an online store, a mobile app, a physical point of sale, or third-party marketplaces like Amazon or eBay. The "fairing_channel" captures this information to help merchants analyze the performance of different sales channels, understand where their orders are coming from, and make informed decisions about channel strategies. This dimension can be important for understanding customer demographics, optimizing marketing efforts, and improving sales processes across different platforms.
product_weight_in_grams
Type:
integer
Description: The dimension key "product_weight_in_grams" represents the weight of a product as stored in Shopify, measured in grams. This data point is crucial for calculating shipping costs, understanding inventory management, and providing accurate product descriptions to customers. In the context of Shopify's platform, this measurement is often used in conjunction with shipping rules and integrations with shipping carriers to determine the weight-based aspects of product logistics.
market_id
Type:
string
Description: The "market_id" in Shopify represents a unique identifier for a specific market associated with an order or a store. In the context of Shopify's multi-market features, a market typically refers to a geographic region, a specific currency, or a particular language setting in which a store operates. This dimension allows merchants to analyze and differentiate data based on various markets where they sell their products, enabling more targeted market analysis and strategy development.
market_name
Type:
string
Description: The "market_name" dimension in Shopify e-commerce data analysis refers to the name of the marketplace or sales channel where the order was placed. This can include various sales channels that a Shopify store might be utilizing, such as online storefronts, physical retail locations, mobile applications, social media platforms, or third-party marketplaces. The dimension helps merchants understand the origin of their sales, allowing them to analyze performance across different channels and make informed decisions regarding marketing and inventory strategies.
market_handle
Type:
string
Description: The "market_handle" dimension in Shopify typically refers to a unique identifier or handle for a specific market or sales channel associated with an order or product. In the context of e-commerce, a market or sales channel could be a specific storefront, platform, region, or method by which products are sold (e.g., online store, point of sale, wholesale). This dimension allows businesses to segment and analyze data based on the source or environment in which transactions occur, providing insights into performance across different sales channels.
product_id
Type:
string
Description: The "product_id" dimension in Shopify represents the unique identifier for a specific product within a store. This identifier is used to distinguish each product in the store's database, facilitating product management, tracking inventory levels, and analyzing sales performance. In the context of Shopify's Admin REST API, "product_id" is used to retrieve or manipulate data related to a particular product, such as fetching product details, updating information, or generating sales reports.
variant_id
Type:
string
Description: The "variant_id" in Shopify represents the unique identifier for a specific variant of a product. In e-commerce and Shopify's context, products can have multiple variants, which are different versions of the same product, distinguished by attributes like size, color, or material. Each variant is considered a distinct item with its own inventory level, price, and SKU (Stock Keeping Unit). The "variant_id" is crucial for tracking and managing these individual product variants in the Shopify system, allowing for precise inventory management, order processing, and data analysis.
inventory_management
Type:
string
Description: The "inventory_management" dimension in Shopify refers to how inventory levels for a product variant are tracked and managed. Specifically, it indicates whether Shopify or another external system is responsible for managing the inventory of a product variant. If "inventory_management" is set to Shopify, it means that Shopify will automatically update the inventory count as orders are placed and items are fulfilled. If it's set to an external system, that system will handle inventory updates and Shopify will not modify these counts automatically. This dimension is crucial for understanding and analyzing how inventory is controlled across different sales channels and fulfillment processes.
inventory_item_id
Type:
string
Description: The dimension "inventory_item_id" in Shopify refers to a unique identifier for an inventory item across Shopify's platform. It represents a specific instance of a product variant's stock. Each distinct variant of a product is assigned an inventory item ID, which is used to track inventory levels, manage stock, and perform inventory-related operations through the Shopify API. This ID helps differentiate between various product variants, even if they belong to the same product, enabling precise inventory management and reporting.
inventory_level_id
Type:
string
Description: The dimension "inventory_level_id" in the context of Shopify and e-commerce data analysis represents a unique identifier for a specific inventory level. This ID is associated with the quantity of a particular product or variant available at a specific location (e.g., a warehouse or physical store). It helps track and manage stock levels across different locations, enabling businesses to keep accurate records of available inventory for fulfilling orders. This dimension is crucial for inventory management, allowing businesses to ensure products are adequately stocked at various locations.
inventory_location_id
Type:
string
Description: The dimension "inventory_location_id" in the context of Shopify represents a unique identifier for a specific location where inventory is stored or managed. This ID is used to track and manage the inventory levels across different physical or virtual locations within a Shopify store. Each location can correspond to a warehouse, retail store, or any other place where the store's products are stocked. This dimension is essential for understanding inventory distribution and availability across various fulfillment points in the e-commerce operation.
store
Type:
string
Description: The "store" dimension in Shopify typically represents the specific online shop or storefront on the Shopify platform. Each store is essentially a unique entity within Shopify, identified by a unique store name or store ID. It encompasses all the settings, products, orders, and other data specific to that particular business or merchant using Shopify's services. In e-commerce analysis, this dimension is used to segment and analyze data at the level of individual storefronts, allowing merchants or analysts to assess performance, sales, and other metrics within each separate Shopify store.
timezone
Type:
string
Description: The "timezone" dimension in Shopify's context represents the time zone setting of the store as configured in the Shopify admin. This dimension is crucial for understanding the timing of order-related activities and sales performance since it dictates how dates and times are displayed and processed in reports and analyses. It ensures that all time-dependent data, such as order timestamps and customer interactions, are accurately aligned with the store's local time zone rather than defaulting to a standard time like UTC. This dimension is especially important for businesses operating across multiple time zones, allowing them to effectively plan and analyze their operations based on their specific local time settings.
product_title
Type:
string
Description: The dimension key "product_title" in Shopify represents the name or title of a product as it appears in the Shopify store. This is the human-readable name that merchants assign to each product to describe it to potential buyers. It is a key attribute used for identifying, categorizing, and displaying products across the Shopify ecosystem, including orders, reports, and the storefront. The "product_title" is significant for customer-facing interactions and helps in distinguishing products in the merchant's inventory.
product_image
Type:
string
Description: The "product_image" dimension in the context of Shopify's Admin REST API refers to the visual representation of a product that is used in an online store. It typically includes the URL or path to the image file that visually depicts the product, which can be used on product detail pages, in listings, and wherever a product might be displayed within the storefront or back-end. These images help attract and inform customers, providing a crucial aspect of the browsing and selection experience in e-commerce. This dimension is essential for showcasing the product's aesthetic and functional attributes, potentially influencing purchasing decisions.
product_status
Type:
string
Description: The "product_status" dimension in Shopify's context represents the current state or condition of a product in the Shopify store's inventory. It typically indicates whether a product is available for purchase or not, and can include various statuses such as:
Active: The product is available and visible to customers. It can be purchased through the online store or other sales channels.
Draft: The product is not yet available for purchase. It might be a new product that is still being set up or edited.
Archived: The product is no longer active and is removed from sales channels but is retained in the store's records for future reference or reporting.
Understanding "product_status" is crucial for managing inventory, sales, and marketing strategies within a Shopify store.
product_type
Type:
string
Description: The "product_type" dimension in Shopify represents a categorization attribute that describes the category to which a product belongs. It is used to group and organize products within the store, making it easier to manage inventory, analyze sales data, and enhance the shopping experience. This categorization can be based on characteristics such as the product's intended use, design, or target market. Examples of product types might include "Apparel," "Electronics," "Home Goods," etc. Merchants can utilize this attribute to filter products, create collections, and run specific analysis on product categories.
product_handle
Type:
string
Description: The "product_handle" in Shopify refers to a unique string identifier for a product, which is used in the URL path to access a product's page on a Shopify store. It is a URL-friendly version of the product's title, typically consisting of lowercase letters, numbers, and hyphens. For example, if a product is titled "Men's Blue T-Shirt," the product handle might be "mens-blue-t-shirt". This handle is crucial for SEO purposes and is used within Shopify's admin and APIs to identify and access specific products.
variant_title
Type:
string
Description: The "variant_title" dimension in Shopify refers to the title of a specific product variant. In e-commerce, a product variant is a version of a product that has different attributes, such as size, color, or material. The "variant_title" provides a concise description of these attributes for a particular product variant. For example, if a product is a t-shirt available in different sizes and colors, the "variant_title" might specify "Large / Red" to indicate the specific variant. This dimension is useful for distinguishing between different versions of the same product in data analysis and reporting.
sku
Type:
string
Description: In the context of Shopify and e-commerce data analysis, the dimension key "sku" stands for "Stock Keeping Unit." It is an alphanumeric code used to uniquely identify a specific product or variant in your inventory. The SKU is crucial for inventory management, allowing merchants to track products, manage stock levels, and streamline operations. Each SKU is unique to a variant of a product, which means even different sizes or colors of the same product will typically have different SKUs. This helps ensure that the right product is tracked and sold, reducing errors and improving order fulfillment efficiency.
inventory_policy
Type:
string
Description: The "inventory_policy" dimension in Shopify refers to the rules and guidelines set by a store regarding how inventory is managed when items are sold through the online store. Specifically, it indicates whether or not products can continue being sold when they run out of stock.
In Shopify, the "inventory_policy" can have one of two values:
Deny: This means that once the inventory level for a product reaches zero, customers will not be able to purchase the product. The product is effectively taken off the market until it is restocked.
Continue: This allows products to be sold even when the inventory level is zero or negative. This policy might be used for items that are quickly restocked, custom-made, or are part of a pre-order campaign.
The "inventory_policy" is an important aspect of inventory management, helping merchants control availability and meet customer demand accurately.
fulfillment_service
Type:
string
Description: The "fulfillment_service" dimension in Shopify refers to the service or method used to fulfill an order. This dimension indicates how an order or specific items within an order are fulfilled, which could be through Shopify's in-house fulfillment centers, a third-party logistics provider, or manual fulfillment by the merchant. Understanding the "fulfillment_service" helps merchants analyze and optimize their supply chain and logistics processes. It is crucial for determining how products are delivered to customers efficiently and cost-effectively.
is_taxable
Type:
string
Description: The dimension key "is_taxable" in Shopify typically represents whether a product or order line item is subject to sales tax. In the context of Shopify's e-commerce data analysis, this boolean value would indicate whether tax needs to be applied when the product is sold. If "is_taxable" is true, the item is taxable; if it is false, no sales tax should be charged for the item. This dimension is important for accurately calculating the total cost customers must pay and for ensuring compliance with tax regulations.
is_shipping_required
Type:
string
Description: The dimension "is_shipping_required" in Shopify e-commerce data analysis represents whether an item or order necessitates physical delivery. Specifically, it indicates if the products involved require shipping logistics, which typically applies to physical goods as opposed to digital products or services that do not require shipping. This dimension helps in understanding the fulfillment needs of an order and may be used to filter or segment orders based on their shipping requirements.
origin_country_code
Type:
string
Description: The "origin_country_code" dimension in Shopify represents the country code where a product or order originates from, typically formatted as a two-letter ISO 3166-1 alpha-2 code. This dimension is used to identify the geographical source of a product, which can be critical for logistics, shipping calculations, tariffs, and compliance with international regulations. In the context of e-commerce data analysis, understanding the origin country of products or orders can also provide insights into sourcing patterns and market reach.
origin_province_code
Type:
string
Description: The dimension "origin_province_code" in Shopify refers to the standardized code representing the province or state where the order originated. This code is typically part of the shipping address or fulfillment location details. In the context of e-commerce analysis and Shopify's platform, it allows merchants to identify and analyze orders based on their geographic origin at the province or state level, facilitating regional sales analysis, inventory distribution, and logistics planning.
inventory_is_tracked
Type:
boolean
Description: The "inventory_is_tracked" dimension in Shopify refers to a boolean attribute that indicates whether inventory tracking is enabled for a particular product or variant. If "inventory_is_tracked" is true, Shopify actively tracks the stock levels of that item, which allows merchants to monitor inventory quantities, automatically update stock levels when an item is sold, and potentially prevent overselling if stock runs out. If "inventory_is_tracked" is false, Shopify does not monitor the inventory for that item, and the shop may have to manage stock levels manually.
inventory_location_city
Type:
string
Description: The "inventory_location_city" dimension in Shopify refers to the city where a specific inventory location or warehouse is situated. This dimension is used in e-commerce data analysis to track and analyze inventory levels and movements across different geographical locations. By using this dimension, businesses can gain insights into the distribution and storage of their products, optimize logistics, and enhance inventory management by evaluating the performance and demand at specific city locations.
inventory_location_country
Type:
string
Description: The dimension key "inventory_location_country" in Shopify data analysis represents the country where the inventory for a particular product is stored or managed. This is typically used to track and analyze inventory levels across different geographical locations, helping businesses understand their stock distribution and manage logistics more effectively. By knowing the country of the inventory location, businesses can optimize shipping, meet local demand efficiently, and comply with regional regulations.
inventory_location_country_code
Type:
string
Description: The "inventory_location_country_code" dimension in Shopify refers to the ISO 3166-1 alpha-2 code representing the country where a specific inventory location is situated. This dimension is useful for analyzing inventory distribution and logistics by providing insight into the geographic location associated with inventory storage. It helps businesses manage and optimize their supply chain by understanding where their products are physically stored across different countries or regions.
inventory_location_province
Type:
string
Description: The "inventory_location_province" dimension in Shopify e-commerce data analysis represents the specific province or state where the inventory is stored or managed. This dimension helps businesses track and analyze inventory levels based on geographic location, allowing for better logistical planning and resource allocation. It is especially useful for merchants with multiple fulfillment centers across different provinces or states, as it provides insights into regional inventory distribution and can impact shipping times, costs, and availability.
inventory_location_province_code
Type:
string
Description: The dimension "inventory_location_province_code" in Shopify represents the provincial or territorial code of the location where a store's inventory is stored. This is part of address information for inventory locations and is typically used to identify the specific province or state within a country where the inventory is kept. This can be particularly useful for businesses managing multiple warehouses or storage facilities across different regions. The code generally follows the standard postal abbreviation for the province or state.
inventory_location_zip
Type:
string
Description: The dimension key "inventory_location_zip" represents the ZIP or postal code of the location where the inventory is stored. In the context of Shopify and e-commerce, this dimension is used to identify and analyze inventory levels and fulfillments based on geographical regions. This helps businesses manage inventory across multiple warehouses or storage facilities, ensuring efficient shipping and fulfillment operations.
vendor
Type:
string
Description: The "vendor" dimension in Shopify represents the manufacturer, wholesaler, or distributor of a product. This dimension is used to categorize and organize products based on their source or brand, which can be particularly useful in analyzing sales data, managing inventory, and assessing the performance of different suppliers. In Shopify's product catalog, each product can have a vendor attribute, allowing merchants to easily filter and report on inventory or orders by vendor.
inventory_location_name
Type:
string
Description: The dimension key "inventory_location_name" in the context of Shopify data analysis refers to the name of the physical or logistical location where the inventory for products is stored or managed. This could be a warehouse, a retail store, or any designated place within a business’s supply chain where stock is kept and from which orders are fulfilled. This dimension is important for tracking inventory levels, managing orders, and optimizing fulfillment processes.
product_tag
Type:
string
Description: The "product_tag" dimension in Shopify represents the labels or keywords assigned to a product to help categorize and filter it within a store's inventory. These tags are user-defined and can be used to describe product characteristics, such as style, season, or any other relevant attributes. The purpose of product tags is to enhance the organization of products, facilitate search and navigation for customers, and enable easier merchandising and marketing strategies within the Shopify platform.
product_tags
Type:
string
Description: The "product_tags" dimension in Shopify represents a set of descriptive labels or keywords assigned to a product. These tags are used to categorize and organize products within a Shopify store, making it easier for both store owners and customers to search for and filter products. Tags can denote various attributes like season, material, style, or any other classification relevant to the product. They enhance the browsing and searching experience by allowing products to be grouped or queried based on these associated tags.
product_weight_in_grams
Type:
integer
Description: The dimension key "product_weight_in_grams" represents the weight of a product as stored in Shopify, measured in grams. This data point is crucial for calculating shipping costs, understanding inventory management, and providing accurate product descriptions to customers. In the context of Shopify's platform, this measurement is often used in conjunction with shipping rules and integrations with shipping carriers to determine the weight-based aspects of product logistics.
product_option_1
Type:
string
Description: The "product_option_1" dimension in Shopify refers to the first variant option for a product. In e-commerce, products can have multiple variants, distinguished by different options such as size, color, or material. The "product_option_1" specifically represents the primary option category for a product variant. For example, if a store sells a t-shirt available in different colors, "product_option_1" might be used to specify the color attribute (e.g., "Red", "Blue", "Green") for each variant of the t-shirt. This dimension helps in organizing and analyzing products based on their variant attributes in Shopify's e-commerce platform.
product_option_2
Type:
string
Description: The dimension key "product_option_2" in Shopify data refers to the second customizable attribute of a product variant. In the context of e-commerce and Shopify's data model, products can have different variants based on options like size, color, material, etc. Each product can have up to three options per variant.
For example, if a store sells t-shirts, the product options could be:
Option 1: Size (e.g., Small, Medium, Large)
Option 2: Color (e.g., Red, Blue, Green)
Option 3: Material (e.g., Cotton, Polyester)
In this case, "product_option_2" would specifically represent the "Color" of the t-shirt. It is a descriptive field that helps in categorizing and distinguishing between different variants of the same base product, improving inventory management and customer selection during the purchasing process.
product_option_3
Type:
string
Description: The dimension key "product_option_3" in Shopify e-commerce data analysis represents the third option value for a product variant. In Shopify, products can have multiple variants, which are combinations of different options. For each variant, a product can have up to three options, such as size, color, and material. "product_option_3" specifically refers to the value of the third option (if it exists) for a given product variant. For instance, if a t-shirt comes in various sizes, colors, and sleeve lengths, "product_option_3" would indicate the sleeve length for that specific variant.
order_id
Type:
string
Description: The "order_id" dimension in Shopify refers to the unique identifier assigned to each individual order placed through a Shopify store. This ID is a distinct numerical value that allows merchants and systems to track, manage, and reference specific orders. It is crucial for order management, enabling actions such as order retrieval, fulfillment, and analysis. The "order_id" is utilized in various API calls to access detailed information about an order, including customer details, products purchased, payment, and shipping information.
selling_plan_name
Type:
string
Description: The "selling_plan_name" dimension in Shopify refers to the name of the specific selling plan associated with a product or an order. Selling plans are used in Shopify to define subscription or recurring purchase options for products. For example, a selling plan might be a monthly subscription for a product, and the "selling_plan_name" would identify the specific plan name set by the merchant, such as "Monthly Subscription" or "Weekly Delivery Plan." This dimension allows merchants and analysts to segment and analyze orders or sales data based on the different subscription offerings available within their store.