Shopify: Most-used fields#
The table below gives information about most-used fields that you can import from Shopify. Other fields might also be available in Adverity.
The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.
API name |
Adverity UI name |
Description |
Use in Adverity |
|---|---|---|---|
Date |
Date |
dimension |
|
abandoned_checkout_url |
abandoned_checkout_url |
The URL of the abandoned checkout. |
dimension |
accepts_marketing |
accepts_marketing |
Indicates whether the customer has consented to receive marketing material via email. This field is deprecated as of API version 2024-01. |
dimension |
accepts_marketing_updated_at |
accepts_marketing_updated_at |
The date and time when the customer’s marketing consent was last updated. This field is deprecated as of API version 2024-01. |
dimension |
accepts_marketing_updated_at.date |
accepts_marketing_updated_at.date |
The date part of when the customer’s marketing consent was last updated. |
dimension |
active |
active |
Indicates if a resource, such as a discount or inventory item, is currently active. |
dimension |
addresses.address1 |
addresses.address1 |
The first line of a customer’s address. |
dimension |
addresses.address2 |
addresses.address2 |
The second line of a customer’s address. |
dimension |
addresses.city |
addresses.city |
The city of a customer’s address. |
dimension |
addresses.company |
addresses.company |
The company name associated with a customer’s address. |
dimension |
addresses.country |
addresses.country |
The country of a customer’s address. |
dimension |
addresses.country_code |
addresses.country_code |
The two-letter country code for a customer’s address. |
dimension |
addresses.country_name |
addresses.country_name |
The normalized country name for a customer’s address. |
dimension |
addresses.customer_id |
addresses.customer_id |
The unique identifier for the customer associated with this address. |
dimension |
addresses.default |
addresses.default |
Indicates if this is the customer’s default address. |
dimension |
addresses.first_name |
addresses.first_name |
The first name of the customer at this address. |
dimension |
addresses.id |
addresses.id |
The unique identifier for the address. |
dimension |
addresses.last_name |
addresses.last_name |
The last name of the customer at this address. |
dimension |
addresses.name |
addresses.name |
The full name of the customer at this address. |
dimension |
addresses.phone |
addresses.phone |
The phone number associated with the address. |
dimension |
addresses.province |
addresses.province |
The province, state, or region of the address. |
dimension |
addresses.province_code |
addresses.province_code |
The alphanumeric code for the province, state, or district of the address. |
dimension |
addresses.zip |
addresses.zip |
The zip or postal code of the address. |
dimension |
addresses.{NUM}.address1 |
addresses.{NUM}.address1 |
The first line of a customer’s address. |
dimension |
addresses.{NUM}.address2 |
addresses.{NUM}.address2 |
The second line of a customer’s address. |
dimension |
addresses.{NUM}.city |
addresses.{NUM}.city |
The city of a customer’s address. |
dimension |
addresses.{NUM}.company |
addresses.{NUM}.company |
The company name associated with a customer’s address. |
dimension |
addresses.{NUM}.country |
addresses.{NUM}.country |
The country of a customer’s address. |
dimension |
addresses.{NUM}.country_code |
addresses.{NUM}.country_code |
The two-letter country code for a customer’s address. |
dimension |
addresses.{NUM}.country_name |
addresses.{NUM}.country_name |
The normalized country name for a customer’s address. |
dimension |
addresses.{NUM}.customer_id |
addresses.{NUM}.customer_id |
The unique identifier for the customer associated with this address. |
dimension |
addresses.{NUM}.default |
addresses.{NUM}.default |
Indicates if this is the customer’s default address. |
dimension |
addresses.{NUM}.first_name |
addresses.{NUM}.first_name |
The first name of the customer at this address. |
dimension |
addresses.{NUM}.id |
addresses.{NUM}.id |
The unique identifier for the address. |
metric |
addresses.{NUM}.last_name |
addresses.{NUM}.last_name |
The last name of the customer at this address. |
dimension |
addresses.{NUM}.name |
addresses.{NUM}.name |
The full name of the customer at this address. |
dimension |
addresses.{NUM}.phone |
addresses.{NUM}.phone |
The phone number associated with the address. |
dimension |
addresses.{NUM}.province |
addresses.{NUM}.province |
The province, state, or region of the address. |
dimension |
addresses.{NUM}.province_code |
addresses.{NUM}.province_code |
The alphanumeric code for the province, state, or district of the address. |
dimension |
addresses.{NUM}.zip |
addresses.{NUM}.zip |
The zip or postal code of the address. |
metric |
admin_graphql_api_id |
admin_graphql_api_id |
The unique identifier for the resource in the Shopify GraphQL Admin API. |
dimension |
amount |
amount |
A monetary amount associated with a transaction or a discount. |
metric |
amount_set_presentment_money_amount |
amount_set_presentment_money_amount |
The monetary amount in the customer’s local (presentment) currency. |
metric |
amount_set_presentment_money_currency_code |
amount_set_presentment_money_currency_code |
The three-letter currency code (ISO 4217 format) for the customer’s local (presentment) currency. |
dimension |
amount_set_shop_money_amount |
amount_set_shop_money_amount |
The monetary amount in the shop’s base currency. |
metric |
amount_set_shop_money_currency_code |
amount_set_shop_money_currency_code |
The three-letter currency code (ISO 4217 format) for the shop’s base currency. |
dimension |
app_id |
app_id |
The unique identifier of the app that created the order. |
dimension |
available |
available |
The quantity of an inventory item available at a specific location. |
metric |
available_for_sale |
available_for_sale |
Indicates whether the product variant is currently available for sale. |
dimension |
barcode |
barcode |
The barcode, UPC, or ISBN of the product variant. |
dimension |
billing_address |
billing_address |
The billing address associated with the payment method selected by the customer for an order. |
dimension |
billing_address.address1 |
billing_address.address1 |
The first line of the customer’s billing address. |
dimension |
billing_address.address2 |
billing_address.address2 |
The second line of the customer’s billing address (optional). |
dimension |
billing_address.city |
billing_address.city |
The city of the customer’s billing address. |
dimension |
billing_address.company |
billing_address.company |
The company name associated with the customer’s billing address. |
dimension |
billing_address.country |
billing_address.country |
The country of the customer’s billing address. |
dimension |
billing_address.country_code |
billing_address.country_code |
The two-letter country code (ISO 3166-1 alpha-2) of the customer’s billing address. |
dimension |
billing_address.first_name |
billing_address.first_name |
The first name of the customer for the billing address. |
dimension |
billing_address.last_name |
billing_address.last_name |
The last name of the customer for the billing address. |
dimension |
billing_address.latitude |
billing_address.latitude |
The latitude coordinate of the billing address. |
metric |
billing_address.longitude |
billing_address.longitude |
The longitude coordinate of the billing address. |
metric |
billing_address.name |
billing_address.name |
The full name of the customer for the billing address. |
dimension |
billing_address.phone |
billing_address.phone |
The phone number for the billing address. |
dimension |
billing_address.province |
billing_address.province |
The province or state of the customer’s billing address. |
dimension |
billing_address.province_code |
billing_address.province_code |
The two-letter province or state code of the customer’s billing address. |
dimension |
billing_address.zip |
billing_address.zip |
The zip or postal code of the customer’s billing address. |
dimension |
body_html |
body_html |
The HTML content of the resource’s body, typically used for product or collection descriptions. |
dimension |
browser_ip |
browser_ip |
The IP address of the browser used by the customer when they placed the order. |
dimension |
buyer_accepts_marketing |
buyer_accepts_marketing |
Indicates whether the customer has consented to receive marketing updates from the shop. |
dimension |
buyer_accepts_sms_marketing |
buyer_accepts_sms_marketing |
Indicates whether the customer has consented to receive SMS marketing messages. |
dimension |
cancel_reason |
cancel_reason |
The reason provided for canceling the order. |
dimension |
cancelled_at |
cancelled_at |
The date and time when the order was canceled. |
dimension |
cancelled_at.date |
cancelled_at.date |
The date when the order was canceled. |
dimension |
cart_token |
cart_token |
The unique token associated with the shopping cart that led to the order. |
dimension |
checkout_token |
checkout_token |
A unique value that references the checkout associated with an order. |
dimension |
client_details |
client_details |
Information about the client (e.g., browser, IP address) used to place the order. |
dimension |
client_details.accept_language |
client_details.accept_language |
The ‘Accept-Language’ header sent by the client’s browser, indicating preferred languages. |
dimension |
client_details.browser_height |
client_details.browser_height |
The height of the client’s browser window in pixels. |
metric |
client_details.browser_ip |
client_details.browser_ip |
The IP address of the browser used by the customer when they placed the order. |
dimension |
client_details.browser_width |
client_details.browser_width |
The width of the client’s browser window in pixels. |
metric |
client_details.session_hash |
client_details.session_hash |
A hash that identifies the client’s browser session. |
dimension |
client_details.user_agent |
client_details.user_agent |
The ‘User-Agent’ header sent by the client’s browser, identifying the browser and operating system. |
dimension |
closed_at |
closed_at |
The date and time when the order was closed. |
dimension |
closed_at.date |
closed_at.date |
The date when the order was closed. |
dimension |
code |
code |
A generic code identifier. Its specific meaning depends on the context (e.g., discount code, shipping method code). |
dimension |
codeDiscount.__typename |
codeDiscount.__typename |
The GraphQL type name for the discount code object. |
dimension |
codeDiscount.asyncUsageCount |
codeDiscount.asyncUsageCount |
The number of times the discount code has been used asynchronously. |
metric |
codeDiscount.createdAt |
codeDiscount.createdAt |
The date and time when the discount code was created. |
dimension |
codeDiscount.discountClass |
codeDiscount.discountClass |
The class of the discount, indicating what it applies to (e.g., product, order, shipping). |
dimension |
codeDiscount.endsAt |
codeDiscount.endsAt |
The date and time when the discount code expires. |
dimension |
codeDiscount.minimumRequirement |
codeDiscount.minimumRequirement |
The minimum purchase requirement or conditions for applying the discount code. |
dimension |
codeDiscount.startsAt |
codeDiscount.startsAt |
The date and time when the discount code becomes active. |
dimension |
codeDiscount.status |
codeDiscount.status |
The current status of the discount code (e.g., active, expired, scheduled). |
dimension |
codeDiscount.summary |
codeDiscount.summary |
A brief summary of the discount code’s purpose or effect. |
dimension |
codeDiscount.title |
codeDiscount.title |
The title or name of the discount code. |
dimension |
codeDiscount.usageLimit |
codeDiscount.usageLimit |
The maximum number of times the discount code can be used. |
dimension |
collection.admin_graphql_api_id |
collection.admin_graphql_api_id |
The unique identifier for the collection in the Shopify GraphQL Admin API. |
dimension |
collection.body_html |
collection.body_html |
The HTML content of the collection’s description. |
dimension |
collection.collection_type |
collection.collection_type |
The type of collection (e.g., ‘smart’ for automated, ‘custom’ for manual). |
dimension |
collection.handle |
collection.handle |
A URL-friendly version of the collection’s title. |
dimension |
collection.id |
collection.id |
The unique identifier for the collection. |
metric |
collection.image |
collection.image |
The image associated with the collection. |
dimension |
collection.products_count |
collection.products_count |
The total number of products within the collection. |
metric |
collection.published_at |
collection.published_at |
The date and time when the collection was published. |
dimension |
collection.published_at.date |
collection.published_at.date |
The date when the collection was published. |
dimension |
collection.published_scope |
collection.published_scope |
The scope of where the collection is published (e.g., ‘web’). |
dimension |
collection.sort_order |
collection.sort_order |
The order in which products are sorted within the collection. |
dimension |
collection.template_suffix |
collection.template_suffix |
The suffix of the liquid template file used to render the collection. |
dimension |
collection.title |
collection.title |
The title of the collection. |
dimension |
collection.updated_at |
collection.updated_at |
The date and time when the collection was last updated. |
dimension |
collection.updated_at.date |
collection.updated_at.date |
The date when the collection was last updated. |
dimension |
collection_type |
collection_type |
The type of collection, either ‘custom’ (manually selected products) or ‘smart’ (products automatically added by rules). |
dimension |
compare_at_price |
compare_at_price |
The product’s original price before any sales or discounts, used for comparison. |
metric |
completed_at |
completed_at |
The date and time when the checkout or order was completed. |
dimension |
completed_at.date |
completed_at.date |
The date when the checkout or order was completed. |
dimension |
cost |
cost |
The cost per item of a product variant. |
metric |
count |
count |
metric |
|
country_code_of_origin |
country_code_of_origin |
The two-letter country code (ISO 3166-1 alpha-2) of the product’s origin. |
dimension |
country_harmonized_system_codes.country_code |
country_harmonized_system_codes.country_code |
The country code for which a specific Harmonized System (HS) code applies. |
dimension |
country_harmonized_system_codes.harmonized_system_code |
country_harmonized_system_codes.harmonized_system_code |
The Harmonized System (HS) code for a product variant in a specific country, used for international shipping and customs. |
dimension |
created_at.date |
created_at.date |
The date when the order or resource was created. |
dimension |
created_at_from_date |
created_at_from_date |
Filters records to include only those created on or after this date. |
dimension |
created_at_to_date |
created_at_to_date |
Filters records to include only those created on or before this date. |
dimension |
current_subtotal_price |
current_subtotal_price |
The current subtotal price of the order after discounts but before taxes and shipping. |
metric |
current_subtotal_price_set |
current_subtotal_price_set |
The current subtotal price of all line items in an order after returns, refunds, order edits, and cancellations, including amounts in both shop and presentment currencies. |
dimension |
current_total_additional_fees_set |
current_total_additional_fees_set |
dimension |
|
current_total_discounts |
current_total_discounts |
The current total amount of discounts applied to the order. |
metric |
current_total_discounts_set |
current_total_discounts_set |
The total amount discounted on the entire order after returns, refunds, order edits, and cancellations, including amounts in both shop and presentment currencies. This includes both order and line level discounts. |
dimension |
current_total_duties_set |
current_total_duties_set |
The sum of all duties (customs fees) on the order, in presentment and shop currencies. |
dimension |
current_total_price |
current_total_price |
The current grand total price of the order, including taxes and shipping after all discounts. |
metric |
current_total_price_set |
current_total_price_set |
The total price of the order, including duties, taxes, and shipping, in presentment and shop currencies. |
dimension |
current_total_tax |
current_total_tax |
The current total tax amount applied to the order. |
metric |
current_total_tax_set |
current_total_tax_set |
The total amount of taxes charged on the order, in presentment and shop currencies. |
dimension |
customer |
customer |
Represents the customer associated with an order, including their contact details and marketing preferences. |
dimension |
customer.accepts_marketing |
customer.accepts_marketing |
Indicates if the customer accepts marketing. |
dimension |
customer.accepts_marketing_updated_at |
customer.accepts_marketing_updated_at |
The date and time when the customer’s marketing acceptance status was last updated. |
dimension |
customer.accepts_marketing_updated_at.date |
customer.accepts_marketing_updated_at.date |
The date when the customer’s marketing acceptance status was last updated. |
dimension |
customer.admin_graphql_api_id |
customer.admin_graphql_api_id |
The unique identifier for the customer in the Shopify GraphQL Admin API. |
dimension |
customer.city |
customer.city |
The city of the customer’s default address. |
dimension |
customer.country |
customer.country |
The country of the customer’s default address. |
dimension |
customer.created |
customer.created |
The date and time when the customer profile was created in the store. |
dimension |
customer.created_at |
customer.created_at |
The date and time when the customer account was created. |
dimension |
customer.created_at.date |
customer.created_at.date |
The date when the customer account was created. |
dimension |
customer.currency |
customer.currency |
The default currency associated with the customer. |
dimension |
customer.default_address.address1 |
customer.default_address.address1 |
The first line of the customer’s default shipping address. |
dimension |
customer.default_address.address2 |
customer.default_address.address2 |
The second line of the customer’s default shipping address. |
dimension |
customer.default_address.city |
customer.default_address.city |
The city of the customer’s default address. |
dimension |
customer.default_address.company |
customer.default_address.company |
The company name associated with the customer’s default address. |
dimension |
customer.default_address.country |
customer.default_address.country |
The country of the customer’s default address. |
dimension |
customer.default_address.country_code |
customer.default_address.country_code |
The two-letter country code for the customer’s default address. |
dimension |
customer.default_address.country_name |
customer.default_address.country_name |
The normalized country name for the customer’s default address. |
dimension |
customer.default_address.customer_id |
customer.default_address.customer_id |
The unique identifier of the customer to whom the default address belongs. |
dimension |
customer.default_address.default |
customer.default_address.default |
Indicates if this address is the customer’s default address. |
dimension |
customer.default_address.first_name |
customer.default_address.first_name |
The first name of the customer at their default address. |
dimension |
customer.default_address.id |
customer.default_address.id |
A unique identifier for the customer’s default address. |
metric |
customer.default_address.last_name |
customer.default_address.last_name |
The last name of the customer at their default address. |
dimension |
customer.default_address.name |
customer.default_address.name |
The full name of the customer at their default address. |
dimension |
customer.default_address.phone |
customer.default_address.phone |
The phone number for the customer’s default address. |
dimension |
customer.default_address.province |
customer.default_address.province |
The province or state name for the customer’s default address. |
dimension |
customer.default_address.province_code |
customer.default_address.province_code |
The alphanumeric code for the province or state of the customer’s default address. |
dimension |
customer.default_address.zip |
customer.default_address.zip |
The postal code for the customer’s default address. |
dimension |
customer.email |
customer.email |
The email address of the customer. |
dimension |
customer.email_marketing_consent |
customer.email_marketing_consent |
Whether the customer has consented to receive email marketing. |
dimension |
customer.email_marketing_consent.consent_updated_at |
customer.email_marketing_consent.consent_updated_at |
The date and time when the customer’s email marketing consent was last updated. |
dimension |
customer.email_marketing_consent.consent_updated_at.date |
customer.email_marketing_consent.consent_updated_at.date |
The date when the customer’s email marketing consent was last updated. |
dimension |
customer.email_marketing_consent.opt_in_level |
customer.email_marketing_consent.opt_in_level |
The opt-in level for the customer’s email marketing consent. |
dimension |
customer.email_marketing_consent.state |
customer.email_marketing_consent.state |
The current state of the customer’s email marketing consent. |
dimension |
customer.first_name |
customer.first_name |
The first name of the customer. |
dimension |
customer.id |
customer.id |
A unique identifier for the customer. |
metric |
customer.last_name |
customer.last_name |
The last name of the customer. |
dimension |
customer.last_order_id |
customer.last_order_id |
The unique identifier of the customer’s last order. |
dimension |
customer.last_order_name |
customer.last_order_name |
The name of the customer’s last order. |
dimension |
customer.marketing_opt_in_level |
customer.marketing_opt_in_level |
The marketing opt-in level for the customer. |
dimension |
customer.multipass_identifier |
customer.multipass_identifier |
dimension |
|
customer.note |
customer.note |
A general note or comment associated with the customer. |
dimension |
customer.orders_count |
customer.orders_count |
The total number of orders placed by the customer. |
metric |
customer.phone |
customer.phone |
The primary phone number of the customer. |
metric |
customer.sms_marketing_consent |
customer.sms_marketing_consent |
Whether the customer has consented to receive SMS marketing. |
dimension |
customer.sms_marketing_consent.consent_collected_from |
customer.sms_marketing_consent.consent_collected_from |
The source from which the customer’s SMS marketing consent was collected. |
dimension |
customer.sms_marketing_consent.consent_updated_at |
customer.sms_marketing_consent.consent_updated_at |
The date and time when the customer’s SMS marketing consent was last updated. |
dimension |
customer.sms_marketing_consent.consent_updated_at.date |
customer.sms_marketing_consent.consent_updated_at.date |
The date when the customer’s SMS marketing consent was last updated. |
dimension |
customer.sms_marketing_consent.opt_in_level |
customer.sms_marketing_consent.opt_in_level |
The opt-in level for the customer’s SMS marketing consent. |
dimension |
customer.sms_marketing_consent.state |
customer.sms_marketing_consent.state |
The current state of the customer’s SMS marketing consent. |
dimension |
customer.state |
customer.state |
The state or province of the customer’s default address. |
dimension |
customer.tags |
customer.tags |
A list of tags associated with the customer. |
dimension |
customer.tax_exempt |
customer.tax_exempt |
Indicates if the customer is exempt from paying taxes. |
dimension |
customer.tax_exemptions |
customer.tax_exemptions |
A list of tax exemptions applicable to the customer. |
dimension |
customer.total_spent |
customer.total_spent |
The total amount of money the customer has spent across all orders. |
metric |
customer.updated_at |
customer.updated_at |
The date and time when the customer’s record was last updated. |
dimension |
customer.updated_at.date |
customer.updated_at.date |
The date when the customer’s record was last updated. |
dimension |
customer.verified_email |
customer.verified_email |
Indicates whether the customer’s email address has been verified. |
dimension |
customer_locale |
customer_locale |
The locale of the customer who placed the order (e.g., en-US). |
dimension |
customer_url |
customer_url |
dimension |
|
default_address.address1 |
default_address.address1 |
The first line of the customer’s default address. |
dimension |
default_address.address2 |
default_address.address2 |
The second line of the customer’s default address. |
dimension |
default_address.city |
default_address.city |
The city of the customer’s default address. |
dimension |
default_address.company |
default_address.company |
The company name associated with the customer’s default address. |
dimension |
default_address.country |
default_address.country |
The country of the customer’s default address. |
dimension |
default_address.country_code |
default_address.country_code |
The two-letter country code for the customer’s default address. |
dimension |
default_address.country_name |
default_address.country_name |
The normalized country name for the customer’s default address. |
dimension |
default_address.customer_id |
default_address.customer_id |
The unique identifier for the customer associated with this default address. |
dimension |
default_address.default |
default_address.default |
Indicates that this is the customer’s default address. |
dimension |
default_address.first_name |
default_address.first_name |
The first name of the customer at their default address. |
dimension |
default_address.id |
default_address.id |
The unique identifier for the customer’s default address. |
metric |
default_address.last_name |
default_address.last_name |
The last name of the customer at their default address. |
dimension |
default_address.name |
default_address.name |
The full name of the customer at their default address. |
dimension |
default_address.phone |
default_address.phone |
The phone number associated with the customer’s default address. |
dimension |
default_address.province |
default_address.province |
The province, state, or region of the customer’s default address. |
dimension |
default_address.province_code |
default_address.province_code |
The alphanumeric code for the province, state, or district of the customer’s default address. |
dimension |
default_address.zip |
default_address.zip |
The zip or postal code of the customer’s default address. |
metric |
description |
description |
A descriptive text for a given resource (e.g., product, collection, discount, or metafield). |
dimension |
device_id |
device_id |
A unique identifier for the device used when the order was placed or checkout occurred. |
dimension |
discount_allocations |
discount_allocations |
A list of allocations detailing how discounts are distributed across line items or shipping lines. |
dimension |
discount_application_index |
discount_application_index |
An index used to identify a specific discount application within an order’s list of applied discounts, indicating its position or precedence. |
metric |
discount_applications |
discount_applications |
Details about the specific discounts applied to the order, including their types and amounts. |
dimension |
discount_codes |
discount_codes |
A list of discount codes applied to the order. |
dimension |
discount_codes.{NUM}.amount |
discount_codes.{NUM}.amount |
The amount of the discount applied by the discount code. |
metric |
discount_codes.{NUM}.code |
discount_codes.{NUM}.code |
The actual discount code entered by the customer. |
dimension |
discount_codes.{NUM}.type |
discount_codes.{NUM}.type |
The type of discount applied (e.g., fixed_amount, percentage). |
dimension |
display_name |
display_name |
A human-readable name for a resource, such as a product, variant, or customer. |
dimension |
duties |
duties |
A list of duties (customs fees) charged on the order. |
dimension |
The customer’s email address. |
dimension |
||
email_marketing_consent |
email_marketing_consent |
Contains information about the customer’s consent to receive email marketing, including their subscription state and opt-in level. |
dimension |
estimated_taxes |
estimated_taxes |
Indicates whether the taxes on the order are estimated. |
dimension |
financial_status |
financial_status |
The financial status of the order (e.g., ‘pending’, ‘paid’, ‘refunded’). |
dimension |
first_name |
first_name |
The first name of the customer. |
dimension |
fulfillable_quantity |
fulfillable_quantity |
The quantity of a line item that is still available to be fulfilled. |
metric |
fulfillment_service |
fulfillment_service |
A third-party service or warehouse that prepares and ships orders on behalf of the store owner. |
dimension |
fulfillment_status |
fulfillment_status |
The fulfillment status of the order (e.g., ‘null’, ‘partially_fulfilled’, ‘fulfilled’). |
dimension |
fulfillments |
fulfillments |
A list of fulfillment details for the order. |
dimension |
fulfillments.created_at |
fulfillments.created_at |
The date and time when the fulfillment was created. |
dimension |
fulfillments.created_at.date |
fulfillments.created_at.date |
The date when the fulfillment was created, derived from the ‘created_at’ timestamp. |
dimension |
fulfillments.id |
fulfillments.id |
A unique identifier for the fulfillment. |
metric |
fulfillments.line_items.discount_allocations |
fulfillments.line_items.discount_allocations |
A list of discounts applied to the line item within the fulfillment, showing how the discount amount is distributed. |
dimension |
fulfillments.line_items.duties |
fulfillments.line_items.duties |
A list of duties associated with the line item in the fulfillment. |
dimension |
fulfillments.line_items.fulfillable_quantity |
fulfillments.line_items.fulfillable_quantity |
The number of units of the line item in the fulfillment that are still available to be fulfilled. (Note: This field is deprecated; refer to FulfillmentOrder for current information). |
metric |
fulfillments.line_items.fulfillment_service |
fulfillments.line_items.fulfillment_service |
The fulfillment service responsible for the line item within this fulfillment. (Note: This field is deprecated). |
dimension |
fulfillments.line_items.fulfillment_status |
fulfillments.line_items.fulfillment_status |
The status of the line item’s fulfillment. (Note: This field is deprecated; refer to FulfillmentOrder’s status property for current information). |
dimension |
fulfillments.line_items.gift_card |
fulfillments.line_items.gift_card |
Indicates whether the line item in the fulfillment is a gift card. |
dimension |
fulfillments.line_items.grams |
fulfillments.line_items.grams |
The weight of the line item in the fulfillment, in grams. |
metric |
fulfillments.line_items.id |
fulfillments.line_items.id |
The unique identifier of the line item within the fulfillment. |
metric |
fulfillments.line_items.name |
fulfillments.line_items.name |
The name of the line item included in the fulfillment. |
dimension |
fulfillments.line_items.origin_location.address1 |
fulfillments.line_items.origin_location.address1 |
The first line of the address of the location where the fulfillment originated. |
dimension |
fulfillments.line_items.origin_location.address2 |
fulfillments.line_items.origin_location.address2 |
The second line of the address of the location where the fulfillment originated. |
dimension |
fulfillments.line_items.origin_location.city |
fulfillments.line_items.origin_location.city |
The city of the original fulfillment location for the line item. (Note: This ‘origin_location’ field is deprecated; refer to FulfillmentOrder’s ‘assigned_location’ for current information). |
dimension |
fulfillments.line_items.origin_location.country_code |
fulfillments.line_items.origin_location.country_code |
The two-letter country code (ISO 3166-1 format) of the original fulfillment location for the line item. (Note: This ‘origin_location’ field is deprecated; refer to FulfillmentOrder’s ‘assigned_location’ for current information). |
dimension |
fulfillments.line_items.origin_location.id |
fulfillments.line_items.origin_location.id |
The unique identifier of the original fulfillment location for the line item. (Note: This ‘origin_location’ field is deprecated; refer to FulfillmentOrder’s ‘assigned_location’ for current information). |
metric |
fulfillments.line_items.origin_location.name |
fulfillments.line_items.origin_location.name |
The name of the original fulfillment location or supplier for the line item. (Note: This ‘origin_location’ field is deprecated; refer to FulfillmentOrder’s ‘assigned_location’ for current information). |
dimension |
fulfillments.line_items.origin_location.province_code |
fulfillments.line_items.origin_location.province_code |
The province or state code of the original fulfillment location for the line item. (Note: This ‘origin_location’ field is deprecated; refer to FulfillmentOrder’s ‘assigned_location’ for current information). |
dimension |
fulfillments.line_items.origin_location.zip |
fulfillments.line_items.origin_location.zip |
The zip or postal code of the original fulfillment location for the line item. (Note: This ‘origin_location’ field is deprecated; refer to FulfillmentOrder’s ‘assigned_location’ for current information). |
dimension |
fulfillments.line_items.pre_tax_price |
fulfillments.line_items.pre_tax_price |
dimension |
|
fulfillments.line_items.pre_tax_price_set.presentment_money.amount |
fulfillments.line_items.pre_tax_price_set.presentment_money.amount |
dimension |
|
fulfillments.line_items.pre_tax_price_set.presentment_money.currency_code |
fulfillments.line_items.pre_tax_price_set.presentment_money.currency_code |
dimension |
|
fulfillments.line_items.pre_tax_price_set.shop_money.amount |
fulfillments.line_items.pre_tax_price_set.shop_money.amount |
dimension |
|
fulfillments.line_items.pre_tax_price_set.shop_money.currency_code |
fulfillments.line_items.pre_tax_price_set.shop_money.currency_code |
dimension |
|
fulfillments.line_items.price |
fulfillments.line_items.price |
The price of the line item in the fulfillment before discounts are applied, in the shop’s currency. |
metric |
fulfillments.line_items.price_set.presentment_money.amount |
fulfillments.line_items.price_set.presentment_money.amount |
The price of the line item in the customer’s presentment currency. |
metric |
fulfillments.line_items.price_set.presentment_money.currency_code |
fulfillments.line_items.price_set.presentment_money.currency_code |
The three-letter currency code (ISO 4217 format) for the customer’s presentment currency of the line item price. |
dimension |
fulfillments.line_items.price_set.shop_money.amount |
fulfillments.line_items.price_set.shop_money.amount |
The price of the line item in the shop’s currency. |
metric |
fulfillments.line_items.price_set.shop_money.currency_code |
fulfillments.line_items.price_set.shop_money.currency_code |
The three-letter currency code (ISO 4217 format) for the shop’s currency of the line item price. |
dimension |
fulfillments.line_items.product_exists |
fulfillments.line_items.product_exists |
Indicates whether the product associated with the line item in the fulfillment still exists. |
dimension |
fulfillments.line_items.product_id |
fulfillments.line_items.product_id |
The unique numeric identifier for the product associated with the line item in the fulfillment. |
dimension |
fulfillments.line_items.properties |
fulfillments.line_items.properties |
A list of additional custom properties associated with the line item in the fulfillment. |
dimension |
fulfillments.line_items.quantity |
fulfillments.line_items.quantity |
The number of units of the line item included in the fulfillment. |
metric |
fulfillments.line_items.requires_shipping |
fulfillments.line_items.requires_shipping |
Indicates whether the line item in the fulfillment requires physical shipping. (Note: This field is deprecated on ProductVariant; refer to InventoryItem for current information). |
dimension |
fulfillments.line_items.sku |
fulfillments.line_items.sku |
The Stock Keeping Unit (SKU) of the line item in the fulfillment. |
dimension |
fulfillments.line_items.tax_lines |
fulfillments.line_items.tax_lines |
A list of tax applications for the line item in the fulfillment, including amounts, rates, and titles. |
dimension |
fulfillments.line_items.taxable |
fulfillments.line_items.taxable |
Indicates whether the line item in the fulfillment is taxable. |
dimension |
fulfillments.line_items.title |
fulfillments.line_items.title |
The title of the product or product variant for the line item in the fulfillment. |
dimension |
fulfillments.line_items.total_discount |
fulfillments.line_items.total_discount |
The total amount of discount applied to the line item in the fulfillment. (Note: This field is deprecated; ‘discount_allocations’ is recommended instead). |
metric |
fulfillments.line_items.total_discount_set.presentment_money.amount |
fulfillments.line_items.total_discount_set.presentment_money.amount |
The total amount of discount applied to the line item in the customer’s presentment currency. |
metric |
fulfillments.line_items.total_discount_set.presentment_money.currency_code |
fulfillments.line_items.total_discount_set.presentment_money.currency_code |
The three-letter currency code (ISO 4217 format) for the customer’s presentment currency of the total discount applied to the line item. |
dimension |
fulfillments.line_items.total_discount_set.shop_money.amount |
fulfillments.line_items.total_discount_set.shop_money.amount |
The total amount of discount applied to the line item in the shop’s currency. |
metric |
fulfillments.line_items.total_discount_set.shop_money.currency_code |
fulfillments.line_items.total_discount_set.shop_money.currency_code |
The three-letter currency code (ISO 4217 format) for the shop’s currency of the total discount applied to the line item. |
dimension |
fulfillments.line_items.variant_id |
fulfillments.line_items.variant_id |
The unique numeric identifier for the product variant of the line item in the fulfillment. |
dimension |
fulfillments.line_items.variant_inventory_management |
fulfillments.line_items.variant_inventory_management |
The inventory management system used for the product variant of the line item. |
dimension |
fulfillments.line_items.variant_title |
fulfillments.line_items.variant_title |
The title of the product variant for the line item in the fulfillment. |
dimension |
fulfillments.line_items.vendor |
fulfillments.line_items.vendor |
The name of the vendor or supplier for the line item in the fulfillment. |
dimension |
fulfillments.location_id |
fulfillments.location_id |
The unique identifier of the location where the fulfillment was processed. |
dimension |
fulfillments.name |
fulfillments.name |
A unique, human-readable identifier for the fulfillment, combining the order name and fulfillment number. |
dimension |
fulfillments.order_id |
fulfillments.order_id |
The unique numeric identifier for the order associated with this fulfillment. |
dimension |
fulfillments.origin_address |
fulfillments.origin_address |
The address from which the fulfillment originated, typically used for tax calculation purposes. |
dimension |
fulfillments.receipt |
fulfillments.receipt |
Information pertaining to the fulfillment receipt, such as authorization details. |
dimension |
fulfillments.service |
fulfillments.service |
The name or handle of the fulfillment service used for this fulfillment. |
dimension |
fulfillments.shipment_status |
fulfillments.shipment_status |
The status of the shipment (e.g., ‘pending’, ‘confirmed’, ‘in_transit’, ‘delivered’). |
dimension |
fulfillments.status |
fulfillments.status |
The overall status of the fulfillment (e.g., ‘pending’, ‘open’, ‘success’, ‘cancelled’). |
dimension |
fulfillments.tracking_company |
fulfillments.tracking_company |
The name of the company providing tracking services for the shipment. |
dimension |
fulfillments.tracking_number |
fulfillments.tracking_number |
The primary tracking number for the shipment. |
dimension |
fulfillments.tracking_numbers |
fulfillments.tracking_numbers |
A list of all tracking numbers associated with the shipment. (Note: The REST API typically supports a single tracking number per fulfillment, while GraphQL supports multiple). |
dimension |
fulfillments.tracking_url |
fulfillments.tracking_url |
The URL where customers can track the shipment. |
dimension |
fulfillments.tracking_urls |
fulfillments.tracking_urls |
A list of all tracking URLs associated with the shipment. (Note: The REST API typically supports a single tracking URL per fulfillment, while GraphQL supports multiple). |
dimension |
fulfillments.updated_at |
fulfillments.updated_at |
The date and time when the fulfillment was last updated. |
dimension |
fulfillments.updated_at.date |
fulfillments.updated_at.date |
The date when the fulfillment was last updated, derived from the ‘updated_at’ timestamp. |
dimension |
fulfills_online_orders |
fulfills_online_orders |
Indicates whether the location fulfills online orders. |
dimension |
fulfilment_status |
fulfilment_status |
The fulfillment status of the order (e.g., fulfilled, partial, unfulfilled). |
dimension |
gateway |
gateway |
The payment gateway used for the order (e.g., ‘shopify_payments’, ‘bogus’). |
dimension |
gift_card |
gift_card |
Indicates if the product is a gift card. |
dimension |
grams |
grams |
The weight of the product variant in grams. |
metric |
handle |
handle |
A URL-friendly version of the product or collection title. |
dimension |
harmonized_system_code |
harmonized_system_code |
The Harmonized System (HS) code for the product variant, used for international shipping and customs. |
metric |
id |
id |
The unique identifier for the order. |
dimension |
image |
image |
The primary image associated with a product or collection. |
dimension |
images |
images |
A list of images associated with a product. |
dimension |
index |
index |
metric |
|
inventory_item.admin_graphql_api_id |
inventory_item.admin_graphql_api_id |
The unique identifier for the inventory item in the Shopify GraphQL Admin API. |
dimension |
inventory_item.created_at |
inventory_item.created_at |
The date and time when the inventory item was created. |
dimension |
inventory_item.created_at.date |
inventory_item.created_at.date |
The date when the inventory item was created. |
dimension |
inventory_item.updated_at |
inventory_item.updated_at |
The date and time when the inventory item was last updated. |
dimension |
inventory_item.updated_at.date |
inventory_item.updated_at.date |
The date when the inventory item was last updated. |
dimension |
inventory_item_id |
inventory_item_id |
The unique identifier for the inventory item, which links a product variant to its stock information. |
dimension |
inventory_level.admin_graphql_api_id |
inventory_level.admin_graphql_api_id |
The unique identifier for the inventory level in the Shopify GraphQL Admin API. |
dimension |
inventory_level.updated_at |
inventory_level.updated_at |
The date and time when the inventory level at a specific location was last updated. |
dimension |
inventory_level.updated_at.date |
inventory_level.updated_at.date |
The date when the inventory level at a specific location was last updated. |
dimension |
inventory_policy |
inventory_policy |
The inventory policy for the product variant (e.g., ‘deny’ for no overselling, ‘continue’ to allow overselling). |
dimension |
inventory_quantity |
inventory_quantity |
The total number of units of the product variant in stock across all locations. |
metric |
key |
key |
A unique identifier for a metafield within its assigned namespace. |
dimension |
kind |
kind |
dimension |
|
landing_site |
landing_site |
The URL of the landing site that the customer visited before placing the order. |
dimension |
last_name |
last_name |
The last name of the customer. |
dimension |
last_order_id |
last_order_id |
The unique identifier of the customer’s last order. |
dimension |
last_order_name |
last_order_name |
The customer-facing name of the customer’s last order (e.g., #1001). |
dimension |
legacy |
legacy |
dimension |
|
line_item.admin_graphql_api_id |
line_item.admin_graphql_api_id |
The globally unique identifier for the line item in the Shopify GraphQL Admin API. |
dimension |
line_item.discount_allocations |
line_item.discount_allocations |
A list of discounts applied to this specific line item. |
dimension |
line_item.duties |
line_item.duties |
A list of duties associated with this line item for international shipments. |
dimension |
line_item.fulfillable_quantity |
line_item.fulfillable_quantity |
The quantity of this line item that is still available to be fulfilled. |
metric |
line_item.fulfillment_service |
line_item.fulfillment_service |
The fulfillment service responsible for the line item’s variant. (Note: This field is deprecated). |
dimension |
line_item.fulfillment_status |
line_item.fulfillment_status |
The status of an order’s line item in terms of fulfillment (e.g., ‘fulfilled’, ‘unfulfilled’, ‘partial’). |
dimension |
line_item.gift_card |
line_item.gift_card |
Indicates if the line item represents a gift card. |
dimension |
line_item.grams |
line_item.grams |
The weight of one unit of the line item in grams. |
metric |
line_item.id |
line_item.id |
The unique identifier for the line item within an order. |
metric |
line_item.name |
line_item.name |
The name of the product variant in the line item. |
dimension |
line_item.pre_tax_price |
line_item.pre_tax_price |
The price of the line item before any taxes are applied. |
metric |
line_item.pre_tax_price_set.presentment_money.amount |
line_item.pre_tax_price_set.presentment_money.amount |
The amount of the line item’s price before tax in the currency presented to the customer. |
metric |
line_item.pre_tax_price_set.presentment_money.currency_code |
line_item.pre_tax_price_set.presentment_money.currency_code |
The three-letter code (ISO 4217) for the currency presented to the customer for the pre-tax price. |
dimension |
line_item.pre_tax_price_set.shop_money.amount |
line_item.pre_tax_price_set.shop_money.amount |
The amount of the line item’s price before tax in the shop’s local currency. |
metric |
line_item.pre_tax_price_set.shop_money.currency_code |
line_item.pre_tax_price_set.shop_money.currency_code |
The three-letter code (ISO 4217) for the shop’s local currency for the pre-tax price. |
dimension |
line_item.price |
line_item.price |
The price of the line item before discounts, in the shop currency. |
metric |
line_item.price_set |
line_item.price_set |
A collection of monetary values representing the price of the line item in both shop and presentment currencies. |
dimension |
line_item.price_set.presentment_money.amount |
line_item.price_set.presentment_money.amount |
The monetary amount of the line item’s price in the currency presented to the customer. |
metric |
line_item.price_set.presentment_money.currency_code |
line_item.price_set.presentment_money.currency_code |
The three-letter code (ISO 4217) for the currency presented to the customer for the line item’s price. |
dimension |
line_item.price_set.shop_money.amount |
line_item.price_set.shop_money.amount |
The monetary amount of the line item’s price in the shop’s local currency. |
metric |
line_item.price_set.shop_money.currency_code |
line_item.price_set.shop_money.currency_code |
The three-letter code (ISO 4217) for the shop’s local currency for the line item’s price. |
dimension |
line_item.product_exists |
line_item.product_exists |
Indicates whether the product associated with this line item currently exists in the store. |
dimension |
line_item.product_id |
line_item.product_id |
The unique identifier of the product associated with this line item. |
dimension |
line_item.properties |
line_item.properties |
A list of custom key-value pairs that provide additional details about the line item. |
dimension |
line_item.quantity |
line_item.quantity |
The number of units of the product variant in the line item. |
metric |
line_item.requires_shipping |
line_item.requires_shipping |
Indicates whether the line item requires physical shipping. |
dimension |
line_item.sku |
line_item.sku |
The Stock Keeping Unit (SKU) of the product variant in this line item. |
dimension |
line_item.tax_lines |
line_item.tax_lines |
A list of tax lines applied to this specific line item. |
dimension |
line_item.taxable |
line_item.taxable |
Indicates whether the line item is subject to taxes. |
dimension |
line_item.title |
line_item.title |
The title of the product or variant in the line item. |
dimension |
line_item.total_discount |
line_item.total_discount |
The total amount of discounts applied specifically to this line item. |
metric |
line_item.total_discount_set.presentment_money.amount |
line_item.total_discount_set.presentment_money.amount |
The monetary amount of the total discount applied to the line item in the currency presented to the customer. |
metric |
line_item.total_discount_set.presentment_money.currency_code |
line_item.total_discount_set.presentment_money.currency_code |
The three-letter code (ISO 4217) for the currency presented to the customer for the total discount on this line item. |
dimension |
line_item.total_discount_set.shop_money.amount |
line_item.total_discount_set.shop_money.amount |
The monetary amount of the total discount applied to the line item in the shop’s local currency. |
metric |
line_item.total_discount_set.shop_money.currency_code |
line_item.total_discount_set.shop_money.currency_code |
The three-letter code (ISO 4217) for the shop’s local currency for the total discount on this line item. |
dimension |
line_item.variant_id |
line_item.variant_id |
The unique identifier of the product variant associated with this line item. |
dimension |
line_item.variant_inventory_management |
line_item.variant_inventory_management |
The system or method used for managing the inventory of the product variant (e.g., ‘shopify’, ‘fulfillment_service’). |
dimension |
line_item.variant_title |
line_item.variant_title |
The title of the product variant in the line item (e.g., ‘Small / Red’). |
dimension |
line_item.vendor |
line_item.vendor |
The vendor or supplier of the product in this line item. |
dimension |
line_item_id |
line_item_id |
The unique identifier for the line item. |
dimension |
line_items |
line_items |
A list of product variants included in the order. |
dimension |
line_items.sku |
line_items.sku |
The Stock Keeping Unit (SKU) of the product variant for the line item. |
dimension |
line_items.{NUM}.applied_discounts.{NUM}.amount |
line_items.{NUM}.applied_discounts.{NUM}.amount |
The monetary amount of the discount applied to the line item. |
metric |
line_items.{NUM}.applied_discounts.{NUM}.application_type |
line_items.{NUM}.applied_discounts.{NUM}.application_type |
The method by which the discount was applied (e.g., ‘discount_code’). |
dimension |
line_items.{NUM}.applied_discounts.{NUM}.created_at |
line_items.{NUM}.applied_discounts.{NUM}.created_at |
The date and time when the discount allocation was created. |
dimension |
line_items.{NUM}.applied_discounts.{NUM}.created_at.date |
line_items.{NUM}.applied_discounts.{NUM}.created_at.date |
The date when the discount allocation was created, derived from the ‘created_at’ timestamp. |
dimension |
line_items.{NUM}.applied_discounts.{NUM}.description |
line_items.{NUM}.applied_discounts.{NUM}.description |
A description of the applied discount. |
dimension |
line_items.{NUM}.applied_discounts.{NUM}.discount_class |
line_items.{NUM}.applied_discounts.{NUM}.discount_class |
The class of the discount applied (‘PRODUCT’ for specific products, ‘ORDER’ for the entire order). |
dimension |
line_items.{NUM}.applied_discounts.{NUM}.id |
line_items.{NUM}.applied_discounts.{NUM}.id |
The unique identifier for the discount allocation. |
dimension |
line_items.{NUM}.compare_at_price |
line_items.{NUM}.compare_at_price |
The original price of the item before any sales or discounts, used for comparison. |
metric |
line_items.{NUM}.destination_location_id |
line_items.{NUM}.destination_location_id |
The unique identifier of the location where the line item is destined for fulfillment. |
dimension |
line_items.{NUM}.discount_allocations.{NUM}.amount |
line_items.{NUM}.discount_allocations.{NUM}.amount |
The amount of money discounted for this specific discount allocation on the line item. |
metric |
line_items.{NUM}.discount_allocations.{NUM}.application_type |
line_items.{NUM}.discount_allocations.{NUM}.application_type |
The type of discount application, indicating how the discount was applied (e.g., ‘fixed_amount’, ‘percentage’). |
dimension |
line_items.{NUM}.discount_allocations.{NUM}.created_at |
line_items.{NUM}.discount_allocations.{NUM}.created_at |
The date and time when this discount allocation was created. |
dimension |
line_items.{NUM}.discount_allocations.{NUM}.created_at.date |
line_items.{NUM}.discount_allocations.{NUM}.created_at.date |
The date when this discount allocation was created. |
dimension |
line_items.{NUM}.discount_allocations.{NUM}.description |
line_items.{NUM}.discount_allocations.{NUM}.description |
A description of the discount applied in this allocation. |
dimension |
line_items.{NUM}.discount_allocations.{NUM}.id |
line_items.{NUM}.discount_allocations.{NUM}.id |
A unique identifier for this specific discount allocation. |
dimension |
line_items.{NUM}.fulfillment_service |
line_items.{NUM}.fulfillment_service |
The name of the fulfillment service associated with the line item. |
dimension |
line_items.{NUM}.gift_card |
line_items.{NUM}.gift_card |
Indicates if the line item represents a gift card. |
dimension |
line_items.{NUM}.grams |
line_items.{NUM}.grams |
The weight of the item in grams. |
metric |
line_items.{NUM}.id |
line_items.{NUM}.id |
A unique identifier for the line item. |
dimension |
line_items.{NUM}.key |
line_items.{NUM}.key |
dimension |
|
line_items.{NUM}.line_price |
line_items.{NUM}.line_price |
The total price of the line item, accounting for quantity and any applied line-item specific discounts. |
metric |
line_items.{NUM}.origin_location_id |
line_items.{NUM}.origin_location_id |
The unique identifier of the location from which the line item originated. |
dimension |
line_items.{NUM}.presentment_title |
line_items.{NUM}.presentment_title |
The title of the product as displayed in the customer’s presentment currency. |
dimension |
line_items.{NUM}.presentment_variant_title |
line_items.{NUM}.presentment_variant_title |
The variant title of the product as displayed in the customer’s presentment currency. |
dimension |
line_items.{NUM}.price |
line_items.{NUM}.price |
The price of a single unit of the line item before any discounts are applied. |
metric |
line_items.{NUM}.product_id |
line_items.{NUM}.product_id |
The unique identifier of the product associated with the line item. |
dimension |
line_items.{NUM}.properties |
line_items.{NUM}.properties |
A list of custom key-value pairs that provide additional details about this specific line item. |
dimension |
line_items.{NUM}.properties.{NUM}.name |
line_items.{NUM}.properties.{NUM}.name |
The name of a custom property attached to the line item. |
dimension |
line_items.{NUM}.properties.{NUM}.value |
line_items.{NUM}.properties.{NUM}.value |
The value of a custom property attached to the line item. |
dimension |
line_items.{NUM}.quantity |
line_items.{NUM}.quantity |
The number of units of the line item purchased. |
metric |
line_items.{NUM}.rank |
line_items.{NUM}.rank |
dimension |
|
line_items.{NUM}.requires_shipping |
line_items.{NUM}.requires_shipping |
Indicates whether the line item requires physical shipping. |
dimension |
line_items.{NUM}.selling_plan_application.api_client_id |
line_items.{NUM}.selling_plan_application.api_client_id |
The identifier of the API client that created or is associated with this selling plan application. |
dimension |
line_items.{NUM}.selling_plan_application.billing_anchors |
line_items.{NUM}.selling_plan_application.billing_anchors |
The specific dates or intervals at which billing cycles for the selling plan are anchored. |
dimension |
line_items.{NUM}.selling_plan_application.billing_interval |
line_items.{NUM}.selling_plan_application.billing_interval |
The frequency or interval of the billing cycle for the selling plan (e.g., ‘DAY’, ‘WEEK’, ‘MONTH’, ‘YEAR’). |
dimension |
line_items.{NUM}.selling_plan_application.billing_interval_count |
line_items.{NUM}.selling_plan_application.billing_interval_count |
The number of billing intervals (e.g., 3 for ‘every 3 months’). |
metric |
line_items.{NUM}.selling_plan_application.billing_max_cycles |
line_items.{NUM}.selling_plan_application.billing_max_cycles |
The maximum number of billing cycles for the selling plan. |
dimension |
line_items.{NUM}.selling_plan_application.billing_min_cycles |
line_items.{NUM}.selling_plan_application.billing_min_cycles |
The minimum number of billing cycles for the selling plan. |
dimension |
line_items.{NUM}.selling_plan_application.delivery_anchors |
line_items.{NUM}.selling_plan_application.delivery_anchors |
The specific dates or intervals at which delivery cycles for the selling plan are anchored. |
dimension |
line_items.{NUM}.selling_plan_application.delivery_cutoff_period |
line_items.{NUM}.selling_plan_application.delivery_cutoff_period |
The buffer period for orders to be included in the next fulfillment anchor. |
dimension |
line_items.{NUM}.selling_plan_application.delivery_intent |
line_items.{NUM}.selling_plan_application.delivery_intent |
The intended delivery behavior for the selling plan (e.g., ‘FULFILL_ALL_AT_ONCE’, ‘FULFILL_AS_SCHEDULED’). |
dimension |
line_items.{NUM}.selling_plan_application.delivery_interval |
line_items.{NUM}.selling_plan_application.delivery_interval |
The frequency or interval of the delivery cycle for the selling plan (e.g., ‘DAY’, ‘WEEK’, ‘MONTH’, ‘YEAR’). |
dimension |
line_items.{NUM}.selling_plan_application.delivery_interval_count |
line_items.{NUM}.selling_plan_application.delivery_interval_count |
The number of delivery intervals (e.g., 1 for ‘every month’). |
metric |
line_items.{NUM}.selling_plan_application.delivery_pre_cutoff_behavior |
line_items.{NUM}.selling_plan_application.delivery_pre_cutoff_behavior |
The behavior for deliveries that occur before the cutoff period for the selling plan. |
dimension |
line_items.{NUM}.selling_plan_application.description |
line_items.{NUM}.selling_plan_application.description |
A detailed description of the selling plan application. |
dimension |
line_items.{NUM}.selling_plan_application.name |
line_items.{NUM}.selling_plan_application.name |
The name of the selling plan application. |
dimension |
line_items.{NUM}.selling_plan_application.pricing_policies.{NUM}.adjustment_type |
line_items.{NUM}.selling_plan_application.pricing_policies.{NUM}.adjustment_type |
The type of price adjustment applied by this pricing policy (e.g., ‘PERCENTAGE’, ‘FIXED_AMOUNT’). |
dimension |
line_items.{NUM}.selling_plan_application.pricing_policies.{NUM}.adjustment_value |
line_items.{NUM}.selling_plan_application.pricing_policies.{NUM}.adjustment_value |
The value of the price adjustment, based on the adjustment_type. |
metric |
line_items.{NUM}.selling_plan_application.pricing_policies.{NUM}.after_cycle |
line_items.{NUM}.selling_plan_application.pricing_policies.{NUM}.after_cycle |
The cycle number after which this pricing policy adjustment takes effect. |
metric |
line_items.{NUM}.selling_plan_application.pricing_policies.{NUM}.base_price |
line_items.{NUM}.selling_plan_application.pricing_policies.{NUM}.base_price |
The base price used for calculations within this pricing policy. |
metric |
line_items.{NUM}.selling_plan_application.pricing_policies.{NUM}.computed_price |
line_items.{NUM}.selling_plan_application.pricing_policies.{NUM}.computed_price |
The final computed price after applying this pricing policy. |
metric |
line_items.{NUM}.selling_plan_application.selling_plan_id |
line_items.{NUM}.selling_plan_application.selling_plan_id |
The unique identifier of the selling plan associated with this application. |
dimension |
line_items.{NUM}.selling_plan_id |
line_items.{NUM}.selling_plan_id |
The unique identifier of the selling plan applied to this line item. |
dimension |
line_items.{NUM}.sku |
line_items.{NUM}.sku |
The Stock Keeping Unit (SKU) for a specific line item in an order. |
dimension |
line_items.{NUM}.tax_code |
line_items.{NUM}.tax_code |
The tax code applicable to the line item. |
dimension |
line_items.{NUM}.tax_lines.{NUM}.channel_liable |
line_items.{NUM}.tax_lines.{NUM}.channel_liable |
Indicates if the sales channel that submitted the tax line is liable for remitting the tax. |
dimension |
line_items.{NUM}.tax_lines.{NUM}.compare_at |
line_items.{NUM}.tax_lines.{NUM}.compare_at |
dimension |
|
line_items.{NUM}.tax_lines.{NUM}.compare_at.date |
line_items.{NUM}.tax_lines.{NUM}.compare_at.date |
dimension |
|
line_items.{NUM}.tax_lines.{NUM}.identifier |
line_items.{NUM}.tax_lines.{NUM}.identifier |
A unique identifier for the specific tax line. |
dimension |
line_items.{NUM}.tax_lines.{NUM}.jurisdiction_id |
line_items.{NUM}.tax_lines.{NUM}.jurisdiction_id |
The unique identifier for the tax jurisdiction associated with this tax line. |
dimension |
line_items.{NUM}.tax_lines.{NUM}.jurisdiction_source |
line_items.{NUM}.tax_lines.{NUM}.jurisdiction_source |
The source that determined the tax jurisdiction for this tax line. |
dimension |
line_items.{NUM}.tax_lines.{NUM}.jurisdiction_type |
line_items.{NUM}.tax_lines.{NUM}.jurisdiction_type |
The type of tax jurisdiction (e.g., ‘STATE’, ‘COUNTY’, ‘CITY’). |
dimension |
line_items.{NUM}.tax_lines.{NUM}.position |
line_items.{NUM}.tax_lines.{NUM}.position |
metric |
|
line_items.{NUM}.tax_lines.{NUM}.price |
line_items.{NUM}.tax_lines.{NUM}.price |
The price component associated with the tax line. |
metric |
line_items.{NUM}.tax_lines.{NUM}.rate |
line_items.{NUM}.tax_lines.{NUM}.rate |
The tax rate applied for this tax line. |
metric |
line_items.{NUM}.tax_lines.{NUM}.reporting_exempt_amount |
line_items.{NUM}.tax_lines.{NUM}.reporting_exempt_amount |
The amount of the line item that is exempt from tax, for reporting purposes. |
dimension |
line_items.{NUM}.tax_lines.{NUM}.reporting_jurisdiction_code |
line_items.{NUM}.tax_lines.{NUM}.reporting_jurisdiction_code |
The code for the tax jurisdiction, used for reporting. |
dimension |
line_items.{NUM}.tax_lines.{NUM}.reporting_jurisdiction_name |
line_items.{NUM}.tax_lines.{NUM}.reporting_jurisdiction_name |
The name of the tax jurisdiction, used for reporting. |
dimension |
line_items.{NUM}.tax_lines.{NUM}.reporting_jurisdiction_type |
line_items.{NUM}.tax_lines.{NUM}.reporting_jurisdiction_type |
The type of tax jurisdiction (e.g., ‘STATE’, ‘COUNTY’, ‘CITY’), used for reporting. |
dimension |
line_items.{NUM}.tax_lines.{NUM}.reporting_non_taxable_amount |
line_items.{NUM}.tax_lines.{NUM}.reporting_non_taxable_amount |
The amount of the line item that is non-taxable, for reporting purposes. |
dimension |
line_items.{NUM}.tax_lines.{NUM}.reporting_taxable_amount |
line_items.{NUM}.tax_lines.{NUM}.reporting_taxable_amount |
The amount of the line item that is taxable, for reporting purposes. |
dimension |
line_items.{NUM}.tax_lines.{NUM}.source |
line_items.{NUM}.tax_lines.{NUM}.source |
The source of the tax calculation or application. |
dimension |
line_items.{NUM}.tax_lines.{NUM}.tax_api_client_id |
line_items.{NUM}.tax_lines.{NUM}.tax_api_client_id |
The identifier of the API client that calculated or provided this tax line. |
dimension |
line_items.{NUM}.tax_lines.{NUM}.tax_calculation_price |
line_items.{NUM}.tax_lines.{NUM}.tax_calculation_price |
The price used as the base for calculating this tax line. |
metric |
line_items.{NUM}.tax_lines.{NUM}.tax_type |
line_items.{NUM}.tax_lines.{NUM}.tax_type |
The specific type of tax applied (e.g., ‘sales_tax’, ‘VAT’). |
dimension |
line_items.{NUM}.tax_lines.{NUM}.title |
line_items.{NUM}.tax_lines.{NUM}.title |
The title or name of the tax. |
dimension |
line_items.{NUM}.tax_lines.{NUM}.zone |
line_items.{NUM}.tax_lines.{NUM}.zone |
dimension |
|
line_items.{NUM}.taxable |
line_items.{NUM}.taxable |
Indicates if the line item is subject to taxes. |
dimension |
line_items.{NUM}.title |
line_items.{NUM}.title |
The title or name of the product. |
dimension |
line_items.{NUM}.unit_price_measurement |
line_items.{NUM}.unit_price_measurement |
Details about the unit price and measurement of the line item (e.g., weight, dimensions). |
dimension |
line_items.{NUM}.unit_price_measurement.measured_type |
line_items.{NUM}.unit_price_measurement.measured_type |
dimension |
|
line_items.{NUM}.unit_price_measurement.quantity_unit |
line_items.{NUM}.unit_price_measurement.quantity_unit |
dimension |
|
line_items.{NUM}.unit_price_measurement.quantity_value |
line_items.{NUM}.unit_price_measurement.quantity_value |
metric |
|
line_items.{NUM}.unit_price_measurement.reference_unit |
line_items.{NUM}.unit_price_measurement.reference_unit |
dimension |
|
line_items.{NUM}.unit_price_measurement.reference_value |
line_items.{NUM}.unit_price_measurement.reference_value |
metric |
|
line_items.{NUM}.user_id |
line_items.{NUM}.user_id |
The unique identifier of the user (e.g., staff member) associated with creating or modifying this line item. |
dimension |
line_items.{NUM}.variant_id |
line_items.{NUM}.variant_id |
The unique identifier of the product variant associated with the line item. |
dimension |
line_items.{NUM}.variant_price |
line_items.{NUM}.variant_price |
The price of the product variant. |
metric |
line_items.{NUM}.variant_title |
line_items.{NUM}.variant_title |
The title of the product variant. |
dimension |
line_items.{NUM}.vendor |
line_items.{NUM}.vendor |
The vendor of the product. |
dimension |
localized_country_name |
localized_country_name |
The localized name of the country for an address. |
dimension |
localized_province_name |
localized_province_name |
The localized name of the province or state for an address. |
dimension |
location.admin_graphql_api_id |
location.admin_graphql_api_id |
The unique identifier for the location in the Shopify GraphQL Admin API. |
dimension |
location.created_at |
location.created_at |
The date and time when the location was created. |
dimension |
location.created_at.date |
location.created_at.date |
The date when the location was created. |
dimension |
location.updated_at |
location.updated_at |
The date and time when the location was last updated. |
dimension |
location.updated_at.date |
location.updated_at.date |
The date when the location was last updated. |
dimension |
location_id |
location_id |
The unique identifier for the physical location where inventory is stocked or an order is fulfilled. |
dimension |
location_name |
location_name |
The name of the inventory location. |
dimension |
marketing_opt_in_level |
marketing_opt_in_level |
The marketing subscription opt-in level the customer gave when consenting to marketing. This field is deprecated as of API version 2024-01. |
dimension |
message |
message |
A general message or note associated with a resource, such as an order or a risk assessment. |
dimension |
metafield_created_at |
metafield_created_at |
The date and time when the metafield was created. |
dimension |
metafield_updated_at |
metafield_updated_at |
The date and time when the metafield was last updated. |
dimension |
metafields |
metafields |
Custom fields that can be added to Shopify resources to store additional, specific information not covered by standard fields. |
dimension |
multipass_identifier |
multipass_identifier |
A unique identifier for the customer used with Multipass login (Shopify Plus SSO). |
dimension |
name |
name |
The name of the resource, such as the customer’s full name or the order’s name. |
dimension |
namespace |
namespace |
A container that logically groups related metafields together. |
dimension |
note |
note |
Additional notes or comments associated with the order. |
dimension |
note_attributes |
note_attributes |
Additional key-value pairs of information attached to the order. |
dimension |
note_attributes.{NUM}.name |
note_attributes.{NUM}.name |
The name of a custom attribute associated with the order’s notes. |
dimension |
note_attributes.{NUM}.value |
note_attributes.{NUM}.value |
The value of a custom attribute associated with the order’s notes. |
dimension |
number |
number |
The order number presented to the customer. |
metric |
options |
options |
A list of options for a product variant (e.g., ‘Size: Small’, ‘Color: Red’). |
dimension |
order.app_id |
order.app_id |
The unique identifier of the app that created this order. |
dimension |
order.billing_address |
order.billing_address |
The billing address associated with the order. |
dimension |
order.browser_ip |
order.browser_ip |
The IP address of the browser used when the order was placed. |
dimension |
order.buyer_accepts_marketing |
order.buyer_accepts_marketing |
Indicates whether the customer for this order has consented to receive marketing updates from the shop. |
dimension |
order.cancel_reason |
order.cancel_reason |
The reason provided for canceling this order. |
dimension |
order.cancelled_at |
order.cancelled_at |
The date and time when this order was canceled. |
dimension |
order.cancelled_at.date |
order.cancelled_at.date |
The date when this order was canceled. |
dimension |
order.cart_token |
order.cart_token |
The unique token associated with the shopping cart that led to this order. |
dimension |
order.checkout_token |
order.checkout_token |
A unique token used to reference the checkout associated with the order. |
dimension |
order.client_details |
order.client_details |
Information about the client (e.g., browser, IP address) used to place this order. |
dimension |
order.closed_at |
order.closed_at |
The date and time when this order was closed. |
dimension |
order.closed_at.date |
order.closed_at.date |
The date when this order was closed. |
dimension |
order.created_at |
order.created_at |
The date and time when this order was created. |
dimension |
order.created_at.date |
order.created_at.date |
The date when this order was created. |
dimension |
order.currency |
order.currency |
The three-letter code (ISO 4217 format) for the currency of this order. |
dimension |
order.current_subtotal_price |
order.current_subtotal_price |
The current subtotal price of the order before taxes, duties, and shipping. |
metric |
order.current_subtotal_price_set |
order.current_subtotal_price_set |
The current subtotal price of the order, including its value in shop and presentment currencies. |
dimension |
order.current_total_additional_fees_set |
order.current_total_additional_fees_set |
The current total amount of additional fees, such as customs fees or import taxes, in both shop and presentment currencies. |
dimension |
order.current_total_discounts |
order.current_total_discounts |
The current total amount of discounts applied to the order. |
metric |
order.current_total_discounts_set |
order.current_total_discounts_set |
The current total amount of discounts applied to the order, including its value in shop and presentment currencies. |
dimension |
order.current_total_duties_set |
order.current_total_duties_set |
The current total amount of duties for the order, in both shop and presentment currencies. |
dimension |
order.current_total_price |
order.current_total_price |
The current grand total price of this order, including taxes and shipping after all discounts. |
metric |
order.current_total_price_set |
order.current_total_price_set |
The current total price of the order, in both shop and presentment currencies. |
dimension |
order.current_total_tax |
order.current_total_tax |
The current total amount of tax applied to the order. |
metric |
order.current_total_tax_set |
order.current_total_tax_set |
The current total amount of tax for the order, in both shop and presentment currencies. |
dimension |
order.customer_locale |
order.customer_locale |
The locale of the customer who placed this order (e.g., en-US). |
dimension |
order.discount_applications |
order.discount_applications |
Details about the specific discounts applied to this order. |
dimension |
order.discount_applications.allocation_method |
order.discount_applications.allocation_method |
The method by which the discount’s value is applied to its entitled items (e.g., ‘across’ or ‘each’). |
dimension |
order.discount_applications.code |
order.discount_applications.code |
The string identifying the discount code that was used at the time of application. |
dimension |
order.discount_applications.target_selection |
order.discount_applications.target_selection |
How the discount amount is distributed on the discounted lines (e.g., ‘all’, ‘explicit’). |
dimension |
order.discount_applications.target_type |
order.discount_applications.target_type |
Indicates whether the discount is applied on line items or shipping lines. |
dimension |
order.discount_applications.type |
order.discount_applications.type |
The type of discount application (e.g., ‘automatic’, ‘code’, ‘manual’, ‘script’). |
dimension |
order.discount_applications.value_type |
order.discount_applications.value_type |
The type of value the discount represents (e.g., ‘fixed_amount’, ‘percentage’). |
dimension |
order.discount_codes |
order.discount_codes |
A list of discount codes applied to this order. |
dimension |
order.discount_codes.amount |
order.discount_codes.amount |
The monetary amount of the discount applied by the discount code. |
dimension |
order.discount_codes.code |
order.discount_codes.code |
The case-insensitive discount code that customers use at checkout. |
dimension |
order.discount_codes.type |
order.discount_codes.type |
The type of discount (e.g., ‘percentage’, ‘shipping’, ‘fixed_amount’). |
dimension |
order.email |
order.email |
The email address of the customer for this order. |
dimension |
order.estimated_taxes |
order.estimated_taxes |
The estimated tax amount for an order during the checkout process. |
dimension |
order.financial_status |
order.financial_status |
The financial status of this order (e.g., ‘pending’, ‘paid’, ‘refunded’). |
dimension |
order.fulfillment_status |
order.fulfillment_status |
The fulfillment status of this order (e.g., ‘null’, ‘partially_fulfilled’, ‘fulfilled’). |
dimension |
order.fulfillments |
order.fulfillments |
A list of fulfillment details for this order. |
dimension |
order.gateway |
order.gateway |
The payment gateway used for the order (e.g., ‘shopify_payments’, ‘bogus’). |
dimension |
order.id |
order.id |
The unique identifier for this order. |
metric |
order.landing_site |
order.landing_site |
The URL of the landing site that the customer visited before placing this order. |
dimension |
order.location_id |
order.location_id |
The unique identifier for the location associated with this order. |
dimension |
order.name |
order.name |
The name of this order. |
dimension |
order.note |
order.note |
Additional notes or comments associated with this order. |
dimension |
order.note_attributes |
order.note_attributes |
Additional key-value pairs of information attached to this order. |
dimension |
order.number |
order.number |
The order number presented to the customer for this order. |
metric |
order.order_number |
order.order_number |
The order number as it appears in the Shopify admin for this order. |
metric |
order.order_status_url |
order.order_status_url |
The URL to this order’s status page, where the customer can track their order. |
dimension |
order.original_total_additional_fees_set |
order.original_total_additional_fees_set |
The original total amount of additional fees for the order before any adjustments, in both shop and presentment currencies. |
dimension |
order.original_total_duties_set |
order.original_total_duties_set |
The original total amount of duties for the order before any adjustments, in both shop and presentment currencies. |
dimension |
order.payment_details |
order.payment_details |
Contains details about the payment method used for the order, such as AVS, CVV results, credit card company, and truncated number. |
dimension |
order.payment_gateway_names |
order.payment_gateway_names |
A list of names of the payment gateways used for this order. |
dimension |
order.payment_terms |
order.payment_terms |
Details regarding the payment terms for the order. |
dimension |
order.phone |
order.phone |
The phone number of the customer for this order. |
metric |
order.presentment_currency |
order.presentment_currency |
The three-letter code (ISO 4217) for the currency presented to the customer for the order. |
dimension |
order.processed_at |
order.processed_at |
The date and time when this order was processed. |
dimension |
order.processed_at.date |
order.processed_at.date |
The date when this order was processed. |
dimension |
order.referring_site |
order.referring_site |
The URL of the referring website that directed the customer to the shop for this order. |
dimension |
order.refunds |
order.refunds |
A list of refund transactions associated with this order. |
dimension |
order.shipping_address |
order.shipping_address |
The shipping address associated with the order. |
dimension |
order.shipping_lines |
order.shipping_lines |
A list of shipping methods and their associated costs for the order. |
dimension |
order.source_identifier |
order.source_identifier |
An identifier for the source from which the order originated. |
dimension |
order.source_name |
order.source_name |
The channel or source through which this order was created (e.g., ‘web’, ‘pos’). |
dimension |
order.source_url |
order.source_url |
The URL of the source from which the order originated. |
dimension |
order.status |
order.status |
The overall status of this order. |
dimension |
order.subtotal_price |
order.subtotal_price |
The price of this order before taxes and shipping, and after discounts. |
metric |
order.subtotal_price_set |
order.subtotal_price_set |
The subtotal price of the order (total of line items before discounts and taxes), in both shop and presentment currencies. |
dimension |
order.tags |
order.tags |
A comma-separated list of tags associated with this order. |
dimension |
order.tax_lines |
order.tax_lines |
A list of tax line objects, each detailing a tax applied to the order. |
dimension |
order.taxes_included |
order.taxes_included |
Indicates whether taxes are included in the prices for this order. |
dimension |
order.test |
order.test |
Indicates whether this order is a test order. |
dimension |
order.token |
order.token |
A unique token associated with this order. |
dimension |
order.total_discounts |
order.total_discounts |
The total amount of discounts applied to this order. |
metric |
order.total_discounts_set |
order.total_discounts_set |
The total amount of discounts applied to the order, including its value in shop and presentment currencies. |
dimension |
order.total_line_items_price |
order.total_line_items_price |
The total price of all line items in this order before any order-level discounts or taxes. |
metric |
order.total_line_items_price_set |
order.total_line_items_price_set |
The total price of all line items in the order, in both shop and presentment currencies. |
dimension |
order.total_outstanding |
order.total_outstanding |
The total amount of money outstanding on the order. |
metric |
order.total_price |
order.total_price |
The grand total price of this order, including taxes and shipping after all discounts. |
metric |
order.total_price_set |
order.total_price_set |
The grand total price of the order, in both shop and presentment currencies. |
dimension |
order.total_shipping_price_set |
order.total_shipping_price_set |
The total shipping price for the order, in both shop and presentment currencies. |
dimension |
order.total_tax |
order.total_tax |
The total tax amount charged for this order. |
metric |
order.total_tax_set |
order.total_tax_set |
The total amount of tax for the order, in both shop and presentment currencies. |
dimension |
order.total_tip_received |
order.total_tip_received |
The total amount of tip received for this order. |
metric |
order.total_weight |
order.total_weight |
The total weight of this order in grams. |
metric |
order.updated_at |
order.updated_at |
The date and time when this order was last updated. |
dimension |
order.updated_at.date |
order.updated_at.date |
The date when this order was last updated. |
dimension |
order.user_id |
order.user_id |
The unique identifier of the user (e.g., staff member) who processed this order. |
dimension |
order_id |
order_id |
The unique identifier for the order. |
dimension |
order_line_id |
order_line_id |
The unique identifier for a specific line item within an order. Each distinct product variant in an order is represented as a line item. |
dimension |
order_number |
order_number |
The order number as it appears in the Shopify admin. |
metric |
order_status_url |
order_status_url |
The URL to the order’s status page, where the customer can track their order. |
dimension |
orders_count |
orders_count |
The total number of orders the customer has placed. |
metric |
original_total_additional_fees_set |
original_total_additional_fees_set |
dimension |
|
original_total_duties_set |
original_total_duties_set |
The original sum of all duties (customs fees) on the order, in presentment and shop currencies, before any adjustments. |
dimension |
owner_resource |
owner_resource |
The type of Shopify resource (e.g., ‘product’, ‘customer’, ‘order’) that the metafield is attached to. |
dimension |
parent_id |
parent_id |
The unique identifier of the parent resource, if applicable. |
dimension |
payment_details |
payment_details |
Details pertaining to the payment transaction for the order. |
dimension |
payment_details.avs_result_code |
payment_details.avs_result_code |
The Address Verification System (AVS) response code from the credit card company. |
dimension |
payment_details.credit_card_bin |
payment_details.credit_card_bin |
The Bank Identification Number (BIN) or Issuer Identification Number (IIN) of the customer’s credit card. |
metric |
payment_details.credit_card_company |
payment_details.credit_card_company |
The name of the company that issued the customer’s credit card (e.g., Visa). |
dimension |
payment_details.credit_card_number |
payment_details.credit_card_number |
The customer’s credit card number, usually with most leading digits redacted. |
dimension |
payment_details.cvv_result_code |
payment_details.cvv_result_code |
The Card Verification Value (CVV) response code from the credit card company. |
dimension |
payment_gateway_names |
payment_gateway_names |
A list of names of the payment gateways used for the order. |
dimension |
payment_terms |
payment_terms |
The terms of payment associated with the order. |
dimension |
phone |
phone |
The customer’s phone number. |
dimension |
position |
position |
metric |
|
pre_tax_price_set.shop_money.amount |
pre_tax_price_set.shop_money.amount |
The amount of the line item before taxes, in the shop’s currency. |
metric |
pre_tax_price_set.shop_money.currency_code |
pre_tax_price_set.shop_money.currency_code |
The three-letter currency code (ISO 4217 format) for the shop’s currency of the pre-tax price. |
dimension |
presentment_currency |
presentment_currency |
The currency in which the order was presented to the customer. |
dimension |
price |
price |
The base price of a product variant. |
metric |
price_set |
price_set |
The price of an item or component, including its value in shop and presentment currencies. |
dimension |
price_set.presentment_money.amount |
price_set.presentment_money.amount |
The monetary amount of the price in the currency presented to the customer. |
metric |
price_set.presentment_money.currency_code |
price_set.presentment_money.currency_code |
The three-letter currency code (e.g., USD) of the price presented to the customer. |
dimension |
price_set.shop_money.amount |
price_set.shop_money.amount |
The monetary amount of the price in the shop’s local currency. |
metric |
price_set.shop_money.currency_code |
price_set.shop_money.currency_code |
The three-letter currency code (e.g., USD) of the price in the shop’s local currency. |
dimension |
processed_at |
processed_at |
The date and time when the order was processed. |
dimension |
processed_at.date |
processed_at.date |
The date when the order was processed. |
dimension |
product_exists |
product_exists |
Indicates whether the product exists. |
dimension |
product_id |
product_id |
The unique identifier for a product. |
dimension |
product_type |
product_type |
A categorization for the product used for filtering and searching products. |
dimension |
product_variant_id |
product_variant_id |
The unique identifier for the product variant. |
dimension |
products_count |
products_count |
The total number of products within a collection. |
metric |
properties |
properties |
Any additional custom key-value pair properties associated with the line item. |
dimension |
province_code_of_origin |
province_code_of_origin |
The standardized alphanumeric code for the province, state, or region where the product originated. |
dimension |
published_at |
published_at |
The date and time when the product was published. |
dimension |
published_at.date |
published_at.date |
The date part of when the product was published. |
dimension |
published_scope |
published_scope |
Indicates where a product is published, such as ‘web’ for the online store or ‘global’ for both online store and Point of Sale. |
dimension |
quantity |
quantity |
The number of units of a specific item in a line item or a product variant. |
metric |
quantity_available |
quantity_available |
The number of units of the product variant currently available for sale at a specific location. |
metric |
receipt |
receipt |
Indicates whether a receipt was sent or provides details of the transaction receipt. |
dimension |
referring_site |
referring_site |
The URL of the referring website that directed the customer to the shop. |
dimension |
refund.created_at |
refund.created_at |
The date and time when the refund record was created. |
dimension |
refund.created_at.date |
refund.created_at.date |
The date part of when the refund record was created. |
dimension |
refund.duties |
refund.duties |
A list of duties that were refunded as part of this refund. |
dimension |
refund.id |
refund.id |
The unique identifier for the refund record. |
metric |
refund.note |
refund.note |
An optional note or comment associated with the refund. |
dimension |
refund.order_adjustments |
refund.order_adjustments |
A list of adjustments applied to the order as part of the refund process. |
dimension |
refund.processed_at |
refund.processed_at |
The date and time when the refund transaction was processed. |
dimension |
refund.processed_at.date |
refund.processed_at.date |
The date part of when the refund transaction was processed. |
dimension |
refund.refund_duties |
refund.refund_duties |
Indicates whether duties were refunded as part of a refund transaction. |
dimension |
refunds |
refunds |
A list of refund transactions associated with the order. |
dimension |
report_date |
report_date |
dimension |
|
report_date_time_UTC |
report_date_time_UTC |
dimension |
|
requires_shipping |
requires_shipping |
Indicates whether the inventory item requires a shipping address. |
dimension |
restock_type |
restock_type |
How a refunded line item affects inventory levels (e.g., ‘no_restock’, ‘cancel’, ‘return’, ‘replace’). |
dimension |
risk.cause_cancel |
risk.cause_cancel |
Indicates whether the order risk assessment recommends canceling the order due to high fraud risk. |
dimension |
risk.checkout_id |
risk.checkout_id |
The unique identifier of the checkout that the order risk belongs to. |
dimension |
risk.display |
risk.display |
Indicates whether the order risk is displayed on the order details page in the Shopify admin. |
dimension |
risk.id |
risk.id |
A unique numeric identifier for the order risk. |
metric |
risk.merchant_message |
risk.merchant_message |
A message displayed to the merchant to indicate the results of the fraud check. |
dimension |
risk.message |
risk.message |
A general message associated with the order risk. |
dimension |
risk.order_id |
risk.order_id |
The unique identifier of the order that the order risk belongs to. |
dimension |
risk.recommendation |
risk.recommendation |
The recommendation for the order based on the risk assessment (e.g., ‘cancel’, ‘investigate’, ‘accept’). |
dimension |
risk.score |
risk.score |
A numerical score representing the level of risk associated with the order. |
metric |
risk.source |
risk.source |
The source that generated the order risk assessment. |
dimension |
sellable_online_quantity |
sellable_online_quantity |
The quantity of the product variant available to sell online. |
metric |
shipping_address |
shipping_address |
The complete shipping address for the order. |
dimension |
shipping_address.address1 |
shipping_address.address1 |
The first line of the shipping address, typically the street number and name or PO box. |
dimension |
shipping_address.address2 |
shipping_address.address2 |
The second line of the shipping address, typically the apartment, suite, or unit number. |
dimension |
shipping_address.city |
shipping_address.city |
The city of the shipping address. |
dimension |
shipping_address.company |
shipping_address.company |
The company name associated with the shipping address. |
dimension |
shipping_address.country |
shipping_address.country |
The full name of the country for the shipping address. |
dimension |
shipping_address.country_code |
shipping_address.country_code |
The two-letter ISO 3166-1 alpha-2 country code for the shipping address (e.g., US, CA). |
dimension |
shipping_address.first_name |
shipping_address.first_name |
The first name of the recipient at the shipping address. |
dimension |
shipping_address.last_name |
shipping_address.last_name |
The last name of the recipient at the shipping address. |
dimension |
shipping_address.latitude |
shipping_address.latitude |
The latitude coordinate of the shipping address. |
metric |
shipping_address.longitude |
shipping_address.longitude |
The longitude coordinate of the shipping address. |
metric |
shipping_address.name |
shipping_address.name |
The full name of the recipient at the shipping address, typically a combination of first and last names. |
dimension |
shipping_address.phone |
shipping_address.phone |
The phone number associated with the shipping address, formatted using E.164 standard. |
dimension |
shipping_address.province |
shipping_address.province |
The full name of the province, state, or region for the shipping address. |
dimension |
shipping_address.province_code |
shipping_address.province_code |
The alphanumeric code for the province, state, or district (e.g., ON for Ontario, Canada) of the shipping address. |
dimension |
shipping_address.zip |
shipping_address.zip |
The zip or postal code of the shipping address. |
dimension |
shipping_lines |
shipping_lines |
A list of shipping methods and their associated costs for the order. |
dimension |
shipping_lines.carrier_identifier |
shipping_lines.carrier_identifier |
A reference identifier for the carrier service that provided the shipping rate. |
dimension |
shipping_lines.code |
shipping_lines.code |
A short code or reference for the specific shipping method. |
dimension |
shipping_lines.delivery_category |
shipping_lines.delivery_category |
The general classification of the delivery method. (Note: This field is deprecated and no longer present in recent API versions). |
dimension |
shipping_lines.discount_allocations |
shipping_lines.discount_allocations |
An array of discount allocation objects applied to the shipping line. |
dimension |
shipping_lines.discounted_price |
shipping_lines.discounted_price |
The price of the shipping line after applying any discounts. |
metric |
shipping_lines.discounted_price_set.presentment_money.amount |
shipping_lines.discounted_price_set.presentment_money.amount |
The discounted shipping price in the customer’s presentment currency. |
metric |
shipping_lines.discounted_price_set.presentment_money.currency_code |
shipping_lines.discounted_price_set.presentment_money.currency_code |
The three-letter currency code (ISO 4217 format) for the customer’s presentment currency of the discounted shipping price. |
dimension |
shipping_lines.discounted_price_set.shop_money.amount |
shipping_lines.discounted_price_set.shop_money.amount |
The discounted shipping price in the shop’s currency. |
metric |
shipping_lines.discounted_price_set.shop_money.currency_code |
shipping_lines.discounted_price_set.shop_money.currency_code |
The three-letter currency code (ISO 4217 format) for the shop’s currency of the discounted shipping price. |
dimension |
shipping_lines.id |
shipping_lines.id |
The unique identifier for the shipping line. |
metric |
shipping_lines.phone |
shipping_lines.phone |
The phone number associated with the shipping address for this line. |
dimension |
shipping_lines.price |
shipping_lines.price |
The original price of the shipping line before any discounts are applied. |
metric |
shipping_lines.price_set.presentment_money.amount |
shipping_lines.price_set.presentment_money.amount |
The original shipping price in the customer’s presentment currency, before discounts. |
metric |
shipping_lines.price_set.presentment_money.currency_code |
shipping_lines.price_set.presentment_money.currency_code |
The three-letter currency code (ISO 4217 format) for the customer’s presentment currency of the original shipping price. |
dimension |
shipping_lines.price_set.shop_money.amount |
shipping_lines.price_set.shop_money.amount |
The original shipping price in the shop’s currency, before discounts. |
metric |
shipping_lines.price_set.shop_money.currency_code |
shipping_lines.price_set.shop_money.currency_code |
The three-letter currency code (ISO 4217 format) for the shop’s currency of the original shipping price. |
dimension |
shipping_lines.requested_fulfillment_service_id |
shipping_lines.requested_fulfillment_service_id |
The unique identifier of the fulfillment service requested for this shipping line. |
dimension |
shipping_lines.source |
shipping_lines.source |
The source of the shipping rate, such as ‘shopify’ or a third-party carrier name. |
dimension |
shipping_lines.tax_lines |
shipping_lines.tax_lines |
Tax line objects associated with the shipping lines. |
dimension |
shipping_lines.title |
shipping_lines.title |
The title or name of the shipping method selected by the customer. |
dimension |
shipping_lines.{NUM}.api_client_id |
shipping_lines.{NUM}.api_client_id |
dimension |
|
shipping_lines.{NUM}.applied_discounts.{NUM}.amount |
shipping_lines.{NUM}.applied_discounts.{NUM}.amount |
The amount of money discounted for this specific discount applied to the shipping line. |
metric |
shipping_lines.{NUM}.applied_discounts.{NUM}.description |
shipping_lines.{NUM}.applied_discounts.{NUM}.description |
A description of the discount applied to the shipping line. |
dimension |
shipping_lines.{NUM}.applied_discounts.{NUM}.price_rule_id |
shipping_lines.{NUM}.applied_discounts.{NUM}.price_rule_id |
The unique identifier of the price rule that generated this discount on the shipping line. |
dimension |
shipping_lines.{NUM}.applied_discounts.{NUM}.script_version_id |
shipping_lines.{NUM}.applied_discounts.{NUM}.script_version_id |
The unique identifier of the script version used to apply this discount to the shipping line. |
dimension |
shipping_lines.{NUM}.carrier_identifier |
shipping_lines.{NUM}.carrier_identifier |
A unique identifier for the carrier service that provided the shipping rate. |
dimension |
shipping_lines.{NUM}.carrier_service_id |
shipping_lines.{NUM}.carrier_service_id |
The unique identifier of the carrier service that provided the rate for the shipping line. |
dimension |
shipping_lines.{NUM}.code |
shipping_lines.{NUM}.code |
A unique identifier for the specific shipping rate. |
dimension |
shipping_lines.{NUM}.custom_tax_lines |
shipping_lines.{NUM}.custom_tax_lines |
A list of custom tax lines specifically applied to this shipping line. |
dimension |
shipping_lines.{NUM}.delivery_category |
shipping_lines.{NUM}.delivery_category |
dimension |
|
shipping_lines.{NUM}.delivery_expectation_range |
shipping_lines.{NUM}.delivery_expectation_range |
dimension |
|
shipping_lines.{NUM}.delivery_expectation_range.{NUM} |
shipping_lines.{NUM}.delivery_expectation_range.{NUM} |
A range representing the expected delivery time for the shipping line. |
metric |
shipping_lines.{NUM}.delivery_expectation_type |
shipping_lines.{NUM}.delivery_expectation_type |
dimension |
|
shipping_lines.{NUM}.delivery_option_group.token |
shipping_lines.{NUM}.delivery_option_group.token |
dimension |
|
shipping_lines.{NUM}.delivery_option_group.type |
shipping_lines.{NUM}.delivery_option_group.type |
dimension |
|
shipping_lines.{NUM}.delivery_option_group_type |
shipping_lines.{NUM}.delivery_option_group_type |
The type of delivery option group this shipping line belongs to (e.g., ‘standard’, ‘express’). |
dimension |
shipping_lines.{NUM}.discount_allocations |
shipping_lines.{NUM}.discount_allocations |
Details on how discounts are allocated to a specific shipping line. |
dimension |
shipping_lines.{NUM}.discounted_price |
shipping_lines.{NUM}.discounted_price |
The price of the shipping line after any discounts have been applied. |
metric |
shipping_lines.{NUM}.discounted_price_set.presentment_money.amount |
shipping_lines.{NUM}.discounted_price_set.presentment_money.amount |
The amount of the discounted shipping price in the customer’s presentment currency. |
dimension |
shipping_lines.{NUM}.discounted_price_set.presentment_money.currency_code |
shipping_lines.{NUM}.discounted_price_set.presentment_money.currency_code |
The currency code for the discounted shipping price in the customer’s presentment currency. |
dimension |
shipping_lines.{NUM}.discounted_price_set.shop_money.amount |
shipping_lines.{NUM}.discounted_price_set.shop_money.amount |
The amount of the discounted shipping price in the shop’s currency. |
dimension |
shipping_lines.{NUM}.discounted_price_set.shop_money.currency_code |
shipping_lines.{NUM}.discounted_price_set.shop_money.currency_code |
The currency code for the discounted shipping price in the shop’s currency. |
dimension |
shipping_lines.{NUM}.estimated_delivery_time_range |
shipping_lines.{NUM}.estimated_delivery_time_range |
The estimated time frame within which the shipping line is expected to be delivered. |
dimension |
shipping_lines.{NUM}.estimated_delivery_time_range.{NUM} |
shipping_lines.{NUM}.estimated_delivery_time_range.{NUM} |
The estimated delivery time range for a specific shipping line, represented as a numerical value within an array (e.g., minimum or maximum days). |
dimension |
shipping_lines.{NUM}.id |
shipping_lines.{NUM}.id |
A unique identifier for the shipping line. |
metric |
shipping_lines.{NUM}.markup |
shipping_lines.{NUM}.markup |
metric |
|
shipping_lines.{NUM}.original_rate_price |
shipping_lines.{NUM}.original_rate_price |
The original price of the shipping rate before any discounts or adjustments. |
metric |
shipping_lines.{NUM}.original_shop_markup |
shipping_lines.{NUM}.original_shop_markup |
metric |
|
shipping_lines.{NUM}.original_shop_price |
shipping_lines.{NUM}.original_shop_price |
The original pre-tax shipping price of the line item before any discounts are applied, in the shop’s currency. |
metric |
shipping_lines.{NUM}.phone |
shipping_lines.{NUM}.phone |
The phone number associated with the shipping address for this line. |
dimension |
shipping_lines.{NUM}.presentment_title |
shipping_lines.{NUM}.presentment_title |
The title of the shipping line as displayed in the customer’s presentment currency. |
dimension |
shipping_lines.{NUM}.price |
shipping_lines.{NUM}.price |
The original price of the shipping line before any discounts. |
metric |
shipping_lines.{NUM}.price_set.presentment_money.amount |
shipping_lines.{NUM}.price_set.presentment_money.amount |
The amount of the shipping price in the customer’s presentment currency, before discounts. |
dimension |
shipping_lines.{NUM}.price_set.presentment_money.currency_code |
shipping_lines.{NUM}.price_set.presentment_money.currency_code |
The currency code for the shipping price in the customer’s presentment currency, before discounts. |
dimension |
shipping_lines.{NUM}.price_set.shop_money.amount |
shipping_lines.{NUM}.price_set.shop_money.amount |
The amount of the shipping price in the shop’s currency, before discounts. |
dimension |
shipping_lines.{NUM}.price_set.shop_money.currency_code |
shipping_lines.{NUM}.price_set.shop_money.currency_code |
The currency code for the shipping price in the shop’s currency, before discounts. |
dimension |
shipping_lines.{NUM}.requested_fulfillment_service_id |
shipping_lines.{NUM}.requested_fulfillment_service_id |
dimension |
|
shipping_lines.{NUM}.source |
shipping_lines.{NUM}.source |
The source of the shipping rate. |
dimension |
shipping_lines.{NUM}.tax_lines |
shipping_lines.{NUM}.tax_lines |
An array of tax line objects associated with a specific shipping line, detailing the taxes applied. |
dimension |
shipping_lines.{NUM}.tax_lines.{NUM}.channel_liable |
shipping_lines.{NUM}.tax_lines.{NUM}.channel_liable |
Indicates whether the sales channel is responsible for collecting and remitting this specific tax line on the shipping cost. |
dimension |
shipping_lines.{NUM}.tax_lines.{NUM}.compare_at |
shipping_lines.{NUM}.tax_lines.{NUM}.compare_at |
dimension |
|
shipping_lines.{NUM}.tax_lines.{NUM}.compare_at.date |
shipping_lines.{NUM}.tax_lines.{NUM}.compare_at.date |
dimension |
|
shipping_lines.{NUM}.tax_lines.{NUM}.identifier |
shipping_lines.{NUM}.tax_lines.{NUM}.identifier |
A unique identifier for the specific tax line applied to the shipping cost. |
dimension |
shipping_lines.{NUM}.tax_lines.{NUM}.jurisdiction_id |
shipping_lines.{NUM}.tax_lines.{NUM}.jurisdiction_id |
The unique identifier of the tax jurisdiction applied to the shipping line. |
dimension |
shipping_lines.{NUM}.tax_lines.{NUM}.jurisdiction_source |
shipping_lines.{NUM}.tax_lines.{NUM}.jurisdiction_source |
The source that provided the tax jurisdiction information for the shipping line. |
dimension |
shipping_lines.{NUM}.tax_lines.{NUM}.jurisdiction_type |
shipping_lines.{NUM}.tax_lines.{NUM}.jurisdiction_type |
The type of tax jurisdiction (e.g., state, province, country) applied to the shipping line. |
dimension |
shipping_lines.{NUM}.tax_lines.{NUM}.position |
shipping_lines.{NUM}.tax_lines.{NUM}.position |
The numerical position of this tax line within the list of tax lines for the shipping method. |
metric |
shipping_lines.{NUM}.tax_lines.{NUM}.price |
shipping_lines.{NUM}.tax_lines.{NUM}.price |
The amount of tax charged for this specific shipping tax line. |
metric |
shipping_lines.{NUM}.tax_lines.{NUM}.rate |
shipping_lines.{NUM}.tax_lines.{NUM}.rate |
The tax rate percentage applied to the shipping cost for this tax line. |
metric |
shipping_lines.{NUM}.tax_lines.{NUM}.reporting_exempt_amount |
shipping_lines.{NUM}.tax_lines.{NUM}.reporting_exempt_amount |
The portion of the shipping line amount that is exempt from taxes for reporting purposes. |
dimension |
shipping_lines.{NUM}.tax_lines.{NUM}.reporting_jurisdiction_code |
shipping_lines.{NUM}.tax_lines.{NUM}.reporting_jurisdiction_code |
The code for the tax jurisdiction used in tax reporting for the shipping line. |
dimension |
shipping_lines.{NUM}.tax_lines.{NUM}.reporting_jurisdiction_name |
shipping_lines.{NUM}.tax_lines.{NUM}.reporting_jurisdiction_name |
The name of the tax jurisdiction used in tax reporting for the shipping line. |
dimension |
shipping_lines.{NUM}.tax_lines.{NUM}.reporting_jurisdiction_type |
shipping_lines.{NUM}.tax_lines.{NUM}.reporting_jurisdiction_type |
The type of tax jurisdiction (e.g., state, province) for tax reporting purposes for the shipping line. |
dimension |
shipping_lines.{NUM}.tax_lines.{NUM}.reporting_non_taxable_amount |
shipping_lines.{NUM}.tax_lines.{NUM}.reporting_non_taxable_amount |
The amount of the shipping line that is non-taxable for reporting purposes. |
dimension |
shipping_lines.{NUM}.tax_lines.{NUM}.reporting_taxable_amount |
shipping_lines.{NUM}.tax_lines.{NUM}.reporting_taxable_amount |
The amount of the shipping line that is taxable for reporting purposes. |
dimension |
shipping_lines.{NUM}.tax_lines.{NUM}.source |
shipping_lines.{NUM}.tax_lines.{NUM}.source |
The source from which this shipping tax line was generated or applied. |
dimension |
shipping_lines.{NUM}.tax_lines.{NUM}.tax_api_client_id |
shipping_lines.{NUM}.tax_lines.{NUM}.tax_api_client_id |
dimension |
|
shipping_lines.{NUM}.tax_lines.{NUM}.tax_calculation_price |
shipping_lines.{NUM}.tax_lines.{NUM}.tax_calculation_price |
metric |
|
shipping_lines.{NUM}.tax_lines.{NUM}.tax_type |
shipping_lines.{NUM}.tax_lines.{NUM}.tax_type |
The type of tax applied to the shipping line (e.g., VAT, GST). |
dimension |
shipping_lines.{NUM}.tax_lines.{NUM}.title |
shipping_lines.{NUM}.tax_lines.{NUM}.title |
The title or name of the tax applied to the shipping cost (e.g., ‘State Tax’, ‘VAT’). |
dimension |
shipping_lines.{NUM}.tax_lines.{NUM}.zone |
shipping_lines.{NUM}.tax_lines.{NUM}.zone |
The geographic zone or region to which this shipping tax line applies. |
dimension |
shipping_lines.{NUM}.title |
shipping_lines.{NUM}.title |
The title or name of the shipping method. |
dimension |
shipping_lines.{NUM}.validation_context |
shipping_lines.{NUM}.validation_context |
dimension |
|
shop_address1 |
address1 |
The first line of the shop’s street address. |
dimension |
shop_address2 |
address2 |
The optional second line of the shop’s street address. |
dimension |
shop_city |
city |
The city where the shop is located. |
dimension |
shop_country |
country |
The country where the shop is located. |
dimension |
shop_country_code |
country_code |
The two-letter ISO country code for the shop’s country. |
dimension |
shop_country_name |
country_name |
The normalized country name where the shop is located. |
dimension |
shop_created_at |
created_at |
The date and time when the Shopify shop was created. |
dimension |
shop_currency |
currency |
The three-letter code (ISO 4217 format) for the shop’s default currency. |
dimension |
shop_email |
The primary email address associated with the Shopify store. |
dimension |
|
shop_id |
shop_id |
The unique identifier for the Shopify shop. |
dimension |
shop_name |
shop_name |
The name of the Shopify shop. |
dimension |
shop_phone |
phone |
The main phone number for the shop. |
metric |
shop_province |
province |
The province, state, or region where the shop is located. |
dimension |
shop_province_code |
province_code |
The alphanumeric code for the province, state, or district where the shop is located (e.g., ON for Ontario, Canada). |
dimension |
shop_taxes_included |
taxes_included |
Indicates whether taxes are included in product prices by default for the shop. |
dimension |
shop_timezone |
shop_timezone |
The timezone configured for the Shopify shop. |
dimension |
shop_updated_at |
updated_at |
The date and time when the Shopify shop information was last updated. |
dimension |
shop_zip |
zip |
The zip or postal code of the shop’s address. |
metric |
shopify_domain |
shopify_domain |
The unique web address or domain name of the Shopify store. |
dimension |
sku |
sku |
The Stock Keeping Unit (SKU) used to identify a product variant. |
dimension |
sms_marketing_phone |
sms_marketing_phone |
The customer’s phone number designated for receiving SMS marketing communications. |
dimension |
sort_order |
sort_order |
The method used to sort products within a collection (e.g., ‘manual’, ‘best-selling’, ‘price-asc’). |
dimension |
source |
source |
The channel or method by which an order or other resource was created. |
dimension |
source_identifier |
source_identifier |
An identifier for the source that created the order or checkout. |
dimension |
source_name |
source_name |
The channel or source through which the order was created (e.g., ‘web’, ‘pos’). |
dimension |
source_url |
source_url |
The URL from which the order or checkout originated. |
dimension |
state |
state |
The state of the customer’s account (e.g., ‘enabled’). |
dimension |
status |
status |
The status of an order or product. For products, this includes ‘active’, ‘archived’, ‘draft’. For orders, statuses like ‘Open’, ‘Archived’, ‘Canceled’ exist, along with fulfillment statuses. |
dimension |
subtotal |
subtotal |
The subtotal price of all line items in an order before discounts, taxes, and shipping. |
metric |
subtotal_price |
subtotal_price |
The price of the order before taxes and shipping, and after discounts. |
metric |
subtotal_price_set |
subtotal_price_set |
The subtotal price of the order, including its value in shop and presentment currencies. |
dimension |
subtotal_set |
subtotal_set |
A complex object representing the subtotal price of all line items, including amounts in both shop and presentment currencies. |
dimension |
subtotal_set.presentment_money.amount |
subtotal_set.presentment_money.amount |
The monetary amount of the subtotal in the currency presented to the customer. |
metric |
subtotal_set.presentment_money.currency_code |
subtotal_set.presentment_money.currency_code |
The currency code of the subtotal in the currency presented to the customer. |
dimension |
subtotal_set.shop_money.amount |
subtotal_set.shop_money.amount |
The monetary amount of the subtotal in the shop’s local currency. |
metric |
subtotal_set.shop_money.currency_code |
subtotal_set.shop_money.currency_code |
The currency code of the subtotal in the shop’s local currency. |
dimension |
tags |
tags |
A comma-separated list of tags associated with the order. |
dimension |
tax |
tax |
metric |
|
tax_code |
tax_code |
The tax code associated with the product variant for tax calculation purposes. |
dimension |
tax_exempt |
tax_exempt |
Indicates whether the customer is exempt from being charged taxes on their orders. |
dimension |
tax_lines |
tax_lines |
A list of tax line items, detailing the taxes applied to the order. |
dimension |
tax_lines.{NUM}.channel_liable |
tax_lines.{NUM}.channel_liable |
Indicates whether the sales channel is responsible for collecting and remitting this specific tax line. |
dimension |
tax_lines.{NUM}.compare_at |
tax_lines.{NUM}.compare_at |
dimension |
|
tax_lines.{NUM}.compare_at.date |
tax_lines.{NUM}.compare_at.date |
dimension |
|
tax_lines.{NUM}.identifier |
tax_lines.{NUM}.identifier |
A unique identifier for the specific tax line. |
dimension |
tax_lines.{NUM}.position |
tax_lines.{NUM}.position |
The numerical position of this tax line within the list of tax lines. |
metric |
tax_lines.{NUM}.price |
tax_lines.{NUM}.price |
The amount of tax charged for this specific tax line. |
metric |
tax_lines.{NUM}.rate |
tax_lines.{NUM}.rate |
The tax rate percentage applied for this tax line. |
metric |
tax_lines.{NUM}.source |
tax_lines.{NUM}.source |
The source from which this tax line was generated or applied. |
dimension |
tax_lines.{NUM}.title |
tax_lines.{NUM}.title |
The title or name of the tax (e.g., ‘State Tax’, ‘VAT’). |
dimension |
tax_lines.{NUM}.zone |
tax_lines.{NUM}.zone |
The geographic zone or region to which this tax line applies. |
dimension |
tax_name |
tax_name |
The descriptive name of the tax applied. |
dimension |
taxable |
taxable |
Indicates whether a line item or product is subject to taxes. |
dimension |
template_suffix |
template_suffix |
The suffix of the Liquid template being used for a product or page (e.g., ‘custom’ for product.custom.liquid). |
dimension |
test |
test |
Indicates whether the order is a test order. |
dimension |
title |
title |
The title of a product, product variant, or shipping line. |
dimension |
token |
token |
A unique token associated with the order. |
dimension |
total_discount |
total_discount |
The total amount of discounts applied to an order or line item. |
metric |
total_discount_set.presentment_money.amount |
total_discount_set.presentment_money.amount |
The monetary value of the total discount applied to a line item, presented in the currency the customer saw at the time of purchase. |
dimension |
total_discount_set.presentment_money.currency_code |
total_discount_set.presentment_money.currency_code |
The three-letter ISO 4217 currency code (e.g., ‘USD’, ‘EUR’) for the amount of the total discount, reflecting the currency presented to the customer. |
dimension |
total_discount_set.shop_money.amount |
total_discount_set.shop_money.amount |
The total amount of discounts applied to the order, in the shop’s currency. |
dimension |
total_discount_set.shop_money.currency_code |
total_discount_set.shop_money.currency_code |
The three-letter currency code (ISO 4217 format) for the shop’s currency of the total discount. |
dimension |
total_discounts |
total_discounts |
The total amount of discounts applied to the order. |
metric |
total_discounts_set |
total_discounts_set |
The total amount of discounts applied to the order, including its value in shop and presentment currencies. |
dimension |
total_duties |
total_duties |
The total amount of duties applied to an order. |
metric |
total_line_items_price |
total_line_items_price |
The total price of all line items in the order before any order-level discounts or taxes. |
metric |
total_line_items_price_set |
total_line_items_price_set |
The sum of prices of all line items before any discounts, taxes, or shipping are applied, including amounts in both shop and presentment currencies. |
dimension |
total_outstanding |
total_outstanding |
The total outstanding amount that still needs to be paid for the order. |
metric |
total_price |
total_price |
The grand total price of the order, including taxes and shipping after all discounts. |
metric |
total_price_set |
total_price_set |
The total price of the order in both shop and presentment currencies. |
dimension |
total_price_usd |
total_price_usd |
The total price of the order converted to USD. |
metric |
total_shipping_price_set |
total_shipping_price_set |
The total shipping price of the order in both shop and presentment currencies. |
dimension |
total_shipping_price_set.presentment_money.amount |
total_shipping_price_set.presentment_money.amount |
The monetary amount of the total shipping price in the currency presented to the customer. |
metric |
total_shipping_price_set.presentment_money.currency_code |
total_shipping_price_set.presentment_money.currency_code |
The currency code of the total shipping price in the currency presented to the customer. |
dimension |
total_shipping_price_set.shop_money.amount |
total_shipping_price_set.shop_money.amount |
The monetary amount of the total shipping price in the shop’s local currency. |
metric |
total_shipping_price_set.shop_money.currency_code |
total_shipping_price_set.shop_money.currency_code |
The currency code of the total shipping price in the shop’s local currency. |
dimension |
total_spent |
total_spent |
The total amount the customer has spent on orders in their lifetime. |
metric |
total_tax |
total_tax |
The total tax amount charged for the order. |
metric |
total_tax_set |
total_tax_set |
The total amount of taxes applied to an order, including amounts in both shop and presentment currencies. |
dimension |
total_tax_set.presentment_money.amount |
total_tax_set.presentment_money.amount |
The monetary amount of the total tax in the currency presented to the customer. |
metric |
total_tax_set.presentment_money.currency_code |
total_tax_set.presentment_money.currency_code |
The currency code of the total tax in the currency presented to the customer. |
dimension |
total_tax_set.shop_money.amount |
total_tax_set.shop_money.amount |
The monetary amount of the total tax in the shop’s local currency. |
metric |
total_tax_set.shop_money.currency_code |
total_tax_set.shop_money.currency_code |
The currency code of the total tax in the shop’s local currency. |
dimension |
total_tip_received |
total_tip_received |
The total amount of tip received for the order. |
metric |
total_weight |
total_weight |
The total weight of the order in grams. |
metric |
tracked |
tracked |
Indicates whether the inventory levels for an item are being tracked by Shopify. |
dimension |
transaction_channel |
transaction_channel |
The sales channel or origin through which the transaction was made (e.g., ‘web’, ‘pos’). |
dimension |
transaction_revenue_without_tax |
transaction_revenue_without_tax |
The revenue generated from a transaction, excluding any tax amounts. |
metric |
type |
type |
The data type of the value stored in the metafield (e.g., ‘string’, ‘integer’, ‘json’). |
dimension |
updated_at.date |
updated_at.date |
The date when the order or resource was last updated. |
dimension |
user_id |
user_id |
The unique identifier of the user (e.g., staff member) who processed the order. |
dimension |
utm_campaign |
utm_campaign |
The name of the marketing campaign from which the order originated, used for tracking purposes. |
dimension |
utm_content |
utm_content |
Identifies specific content within a marketing campaign for tracking and differentiation. |
dimension |
utm_medium |
utm_medium |
The marketing medium (e.g., ‘cpc’, ‘social’, ‘email’) from which the order originated. |
dimension |
utm_source |
utm_source |
The source of the marketing traffic (e.g., ‘google’, ‘instagram’) from which the order originated. |
dimension |
utm_term |
utm_term |
Paid search terms used in the marketing campaign from which the order originated. |
dimension |
value |
value |
The actual data stored in the metafield, always represented as a string. |
dimension |
variant |
variant |
A detailed object representing a specific version of a product, defined by options like size or color. |
metric |
variant_id |
variant_id |
The unique identifier for a product variant. |
dimension |
variant_inventory_management |
variant_inventory_management |
The inventory management system used for a product variant (e.g., ‘shopify’ if tracked by Shopify, or ‘null’ if not tracked). |
dimension |
variant_title |
variant_title |
The title of the product variant, often generated from its options (e.g., ‘Small / Red’). |
dimension |
variants.barcode |
variants.barcode |
The barcode (UPC, ISBN, or GTIN) associated with the product variant. |
metric |
variants.compare_at_price |
variants.compare_at_price |
The compare-at price of the product variant, typically used to show a discount or sale price. |
dimension |
variants.fulfillment_service |
variants.fulfillment_service |
The handle of the fulfillment service responsible for stocking and shipping this product variant. (Note: This field is deprecated and its use is no longer recommended for new implementations). |
dimension |
variants.grams |
variants.grams |
The weight of the product variant in grams. |
metric |
variants.id |
variants.id |
The unique numeric identifier for the product variant. |
metric |
variants.image_id |
variants.image_id |
The unique identifier of the image associated with the product variant. |
dimension |
variants.inventory_item_id |
variants.inventory_item_id |
The unique identifier for the inventory item associated with the product variant, used for tracking inventory. |
dimension |
variants.inventory_management |
variants.inventory_management |
Indicates how inventory for the product variant is managed (e.g., ‘shopify’ for Shopify-tracked inventory or ‘null’ if not tracked). |
dimension |
variants.inventory_policy |
variants.inventory_policy |
The inventory policy for the product variant, which determines whether customers can order the item when it is out of stock. |
dimension |
variants.inventory_quantity |
variants.inventory_quantity |
The quantity of available inventory for a specific product variant. |
metric |
variants.position |
variants.position |
The order of the product variant in relation to other variants of the same product. |
metric |
variants.price |
variants.price |
The price of the product variant. |
metric |
variants.product_id |
variants.product_id |
The unique identifier of the parent product to which the variant belongs. |
dimension |
variants.requires_shipping |
variants.requires_shipping |
Indicates whether the product variant requires physical shipping. (Note: This field is deprecated on ProductVariant; refer to InventoryItem for current information). |
dimension |
variants.sku |
variants.sku |
The Stock Keeping Unit (SKU) for the product variant. |
dimension |
variants.tax_code |
variants.tax_code |
The tax code used for classifying the product variant for tax purposes. |
dimension |
variants.taxable |
variants.taxable |
Indicates whether the product variant is subject to taxes. |
dimension |
variants.title |
variants.title |
The title or name of the product variant (e.g., ‘Small/Blue’). |
dimension |
variants.weight |
variants.weight |
The weight of the product variant. |
metric |
variants.weight_unit |
variants.weight_unit |
The unit of measurement for the product variant’s weight (e.g., ‘kg’, ‘g’, ‘lb’, ‘oz’). |
dimension |
vendor |
vendor |
The name of the product’s vendor or supplier. |
dimension |
verified_email |
verified_email |
Indicates whether the customer has verified their email address. Defaults to true if created via admin or API. |
dimension |
voucher_code |
voucher_code |
A specific code used to apply a voucher or discount. |
dimension |