Shopify

Field reference and API usage

Shopify

Ecommerce

Ecommerce platform for online stores

223 metrics232 dimensions1 data viewapiKey auth

Metrics

223

Sales 66

IDNameSymbol
total_salesTotal Salescurrency
gross_salesGross Salescurrency
net_salesNet Salescurrency
discountsDiscountscurrency
returnsReturnscurrency
shippingShippingcurrency
taxesTaxescurrency
tipsTotal Tipscurrency
total_sales_first_timeTotal Sales (First-Time)currency
total_sales_returningTotal Sales (Returning)currency
total_shipping_chargesTotal Shipping Chargescurrency
active_subscriptionsActive Subscriptionsnumber
additional_feesAdditional Feescurrency
additional_product_and_order_discountsAdditional Product and Order Discountscurrency
additional_shipping_discountsAdditional Shipping Discountscurrency
amount_spent_per_customerAmount Spent Per Customercurrency
applied_discountsApplied Discountscurrency
bundles_orderedBundles Orderednumber
cost_of_goods_soldCost of Goods Soldnumber
customersCustomersnumber
discounted_ordersDiscounted Ordersnumber
discounts_returnedDiscounts Returnedcurrency
dutiesDutiescurrency
gift_card_discountsGift Card Discountscurrency
gift_card_gross_salesGift Card Gross Salescurrency
gift_card_net_salesGift Card Net Salescurrency
gift_card_taxesGift Card Taxescurrency
gross_marginGross Margin%
gross_profitGross Profitcurrency
gross_returnsGross Returnscurrency
line_item_discountsLine Item Discountscurrency
net_items_soldNet Items Soldnumber
net_returnsNet Returnscurrency
net_sales_with_cost_recordedNet Sales With Cost Recordedcurrency
net_sales_without_cost_recordedNet Sales Without Cost Recordedcurrency
new_customersNew Customersnumber
number_of_orders_per_customerNumber of Orders Per Customernumber
order_level_discountsOrder-Level Discountscurrency
order_sale_agreementsOrder Sale Agreementsnumber
orders_first_timeOrders (first-time)number
orders_returningOrders (returning)number
product_and_order_discountsProduct and Order Discountsnumber
product_and_order_discounts_from_appsProduct and Order Discounts From Appsnumber
quantity_orderedQuantity Orderednumber
quantity_ordered_per_orderQuantity Ordered Per Ordernumber
quantity_returnedQuantity Returnednumber
rate_of_staff_assisted_salesRate of Staff-Assisted Sales%
returned_quantity_rateReturned Quantity Rate%
return_feesReturn Feescurrency
returning_customer_rateReturning Customer Rate%
returning_customersReturning Customersnumber
shipping_charge_discountsShipping Charge Discountscurrency
shipping_chargesShipping Chargescurrency
shipping_charge_taxesShipping Charge Taxescurrency
shipping_discountsShipping Discountscurrency
shipping_discounts_from_appsShipping Discounts From Appscurrency
shipping_returnedShipping Returnedcurrency
shop_mini_ordersShop Mini Ordersnumber
shop_mini_salesShop Mini Salescurrency
shop_post_purchase_ordersShop Post-Purchase Ordersnumber
shop_post_purchase_salesShop Post-Purchase Salescurrency
subscriptions_addedSubscriptions Addednumber
subscriptions_canceledSubscriptions Cancelednumber
taxes_excluding_gift_cardsTaxes Excluding Gift Cardscurrency
taxes_returnedTaxes Returnedcurrency
total_returnsTotal Returnscurrency

Orders 54

