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.
base_handling_cost Metric
The base handling cost of the order, before any taxes or discounts are applied.
base_shipping_cost Metric
The base shipping cost of the order, before any taxes or discounts are applied.
base_wrapping_cost Metric
The base wrapping cost of the order, before any taxes or discounts are applied.
billing_address.city Dimension
The city of the customer's billing address.
billing_address.company Dimension
The company name associated with the customer's billing address.
billing_address.country Dimension
The country of the customer's billing address.
billing_address.country_iso2 Dimension
The two-letter ISO 3166-1 alpha-2 code for the country of the customer's billing address.
billing_address.email Dimension
The email address associated with the customer's billing address.
billing_address.first_name Dimension
The first name on the customer's billing address.
billing_address.form_fields Dimension
Custom form fields and their values associated with the customer's billing address.
billing_address.last_name Dimension
The last name on the customer's billing address.
billing_address.phone Dimension
The phone number for the customer's billing address.
billing_address.state Dimension
The state, province, or region of the customer's billing address.
billing_address.street_1 Dimension
The first line of the street address for the customer's billing address.
billing_address.street_2 Dimension
The second line of the street address for the customer's billing address.
billing_address.zip Metric
The postal code or ZIP code of the customer's billing address.
cart_id Dimension
The ID of the shopping cart that was converted into this order.
channel_id Dimension
The unique identifier of the BigCommerce sales channel where the order originated.
coupon_discount Metric
The total amount discounted from the order due to applied coupons.
credit_card_type Dimension
The type of credit card used for the order's payment.
currency_code Dimension
The ISO 4217 three-letter currency code for the order's transactional currency.
currency_exchange_rate Metric
The exchange rate from the store's default currency to the order's transactional currency.
currency_id Dimension
The ID of the currency used for the order.
customer_id Dimension
The unique identifier of the customer who placed the order.
customer_locale Dimension
Represents the locale settings associated with the customer or the store, influencing the display of localized information such as currency, language, and date formats.
customer_message Dimension
Any message or comments entered by the customer during the checkout process.
date_created Dimension
The date and time when the order was created.
date_modified Dimension
The date and time when the order was last modified.
date_shipped Dimension
The date when the order was shipped.
default_currency_code Dimension
The ISO 4217 three-letter currency code of the store's default currency.
default_currency_id Dimension
The ID of the store's default currency.
discount_amount Metric
The total monetary amount of discounts applied to the order.
external_id Dimension
An optional ID for the order if it originated from an external system, such as Amazon.
external_order_id Dimension
An identifier used to link a BigCommerce order to a corresponding order in an external system, such as an Enterprise Resource Planning (ERP) system or another marketplace. This ID can be set when an order is created but cannot be modified afterward.
external_source Dimension
A field to identify the system used to create or modify the order via the API, e.g., 'POS'.
geoip_country Dimension
The full name of the country where the customer made the purchase, derived from their IP address.
geoip_country_iso2 Dimension
The two-letter ISO 3166-1 alpha-2 code of the country where the customer made the purchase, derived from their IP address.
gift_certificate_amount Metric
The total amount of gift certificates applied to the order.
handling_cost_ex_tax Metric
The handling cost of the order, excluding tax.
handling_cost_inc_tax Metric
The handling cost of the order, including tax.
handling_cost_tax Metric
The amount of tax applied to the handling cost of the order.
handling_cost_tax_class_id Dimension
The ID of the tax class applied to the handling cost.
id Dimension
The unique identifier for the order or customer.
ip_address Dimension
The IPv4 address of the customer when the order was placed.
ip_address_v6 Dimension
The customer's IPv6 address recorded at the time of the transaction. If both IPv4 (ip_address) and IPv6 are available, setting one will override the other.
is_deleted Dimension
A boolean indicating if the order has been archived (true for deleted, false otherwise).
is_email_opt_in Dimension
Indicates if the customer has opted in to receive marketing emails.
items_shipped Metric
The number of distinct items in the order that have been shipped.
items_total Metric
The total number of distinct items in the order.
order_is_digital Dimension
A boolean indicating if the order consists entirely of digital products.
order_source Dimension
Indicates the origin or sales channel from which the order was placed (e.g., direct, Google, Instagram, Facebook, API).
payment_method Dimension
The payment method used for the order (e.g., 'Credit Card', 'Manual', 'Test Payment Gateway').
payment_provider_id Dimension
The unique identifier for the transaction within the payment gateway or provider.
payment_status Dimension
The current payment status of the order (e.g., 'Pending', 'Paid', 'Refunded').
refunded_amount Metric
The total monetary amount that has been refunded for this order.
shipping_address_count Metric
The number of different shipping addresses associated with this order.
shipping_cost_ex_tax Metric
The shipping cost of the order, excluding tax.
shipping_cost_inc_tax Metric
The shipping cost of the order, including tax.
shipping_cost_tax Metric
The amount of tax applied to the shipping cost of the order.
shipping_cost_tax_class_id Dimension
The ID of the tax class applied to the shipping cost.
staff_notes Dimension
Any additional internal notes related to an order, viewable only in the BigCommerce control panel by staff, not visible to customers.
status Dimension
The human-readable status of the order (e.g., 'Awaiting Fulfillment', 'Shipped').
status_id Dimension
The unique numerical ID representing the current status of the order.
store_credit_amount Metric
The amount of store credit applied to the order.
store_default_currency_code Dimension
The ISO 4217 three-letter currency code of the store's default currency.
store_default_to_transactional_exchange_rate Metric
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.
subtotal_ex_tax Metric
The subtotal of the order's items, excluding tax.
subtotal_inc_tax Metric
The subtotal of the order's items, including tax.
subtotal_tax Metric
The total tax amount applied to the subtotal of the order's items.
tax_provider_id Dimension
The ID of the tax provider used for calculating taxes on the order.
total_ex_tax Metric
The grand total of the order, excluding tax.
total_inc_tax Metric
The grand total of the order, including tax.
total_tax Metric
The total tax amount applied to the entire order.
wrapping_cost_ex_tax Metric
The gift wrapping cost for the order, excluding tax.
wrapping_cost_inc_tax Metric
The gift wrapping cost for the order, including tax.
wrapping_cost_tax Metric
The amount of tax applied to the gift wrapping cost of the order.
wrapping_cost_tax_class_id Dimension
The ID of the tax class applied to the gift wrapping cost.