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.
billing_address_1 Dimension
The first line of the billing address.
billing_address_2 Dimension
This field represents the second line of the customer's billing address, often used for apartment numbers, suites, or other secondary address details.
billing_city Dimension
The city of the billing address.
billing_company Dimension
The company name associated with the billing address.
billing_country Dimension
The country code (ISO 3166-1 alpha-2 format) of the billing address.
billing_email Dimension
The email address associated with the billing details.
billing_first_name Dimension
The first name of the billing contact.
billing_last_name Dimension
The last name of the billing contact.
billing_phone Dimension
The phone number for the customer's billing contact.
billing_postcode Dimension
The postal code of the billing address.
billing_state Dimension
The ISO code or name of the state, province, or district for the billing address.
cart_tax Metric
The sum of taxes for all line items in the cart.
coupon_lines_code Dimension
The code of the applied coupon.
coupon_lines_discount Metric
The total discount amount provided by the coupon line.
coupon_lines_discount_tax Metric
The total tax amount on the discount provided by the coupon line.
coupon_lines_discount_type Dimension
The type of discount applied by the coupon (e.g., 'fixed_cart', 'percent', 'fixed_product', 'recurring_percent').
coupon_lines_free_shipping Dimension
Indicates if the coupon provides free shipping for the order.
coupon_lines_id Metric
The unique identifier for the coupon line item.
coupon_lines_meta_data Dimension
Additional meta data associated with the coupon line.
coupon_lines_nominal_amount Metric
The total discount amount applied by a coupon line.
created_via Dimension
Indicates how the order or subscription was created (e.g., 'checkout', 'rest-api').
currency Dimension
The currency code (ISO format) in which the order or subscription was created (e.g., USD).
customer_id Dimension
The unique identifier for the customer who owns the order or subscription.
customer_ip_address Dimension
The IP address of the customer when the order or subscription was placed.
customer_note Dimension
Any note left by the customer during the checkout process.
customer_user_agent Dimension
The user agent string of the customer's browser or device.
customers Metric
Refers to data related to customer profiles, including details like name, address, and contact information.
date Dimension
This field represents a specific date or a date range used to filter sales reports, orders, or subscriptions from the WooCommerce store. It can be used to define the start or end of a period for data retrieval.
date_completed Dimension
The date and time when the order or subscription was marked as completed, in the site's timezone.
date_completed_gmt Dimension
The date and time when the subscription was marked as completed, in GMT.
date_created Dimension
The date and time (in the site's timezone) when the order or subscription was created.
date_created_gmt Dimension
The date and time (in GMT) when the order or subscription was created.
date_modified Dimension
The date and time (in the site's timezone) when the order or subscription was last modified.
date_modified_gmt Dimension
The date and time (in GMT) when the order or subscription was last modified.
date_paid Dimension
The date and time when the order or subscription was marked as paid, in the site's timezone.
discount Metric
The monetary value of discounts applied to an order or line item, returned as a string with two decimal places.
discount_tax Metric
The total tax amount associated with discounts applied to the order or subscription.
discount_total Metric
The total discount amount applied to the order or subscription.
domain_name Dimension
This field specifies the domain name of the WooCommerce store from which data is collected. For example, 'yourstore.com'.
id Metric
The unique identifier for the resource (e.g., subscription, order, line item).
items Metric
General category for product items included in an order or subscription. Detailed information is found under 'line_items'.
line_items_id Metric
The unique identifier for the line item within an order or subscription.
line_items_image_id Metric
The unique identifier for the image associated with a specific line item in an order or subscription.
line_items_image_src Dimension
The URL source for the image associated with a specific line item in an order or subscription.
line_items_meta_data Dimension
Additional meta data associated with the line item, often including custom product attributes.
line_items_name Dimension
The name of the product in the line item.
line_items_price Metric
The price of the product in the line item.
line_items_product_id Metric
The unique identifier of the product in the line item.
line_items_quantity Metric
The quantity of the product ordered in the line item.
line_items_sku Dimension
The Stock Keeping Unit (SKU) of the product in the line item.
line_items_subtotal Metric
The subtotal amount for the line item before discounts.
line_items_subtotal_tax Metric
The tax amount for the line item subtotal before discounts.
line_items_tax_class Dimension
The tax class slug applied to the product in the line item.
line_items_taxes Dimension
An array of tax details applied to the line item, including ID, total, and subtotal.
line_items_total Metric
The total amount for the line item after discounts.
line_items_total_tax Metric
The total tax amount for the line item after discounts.
line_items_variation_id Metric
The ID of the product variation, if applicable, for the line item.
meta_data Dimension
An array of key-value pairs for additional custom meta data associated with the resource.
number Metric
The human-readable number assigned to the subscription or order.
order_key Dimension
A unique key for the order or subscription, used for security and verification.
orders Metric
Represents individual customer purchase records, including details about products, pricing, and customer information.
parent_id Dimension
The ID of the parent/initial order for a subscription, or the parent order ID for a renewal order.
payment_method Dimension
The ID of the payment method used for the order or subscription.
payment_method_title Dimension
The human-readable title of the payment method used.
prices_include_tax Dimension
A boolean indicating whether prices displayed during checkout included tax.
refunds Metric
Represents records of refunded amounts associated with orders, including details such as the refund amount, the reason for the refund, the date it was created, and the specific line items that were refunded.
sales Metric
Refers to aggregated sales report data, including total sales, net sales, and other sales-related metrics.
shipping Metric
The monetary cost of shipping for an order or subscription, returned as a string with two decimal places.
shipping_address_1 Dimension
The first line of the shipping address.
shipping_address_2 Dimension
The second line of the shipping address.
shipping_city Dimension
The city of the shipping address.
shipping_company Dimension
The company name associated with the shipping address.
shipping_country Dimension
The country code (ISO 3166-1 alpha-2 format) of the shipping address.
shipping_first_name Dimension
The first name of the shipping contact.
shipping_last_name Dimension
The last name of the shipping contact.
shipping_phone Dimension
The phone number associated with the customer's shipping address.
shipping_postcode Dimension
The postal code of the shipping address.
shipping_state Dimension
The ISO code or name of the state, province, or district for the shipping address.
shipping_tax Metric
The total tax amount associated with shipping for the order or subscription.
shipping_total Metric
The total shipping amount for the order or subscription.
status Dimension
The current status of the order or subscription (e.g., 'pending', 'active', 'completed').
tax Metric
The monetary amount of tax applied to an order, subscription, or individual line item, returned as a string with two decimal places.
total Metric
The grand total amount for the order or subscription, including taxes and shipping.
total_tax Metric
The sum of all taxes applied to the order or subscription.
transaction_id Dimension
The unique transaction ID provided by the payment gateway.
version Dimension
The version of WooCommerce that was active when the order or subscription was created.