BigCommerce: Most-used fields

The table below gives information about most-used fields that you can import from BigCommerce. 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
accepts_product_review_abandoned_cart_emails	accepts_product_review_abandoned_cart_emails	Indicates whether the customer has opted in to receive emails related to product reviews and/or abandoned carts.	dimension
authentication.force_password_reset	authentication.force_password_reset	A flag within the customer’s authentication settings that, when set to true, forces the customer to reset their password upon their next login attempt.	dimension
base_handling_cost	base_handling_cost	The base handling cost of the order, before any taxes or discounts are applied.	metric
base_shipping_cost	base_shipping_cost	The base shipping cost of the order, before any taxes or discounts are applied.	metric
base_wrapping_cost	base_wrapping_cost	The base wrapping cost of the order, before any taxes or discounts are applied.	metric
billing_address.city	billing_address.city	The city of the customer’s billing address.	dimension
billing_address.company	billing_address.company	The company name associated with the customer’s billing address.	dimension
billing_address.country	billing_address.country	The country of the customer’s billing address.	dimension
billing_address.country_iso2	billing_address.country_iso2	The two-letter ISO 3166-1 alpha-2 code for the country of the customer’s billing address.	dimension
billing_address.email	billing_address.email	The email address associated with the customer’s billing address.	dimension
billing_address.first_name	billing_address.first_name	The first name on the customer’s billing address.	dimension
billing_address.form_fields	billing_address.form_fields	Custom form fields and their values associated with the customer’s billing address.	dimension
billing_address.last_name	billing_address.last_name	The last name on the customer’s billing address.	dimension
billing_address.phone	billing_address.phone	The phone number for the customer’s billing address.	metric
billing_address.state	billing_address.state	The state, province, or region of the customer’s billing address.	dimension
billing_address.street_1	billing_address.street_1	The first line of the street address for the customer’s billing address.	dimension
billing_address.street_2	billing_address.street_2	The second line of the street address for the customer’s billing address.	dimension
billing_address.zip	billing_address.zip	The postal code or ZIP code of the customer’s billing address.	metric
cart_id	cart_id	The ID of the shopping cart that was converted into this order.	dimension
channel_id	channel_id	The unique identifier of the BigCommerce sales channel where the order originated.	dimension
channel_ids	channel_ids	An array of channel IDs that the customer is associated with or can access.	dimension
company	company	The company associated with the customer’s account.	dimension
coupon_discount	coupon_discount	The total amount discounted from the order due to applied coupons.	metric
credit_card_type	credit_card_type	The type of credit card used for the order’s payment.	dimension
currency_code	currency_code	The ISO 4217 three-letter currency code for the order’s transactional currency.	dimension
currency_exchange_rate	currency_exchange_rate	The exchange rate from the store’s default currency to the order’s transactional currency.	metric
currency_id	currency_id	The ID of the currency used for the order.	dimension
customer_group_id	customer_group_id	The unique identifier of the customer group to which the customer belongs.	dimension
customer_id	customer_id	The unique identifier of the customer who placed the order.	dimension
customer_locale	customer_locale	The locale setting (language and region) of the customer at the time of the order.	dimension
customer_message	customer_message	Any message or comments entered by the customer during the checkout process.	dimension
date_created	date_created	The date and time when the order was created.	dimension
date_modified	date_modified	The date and time when the order was last modified.	dimension
date_shipped	date_shipped	The date when the order was shipped.	dimension
default_currency_code	default_currency_code	The ISO 4217 three-letter currency code of the store’s default currency.	dimension
default_currency_id	default_currency_id	The ID of the store’s default currency.	dimension
discount_amount	discount_amount	The total monetary amount of discounts applied to the order.	metric
email	email	The primary email address of the customer.	dimension
external_id	external_id	An optional ID for the order if it originated from an external system, such as Amazon.	dimension
external_order_id	external_order_id	An identifier for the order from an external system, allowing for cross-referencing with other platforms. This field is typically set during order creation.	dimension
external_source	external_source	A field to identify the system used to create or modify the order via the API, e.g., ‘POS’.	dimension
fees	fees	Any additional fees applied to the order.	dimension
first_name	first_name	The first name of the customer.	dimension
geoip_country	geoip_country	The full name of the country where the customer made the purchase, derived from their IP address.	dimension
geoip_country_iso2	geoip_country_iso2	The two-letter ISO 3166-1 alpha-2 code of the country where the customer made the purchase, derived from their IP address.	dimension
gift_certificate_amount	gift_certificate_amount	The total amount of gift certificates applied to the order.	metric
handling_cost_ex_tax	handling_cost_ex_tax	The handling cost of the order, excluding tax.	metric
handling_cost_inc_tax	handling_cost_inc_tax	The handling cost of the order, including tax.	metric
handling_cost_tax	handling_cost_tax	The amount of tax applied to the handling cost of the order.	metric
handling_cost_tax_class_id	handling_cost_tax_class_id	The ID of the tax class applied to the handling cost.	dimension
id	id	The unique identifier for the order or customer.	dimension
ip_address	ip_address	The IPv4 address of the customer when the order was placed.	dimension
ip_address_v6	ip_address_v6	The IPv6 address of the customer associated with the order, if available. Setting this value may reset any existing IPv4 address.	dimension
is_deleted	is_deleted	A boolean indicating if the order has been archived (true for deleted, false otherwise).	dimension
is_email_opt_in	is_email_opt_in	Indicates if the customer has opted in to receive marketing emails.	dimension
is_tax_inclusive_pricing	is_tax_inclusive_pricing	Indicates whether product prices, shipping costs, and gift wrapping prices include tax (inclusive pricing) or if tax is added separately during checkout (exclusive pricing).	dimension
items_shipped	items_shipped	The number of distinct items in the order that have been shipped.	metric
items_total	items_total	The total number of distinct items in the order.	metric
last_name	last_name	The last name of the customer.	dimension
notes	notes	Any internal notes or comments pertaining to the customer.	dimension
order_is_digital	order_is_digital	A boolean indicating if the order consists entirely of digital products.	dimension
order_source	order_source	Indicates the origin or sales channel from which the order was placed (e.g., direct, Google, Instagram, Facebook, API).	dimension
origin_channel_id	origin_channel_id	The unique identifier of the BigCommerce channel where the order originated. This helps track the sales channel for reporting and fulfillment. The default value is typically 1.	dimension
payment_method	payment_method	The payment method used for the order (e.g., ‘Credit Card’, ‘Manual’, ‘Test Payment Gateway’).	dimension
payment_provider_id	payment_provider_id	The unique identifier for the transaction within the payment gateway or provider.	dimension
payment_status	payment_status	The current payment status of the order (e.g., ‘Pending’, ‘Paid’, ‘Refunded’).	dimension
phone	phone	The primary phone number of the customer.	dimension
refunded_amount	refunded_amount	The total monetary amount that has been refunded for this order.	metric
registration_ip_address	registration_ip_address	The IP address recorded when the customer registered their account with the store.	dimension
shipping_address_count	shipping_address_count	The number of different shipping addresses associated with this order.	metric
shipping_cost_ex_tax	shipping_cost_ex_tax	The shipping cost of the order, excluding tax.	metric
shipping_cost_inc_tax	shipping_cost_inc_tax	The shipping cost of the order, including tax.	metric
shipping_cost_tax	shipping_cost_tax	The amount of tax applied to the shipping cost of the order.	metric
shipping_cost_tax_class_id	shipping_cost_tax_class_id	The ID of the tax class applied to the shipping cost.	dimension
staff_notes	staff_notes	Any additional internal notes related to an order, viewable only in the BigCommerce control panel by staff, not visible to customers.	dimension
status	status	The human-readable status of the order (e.g., ‘Awaiting Fulfillment’, ‘Shipped’).	dimension
status_id	status_id	The unique numerical ID representing the current status of the order.	dimension
store_credit_amount	store_credit_amount	The amount of store credit applied to the order.	metric
store_default_currency_code	store_default_currency_code	The ISO 4217 three-letter currency code of the store’s default currency.	dimension
store_default_to_transactional_exchange_rate	store_default_to_transactional_exchange_rate	The currency exchange rate between the store’s default currency and the transactional currency used for the order. This rate is applied when a customer transacts in a currency different from the store’s default.	metric
subtotal_ex_tax	subtotal_ex_tax	The subtotal of the order’s items, excluding tax.	metric
subtotal_inc_tax	subtotal_inc_tax	The subtotal of the order’s items, including tax.	metric
subtotal_tax	subtotal_tax	The total tax amount applied to the subtotal of the order’s items.	metric
tax_exempt_category	tax_exempt_category	The tax-exempt category assigned to the customer, if applicable.	dimension
tax_provider_id	tax_provider_id	The ID of the tax provider used for calculating taxes on the order.	dimension
total_ex_tax	total_ex_tax	The grand total of the order, excluding tax.	metric
total_inc_tax	total_inc_tax	The grand total of the order, including tax.	metric
total_tax	total_tax	The total tax amount applied to the entire order.	metric
wrapping_cost_ex_tax	wrapping_cost_ex_tax	The gift wrapping cost for the order, excluding tax.	metric
wrapping_cost_inc_tax	wrapping_cost_inc_tax	The gift wrapping cost for the order, including tax.	metric
wrapping_cost_tax	wrapping_cost_tax	The amount of tax applied to the gift wrapping cost of the order.	metric
wrapping_cost_tax_class_id	wrapping_cost_tax_class_id	The ID of the tax class applied to the gift wrapping cost.	dimension