IDNameSymbol
ordersOrdersnumber
average_order_valueAvg. Order Valuecurrency
orders_first_timeOrders (first-time)number
orders_returningOrders (returning)number
average_cost_of_goods_soldAverage Cost of Goods Soldcurrency
average_customer_duties_and_import_taxesAverage Customer Duties and Import Taxescurrency
average_customer_shipping_chargesAverage Customer Shipping Chargescurrency
average_duty_and_import_tax_adjustment_costsAverage Duty and Import Tax Adjustment Costscurrency
average_profit_at_delivery_before_returnsAverage Profit at Delivery (Before Returns)currency
average_revenue_before_returnsAverage Revenue (Before Returns)currency
average_sale_after_discountsAverage Sale After Discountscurrency
average_sales_taxesAverage Sales Taxescurrency
average_shipping_label_adjustment_costsAverage Shipping Label Adjustment Costscurrency
average_store_costs_before_returnsAverage Store Costs (Before Returns)currency
average_store_duties_and_import_taxesAverage Store Duties and Import Taxescurrency
average_store_shipping_costsAverage Store Shipping Costscurrency
orders_delivered_fast_rateDelivered Within 5 Days Rate%
campaign_first_click_average_order_quantityFirst Click Average Order Quantitynumber
campaign_first_click_average_order_valueFirst Click Average Order Valuecurrency
campaign_first_click_net_items_soldFirst Click Net Items Soldnumber
campaign_first_click_order_countFirst Click Order Countnumber
campaign_first_click_salesFirst Click Salescurrency
campaign_last_click_average_order_quantityLast Click Average Order Quantitynumber
campaign_last_click_average_order_valueLast Click Average Order Valuecurrency
campaign_last_click_net_items_soldLast Click Net Items Soldnumber
campaign_last_click_order_countLast Click Order Countnumber
campaign_last_click_salesLast Click Salescurrency
campaign_last_non_direct_click_average_order_quantityLast Non-Direct Click Average Order Quantitynumber
campaign_last_non_direct_click_average_order_valueLast Non-Direct Click Average Order Valuecurrency
campaign_last_non_direct_click_net_items_soldLast Non-Direct Click Net Items Soldnumber
campaign_last_non_direct_click_order_countLast Non-Direct Click Order Countnumber
campaign_last_non_direct_click_salesLast Non-Direct Click Salescurrency
campaign_linear_average_order_quantityLinear Average Order Quantitynumber
campaign_linear_average_order_valueLinear Average Order Valuecurrency
campaign_linear_net_items_soldLinear Net Items Soldnumber
campaign_linear_order_countLinear Order Countnumber
campaign_linear_salesLinear Salesnumber
median_days_fulfillment_to_shippingMedian Days Fulfillment to Shippingnumber
median_days_order_to_deliveryMedian Days Order to Deliverynumber
median_days_order_to_fulfillmentMedian Days Order to Fulfillmentnumber
median_days_order_to_shippingMedian Days Order to Shippingnumber
median_days_shipping_to_deliveryMedian Days Shipping to Deliverynumber
median_hours_fulfillment_to_shippingMedian Hours Fulfillment to Shippingnumber
median_hours_order_to_deliveryMedian Hours Order to Deliverynumber
median_hours_order_to_fulfillmentMedian Hours Order to Fulfillmentnumber
median_hours_order_to_shippingMedian Hours Order to Shippingnumber
median_hours_shipping_to_deliveryMedian Hours Shipping to Deliverynumber
orders_deliveredOrders Deliverednumber
orders_fulfilledOrders Fulfillednumber
orders_shippedOrders Shippednumber
orders_shipped_fast_rateShipped Next Day Rate%
shipping_label_costsShipping Label Costscurrency
shipping_labelsShipping Labelsnumber
orders_with_tracking_included_rateTracking Included Rate%

Sessions 3

IDNameSymbol
sessionsSessionsnumber
bouncesBouncesnumber
bounce_rateBounce Rate%

Customers 6

IDNameSymbol
days_since_last_orderDays Since Last Ordernumber
new_customer_recordsNew Customer Recordsnumber
percent_of_customersPercent of Customers%
total_amount_spentTotal Amount Spentcurrency
total_amount_spent_per_orderTotal Amount Spent Per Ordercurrency
total_number_of_ordersTotal Number of Ordersnumber

