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
billing_address_1	billing_address_1	The first line of the billing address.	dimension
billing_address_2	billing_address_2	This field represents the second line of the customer’s billing address, often used for apartment numbers, suites, or other secondary address details.	dimension
billing_city	billing_city	The city of the billing address.	dimension
billing_company	billing_company	The company name associated with the billing address.	dimension
billing_country	billing_country	The country code (ISO 3166-1 alpha-2 format) of the billing address.	dimension
billing_email	billing_email	The email address associated with the billing details.	dimension
billing_first_name	billing_first_name	The first name of the billing contact.	dimension
billing_last_name	billing_last_name	The last name of the billing contact.	dimension
billing_phone	billing_phone	The phone number for the customer’s billing contact.	dimension
billing_postcode	billing_postcode	The postal code of the billing address.	dimension
billing_state	billing_state	The ISO code or name of the state, province, or district for the billing address.	dimension
cart_tax	cart_tax	The sum of taxes for all line items in the cart.	metric
coupon_lines_code	coupon_lines_code	The code of the applied coupon.	dimension
coupon_lines_discount	coupon_lines_discount	The total discount amount provided by the coupon line.	dimension
coupon_lines_discount_tax	coupon_lines_discount_tax	The total tax amount on the discount provided by the coupon line.	dimension
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
coupon_lines_nominal_amount	coupon_lines_nominal_amount	The total discount amount applied by a coupon line.	metric
created_via	created_via	Indicates how the order or subscription was created (e.g., ‘checkout’, ‘rest-api’).	dimension
currency	currency	The currency code (ISO format) in which the order or subscription was created (e.g., USD).	dimension
customer_id	customer_id	The unique identifier for the customer who owns the order or subscription.	dimension
customer_ip_address	customer_ip_address	The IP address of the customer when the order or subscription was placed.	dimension
customer_note	customer_note	Any note left 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.	dimension
customers	customers	Refers to data related to customer profiles, including details like name, address, and contact information.	metric
date	date	The date associated with an order, report, or other event, typically returned in RFC3339 format (YYYY-MM-DDTHH:MM:SSZ) and UTC timezone.	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 (in the site’s timezone) when the order or subscription was created.	dimension
date_created_gmt	date_created_gmt	The date and time (in GMT) when the order or subscription was created.	dimension
date_modified	date_modified	The date and time (in the site’s timezone) when the order or subscription was last modified.	dimension
date_modified_gmt	date_modified_gmt	The date and time (in GMT) when the order or subscription was last modified.	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 monetary value of discounts applied to an order or line item, returned as a string with two decimal places.	metric
discount_tax	discount_tax	The total tax amount associated with discounts applied to the order or subscription.	metric
discount_total	discount_total	The total discount amount applied to the order or subscription.	metric
domain_name	domain_name		dimension
id	id	The unique identifier for the resource (e.g., subscription, order, line item).	metric
items	items	General category for product items included in an order or subscription. Detailed information is found under ‘line_items’.	metric
line_items_id	line_items_id	The unique identifier for the line item within an order or subscription.	dimension
line_items_image_id	line_items_image_id	The unique identifier for the image associated with a specific line item in an order or subscription.	dimension
line_items_image_src	line_items_image_src	The URL source for the image associated with a specific line item in an order or subscription.	dimension
line_items_meta_data	line_items_meta_data	Additional meta data associated with the line item, often including custom product attributes.	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 of 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 amount for the line item before discounts.	metric
line_items_subtotal_tax	line_items_subtotal_tax	The tax amount for the line item subtotal before discounts.	metric
line_items_tax_class	line_items_tax_class	The tax class slug 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 discounts.	metric
line_items_total_tax	line_items_total_tax	The total tax amount for the line item after discounts.	metric
line_items_variation_id	line_items_variation_id	The ID of the product variation, if applicable, for the line item.	dimension
meta_data	meta_data	An array of key-value pairs for additional custom meta data associated with the resource.	dimension
number	number	The human-readable number assigned to the subscription or order.	metric
order_key	order_key	A unique key for the order or subscription, used for security and verification.	dimension
orders	orders	Represents individual customer purchase records, including details about products, pricing, and customer information.	metric
parent_id	parent_id	The ID of the parent/initial order for a subscription, or the parent order ID for a renewal order.	dimension
payment_method	payment_method	The ID of 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.	dimension
prices_include_tax	prices_include_tax	A boolean indicating whether prices displayed during checkout included tax.	dimension
sales	sales	Refers to aggregated sales report data, including total sales, net sales, and other sales-related metrics.	metric
shipping	shipping	The monetary cost of shipping for an order or subscription, returned as a string with two decimal places.	metric
shipping_address_1	shipping_address_1	The first line of the shipping address.	dimension
shipping_address_2	shipping_address_2	The second line of the shipping address.	dimension
shipping_city	shipping_city	The city of the shipping address.	dimension
shipping_company	shipping_company	The company name associated with the shipping address.	dimension
shipping_country	shipping_country	The country code (ISO 3166-1 alpha-2 format) of the shipping address.	dimension
shipping_first_name	shipping_first_name	The first name of the shipping contact.	dimension
shipping_last_name	shipping_last_name	The last name of the shipping contact.	dimension
shipping_phone	shipping_phone	The phone number associated with the customer’s shipping address.	dimension
shipping_postcode	shipping_postcode	The postal code of the shipping address.	dimension
shipping_state	shipping_state	The ISO code or name of the state, province, or district for the shipping address.	dimension
shipping_tax	shipping_tax	The total tax amount associated with shipping for the order or subscription.	metric
shipping_total	shipping_total	The total shipping amount for the order or subscription.	metric
status	status	The current status of the order or subscription (e.g., ‘pending’, ‘active’, ‘completed’).	dimension
tax	tax	The monetary amount of tax applied to an order, subscription, or individual line item, returned as a string with two decimal places.	metric
total	total	The grand total amount for the order or subscription, including taxes and shipping.	metric
total_tax	total_tax	The sum of all taxes applied to the order or subscription.	metric
transaction_id	transaction_id	The unique transaction ID provided by the payment gateway.	dimension
version	version	The version of WooCommerce that was active when the order or subscription was created.	dimension