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_1Dimension
The first line of the billing address.
billing_address_2Dimension
This field represents the second line of the customer's billing address, often used for apartment numbers, suites, or other secondary address details.
billing_cityDimension
The city of the billing address.
billing_companyDimension
The company name associated with the billing address.
billing_countryDimension
The country code (ISO 3166-1 alpha-2 format) of the billing address.
billing_emailDimension
The email address associated with the billing details.
billing_first_nameDimension
The first name of the billing contact.
billing_last_nameDimension
The last name of the billing contact.
billing_phoneDimension
The phone number for the customer's billing contact.
billing_postcodeDimension
The postal code of the billing address.
billing_stateDimension
The ISO code or name of the state, province, or district for the billing address.
cart_taxMetric
The sum of taxes for all line items in the cart.
coupon_lines_codeDimension
The code of the applied coupon.
coupon_lines_discountMetric
The total discount amount provided by the coupon line.
coupon_lines_discount_taxMetric
The total tax amount on the discount provided by the coupon line.
coupon_lines_discount_typeDimension
The type of discount applied by the coupon (e.g., 'fixed_cart', 'percent', 'fixed_product', 'recurring_percent').
coupon_lines_free_shippingDimension
Indicates if the coupon provides free shipping for the order.
coupon_lines_idMetric
The unique identifier for the coupon line item.
coupon_lines_meta_dataDimension
Additional meta data associated with the coupon line.
coupon_lines_nominal_amountMetric
The total discount amount applied by a coupon line.
created_viaDimension
Indicates how the order or subscription was created (e.g., 'checkout', 'rest-api').
currencyDimension
The currency code (ISO format) in which the order or subscription was created (e.g., USD).
customer_idDimension
The unique identifier for the customer who owns the order or subscription.
customer_ip_addressDimension
The IP address of the customer when the order or subscription was placed.
customer_noteDimension
Any note left by the customer during the checkout process.
customer_user_agentDimension
The user agent string of the customer's browser or device.
customersMetric
Refers to data related to customer profiles, including details like name, address, and contact information.
dateDimension
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_completedDimension
The date and time when the order or subscription was marked as completed, in the site's timezone.
date_completed_gmtDimension
The date and time when the subscription was marked as completed, in GMT.
date_createdDimension
The date and time (in the site's timezone) when the order or subscription was created.
date_created_gmtDimension
The date and time (in GMT) when the order or subscription was created.
date_modifiedDimension
The date and time (in the site's timezone) when the order or subscription was last modified.
date_modified_gmtDimension
The date and time (in GMT) when the order or subscription was last modified.
date_paidDimension
The date and time when the order or subscription was marked as paid, in the site's timezone.
discountMetric
The monetary value of discounts applied to an order or line item, returned as a string with two decimal places.
discount_taxMetric
The total tax amount associated with discounts applied to the order or subscription.
discount_totalMetric
The total discount amount applied to the order or subscription.
domain_nameDimension
This field specifies the domain name of the WooCommerce store from which data is collected. For example, 'yourstore.com'.
idMetric
The unique identifier for the resource (e.g., subscription, order, line item).
itemsMetric
General category for product items included in an order or subscription. Detailed information is found under 'line_items'.
line_items_idMetric
The unique identifier for the line item within an order or subscription.
line_items_image_idMetric
The unique identifier for the image associated with a specific line item in an order or subscription.
line_items_image_srcDimension
The URL source for the image associated with a specific line item in an order or subscription.
line_items_meta_dataDimension
Additional meta data associated with the line item, often including custom product attributes.
line_items_nameDimension
The name of the product in the line item.
line_items_priceMetric
The price of the product in the line item.
line_items_product_idMetric
The unique identifier of the product in the line item.
line_items_quantityMetric
The quantity of the product ordered in the line item.
line_items_skuDimension
The Stock Keeping Unit (SKU) of the product in the line item.
line_items_subtotalMetric
The subtotal amount for the line item before discounts.
line_items_subtotal_taxMetric
The tax amount for the line item subtotal before discounts.
line_items_tax_classDimension
The tax class slug applied to the product in the line item.
line_items_taxesDimension
An array of tax details applied to the line item, including ID, total, and subtotal.
line_items_totalMetric
The total amount for the line item after discounts.
line_items_total_taxMetric
The total tax amount for the line item after discounts.
line_items_variation_idMetric
The ID of the product variation, if applicable, for the line item.
meta_dataDimension
An array of key-value pairs for additional custom meta data associated with the resource.
numberMetric
The human-readable number assigned to the subscription or order.
order_keyDimension
A unique key for the order or subscription, used for security and verification.
ordersMetric
Represents individual customer purchase records, including details about products, pricing, and customer information.
parent_idDimension
The ID of the parent/initial order for a subscription, or the parent order ID for a renewal order.
payment_methodDimension
The ID of the payment method used for the order or subscription.
payment_method_titleDimension
The human-readable title of the payment method used.
prices_include_taxDimension
A boolean indicating whether prices displayed during checkout included tax.
refundsMetric
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.
salesMetric
Refers to aggregated sales report data, including total sales, net sales, and other sales-related metrics.
shippingMetric
The monetary cost of shipping for an order or subscription, returned as a string with two decimal places.
shipping_address_1Dimension
The first line of the shipping address.
shipping_address_2Dimension
The second line of the shipping address.
shipping_cityDimension
The city of the shipping address.
shipping_companyDimension
The company name associated with the shipping address.
shipping_countryDimension
The country code (ISO 3166-1 alpha-2 format) of the shipping address.
shipping_first_nameDimension
The first name of the shipping contact.
shipping_last_nameDimension
The last name of the shipping contact.
shipping_phoneDimension
The phone number associated with the customer's shipping address.
shipping_postcodeDimension
The postal code of the shipping address.
shipping_stateDimension
The ISO code or name of the state, province, or district for the shipping address.
shipping_taxMetric
The total tax amount associated with shipping for the order or subscription.
shipping_totalMetric
The total shipping amount for the order or subscription.
statusDimension
The current status of the order or subscription (e.g., 'pending', 'active', 'completed').
taxMetric
The monetary amount of tax applied to an order, subscription, or individual line item, returned as a string with two decimal places.
totalMetric
The grand total amount for the order or subscription, including taxes and shipping.
total_taxMetric
The sum of all taxes applied to the order or subscription.
transaction_idDimension
The unique transaction ID provided by the payment gateway.
versionDimension
The version of WooCommerce that was active when the order or subscription was created.