Magento: Most-used fields#
The table below gives information about most-used fields that you can import from Magento. 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 |
|---|---|---|---|
addresses.{NUM}.city |
addresses.{NUM}.city |
The city of the customer’s address. |
dimension |
addresses.{NUM}.company |
addresses.{NUM}.company |
The company name associated with the customer’s address. |
dimension |
addresses.{NUM}.country_id |
addresses.{NUM}.country_id |
The ID of the country associated with the customer’s address. |
dimension |
addresses.{NUM}.customer_id |
addresses.{NUM}.customer_id |
The ID of the customer to whom the address belongs. |
dimension |
addresses.{NUM}.default_billing |
addresses.{NUM}.default_billing |
A flag indicating if this is the customer’s default billing address. |
dimension |
addresses.{NUM}.default_shipping |
addresses.{NUM}.default_shipping |
A flag indicating if this is the customer’s default shipping address. |
dimension |
addresses.{NUM}.firstname |
addresses.{NUM}.firstname |
The first name of the person associated with the address. |
dimension |
addresses.{NUM}.id |
addresses.{NUM}.id |
The unique identifier for the address record. |
metric |
addresses.{NUM}.lastname |
addresses.{NUM}.lastname |
The last name of the person associated with the address. |
dimension |
addresses.{NUM}.postcode |
addresses.{NUM}.postcode |
The postal code or ZIP code of the address. |
dimension |
addresses.{NUM}.region.region |
addresses.{NUM}.region.region |
The full name of the region or state associated with the address. |
dimension |
addresses.{NUM}.region.region_code |
addresses.{NUM}.region.region_code |
The code for the region or state associated with the address. |
dimension |
addresses.{NUM}.region.region_id |
addresses.{NUM}.region.region_id |
The ID of the region or state associated with the address. |
dimension |
addresses.{NUM}.region_id |
addresses.{NUM}.region_id |
The ID of the region or state associated with the address. |
dimension |
addresses.{NUM}.street.{NUM} |
addresses.{NUM}.street.{NUM} |
A line of the street address. Multiple lines can exist for a single address. |
dimension |
addresses.{NUM}.telephone |
addresses.{NUM}.telephone |
The telephone number associated with the address. |
dimension |
addresses.{NUM}.vat_id |
addresses.{NUM}.vat_id |
The Value Added Tax (VAT) identification number for the customer’s address. |
dimension |
amount_refunded |
amount_refunded |
The total amount refunded for an item in the transaction currency. |
metric |
applied_rule_ids |
applied_rule_ids |
A comma-separated list of IDs of the shopping cart price rules that were applied to the order item or the entire order. |
dimension |
base_amount_refunded |
base_amount_refunded |
The total amount refunded for an item in the store’s base currency. |
metric |
base_currency_code |
base_currency_code |
The base currency code of the store. |
dimension |
base_discount_amount |
base_discount_amount |
The discount amount applied to the order in base currency. |
metric |
base_discount_invoiced |
base_discount_invoiced |
The invoiced discount amount in base currency. |
metric |
base_discount_refunded |
base_discount_refunded |
The base discount amount refunded for an item in the store’s base currency. |
metric |
base_discount_tax_compensation_amount |
base_discount_tax_compensation_amount |
The discount tax compensation amount in base currency. |
metric |
base_discount_tax_compensation_invoiced |
base_discount_tax_compensation_invoiced |
The invoiced discount tax compensation amount in base currency. |
metric |
base_discount_tax_compensation_refunded |
base_discount_tax_compensation_refunded |
The amount of tax compensation for discounts that was refunded, expressed in the store’s base currency. This field reflects adjustments made to taxes when a discounted item is returned, ensuring the tax portion of the discount is also accounted for in the refund. |
metric |
base_grand_total |
base_grand_total |
The grand total amount of the order in base currency. |
metric |
base_original_price |
base_original_price |
The original price of the item in the store’s base currency. |
metric |
base_price |
base_price |
The unit price of the item in the store’s base currency. |
metric |
base_price_incl_tax |
base_price_incl_tax |
The unit price of the item, including tax, in the store’s base currency. |
metric |
base_row_invoiced |
base_row_invoiced |
The total row amount that has been invoiced for the item in the store’s base currency. |
metric |
base_row_total |
base_row_total |
The total row amount for the item in the store’s base currency. |
metric |
base_row_total_incl_tax |
base_row_total_incl_tax |
The total row amount for the item, including tax, in the store’s base currency. |
metric |
base_shipping_amount |
base_shipping_amount |
The shipping amount for the order in base currency. |
metric |
base_shipping_discount_amount |
base_shipping_discount_amount |
The shipping discount amount in base currency. |
metric |
base_shipping_discount_tax_compensation_amnt |
base_shipping_discount_tax_compensation_amnt |
The shipping discount tax compensation amount in base currency. |
metric |
base_shipping_incl_tax |
base_shipping_incl_tax |
The shipping amount including tax in base currency. |
metric |
base_shipping_invoiced |
base_shipping_invoiced |
The invoiced shipping amount in base currency. |
metric |
base_shipping_tax_amount |
base_shipping_tax_amount |
The shipping tax amount in base currency. |
metric |
base_subtotal |
base_subtotal |
The subtotal amount of the order in base currency. |
metric |
base_subtotal_incl_tax |
base_subtotal_incl_tax |
The subtotal amount including tax in base currency. |
metric |
base_subtotal_invoiced |
base_subtotal_invoiced |
The invoiced subtotal amount in base currency. |
metric |
base_tax_amount |
base_tax_amount |
The total tax amount for the order in base currency. |
metric |
base_tax_invoiced |
base_tax_invoiced |
The invoiced tax amount in base currency. |
metric |
base_tax_refunded |
base_tax_refunded |
The tax amount refunded for an item in the store’s base currency. |
metric |
base_to_global_rate |
base_to_global_rate |
The currency conversion rate from base currency to global currency. |
metric |
base_to_order_rate |
base_to_order_rate |
The currency conversion rate from base currency to order currency. |
metric |
base_total_due |
base_total_due |
The total amount still due on the order in base currency. |
metric |
base_total_invoiced |
base_total_invoiced |
The total invoiced amount in base currency. |
metric |
base_total_invoiced_cost |
base_total_invoiced_cost |
The total invoiced cost of the items in base currency. |
metric |
base_total_paid |
base_total_paid |
The total amount paid in base currency. |
metric |
billing_address.address_type |
billing_address.address_type |
The type of the billing address (e.g., ‘billing’). |
dimension |
billing_address.city |
billing_address.city |
The city of the billing address. |
dimension |
billing_address.company |
billing_address.company |
The company name associated with the billing address. |
dimension |
billing_address.country_id |
billing_address.country_id |
The country ID of the billing address (e.g., ‘US’). |
dimension |
billing_address.customer_address_id |
billing_address.customer_address_id |
The ID of the customer’s address if it’s a registered address. |
dimension |
billing_address.customer_id |
billing_address.customer_id |
The ID of the customer associated with the billing address. |
dimension |
billing_address.email |
billing_address.email |
The email address associated with the billing address. |
dimension |
billing_address.entity_id |
billing_address.entity_id |
The unique identifier for the billing address entity. |
dimension |
billing_address.firstname |
billing_address.firstname |
The first name for the billing address. |
dimension |
billing_address.lastname |
billing_address.lastname |
The last name for the billing address. |
dimension |
billing_address.parent_id |
billing_address.parent_id |
The ID of the parent entity (e.g., order) to which this billing address belongs. |
dimension |
billing_address.postcode |
billing_address.postcode |
The postcode/zip code of the billing address. |
dimension |
billing_address.region_id |
billing_address.region_id |
The region ID of the billing address. |
dimension |
billing_address.street.{NUM} |
billing_address.street.{NUM} |
A specific line of the street address for the billing address. |
dimension |
billing_address.telephone |
billing_address.telephone |
The telephone number for the billing address. |
dimension |
billing_address.vat_id |
billing_address.vat_id |
The VAT ID associated with the billing address for business customers. |
dimension |
billing_address.vat_is_valid |
billing_address.vat_is_valid |
A flag indicating if the VAT ID provided for the billing address is valid. |
metric |
billing_address.vat_request_success |
billing_address.vat_request_success |
Indicates if the VAT ID validation request for the billing address was successful. |
metric |
billing_address_id |
billing_address_id |
The ID of the billing address. |
dimension |
created_at |
created_at |
The timestamp when the entity (e.g., order, invoice, customer) was created. |
dimension |
created_in |
created_in |
The store view code or name where the entity (e.g., customer, order) was created. |
dimension |
custom_attributes.{NUM}.attribute_code |
custom_attributes.{NUM}.attribute_code |
The code for a custom attribute. |
dimension |
custom_attributes.{NUM}.value |
custom_attributes.{NUM}.value |
The value of the custom attribute. |
metric |
customer_email |
customer_email |
The customer’s email address. |
dimension |
customer_firstname |
customer_firstname |
The customer’s first name. |
dimension |
customer_gender |
customer_gender |
The customer’s gender. |
metric |
customer_group_id |
customer_group_id |
The ID of the customer group to which the customer belongs. |
dimension |
customer_id |
customer_id |
The unique identifier for the customer. |
dimension |
customer_is_guest |
customer_is_guest |
A flag indicating if the customer is a guest (not a registered user). |
metric |
customer_lastname |
customer_lastname |
The customer’s last name. |
dimension |
customer_note_notify |
customer_note_notify |
A flag indicating if the customer should be notified about the customer note. |
metric |
date |
date |
The date associated with the entity’s creation or a relevant event. |
dimension |
default_billing |
default_billing |
The ID of the customer’s default billing address. |
metric |
default_shipping |
default_shipping |
The ID of the customer’s default shipping address. |
metric |
disable_auto_group_change |
disable_auto_group_change |
Indicates whether the automatic change of a customer’s group based on their VAT ID is disabled. When set, the customer’s group will not be automatically updated even if VAT ID rules apply. |
metric |
discount_amount |
discount_amount |
The total discount amount applied to the order. |
metric |
discount_description |
discount_description |
A description of the discount applied to the order. |
dimension |
discount_invoiced |
discount_invoiced |
The amount of discount that has been invoiced. |
metric |
discount_percent |
discount_percent |
The percentage of discount applied to the item. |
metric |
discount_refunded |
discount_refunded |
The discount amount refunded for an item in the transaction currency. |
metric |
discount_tax_compensation_amount |
discount_tax_compensation_amount |
The tax compensation amount for the discount. |
metric |
discount_tax_compensation_canceled |
discount_tax_compensation_canceled |
This field represents the amount of tax compensation for discounts that was canceled for an order or order item. It indicates the portion of tax compensation related to discounts that has been reversed. |
metric |
discount_tax_compensation_invoiced |
discount_tax_compensation_invoiced |
The invoiced tax compensation amount for the discount. |
metric |
discount_tax_compensation_refunded |
discount_tax_compensation_refunded |
The amount of tax compensation for discounts that was refunded, expressed in the currency of the order. This field reflects adjustments made to taxes when a discounted item is returned, ensuring the tax portion of the discount is also accounted for in the refund. |
metric |
The email address of the customer. |
dimension |
||
email_sent |
email_sent |
Indicates whether an email notification for the entity (e.g., order confirmation, invoice) has been sent. |
metric |
entity_id |
entity_id |
The unique identifier for the entity. |
dimension |
extension_attributes.applied_taxes.{NUM}.amount |
extension_attributes.applied_taxes.{NUM}.amount |
The amount of an applied tax. |
metric |
extension_attributes.applied_taxes.{NUM}.base_amount |
extension_attributes.applied_taxes.{NUM}.base_amount |
The base currency amount of an applied tax. |
metric |
extension_attributes.applied_taxes.{NUM}.code |
extension_attributes.applied_taxes.{NUM}.code |
The code of an applied tax. |
metric |
extension_attributes.applied_taxes.{NUM}.percent |
extension_attributes.applied_taxes.{NUM}.percent |
The percentage of an applied tax. |
metric |
extension_attributes.applied_taxes.{NUM}.title |
extension_attributes.applied_taxes.{NUM}.title |
The title or name of an applied tax. |
metric |
extension_attributes.converting_from_quote |
extension_attributes.converting_from_quote |
A flag indicating whether the order was converted from a customer quote. |
dimension |
extension_attributes.is_subscribed |
extension_attributes.is_subscribed |
Indicates whether the customer is subscribed to the newsletter. |
dimension |
extension_attributes.item_applied_taxes.{NUM}.applied_taxes.{NUM}.amount |
extension_attributes.item_applied_taxes.{NUM}.applied_taxes.{NUM}.amount |
The amount of an applied tax for a specific item. |
metric |
extension_attributes.item_applied_taxes.{NUM}.applied_taxes.{NUM}.base_amount |
extension_attributes.item_applied_taxes.{NUM}.applied_taxes.{NUM}.base_amount |
The base currency amount of an applied tax for a specific item. |
metric |
extension_attributes.item_applied_taxes.{NUM}.applied_taxes.{NUM}.code |
extension_attributes.item_applied_taxes.{NUM}.applied_taxes.{NUM}.code |
The code of an applied tax for a specific item. |
metric |
extension_attributes.item_applied_taxes.{NUM}.applied_taxes.{NUM}.percent |
extension_attributes.item_applied_taxes.{NUM}.applied_taxes.{NUM}.percent |
The percentage of an applied tax for a specific item. |
metric |
extension_attributes.item_applied_taxes.{NUM}.applied_taxes.{NUM}.title |
extension_attributes.item_applied_taxes.{NUM}.applied_taxes.{NUM}.title |
The title or name of an applied tax for a specific item. |
metric |
extension_attributes.item_applied_taxes.{NUM}.item_id |
extension_attributes.item_applied_taxes.{NUM}.item_id |
The ID of the item to which the taxes are applied. |
dimension |
extension_attributes.item_applied_taxes.{NUM}.type |
extension_attributes.item_applied_taxes.{NUM}.type |
The type of tax applied to the item. |
dimension |
extension_attributes.payment_additional_info.{NUM}.key |
extension_attributes.payment_additional_info.{NUM}.key |
The key for an additional piece of payment information associated with the order. |
dimension |
extension_attributes.payment_additional_info.{NUM}.value |
extension_attributes.payment_additional_info.{NUM}.value |
The value corresponding to a key in the additional payment information associated with the order. |
dimension |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.amount_refunded |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.amount_refunded |
The amount refunded for this specific item within the shipping assignment. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.applied_rule_ids |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.applied_rule_ids |
A comma-separated list of IDs for cart price rules or promotions that were applied to this item. |
dimension |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_amount_refunded |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_amount_refunded |
The amount refunded for this specific item in the store’s base currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_cost |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_cost |
The base cost of the item within a specific shipping assignment. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_discount_amount |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_discount_amount |
The discount amount applied to this item in the store’s base currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_discount_invoiced |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_discount_invoiced |
The amount of discount that has been invoiced for this item in the store’s base currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_discount_tax_compensation_amount |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_discount_tax_compensation_amount |
The amount of tax compensation applied due to discounts for this item, in the store’s base currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_discount_tax_compensation_invoiced |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_discount_tax_compensation_invoiced |
The amount of tax compensation for discounts that has been invoiced for this item, in the store’s base currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_original_price |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_original_price |
The original price of the item, before any discounts or special pricing, in the store’s base currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_price |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_price |
The unit price of the item in the store’s base currency, excluding tax. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_price_incl_tax |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_price_incl_tax |
The unit price of the item in the store’s base currency, including tax. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_row_invoiced |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_row_invoiced |
The total invoiced amount for this item’s row, in the store’s base currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_row_total |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_row_total |
The total price for this item’s row (quantity * price), excluding tax, in the store’s base currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_row_total_incl_tax |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_row_total_incl_tax |
The total price for this item’s row (quantity * price), including tax, in the store’s base currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_tax_amount |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_tax_amount |
The total tax amount applied to this item in the store’s base currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_tax_invoiced |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.base_tax_invoiced |
The amount of tax that has been invoiced for this item, in the store’s base currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.created_at |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.created_at |
The date and time when this order item was created. |
dimension |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.discount_amount |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.discount_amount |
The discount amount applied to this item in the order’s currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.discount_invoiced |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.discount_invoiced |
The amount of discount that has been invoiced for this item. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.discount_percent |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.discount_percent |
The percentage of the discount applied to this item. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.discount_tax_compensation_amount |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.discount_tax_compensation_amount |
The amount of tax compensation applied due to discounts for this item, in the order’s currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.discount_tax_compensation_invoiced |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.discount_tax_compensation_invoiced |
The amount of tax compensation for discounts that has been invoiced for this item. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.free_shipping |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.free_shipping |
Indicates whether free shipping was applied to this item (1 for yes, 0 for no). |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.is_qty_decimal |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.is_qty_decimal |
Indicates if the quantity for this item can be expressed as a decimal value (e.g., for products sold by weight). |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.is_virtual |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.is_virtual |
Indicates if the item is a virtual product, such as a service or digital download (1 for virtual, 0 for physical). |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.item_id |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.item_id |
The unique identifier for this specific item within the order. |
dimension |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.name |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.name |
The name of the product in the order item. |
dimension |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.no_discount |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.no_discount |
Indicates if this item is excluded from discount calculations. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.order_id |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.order_id |
The unique identifier for the order this item belongs to. |
dimension |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.original_price |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.original_price |
The original unit price of the item in the order’s currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.price |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.price |
The unit price of the item in the order’s currency, excluding tax. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.price_incl_tax |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.price_incl_tax |
The unit price of the item in the order’s currency, including tax. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.product_id |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.product_id |
The unique identifier of the product that this order item represents. |
dimension |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.product_option.extension_attributes.custom_options.{NUM}.option_id |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.product_option.extension_attributes.custom_options.{NUM}.option_id |
The ID of a custom option chosen for a product within a shipping assignment. |
dimension |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.product_option.extension_attributes.custom_options.{NUM}.option_value |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.product_option.extension_attributes.custom_options.{NUM}.option_value |
The selected value for a custom option of a product within a shipping assignment. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.product_type |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.product_type |
The type of product, such as simple, configurable, virtual, or bundle. |
dimension |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.qty_backordered |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.qty_backordered |
The quantity of the item that is currently on backorder within a specific shipping assignment. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.qty_canceled |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.qty_canceled |
The quantity of this item that has been canceled from the order. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.qty_invoiced |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.qty_invoiced |
The quantity of this item that has been invoiced. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.qty_ordered |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.qty_ordered |
The original quantity of this item placed in the order. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.qty_refunded |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.qty_refunded |
The quantity of this item that has been refunded. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.qty_shipped |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.qty_shipped |
The quantity of this item that has been shipped. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.quote_item_id |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.quote_item_id |
The identifier for the corresponding item in the customer’s quote or shopping cart. |
dimension |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.row_invoiced |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.row_invoiced |
The total invoiced amount for this item’s row, in the order’s currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.row_total |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.row_total |
The total price for this item’s row (quantity * price), excluding tax, in the order’s currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.row_total_incl_tax |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.row_total_incl_tax |
The total price for this item’s row (quantity * price), including tax, in the order’s currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.row_weight |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.row_weight |
The total weight of the quantity of this item in the order row. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.sku |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.sku |
The Stock Keeping Unit (SKU) of the product associated with this order item. |
dimension |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.store_id |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.store_id |
The identifier of the store where the order containing this item was placed. |
dimension |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.tax_amount |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.tax_amount |
The total tax amount applied to this item in the order’s currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.tax_invoiced |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.tax_invoiced |
The amount of tax that has been invoiced for this item. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.tax_percent |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.tax_percent |
The percentage rate of the tax applied to this item. |
metric |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.updated_at |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.updated_at |
The date and time when this order item was last updated. |
dimension |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.weee_tax_applied |
extension_attributes.shipping_assignments.{NUM}.items.{NUM}.weee_tax_applied |
Information about any WEEE (Waste Electrical and Electronic Equipment) tax applied to this item. |
dimension |
extension_attributes.shipping_assignments.{NUM}.shipping.address.address_type |
extension_attributes.shipping_assignments.{NUM}.shipping.address.address_type |
The type of address (e.g., ‘shipping’ or ‘billing’). |
dimension |
extension_attributes.shipping_assignments.{NUM}.shipping.address.city |
extension_attributes.shipping_assignments.{NUM}.shipping.address.city |
The city of the shipping address. |
dimension |
extension_attributes.shipping_assignments.{NUM}.shipping.address.company |
extension_attributes.shipping_assignments.{NUM}.shipping.address.company |
The company name associated with the shipping address. |
dimension |
extension_attributes.shipping_assignments.{NUM}.shipping.address.country_id |
extension_attributes.shipping_assignments.{NUM}.shipping.address.country_id |
The two-letter ISO country code for the shipping address (e.g., ‘US’, ‘GB’). |
dimension |
extension_attributes.shipping_assignments.{NUM}.shipping.address.customer_address_id |
extension_attributes.shipping_assignments.{NUM}.shipping.address.customer_address_id |
The ID of the customer’s address book entry used for this shipping address. |
dimension |
extension_attributes.shipping_assignments.{NUM}.shipping.address.customer_id |
extension_attributes.shipping_assignments.{NUM}.shipping.address.customer_id |
The ID of the customer associated with this shipping address. |
dimension |
extension_attributes.shipping_assignments.{NUM}.shipping.address.email |
extension_attributes.shipping_assignments.{NUM}.shipping.address.email |
The email address associated with the shipping address. |
dimension |
extension_attributes.shipping_assignments.{NUM}.shipping.address.entity_id |
extension_attributes.shipping_assignments.{NUM}.shipping.address.entity_id |
A unique identifier for the address entity. |
dimension |
extension_attributes.shipping_assignments.{NUM}.shipping.address.firstname |
extension_attributes.shipping_assignments.{NUM}.shipping.address.firstname |
The first name of the recipient at the shipping address. |
dimension |
extension_attributes.shipping_assignments.{NUM}.shipping.address.lastname |
extension_attributes.shipping_assignments.{NUM}.shipping.address.lastname |
The last name of the recipient for a specific shipping address within a shipping assignment. |
dimension |
extension_attributes.shipping_assignments.{NUM}.shipping.address.parent_id |
extension_attributes.shipping_assignments.{NUM}.shipping.address.parent_id |
The ID of the parent entity associated with the shipping address within a shipping assignment. |
dimension |
extension_attributes.shipping_assignments.{NUM}.shipping.address.postcode |
extension_attributes.shipping_assignments.{NUM}.shipping.address.postcode |
The postal code for a specific shipping address within a shipping assignment. |
dimension |
extension_attributes.shipping_assignments.{NUM}.shipping.address.region_id |
extension_attributes.shipping_assignments.{NUM}.shipping.address.region_id |
The internal identifier for the region (state or province) for a specific shipping address. |
dimension |
extension_attributes.shipping_assignments.{NUM}.shipping.address.street.{NUM} |
extension_attributes.shipping_assignments.{NUM}.shipping.address.street.{NUM} |
A specific line of the street address for the shipping location. |
dimension |
extension_attributes.shipping_assignments.{NUM}.shipping.address.telephone |
extension_attributes.shipping_assignments.{NUM}.shipping.address.telephone |
The telephone number associated with the shipping address. |
dimension |
extension_attributes.shipping_assignments.{NUM}.shipping.address.vat_id |
extension_attributes.shipping_assignments.{NUM}.shipping.address.vat_id |
The Value Added Tax (VAT) identification number associated with the shipping address, used for tax calculation and compliance. |
dimension |
extension_attributes.shipping_assignments.{NUM}.shipping.address.vat_is_valid |
extension_attributes.shipping_assignments.{NUM}.shipping.address.vat_is_valid |
A flag indicating if the VAT ID provided for the shipping address within a shipping assignment is valid. |
metric |
extension_attributes.shipping_assignments.{NUM}.shipping.address.vat_request_success |
extension_attributes.shipping_assignments.{NUM}.shipping.address.vat_request_success |
Indicates if the VAT ID validation request for the shipping address within a shipping assignment was successful. |
metric |
extension_attributes.shipping_assignments.{NUM}.shipping.method |
extension_attributes.shipping_assignments.{NUM}.shipping.method |
The selected shipping method (e.g., ‘flatrate_flatrate’, ‘ups_ground’) for a particular shipping assignment. |
dimension |
extension_attributes.shipping_assignments.{NUM}.shipping.total.base_shipping_amount |
extension_attributes.shipping_assignments.{NUM}.shipping.total.base_shipping_amount |
The shipping amount for a specific shipping assignment in the store’s base currency, before any discounts or taxes. |
metric |
extension_attributes.shipping_assignments.{NUM}.shipping.total.base_shipping_discount_amount |
extension_attributes.shipping_assignments.{NUM}.shipping.total.base_shipping_discount_amount |
The amount of discount applied to the shipping cost for a specific shipping assignment, in the store’s base currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.shipping.total.base_shipping_discount_tax_compensation_amnt |
extension_attributes.shipping_assignments.{NUM}.shipping.total.base_shipping_discount_tax_compensation_amnt |
The amount of tax compensation for shipping discounts in the store’s base currency. This adjusts tax calculation when discounts are applied. |
metric |
extension_attributes.shipping_assignments.{NUM}.shipping.total.base_shipping_incl_tax |
extension_attributes.shipping_assignments.{NUM}.shipping.total.base_shipping_incl_tax |
The total shipping amount for a specific shipping assignment, including taxes, in the store’s base currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.shipping.total.base_shipping_invoiced |
extension_attributes.shipping_assignments.{NUM}.shipping.total.base_shipping_invoiced |
The amount of shipping cost that has been invoiced for a specific shipping assignment, in the store’s base currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.shipping.total.base_shipping_tax_amount |
extension_attributes.shipping_assignments.{NUM}.shipping.total.base_shipping_tax_amount |
The amount of tax applied to the shipping cost for a specific shipping assignment, in the store’s base currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.shipping.total.shipping_amount |
extension_attributes.shipping_assignments.{NUM}.shipping.total.shipping_amount |
The shipping amount for a specific shipping assignment in the display currency, before any discounts or taxes. |
metric |
extension_attributes.shipping_assignments.{NUM}.shipping.total.shipping_discount_amount |
extension_attributes.shipping_assignments.{NUM}.shipping.total.shipping_discount_amount |
The amount of discount applied to the shipping cost for a specific shipping assignment, in the display currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.shipping.total.shipping_discount_tax_compensation_amount |
extension_attributes.shipping_assignments.{NUM}.shipping.total.shipping_discount_tax_compensation_amount |
The amount of tax compensation for shipping discounts in the order’s currency. This adjusts tax calculation when discounts are applied. |
metric |
extension_attributes.shipping_assignments.{NUM}.shipping.total.shipping_incl_tax |
extension_attributes.shipping_assignments.{NUM}.shipping.total.shipping_incl_tax |
The total shipping amount for a specific shipping assignment, including taxes, in the display currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.shipping.total.shipping_invoiced |
extension_attributes.shipping_assignments.{NUM}.shipping.total.shipping_invoiced |
The amount of shipping cost that has been invoiced for a specific shipping assignment, in the display currency. |
metric |
extension_attributes.shipping_assignments.{NUM}.shipping.total.shipping_tax_amount |
extension_attributes.shipping_assignments.{NUM}.shipping.total.shipping_tax_amount |
The amount of tax applied to the shipping cost for a specific shipping assignment, in the display currency. |
metric |
firstname |
firstname |
The first name of the customer. |
dimension |
free_shipping |
free_shipping |
Indicates if free shipping was applied to the item. |
metric |
gender |
gender |
The gender of the customer. |
metric |
global_currency_code |
global_currency_code |
The ISO 4217 currency code for the global base currency configured for the store. |
dimension |
grand_total |
grand_total |
The final total amount of the order, including all items, shipping, taxes, and discounts. |
metric |
group_id |
group_id |
The ID of the customer group to which the customer belongs. |
dimension |
id |
id |
The unique identifier for the entity (e.g., customer, order, product). |
dimension |
increment_id |
increment_id |
The human-readable increment ID (order number) of the order. |
dimension |
is_qty_decimal |
is_qty_decimal |
Indicates if the quantity of the item can be a decimal value. |
metric |
is_virtual |
is_virtual |
A boolean indicator specifying whether the product or item is virtual and does not require shipping. |
metric |
item_id |
item_id |
The unique identifier for the specific order item. |
dimension |
items.{NUM}.amount_refunded |
items.{NUM}.amount_refunded |
The total amount refunded for this specific order item in the display currency. |
metric |
items.{NUM}.applied_rule_ids |
items.{NUM}.applied_rule_ids |
A comma-separated list of IDs of the promotional rules that were applied to this order item. |
dimension |
items.{NUM}.base_amount_refunded |
items.{NUM}.base_amount_refunded |
The total amount refunded for this specific order item in the store’s base currency. |
metric |
items.{NUM}.base_cost |
items.{NUM}.base_cost |
The base cost of an individual item in the order. |
metric |
items.{NUM}.base_discount_amount |
items.{NUM}.base_discount_amount |
The discount amount applied to this order item in the store’s base currency. |
metric |
items.{NUM}.base_discount_invoiced |
items.{NUM}.base_discount_invoiced |
The amount of discount for this order item that has been invoiced, in the store’s base currency. |
metric |
items.{NUM}.base_discount_tax_compensation_amount |
items.{NUM}.base_discount_tax_compensation_amount |
The amount of tax compensation for an item’s discount in the store’s base currency. This adjusts tax calculation when discounts are applied. |
metric |
items.{NUM}.base_discount_tax_compensation_invoiced |
items.{NUM}.base_discount_tax_compensation_invoiced |
The invoiced amount of tax compensation for an item’s discount in the store’s base currency. |
metric |
items.{NUM}.base_original_price |
items.{NUM}.base_original_price |
The original price of the product associated with this order item, in the store’s base currency, before any special pricing or discounts. |
metric |
items.{NUM}.base_price |
items.{NUM}.base_price |
The price of the product associated with this order item, in the store’s base currency, after any special pricing but before item-level discounts. |
metric |
items.{NUM}.base_price_incl_tax |
items.{NUM}.base_price_incl_tax |
The price of the product associated with this order item, including taxes, in the store’s base currency. |
metric |
items.{NUM}.base_row_invoiced |
items.{NUM}.base_row_invoiced |
The total amount of the row (quantity * price) for this order item that has been invoiced, in the store’s base currency. |
metric |
items.{NUM}.base_row_total |
items.{NUM}.base_row_total |
The total amount of the row (quantity * price) for this order item, in the store’s base currency, before taxes and discounts. |
metric |
items.{NUM}.base_row_total_incl_tax |
items.{NUM}.base_row_total_incl_tax |
The total amount of the row (quantity * price) for this order item, including taxes, in the store’s base currency. |
metric |
items.{NUM}.base_tax_amount |
items.{NUM}.base_tax_amount |
The amount of tax applied to this order item, in the store’s base currency. |
metric |
items.{NUM}.base_tax_invoiced |
items.{NUM}.base_tax_invoiced |
The amount of tax for this order item that has been invoiced, in the store’s base currency. |
metric |
items.{NUM}.created_at |
items.{NUM}.created_at |
The timestamp indicating when this order item was created. |
dimension |
items.{NUM}.discount_amount |
items.{NUM}.discount_amount |
The discount amount applied to this order item in the display currency. |
metric |
items.{NUM}.discount_invoiced |
items.{NUM}.discount_invoiced |
The amount of discount for this order item that has been invoiced, in the display currency. |
metric |
items.{NUM}.discount_percent |
items.{NUM}.discount_percent |
The discount rate applied to this order item, expressed as a percentage. |
metric |
items.{NUM}.discount_tax_compensation_amount |
items.{NUM}.discount_tax_compensation_amount |
The amount of tax compensation for an item’s discount in the order’s currency. This adjusts tax calculation when discounts are applied. |
metric |
items.{NUM}.discount_tax_compensation_invoiced |
items.{NUM}.discount_tax_compensation_invoiced |
The invoiced amount of tax compensation for an item’s discount. |
metric |
items.{NUM}.free_shipping |
items.{NUM}.free_shipping |
A boolean indicator specifying if free shipping was applied specifically to this order item. |
metric |
items.{NUM}.is_qty_decimal |
items.{NUM}.is_qty_decimal |
A boolean indicator specifying whether the quantity for this particular order item can be a decimal value. |
metric |
items.{NUM}.is_virtual |
items.{NUM}.is_virtual |
A boolean indicator specifying whether this order item is virtual and does not require shipping. |
metric |
items.{NUM}.item_id |
items.{NUM}.item_id |
The unique identifier for this specific order item. |
dimension |
items.{NUM}.name |
items.{NUM}.name |
The name of the product associated with this order item. |
dimension |
items.{NUM}.no_discount |
items.{NUM}.no_discount |
A flag indicating whether a specific item is excluded from discount calculations. |
metric |
items.{NUM}.order_id |
items.{NUM}.order_id |
The unique identifier of the order to which this item belongs. |
dimension |
items.{NUM}.original_price |
items.{NUM}.original_price |
The original price of the product associated with this order item, in the display currency, before any special pricing or discounts. |
metric |
items.{NUM}.price |
items.{NUM}.price |
The price of the product associated with this order item, in the display currency, after any special pricing but before item-level discounts. |
metric |
items.{NUM}.price_incl_tax |
items.{NUM}.price_incl_tax |
The price of the product associated with this order item, including taxes, in the display currency. |
metric |
items.{NUM}.product_id |
items.{NUM}.product_id |
The unique identifier of the product from the catalog that this order item represents. |
dimension |
items.{NUM}.product_option.extension_attributes.custom_options.{NUM}.option_id |
items.{NUM}.product_option.extension_attributes.custom_options.{NUM}.option_id |
The ID of a custom option selected for a product within an order item. |
dimension |
items.{NUM}.product_option.extension_attributes.custom_options.{NUM}.option_value |
items.{NUM}.product_option.extension_attributes.custom_options.{NUM}.option_value |
The selected value for a custom option of a product within an order item. |
metric |
items.{NUM}.product_type |
items.{NUM}.product_type |
The type of product (e.g., simple, configurable, virtual, bundle) that this order item represents. |
dimension |
items.{NUM}.qty_backordered |
items.{NUM}.qty_backordered |
The quantity of the individual item that is currently on backorder. |
metric |
items.{NUM}.qty_canceled |
items.{NUM}.qty_canceled |
The quantity of this order item that has been canceled. |
metric |
items.{NUM}.qty_invoiced |
items.{NUM}.qty_invoiced |
The quantity of this order item that has been invoiced. |
metric |
items.{NUM}.qty_ordered |
items.{NUM}.qty_ordered |
The original quantity of this product ordered as part of the order item. |
metric |
items.{NUM}.qty_refunded |
items.{NUM}.qty_refunded |
The quantity of this order item that has been refunded. |
metric |
items.{NUM}.qty_shipped |
items.{NUM}.qty_shipped |
The quantity of this order item that has been shipped. |
metric |
items.{NUM}.quote_item_id |
items.{NUM}.quote_item_id |
The unique identifier for the original quote item from which this order item was created. |
dimension |
items.{NUM}.row_invoiced |
items.{NUM}.row_invoiced |
The total amount of the row (quantity * price) for this order item that has been invoiced, in the display currency. |
metric |
items.{NUM}.row_total |
items.{NUM}.row_total |
The total amount of the row (quantity * price) for this order item, in the display currency, before taxes and discounts. |
metric |
items.{NUM}.row_total_incl_tax |
items.{NUM}.row_total_incl_tax |
The total amount of the row (quantity * price) for this order item, including taxes, in the display currency. |
metric |
items.{NUM}.row_weight |
items.{NUM}.row_weight |
The total weight of this order item, calculated as unit weight multiplied by the ordered quantity. |
metric |
items.{NUM}.sku |
items.{NUM}.sku |
The Stock Keeping Unit (SKU) of the product associated with this order item. |
dimension |
items.{NUM}.store_id |
items.{NUM}.store_id |
The unique identifier of the store from which this order item was purchased. |
dimension |
items.{NUM}.tax_amount |
items.{NUM}.tax_amount |
The amount of tax applied to this order item, in the display currency. |
metric |
items.{NUM}.tax_invoiced |
items.{NUM}.tax_invoiced |
The amount of tax for this order item that has been invoiced, in the display currency. |
metric |
items.{NUM}.tax_percent |
items.{NUM}.tax_percent |
The tax rate applied to this order item, expressed as a percentage. |
metric |
items.{NUM}.updated_at |
items.{NUM}.updated_at |
The date and time when this specific order item was last updated. |
dimension |
items.{NUM}.weee_tax_applied |
items.{NUM}.weee_tax_applied |
Details of any WEEE (Waste Electrical and Electronic Equipment) tax applied to this order item. |
dimension |
lastname |
lastname |
The last name of the customer. |
dimension |
name |
name |
The name of the product associated with the order item. |
dimension |
no_discount |
no_discount |
Indicates if no discount was applied to the item. |
metric |
order_currency_code |
order_currency_code |
The currency code used for the order. |
dimension |
order_id |
order_id |
The identifier of the order to which this item belongs. |
dimension |
original_increment_id |
original_increment_id |
The customer-facing identifier for the original order or entity. |
dimension |
original_price |
original_price |
The original price of the item in the transaction currency. |
metric |
parent_item.amount_refunded |
parent_item.amount_refunded |
The total amount refunded for the parent item in the transaction currency. |
metric |
parent_item.applied_rule_ids |
parent_item.applied_rule_ids |
A comma-separated list of rule IDs applied to the parent item. |
dimension |
parent_item.base_amount_refunded |
parent_item.base_amount_refunded |
The total amount refunded for the parent item in the store’s base currency. |
metric |
parent_item.base_discount_amount |
parent_item.base_discount_amount |
The base discount amount applied to the parent item in the store’s base currency. |
metric |
parent_item.base_discount_invoiced |
parent_item.base_discount_invoiced |
The base discount amount invoiced for the parent item in the store’s base currency. |
metric |
parent_item.base_discount_refunded |
parent_item.base_discount_refunded |
The base discount amount refunded for the parent item in the store’s base currency. |
metric |
parent_item.base_discount_tax_compensation_amount |
parent_item.base_discount_tax_compensation_amount |
The base currency amount of tax compensation applied due to discount for a parent item. |
metric |
parent_item.base_discount_tax_compensation_invoiced |
parent_item.base_discount_tax_compensation_invoiced |
The invoiced base currency amount of tax compensation for a parent item’s discount. |
metric |
parent_item.base_discount_tax_compensation_refunded |
parent_item.base_discount_tax_compensation_refunded |
The amount of tax compensation for a discount that has been refunded for the parent item of a product (e.g., for a configurable product), in the base currency. |
metric |
parent_item.base_original_price |
parent_item.base_original_price |
The original price of the parent item in the store’s base currency. |
metric |
parent_item.base_price |
parent_item.base_price |
The unit price of the parent item in the store’s base currency. |
metric |
parent_item.base_price_incl_tax |
parent_item.base_price_incl_tax |
The unit price of the parent item, including tax, in the store’s base currency. |
metric |
parent_item.base_row_invoiced |
parent_item.base_row_invoiced |
The total row amount invoiced for the parent item in the store’s base currency. |
metric |
parent_item.base_row_total |
parent_item.base_row_total |
The total row amount for the parent item in the store’s base currency. |
metric |
parent_item.base_row_total_incl_tax |
parent_item.base_row_total_incl_tax |
The total row amount for the parent item, including tax, in the store’s base currency. |
metric |
parent_item.base_tax_amount |
parent_item.base_tax_amount |
The base tax amount applied to the parent item in the store’s base currency. |
metric |
parent_item.base_tax_invoiced |
parent_item.base_tax_invoiced |
The base tax amount invoiced for the parent item in the store’s base currency. |
metric |
parent_item.base_tax_refunded |
parent_item.base_tax_refunded |
The base tax amount refunded for the parent item in the store’s base currency. |
metric |
parent_item.created_at |
parent_item.created_at |
The timestamp when the parent item was created. |
dimension |
parent_item.discount_amount |
parent_item.discount_amount |
The discount amount applied to the parent item in the transaction currency. |
metric |
parent_item.discount_invoiced |
parent_item.discount_invoiced |
The discount amount invoiced for the parent item in the transaction currency. |
metric |
parent_item.discount_percent |
parent_item.discount_percent |
The percentage of discount applied to the parent item. |
metric |
parent_item.discount_refunded |
parent_item.discount_refunded |
The discount amount refunded for the parent item in the transaction currency. |
metric |
parent_item.discount_tax_compensation_amount |
parent_item.discount_tax_compensation_amount |
The tax compensation amount for the discount applied to the parent order item. |
metric |
parent_item.discount_tax_compensation_canceled |
parent_item.discount_tax_compensation_canceled |
The amount of tax compensation for a discount that has been canceled for the parent item of a product. |
metric |
parent_item.discount_tax_compensation_invoiced |
parent_item.discount_tax_compensation_invoiced |
The invoiced amount of tax compensation for a parent item’s discount. |
metric |
parent_item.discount_tax_compensation_refunded |
parent_item.discount_tax_compensation_refunded |
The amount of tax compensation for a discount that has been refunded for the parent item of a product. |
metric |
parent_item.free_shipping |
parent_item.free_shipping |
Indicates if free shipping was applied to the parent item. |
metric |
parent_item.is_qty_decimal |
parent_item.is_qty_decimal |
Indicates if the quantity of the parent item can be a decimal value. |
metric |
parent_item.is_virtual |
parent_item.is_virtual |
Indicates if the parent item is a virtual product. |
metric |
parent_item.item_id |
parent_item.item_id |
The unique identifier for the parent order item. |
dimension |
parent_item.name |
parent_item.name |
The name of the product associated with the parent order item. |
dimension |
parent_item.no_discount |
parent_item.no_discount |
Indicates if no discount was applied to the parent item. |
metric |
parent_item.order_id |
parent_item.order_id |
The identifier of the order to which the parent item belongs. |
dimension |
parent_item.original_price |
parent_item.original_price |
The original price of the parent item in the transaction currency. |
metric |
parent_item.price |
parent_item.price |
The unit price of the parent item in the transaction currency. |
metric |
parent_item.price_incl_tax |
parent_item.price_incl_tax |
The unit price of the parent item, including tax, in the transaction currency. |
metric |
parent_item.product_id |
parent_item.product_id |
The unique identifier for the product associated with the parent order item. |
dimension |
parent_item.product_option.extension_attributes.configurable_item_options.{NUM}.option_id |
parent_item.product_option.extension_attributes.configurable_item_options.{NUM}.option_id |
The ID of a configurable option selected for the parent product. |
dimension |
parent_item.product_option.extension_attributes.configurable_item_options.{NUM}.option_value |
parent_item.product_option.extension_attributes.configurable_item_options.{NUM}.option_value |
The value of a configurable option selected for the parent product. |
metric |
parent_item.product_type |
parent_item.product_type |
The type of product for the parent item (e.g., ‘simple’, ‘configurable’, ‘bundle’). |
dimension |
parent_item.qty_canceled |
parent_item.qty_canceled |
The quantity of the parent item that has been canceled. |
metric |
parent_item.qty_invoiced |
parent_item.qty_invoiced |
The quantity of the parent item that has been invoiced. |
metric |
parent_item.qty_ordered |
parent_item.qty_ordered |
The quantity of the parent item originally ordered. |
metric |
parent_item.qty_refunded |
parent_item.qty_refunded |
The quantity of the parent item that has been refunded. |
metric |
parent_item.qty_returned |
parent_item.qty_returned |
The quantity of the parent item that has been returned in an order. |
metric |
parent_item.qty_shipped |
parent_item.qty_shipped |
The quantity of the parent item that has been shipped. |
metric |
parent_item.quote_item_id |
parent_item.quote_item_id |
The identifier of the quote item from which the parent order item originated. |
dimension |
parent_item.row_invoiced |
parent_item.row_invoiced |
The total row amount invoiced for the parent item in the transaction currency. |
metric |
parent_item.row_total |
parent_item.row_total |
The total row amount for the parent item in the transaction currency. |
metric |
parent_item.row_total_incl_tax |
parent_item.row_total_incl_tax |
The total row amount for the parent item, including tax, in the transaction currency. |
metric |
parent_item.row_weight |
parent_item.row_weight |
The total weight of the parent item row. |
metric |
parent_item.sku |
parent_item.sku |
The Stock Keeping Unit (SKU) of the parent product. |
dimension |
parent_item.store_id |
parent_item.store_id |
The ID of the store where the parent item was ordered. |
dimension |
parent_item.tax_amount |
parent_item.tax_amount |
The tax amount applied to the parent item in the transaction currency. |
metric |
parent_item.tax_canceled |
parent_item.tax_canceled |
The canceled tax amount for a parent item. |
metric |
parent_item.tax_invoiced |
parent_item.tax_invoiced |
The tax amount invoiced for the parent item in the transaction currency. |
metric |
parent_item.tax_percent |
parent_item.tax_percent |
The tax percentage applied to the parent item. |
metric |
parent_item.tax_refunded |
parent_item.tax_refunded |
The tax amount refunded for the parent item in the transaction currency. |
metric |
parent_item.updated_at |
parent_item.updated_at |
The timestamp when the parent item was last updated. |
dimension |
parent_item.weee_tax_applied |
parent_item.weee_tax_applied |
Indicates if Waste Electrical and Electronic Equipment (WEEE) tax was applied to the parent item. |
dimension |
parent_item.weight |
parent_item.weight |
The weight of the parent item. |
metric |
parent_item_id |
parent_item_id |
The unique identifier for the parent order item. |
dimension |
payment.account_status |
payment.account_status |
The status of the payment account used for the order (e.g., ‘verified’). |
dimension |
payment.additional_information.{NUM} |
payment.additional_information.{NUM} |
Additional information related to the payment method, which can vary by payment gateway. |
dimension |
payment.amount_ordered |
payment.amount_ordered |
The total amount of the order in the order currency. |
metric |
payment.amount_paid |
payment.amount_paid |
The amount that has been paid for the order in the order currency. |
metric |
payment.base_amount_ordered |
payment.base_amount_ordered |
The total amount of the order in the store’s base currency. |
metric |
payment.base_amount_paid |
payment.base_amount_paid |
The amount that has been paid for the order in the store’s base currency. |
metric |
payment.base_shipping_amount |
payment.base_shipping_amount |
The base shipping amount for the order in the store’s base currency. |
metric |
payment.base_shipping_captured |
payment.base_shipping_captured |
The base shipping amount that has been captured for the order in the store’s base currency. |
metric |
payment.cc_exp_year |
payment.cc_exp_year |
The expiration year of the credit card used for payment (if applicable and available). |
metric |
payment.cc_last4 |
payment.cc_last4 |
The last four digits of the credit card number used for payment (if applicable and available). |
dimension |
payment.cc_ss_start_year |
payment.cc_ss_start_year |
The starting year of the credit card’s validity period. This field is part of the payment information and is used for validating the credit card’s issue date, often for specific credit card types or payment processing requirements. |
metric |
payment.entity_id |
payment.entity_id |
The unique identifier for the payment record. |
dimension |
payment.method |
payment.method |
The payment method used for the order (e.g., ‘checkmo’, ‘paypal_express’). |
dimension |
payment.parent_id |
payment.parent_id |
The ID of the order entity associated with this payment record. |
dimension |
payment.shipping_amount |
payment.shipping_amount |
The shipping amount for the order in the order currency. |
metric |
payment.shipping_captured |
payment.shipping_captured |
The shipping amount that has been captured for the order in the order currency. |
metric |
price |
price |
The unit price of the item in the transaction currency. |
metric |
price_incl_tax |
price_incl_tax |
The unit price of the item, including tax, in the transaction currency. |
metric |
product_id |
product_id |
The unique identifier for the product associated with the order item. |
dimension |
product_option.extension_attributes.configurable_item_options.{NUM}.option_id |
product_option.extension_attributes.configurable_item_options.{NUM}.option_id |
The ID of a configurable option selected for the product. |
dimension |
product_option.extension_attributes.configurable_item_options.{NUM}.option_value |
product_option.extension_attributes.configurable_item_options.{NUM}.option_value |
The value of a configurable option selected for the product. |
metric |
product_option.extension_attributes.custom_options.{NUM}.option_id |
product_option.extension_attributes.custom_options.{NUM}.option_id |
The ID of a custom option selected for the product. |
dimension |
product_option.extension_attributes.custom_options.{NUM}.option_value |
product_option.extension_attributes.custom_options.{NUM}.option_value |
The value of a custom option selected for the product. |
metric |
product_type |
product_type |
The type of product (e.g., ‘simple’, ‘configurable’, ‘bundle’). |
dimension |
qty_canceled |
qty_canceled |
The quantity of the item that has been canceled. |
metric |
qty_invoiced |
qty_invoiced |
The quantity of the item that has been invoiced. |
metric |
qty_ordered |
qty_ordered |
The quantity of the item originally ordered. |
metric |
qty_refunded |
qty_refunded |
The quantity of the item that has been refunded. |
metric |
qty_returned |
qty_returned |
The quantity of the item that has been returned in an order. |
metric |
qty_shipped |
qty_shipped |
The quantity of the item that has been shipped. |
metric |
quote_id |
quote_id |
The ID of the quote (shopping cart) from which this order was created. |
dimension |
quote_item_id |
quote_item_id |
The identifier of the quote item from which this order item originated. |
dimension |
row_invoiced |
row_invoiced |
The total row amount that has been invoiced for the item in the transaction currency. |
metric |
row_total |
row_total |
The total row amount for the item in the transaction currency. |
metric |
row_total_incl_tax |
row_total_incl_tax |
The total row amount for the item, including tax, in the transaction currency. |
metric |
row_weight |
row_weight |
The total weight of the item row. |
metric |
shipping_amount |
shipping_amount |
The shipping amount for the order in the order currency. |
metric |
shipping_description |
shipping_description |
A description of the shipping method used for the order (e.g., ‘Flat Rate - Fixed’). |
dimension |
shipping_discount_amount |
shipping_discount_amount |
The discount amount applied to shipping for the order. |
metric |
shipping_discount_tax_compensation_amount |
shipping_discount_tax_compensation_amount |
The amount of tax compensation for shipping discounts applied to the order. |
metric |
shipping_incl_tax |
shipping_incl_tax |
The shipping amount for the order, including tax, in the order currency. |
metric |
shipping_invoiced |
shipping_invoiced |
The shipping amount that has been invoiced for the order. |
metric |
shipping_tax_amount |
shipping_tax_amount |
The tax amount applied to shipping for the order. |
metric |
sku |
sku |
The Stock Keeping Unit (SKU) of the product. |
dimension |
state |
state |
The current state of the order (e.g., ‘new’, ‘pending_payment’, ‘processing’, ‘complete’). |
dimension |
status |
status |
The current status of the order (e.g., ‘pending’, ‘processing’, ‘complete’, ‘closed’). |
dimension |
status_histories.{NUM}.comment |
status_histories.{NUM}.comment |
A comment associated with a specific status update in the order history. |
dimension |
status_histories.{NUM}.created_at |
status_histories.{NUM}.created_at |
The date and time when this status history entry was created. |
dimension |
status_histories.{NUM}.entity_id |
status_histories.{NUM}.entity_id |
The ID of the status history entry. |
dimension |
status_histories.{NUM}.entity_name |
status_histories.{NUM}.entity_name |
The type of entity this status history entry belongs to (e.g., ‘order’). |
dimension |
status_histories.{NUM}.is_customer_notified |
status_histories.{NUM}.is_customer_notified |
Indicates whether the customer was notified about this status update (0 for no, 1 for yes). |
metric |
status_histories.{NUM}.is_visible_on_front |
status_histories.{NUM}.is_visible_on_front |
Indicates whether this status update is visible on the storefront to the customer (0 for no, 1 for yes). |
metric |
status_histories.{NUM}.parent_id |
status_histories.{NUM}.parent_id |
The ID of the parent entity (e.g., the order ID) for this status history entry. |
dimension |
status_histories.{NUM}.status |
status_histories.{NUM}.status |
The status associated with this history entry. |
dimension |
store_currency_code |
store_currency_code |
The default currency code of the store. |
dimension |
store_id |
store_id |
The ID of the store where the order was placed. |
dimension |
store_name |
store_name |
The name of the store where the order was placed. |
dimension |
store_to_base_rate |
store_to_base_rate |
The currency conversion rate from the store’s display currency to its base currency. |
metric |
store_to_order_rate |
store_to_order_rate |
The currency conversion rate from the store’s display currency to the order’s currency. |
metric |
subtotal |
subtotal |
The subtotal of the order before shipping and tax, in the order currency. |
metric |
subtotal_incl_tax |
subtotal_incl_tax |
The subtotal of the order, including tax, before shipping, in the order currency. |
metric |
subtotal_invoiced |
subtotal_invoiced |
The subtotal amount that has been invoiced for the order. |
metric |
tax_amount |
tax_amount |
The amount of tax applied to an item or the entire order/invoice. |
metric |
tax_canceled |
tax_canceled |
The amount of tax that was canceled for the order or an item. |
metric |
tax_invoiced |
tax_invoiced |
The amount of tax that has been invoiced for the order or an item. |
metric |
tax_percent |
tax_percent |
The tax percentage applied to the item. |
metric |
tax_refunded |
tax_refunded |
The tax amount refunded for an item in the transaction currency. |
metric |
total_due |
total_due |
The remaining amount due for the order. |
metric |
total_invoiced |
total_invoiced |
The total monetary amount of the order that has been invoiced. |
metric |
total_item_count |
total_item_count |
The total count of unique items in the order. |
metric |
total_paid |
total_paid |
The total monetary amount that has been paid by the customer for the order. |
metric |
total_qty_ordered |
total_qty_ordered |
The total quantity of all products ordered. |
metric |
updated_at |
updated_at |
The date and time when the entity (e.g., customer, order, product) was last updated. |
dimension |
website_id |
website_id |
The ID of the website where the entity (e.g., customer, order) was created or belongs. |
dimension |
weee_tax_applied |
weee_tax_applied |
Indicates if Waste Electrical and Electronic Equipment (WEEE) tax was applied to the item. |
dimension |
weight |
weight |
The weight of the item or product. |
metric |