Finance & Payments 37

IDNameSymbol
adjusted_gift_card_valueAdjusted Gift Card Valuecurrency
cash_roundingCash Roundingcurrency
credited_store_credit_valueCredited Store Creditcurrency
debited_store_credit_valueDebited Store Creditcurrency
disabled_gift_card_valueDisabled Gift Card Valuecurrency
ending_gift_card_balanceEnding Gift Card Balancecurrency
ending_store_credit_balanceEnding Store Credit Balancecurrency
expired_store_credit_valueExpired Store Creditcurrency
failed_payment_attemptsFailed Payment Attemptsnumber
gift_card_balance_net_changeGift Card Balance Net Changecurrency
gift_cards_adjustedGift Cards Adjustednumber
gift_cards_disabledGift Cards Disablednumber
gift_cards_issuedGift Cards Issuednumber
gross_paymentsGross Paymentscurrency
issued_gift_card_balanceIssued Gift Card Balancecurrency
net_paymentsNet Paymentscurrency
net_payments_excluding_gift_cardsNet Payments Excluding Gift Cardscurrency
orders_with_transactionsOrders With Transactionsnumber
payment_authorization_ratePayment Authorization Rate%
payment_authorization_rate_rawPayment Authorization Rate (Raw)%
payout_amountPayout Amountcurrency
payout_amount_in_payout_currencyPayout Amount in Payout Currencycurrency
pricing_adjustment_valuePricing Adjustment Valuecurrency
redeemed_gift_card_valueRedeemed Gift Card Valuecurrency
refunded_gift_card_valueRefunded Gift Card Valuecurrency
refunded_paymentsRefunded Paymentscurrency
rounded_net_paymentsRounded Net Paymentscurrency
sales_taxesSales Taxescurrency
sold_gift_card_balanceSold Gift Card Balancecurrency
starting_gift_card_balanceStarting Gift Card Balancecurrency
starting_store_credit_balanceStarting Store Credit Balancecurrency
store_credit_balance_net_changeStore Credit Balance Net Changecurrency
successful_paymentsSuccessful Paymentsnumber
total_payment_attemptsTotal Payment Attemptsnumber
transaction_amountTransaction Amountcurrency
transactionsTransactionsnumber
unique_payment_attemptsUnique Payment Attemptsnumber

Fraud Prevention 11

IDNameSymbol
acceptable_fraud_risk_rateAcceptable Fraud Risk Rate%
chargeback_amountChargeback Amountcurrency
chargeback_rateChargeback Rate%
chargebacksChargebacksnumber
checkout_surfaces_impactedCheckout Impact Rate%
checkout_surfaces_impacted_countCheckouts Impacted Decision Rulesnumber
fraudulent_chargeback_rateFraudulent Chargeback Rate%
fraudulent_chargebacksFraudulent Chargebacksnumber
high_fraud_risk_rateHigh Fraud Risk Rate%
successful_transactionsSuccessful Transactionsnumber
checkout_value_impactedValue Impacted By Decision Rulescurrency

Marketing 11

IDNameSymbol
ad_impressionsAd Impressionsnumber
product_network_commissionsCommissionscurrency
product_network_purchasesNetwork Purchasesnumber
pageviews_with_adsPage Views With Adsnumber
product_network_clicksProduct Network Clicksnumber
shop_campaign_ad_spendShop Campaign Ad Spendcurrency
shop_campaign_average_order_valueShop Campaign AVG. Order Valuecurrency
shop_campaign_credits_earnedShop Campaign Credits Earnedcurrency
shop_campaign_customersShop Campaign Customersnumber
shop_campaign_return_on_ad_spendShop Campaign Return on Ad Spendnumber
shop_campaign_salesShop Campaign Salescurrency

Inventory 35

