WooCommerce: Most-used fields

The table below gives information about most-used fields that you can import from WooCommerce. 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
average_sales	average_sales	The daily average of net sales for the specified period.	metric
billing_address_1	billing_address_1	The first line of the customer’s billing address.	dimension
billing_address_2	billing_address_2	The second line of the customer’s billing address.	dimension
billing_city	billing_city	The city for the customer’s billing address.	dimension
billing_company	billing_company	The company name associated with the customer’s billing address.	dimension
billing_country	billing_country	The country code (ISO 3166-1 alpha-2) for the customer’s billing address.	dimension
billing_email	billing_email	The email address for the customer’s billing contact.	dimension
billing_first_name	billing_first_name	The first name for the customer’s billing contact.	dimension
billing_last_name	billing_last_name	The last name for the customer’s billing contact.	dimension
billing_phone	billing_phone	The phone number for the customer’s billing contact.	metric
billing_postcode	billing_postcode	The postal code for the customer’s billing address.	dimension
billing_state	billing_state	The ISO code or name of the state, province, or district for the customer’s billing address.	dimension
cart_tax	cart_tax	The sum of line item taxes for the order or subscription.	metric
coupon_lines_code	coupon_lines_code	The coupon code applied to the order or subscription.	dimension
coupon_lines_discount	coupon_lines_discount	The total discount amount provided by the coupon line.	metric
coupon_lines_discount_tax	coupon_lines_discount_tax	The total tax amount on the discount provided by the coupon line.	metric
coupon_lines_discount_type	coupon_lines_discount_type	The type of discount applied by the coupon (e.g., ‘fixed_cart’, ‘percent’, ‘fixed_product’, ‘recurring_percent’).	dimension
coupon_lines_free_shipping	coupon_lines_free_shipping	Indicates if the coupon provides free shipping for the order.	dimension
coupon_lines_id	coupon_lines_id	The unique identifier for the coupon line item.	dimension
coupon_lines_meta_data	coupon_lines_meta_data	Additional meta data associated with the coupon line.	dimension
created_via	created_via	Indicates the method or source through which the order or subscription was created (e.g., ‘rest-api’, ‘checkout’).	dimension
currency	currency	The currency in ISO format (e.g., USD) used for the order or subscription.	dimension
customer_id	customer_id	The unique identifier for the customer associated with the order or subscription.	dimension
customer_ip_address	customer_ip_address	The IP address of the customer when the order or subscription was created.	dimension
customer_note	customer_note	Any notes provided by the customer during the checkout process.	dimension
customer_user_agent	customer_user_agent	The user agent string of the customer’s browser or device used for the order or subscription.	dimension
customers	customers	The number of customers associated with the aggregated sales data for a specific period or grouping.	metric
date	date		dimension
date_completed	date_completed	The date and time when the order or subscription was marked as completed, in the site’s timezone.	dimension
date_completed_gmt	date_completed_gmt	The date and time when the subscription was marked as completed, in GMT.	dimension
date_created	date_created	The date and time when the order or subscription was created, in the site’s timezone.	dimension
date_created_gmt	date_created_gmt	The date and time when the subscription was created, in GMT.	dimension
date_max	date_max	The end date for filtering sales reports, in YYYY-MM-DD format.	dimension
date_min	date_min	The start date for filtering sales reports, in YYYY-MM-DD format.	dimension
date_modified	date_modified	The date and time when the order or subscription was last modified, in the site’s timezone.	dimension
date_modified_gmt	date_modified_gmt	The date and time when the subscription was last modified, in GMT.	dimension
date_paid	date_paid	The date and time when the order or subscription was marked as paid, in the site’s timezone.	dimension
discount	discount	The discount amount applied to an item or within a specific period.	metric
discount_tax	discount_tax	The total tax amount on discounts applied to the subscription.	metric
discount_total	discount_total	The total discount amount applied to the entire order or subscription.	metric
domain_name	domain_name		dimension
id	id	The unique identifier for the specific resource (e.g., order, subscription, line item).	dimension
items	items	The count of individual products or services within a group or during a specified period.	metric
line_items_id	line_items_id	The unique identifier for an individual line item in an order or subscription.	dimension
line_items_image_id	line_items_image_id		dimension
line_items_image_src	line_items_image_src		dimension
line_items_meta_data	line_items_meta_data	Additional meta data associated with the individual line item.	dimension
line_items_name	line_items_name	The name of the product in the line item.	dimension
line_items_price	line_items_price	The price of the product in the line item.	metric
line_items_product_id	line_items_product_id	The unique identifier for the product in the line item.	dimension
line_items_quantity	line_items_quantity	The quantity of the product ordered in the line item.	metric
line_items_sku	line_items_sku	The Stock Keeping Unit (SKU) of the product in the line item.	dimension
line_items_subtotal	line_items_subtotal	The subtotal for the line item before any discounts are applied.	metric
line_items_subtotal_tax	line_items_subtotal_tax	The tax amount on the line item subtotal before any discounts are applied.	metric
line_items_tax_class	line_items_tax_class	The tax class applied to the product in the line item.	dimension
line_items_taxes	line_items_taxes	An array of tax details applied to the line item, including ID, total, and subtotal.	dimension
line_items_total	line_items_total	The total amount for the line item after any discounts are applied.	metric
line_items_total_tax	line_items_total_tax	The total tax amount on the line item after any discounts are applied.	metric
line_items_variation_id	line_items_variation_id	The unique identifier for the product variation if the product is a variable product.	dimension
meta_data	meta_data	A list of key-value pairs containing additional information about the resource.	dimension
net_sales	net_sales	The total sales amount after deducting returns and discounts for a specified period.	metric
number	number	The human-readable number assigned to the subscription or order.	metric
order_key	order_key	A unique key assigned to the order or subscription for verification.	dimension
orders	orders	The count of orders within a group or during a specified period.	metric
parent_id	parent_id	The ID of the parent order or initial order for a subscription.	dimension
payment_method	payment_method	The identifier for the payment method used for the order or subscription.	dimension
payment_method_title	payment_method_title	The human-readable title of the payment method used for the order or subscription.	dimension
prices_include_tax	prices_include_tax	Indicates whether product prices included tax at the time of checkout.	dimension
sales	sales	The sales amount for a specific period or grouping within a sales report.	metric
shipping	shipping	An object containing details about the shipping address.	metric
shipping_address_1	shipping_address_1	The first line of the customer’s shipping address.	dimension
shipping_address_2	shipping_address_2	The second line of the customer’s shipping address.	dimension
shipping_city	shipping_city	The city for the customer’s shipping address.	dimension
shipping_company	shipping_company	The company name associated with the customer’s shipping address.	dimension
shipping_country	shipping_country	The country code (ISO 3166-1 alpha-2) for the customer’s shipping address.	dimension
shipping_first_name	shipping_first_name	The first name for the customer’s shipping contact.	dimension
shipping_last_name	shipping_last_name	The last name for the customer’s shipping contact.	dimension
shipping_phone	shipping_phone		dimension
shipping_postcode	shipping_postcode	The postal code for the customer’s shipping address.	dimension
shipping_state	shipping_state	The ISO code or name of the state, province, or district for the customer’s shipping address.	dimension
shipping_tax	shipping_tax	The total tax amount applied to the shipping cost for the order or subscription.	metric
shipping_total	shipping_total	The total cost of shipping for the order, subscription, or a specified sales period.	metric
status	status	The current status of the order or subscription (e.g., ‘pending’, ‘active’, ‘completed’).	dimension
tax	tax	The tax amount for a specific item or within a grouping in a sales report.	metric
total	total	The grand total amount for the order, subscription, or gross sales for a specified period.	metric
total_customers	total_customers	The total number of unique customers during a specified sales report period.	metric
total_discount	total_discount	The total value of all discounts applied across a sales period.	metric
total_items	total_items	The total number of individual items sold within a specified sales period.	metric
total_orders	total_orders	The total count of all orders placed within a specified sales period.	metric
total_refunds	total_refunds	The total monetary sum of all refunds processed within a specified sales period.	metric
total_sales	total_sales	The gross sales amount within a specified sales period.	metric
total_shipping	total_shipping	The total shipping fees accrued within a specified sales period.	metric
total_tax	total_tax	The cumulative sum of all taxes charged for the order, subscription, or within a specified sales period.	metric
transaction_id	transaction_id	A unique identifier for the payment transaction.	dimension
version	version	The version of WooCommerce that was active when the order or subscription was created.	dimension