Shopify fields list — Porter Metrics docs
Fields Reference · Shopify

Shopify Fields List

155 fields · 0 dimensions · 0 metrics · 7 groups

155 of 155
Field nameLabelCategoryDescription
dateDate TimeDate.
date_timeDate and Time TimeThe date and time of the order.
day_of_weekDay of week (Mon – Sun) TimeDay of week (Mon – Sun).
hourHour TimeHour.
monthMonth TimeMonth.
month_dayMonth Day TimeMonth Day of the creation of the order.
quarterQuarter TimeQuarter.
weekWeek TimeWeek.
yearYear TimeYear.
year_monthMonth and year TimeMonth and year.
year_quarterQuarter and year TimeQuarter and year.
year_weekWeek and year TimeWeek and year.
average_order_valueAverage order value OrdersThe average value of a staff’s sales.
customersTotal Customers OrdersCount of customers
discount_codeDiscount Code OrdersDiscount code provided by the customer.
financial_statusFinancial Status OrdersFinancial status of the order that can be shown to the merchant. This field does not capture all the possible details of an order’s financial state and should only be used for display summary purposes.
fulfillment_statusFulfillment Status OrdersFulfillment status for the order that can be shown to the merchant. This field does not capture all the possible details of an order’s fulfillment state. It should only be used for display summary purposes.
landing_page_urlLanding Page URL OrdersURL of the first page the customer landed on for the session before an order is made.
order_canceled_dateOrder Canceled Date OrdersThe date when the order was canceled in format. This fields returns null if the order wasn’t canceled.
order_channelChannel OrdersName of the channel that this sub channel belongs to.
order_channel_app_nameChannel app name OrdersName of the channel app.
order_closed_dateOrder Closed Date OrdersDate time when the order closed. If the order is not closed, then this field returns null.
order_creation_dateOrder Creation Date OrdersThe date the order was created.
order_current_total_weightOrder Current Total Weight OrdersThe total weight of the order after returns, in grams.
order_idOrder ID OrdersGlobally unique identifier of an order
order_is_closedOrder Is Closed OrdersWhether the order is closed.
order_is_confirmedOrder Is Confirmed OrdersWhether inventory has been reserved for the order
order_is_editedOrder Is Edited OrdersWhether the order has had any edits applied.
order_is_fully_paidOrder is Fully Paid OrdersWhether the order has been paid in full.
order_is_refundableOrder is Refundable OrdersWhether the order can be refunded.
order_is_testIs Test OrdersWhether the order is a test order.
order_nameOrder Name OrdersUnique identifier for the order that appears on the order. For example, #1000 or _Store1001. This value is not unique across multiple stores.
order_noteOrder Note OrdersContents of the note associated with the order.
order_payment_gateway_namesOrder Payment Gateway Names OrdersA list of the names of all payment gateways used for the order.
order_processed_dateOrder Processed Date OrdersThe date when the order was processed.
order_requires_shippingOrder Requires Shipping OrdersWhether any line item on the order requires physical shipping.
order_risk_levelOrder Risk Level OrdersThe likelihood that an order is fraudulent. Valid values are HIGH, LOW and MEDIUM.
order_tagsOrder Tags OrdersA comma separated list of tags associated with the order.
order_taxes_estimatedOrder Taxes Estimated OrdersWhether taxes on the order are estimated. Many factors can change between the time a customer places an order and the time the order is shipped, which could affect the calculation of taxes. This field returns false when taxes on the order are finalized and aren’t subject to any changes.
order_total_weightOrder Total Weight OrdersThe total weight of the order before returns, in grams.
order_updated_dateOrder Updated Date OrdersThe date the order was last updated.
ordersOrders OrdersCount of the orders.
physical_location_namePhysical Location Name OrdersThe name of the physical location.
referral_codeReferral Code OrdersMarketing referral code from the link that the customer clicked to visit the store. Supports the following URL attributes: ref, source, or r. For example, if the URL is myshopifystore.com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2.
referrer_urlReferrer URL OrdersWebpage where the customer clicked a link that sent them to the online store. For example, https://randomblog.com/page1 or android-app://com.google.android.gm.
sale_action_typeSale action type OrdersThe type of order action that the sale represents.
sale_agreement_reasonSale agreement reason OrdersThe reason the agreement was created.
sale_line_typeSale line type OrdersThe line type assocated with the sale.
sale_quantityNumber Of Sold Items OrdersThe number of units either ordered or intended to be returned.
shipping_address_1Shipping Address 1 OrdersThe first line of the address. Typically the street address or PO Box number.
shipping_address_2Shipping Address 2 OrdersThe second line of the address. Typically the number of the apartment, suite, or unit.
shipping_cityShipping City OrdersThe name of the city, district, village, or town.
shipping_coordinatesShipping Coordinates OrdersThe latitude and longitude coordinates of the customer address.
shipping_countryShipping Country OrdersThe name of the country.
shipping_country_codeShipping Country Code OrdersThe two-letter code for the country of the address. For example, US.
shipping_country_iconShipping Country Icon OrdersCountry icon.
shipping_country_icon_urlShipping Country Icon Url OrdersCountry icon url.
shipping_latitudeShipping Latitude OrdersThe latitude coordinate of the customer address.
shipping_longitudeShipping Longitude OrdersThe longitude coordinate of the customer address.
shipping_provinceShipping Province OrdersThe region of the address, such as the province, state, or district.
shipping_province_codeShipping Province Code OrdersThe two-letter code for the region. For example, ON.
shipping_titleShipping title OrdersThe title of the shipping line.
shipping_zip_codeShipping ZIP Code OrdersThe zip or postal code of the address.
utm_campaignUTM Campaign OrdersThe name of a marketing campaign.
utm_contentUTM Content OrdersIdentifies specific content in a marketing campaign. Used to differentiate between similar content or links in a marketing campaign to determine which is the most effective.
utm_mediumUTM Medium OrdersThe medium of a marketing campaign, such as a banner or email newsletter.
utm_sourceUTM Source OrdersSource from which the customer visited the store, such as a platform (Facebook, Google), email, direct, a website domain, QR code, or unknown.
utm_source_descriptionUTM Source Description OrdersDescribes the source explicitly.
utm_source_typeUTM Source Type OrdersDescribes the source explicitly for first or last session.
utm_termUTM Term OrdersPaid search terms used by a marketing campaign.
average_orders_per_customerAverage Orders per Customer CustomerAverage number of orders per customer.
cogs_minus_returnsCOGS (Minus Refunds) CustomerCOGS minus refunds.
cost_per_orderCost Per Order CustomerCost per order.
customer_accepts_marketingCustomer Accepts Marketing CustomerWhether the customer agreed to receive marketing materials.
customer_creation_dateCustomer Creation Date CustomerThe date when the customer was added to the store.
customer_display_nameCustomer Display Name CustomerThe full name of the customer, based on the values for first_name and last_name. If the first_name and last_name are not available, then this falls back to the customer’s email address, and if that is not available, the customer’s phone number.
customer_emailCustomer Email CustomerThe customer’s email address.
customer_first_nameCustomer First Name CustomerThe customer’s first name.
customer_idCustomer ID CustomerGlobally unique identifier for the customer.
customer_imageCustomer Image CustomerThe image associated with the customer.
customer_image_urlCustomer Image URL CustomerThe image associated with the customer.
customer_last_nameCustomer Last Name CustomerThe customer’s last name.
customer_last_order_dateCustomer Last Order Date CustomerThe customer’s last order creation date.
customer_lifetime_durationCustomer Lifetime Duration CustomerThe amount of time since the customer was first added to the store. Example: ‘about 12 years’.
customer_orders_countCustomer Orders Count CustomerThe number of orders that the customer has made at the store in their lifetime.
customer_phoneCustomer Phone CustomerThe customer’s phone number.
customer_stateCustomer State CustomerThe state of the customer’s account with the shop.
customer_tagsCustomer Tags CustomerA comma separated list of tags that have been added to the customer.
customer_tax_exemptCustomer Tax Exempt CustomerWhether the customer is exempt from being charged taxes on their orders.
customer_total_spentCustomer Total Spent CustomerThe total amount that the customer has spent on orders in their lifetime.
customer_typeCustomer Type CustomerWhether the customer is placing their first order (First-time) or is a returning customer (Returning).
customer_verified_emailCustomer Verified Email CustomerWhether the customer has verified their email address. Defaults to true if the customer is created through the Shopify admin or API.
gross_profitGross Profit CustomerGross profit.
new_customersNew Customers CustomerCount of customers placing their first order (First-time).
new_customers_aovNew Customers AOV CustomerAverage order value of customers placing their first order (First-time).
new_customers_cost_of_goods_soldNew Customers COGS CustomerCost of goods sold of customers placing their first order (First-time).
new_customers_gross_salesNew Customers Gross Sales CustomerGross sales of customers placing their first order (First-time).
new_customers_gross_sales_percentNew Customers Gross Sales % CustomerGross sales of customers placing their first order (First-time) over total gross sales.
new_customers_net_salesNew Customers Net Sales CustomerNet sales of customers placing their first order (First-time).
new_customers_net_sales_percentNew Customers Net Sales % CustomerNet sales of customers placing their first order (First-time) over total gross sales.
new_customers_ordersNew Customer Orders CustomerCount of orders from customers placing their first order (First-time).
new_customers_ratioNew Customers % CustomerRatio of new customers to total customers.
new_customers_total_salesNew Customers Total Sales CustomerTotal sales of customers placing their first order (First-time).
new_customers_total_sales_percentNew Customers Total Sales % CustomerTotal sales of customers placing their first order (First-time) over total sales.
purchase_frequencyPurchase Frequency CustomerPurchase frequency.
returning_customersRepeat Customers CustomerCount of returning customers.
returning_customers_aovRepeat Customers AOV CustomerAverage order value of returning customers.
returning_customers_cost_of_goods_soldRepeat Customers COGS CustomerCost of goods sold of returning customers.
returning_customers_gross_profitRepeat Customers Gross Profit CustomerGross profit of returning customers.
returning_customers_gross_salesRepeat Customers Gross Sales CustomerGross sales of returning customers.
returning_customers_gross_sales_percentRepeat Customers Gross Sales % CustomerGross sales of returning customers over total gross sales.
returning_customers_net_salesRepeat Customers Net Sales CustomerNet sales of returning customers.
returning_customers_net_sales_percentRepeat Customers Net Sales % CustomerNet sales of returning customers over total net sales.
returning_customers_ordersRepeat Customer Orders CustomerCount of orders from returning customers.
returning_customers_ratioRepeat Customers % CustomerRatio of returning customers to total customers.
returning_customers_total_salesRepeat Customers Total Sales CustomerTotal sales of returning customers.
returning_customers_total_sales_percentRepeat Customers Total Sales % CustomerTotal sales of returning customers over total sales.
zero_dollar_orders0$ Orders CustomerCount of orders with a zero dollar value.
product_creation_dateProduct Creation Date ProductThe date when the product was created.
product_descriptionProduct Description ProductA stripped description of the product, single line with HTML tags removed.
product_idProduct ID ProductGlobally unique identifier of the product.
product_imageProduct Image ProductThe Image object associated to the line item’s variant.
product_image_urlProduct Image Url ProductThe Image object associated to the line item’s variant.
product_price_rangeProduct Price Range ProductThe price range of the product with prices formatted as decimals.
product_seo_descriptionProduct SEO description ProductSEO Description.
product_seo_titleProduct SEO title ProductSEO Title.
product_statusProduct Status ProductThe product status. This controls visibility across all channels.
product_tagsProduct Tags ProductA comma separated list of tags associated with the product.
product_titleProduct Title ProductTitle of the product.
product_typeProduct Type ProductThe product type specified by the merchant.
product_vendorProduct Vendor ProductName of the vendor who made the variant.
skuSKU ProductVariant SKU number.
variant_creation_dateVariant creation date ProductThe date and time when the variant was created.
variant_idVariant ID ProductA globally-unique identifier of the product variant.
variant_imageVariant image ProductThe featured image for the variant.
variant_image_urlVariant image URL ProductThe featured image for the variant.
variant_inventory_policyVariant inventory policy ProductWhether customers are allowed to place an order for the product variant when it’s out of stock.
variant_inventory_quantityInventory Quantity ProductThe quantity of inventory in stock.
variant_priceVariant Price ProductThe price of the product variant in the default shop currency.
variant_tax_codeVariant Tax Code ProductThe tax code for the product variant.
variant_titleVariant Title ProductName of the variant.
variant_unit_costUnit Cost ProductUnit cost associated with the inventory item. Note: the user must have ‘View product costs’ permission granted in order to access this field once product granular permissions are enabled.
variant_unit_cost_currency_codeUnit Cost Currency Code ProductUnit cost currency code associated with the inventory item. Note: the user must have ‘View product costs’ permission granted in order to access this field once product granular permissions are enabled.
cost_of_good_soldsCOGS SalesCost of good solds. Equates to product unit cost x quantity.
discounts_orderDiscounts SalesThe sum of all applied discounts on this line item.
gross_sales_orderGross Sales SalesEquates to product price x quantity (before taxes, shipping, discounts, and returns) for a collection of sales. Canceled, pending, and unpaid orders are included. Test and deleted orders are not included.
net_sales_orderNet Sales SalesEquates to gross sales – discounts – returns.
returns_orderReturns SalesThe total amount refunded for each line item.
shipping_orderShipping SalesThe total amount charged for shipping the order.
tax_orderTax SalesThe total of all taxes applied to the order at the time it was created.
total_sales_orderTotal Sales SalesEquates to gross sales – discounts – returns + taxes + shipping charges.
unknown_feesUnknown Fees SalesAn unknown sale line. Represents new types that may be added in future versions.
shop_idShop ID Shop InfoID of the shop.
shop_nameShop Name Shop InfoName of the shop.
line_item_idLine Item ID Line ItemUnique identifier of the line item