IDNameSymbol
acceptance_rateAcceptance Rate%
accepted_quantityAccepted Quantitynumber
days_in_inventoryDays in Inventorynumber
days_in_inventory_at_locationDays in Inventory (At Location)number
days_in_stockDays In Stocknumber
days_in_stock_at_locationDays In Stock (at location)number
days_of_inventory_remainingDays of Inventory Remainingnumber
days_of_inventory_remaining_at_locationDays of Inventory Remaining (at location)number
days_out_of_stockDays Out of Stocknumber
days_out_of_stock_at_locationDays Out of Stock (at location)number
ending_inventory_retail_valueEnding Inventory Retail Valuecurrency
ending_inventory_retail_value_at_locationEnding Inventory Retail Value (At Location)currency
ending_inventory_unitsEnding Inventory Unitsnumber
ending_inventory_units_at_locationEnding Inventory Units (At Location)number
ending_inventory_valueEnding Inventory Valuecurrency
ending_inventory_value_at_locationEnding Inventory Value (At Location)currency
inventory_adjustment_changeInventory Adjustment Changenumber
inventory_adjustment_countInventory Adjustment Countnumber
inventory_units_net_change_at_locationInventory Units Net Change (At Location)number
inventory_units_soldInventory Units Soldnumber
inventory_units_sold_per_dayInventory Units Sold Per Daynumber
ordered_quantityOrdered Quantitynumber
percent_of_inventory_soldPercent of Inventory Sold%
received_quantityReceived Quantitynumber
rejected_quantityRejected Quantitynumber
rejection_rateRejection Rate%
sell_through_rateSell-through rate%
shipment_countShipmentsnumber
shipped_quantityShipped Quantitynumber
starting_inventory_unitsStarting Inventory Unitsnumber
starting_inventory_units_at_locationStarting Inventory Units (At Location)number
transfer_line_item_countTransfer Line Itemsnumber
transfer_countTransfersnumber
unique_items_shippedUnique Items Shippednumber
unique_items_transferredUnique Items Transferrednumber

Dimensions

232

Time 4

IDName
DATEDate
MONTHMonth
WEEKWeek
YEARYear

Stores 2

IDName
shop_nameStore Name
shop_idStore ID

Orders 30

IDName
first_order_referring_channelFirst Order Referring Channel
first_order_sales_channelFirst Order Sales Channel
first_order_traffic_typeFirst Order Traffic Type
is_canceled_orderIs Canceled Order
marketMarket
order_checkout_currencyOrder Checkout Currency
order_fulfillment_statusOrder Fulfillment Status
order_idOrder ID
order_includes_dutiesOrder Includes Duties
order_landing_page_pathOrder Landing Page Path
order_landing_page_urlOrder Landing Page URL
order_marketing_event_idOrder Marketing Event ID
order_marketing_event_targetOrder Marketing Event Target
order_marketing_event_typeOrder Marketing Event Type
order_nameOrder Name
order_payment_statusOrder Payment Status
order_referrer_domainOrder Referrer Domain
order_referrer_nameOrder Referrer Name
order_referrer_pathOrder Referrer Path
order_referrer_siteOrder Referrer Site
order_referrer_sourceOrder Referrer Source
order_referrer_urlOrder Referrer URL
order_sales_channelOrder Sales Channel
order_sales_channel_idOrder Sales Channel ID
order_tagOrder Tag
order_utm_campaignOrder UTM Campaign
order_utm_contentOrder UTM Content
order_utm_mediumOrder UTM Medium
order_utm_sourceOrder UTM Source
order_utm_termOrder UTM Term

Products 31

IDName
app_product_creationApp Product Creation
sales_line_item_group_idBundle ID
bundle_product_idBundle Product ID
bundle_titleBundle Title
line_item_is_bundleIs Bundle
number_of_products_bought_togetherNumber of Products Bought Together
product_collectionProduct Collection
product_idProduct ID
variants_bought_togetherVariants Bought Together
product_tagProduct Tag
product_titleProduct Title
product_typeProduct Type
product_variant_abc_gradeProduct Variant ABC Grade
product_variant_idProduct Variant ID
product_variant_skuProduct Variant SKU
product_variant_titleProduct Variant Title
product_vendorProduct Vendor
number_of_variants_bought_togetherVariants Bought Together (Count)
billing_address_idBilling Address ID
billing_cityBilling City
billing_companyBilling Company
billing_countryBilling Country
billing_postal_codeBilling Postal Code
billing_regionBilling Region
pos_location_namePOS Location Name
shipping_address_idShipping Address ID
shipping_cityShipping City
shipping_companyShipping Company
shipping_countryShipping Country
shipping_postal_codeShipping Postal Code
shipping_regionShipping Region

Retail / POS 5

IDName
assisting_staff_idAssisting Staff Member ID
assisting_staff_member_nameAssisting Staff Member Name
pos_location_idPOS Location ID
staff_idStaff ID
staff_member_nameStaff Member Name

Marketing 3

IDName
referring_mediumReferring Medium
referring_platformReferring Platform
traffic_typeTraffic Type

B2B 5

IDName
company_idCompany ID
company_location_idCompany Location ID
company_location_nameCompany Location Name
company_nameCompany Name
is_b2b_orderIs B2B Order

Fraud Prevention 5

IDName
order_cancellation_reasonOrder Cancellation Reason
order_is_shopify_protect_coveredOrder is Shopify Protect covered
order_is_shopify_protect_eligibleOrder is Shopify Protect eligible
order_is_shopify_protect_protectedOrder is Shopify Protect protected
order_risk_levelOrder Risk Level

Customers 22

IDName
abandoned_checkout_dateAbandoned Checkout Date
customer_account_statusCustomer Account Status
customer_added_dateCustomer Added Date
customer_cohort_monthCustomer Cohort Month
customer_cohort_quarterCustomer Cohort Quarter
customer_cohort_weekCustomer Cohort Week
customer_emailCustomer Email
customer_email_domainCustomer Email Domain
customer_email_subscription_statusCustomer Email Subscription Status
customer_first_order_dateCustomer First Order Date
customer_idCustomer ID
customer_languageCustomer Language
customer_last_order_dateCustomer Last Order Date
customer_nameCustomer Name
customer_number_of_ordersCustomer Number Of Orders
customer_sms_subscription_statusCustomer SMS subscription status
customer_tagCustomer Tag
first_order_has_subscriptionFirst Order Has Subscription
new_or_returning_customerNew Or Returning Customer
predicted_spend_tierPredicted Spend Tier
quarters_since_first_purchaseQuarters Since First Purchase
rfm_groupRFM Group

Sales Revenue 39

IDName
collective_supplierCollective Supplier
cost_is_recordedCost Is Recorded
discount_classDiscount Class
discount_codeDiscount Code
discount_idDiscount ID
discount_line_idDiscount Line ID
discount_methodDiscount Method
discount_nameDiscount Name
discount_shipping_priceDiscount Shipping Price
discount_shipping_titleDiscount Shipping Title
discount_titleDiscount Title
discount_typeDiscount Type
discount_valueDiscount Value
excludes_post_order_adjustmentsExcludes Post-Order Adjustments
is_discounted_saleIs Discounted Sale
is_pos_saleIs POS Sale
is_return_relatedIs Return Related
is_sale_adjustmentIs Sale Adjustment
is_unverified_returnIs Unverified Return
line_item_idLine Item ID
line_typeLine Type
order_or_returnOrder or Return
price_rule_discount_titlePrice Rule Discount Title
price_rule_discount_typePrice Rule Discount Type
price_rule_discount_valuePrice Rule Discount Value
price_rule_typePrice Rule Type
product_title_at_time_of_saleProduct Title at Time of Sale
product_variant_title_at_time_of_saleProduct Variant Title at Time of Sale
product_vendor_at_time_of_saleProduct Vendor at Time of Sale
product_type_at_time_of_saleProduct Type at Time of Sale
product_variant_compare_at_priceProduct Variant Compare at Price
product_variant_priceProduct Variant Price
product_variant_sku_at_time_of_saleProduct Variant SKU at Time of Sale
refund_idRefund ID
return_reasonReturn Reason
sale_idSale ID
sales_channelSales Channel
sale_sales_channel_idSales Channel ID
subscription_or_one_timeSubscription or One-Time

Inventory 21

IDName
inventory_cost_is_recordedInventory Cost Is Recorded
destination_cityInventory Destination City
destination_countryInventory Destination Country
inventory_destination_idInventory Destination ID
destination_nameInventory Destination Name
destination_regionInventory Destination Region
inventory_is_trackedInventory Is Tracked
inventory_item_costInventory Item Cost
inventory_item_idInventory Item ID
inventory_origin_cityInventory Origin City
inventory_origin_countryInventory Origin Country
inventory_origin_idInventory Origin ID
inventory_origin_nameInventory Origin Name
inventory_origin_regionInventory Origin Region
transfer_created_atTransfer Created Date
inventory_transfer_idInventory Transfer ID
transfer_nameTransfer Name
transfer_noteTransfer Note
transfer_reference_nameTransfer Reference
transfer_statusTransfer Status
transfer_tagsTransfer Tags

Sessions and Behaviour 33

IDName
human_or_bot_sessionHuman or Bot Session
session_api_clientSession Api Client
landing_page_pathLanding Page Path
landing_page_typeLanding Page Type
landing_page_urlLanding Page Url
referrer_domainReferrer Domain
referrer_nameReferrer Name
referrer_pathReferrer Path
referrer_siteReferrer Site
referrer_sourceReferrer Source
referrer_termsReferrer Terms
referrer_urlReferrer URL
referring_channelReferring Channel
referring_mediumReferring Medium
referring_platformReferring Platform
session_bouncedSession Bounced
session_device_browserSession Device Browser
session_device_browser_versionSession Device Browser Version
session_citySession City
session_countrySession Country
session_country_codeSession Country Code
session_device_osSession Device OS
session_device_os_versionSession Device OS Version
session_device_typeSession Device Type
session_durationSession Duration
session_idSession ID
session_regionSession Region
traffic_typeTraffic Type
utm_campaignUTM Campaign
utm_contentUTM Content
utm_mediumUTM Medium
utm_sourceUTM Source
utm_termUTM Term

Finance & Payments 16

IDName
credit_card_tierCredit Card Tier
credit_card_typeCredit Card Type
digital_walletDigital Wallet
is_shop_channel_transactionIs Shop Channel Transaction
is_shop_pay_transactionIs Shop Pay Transaction
payment_card_binPayment Card Bin
payment_card_issuerPayment Card Issuer
payment_card_sourcePayment Card Source
payment_gatewayPayment Gateway
payment_methodPayment Method
transaction_currencyTransaction Currency
transaction_idTransaction ID
transaction_kindTransaction Kind
transaction_numberTransaction Number
transaction_sale_typeTransaction Sale Type
transaction_statusTransaction Status

Deprecated 16

IDName
channel_nameChannel Name (Deprecated)
referrerUrlReferrer URL (Deprecated)
landingPageUrlLanding Page URL (Deprecated)
landingPageDisplayTextLanding Page Display Text (Deprecated)
top_marketing_channelsTop Marketing Channels (Deprecated)
address1Address 1 (Deprecated)
address2Address 2 (Deprecated)
cityCity (Deprecated)
countryCountry (Deprecated)
provinceProvince (Deprecated)
zipZip (Deprecated)
displayNameDisplay Name (Deprecated)
emailEmail Address (Deprecated)
phonePhone (Deprecated)
idOrder ID (Deprecated)
nameOrder Name (Deprecated)
← All Integrations · API Reference · Powered by Oviond