BigCommerce

Overview

BigCommerce is an ecommerce platform that allows for online store creation, hosting, marketing, and security for small and medium-sized businesses.

Integrating Lytics with BigCommerce allows you to import customer, order, and product data into Lytics so that you can run segmented marketing campaigns and offer relevant recommendations for your BigCommerce customers.

Authorization

If you haven't already done so, you will need to set up a BigCommerce account before you begin the process described below. To generate a long term access token, follow the Obtaining Store API Credentials instructions on BigCommerce. The minimum scopes required are Customers and Orders.

If you are new to creating authorizations in Lytics, see the Authorizations documentation for more information.

  1. Select BigCommerce from the list of providers.
  2. Select the BigCommerce Access Token method for authorization.
  3. In the Label text box, enter a name for the authorization.
  4. (optional) In the Description text box, enter a description for this authorization.
  5. In the Store Hash text box, enter your unique store hash ID.
  6. In the Access Token password box, enter your access token. This must have read-access scopes to Customers and Orders for imports and modify scope to Customers and read-access scope to Orders for exports.
  7. Click Save Authorization.

Import Users & Activity Data

Importing your BigCommerce customers and their order activity data into Lytics enables you to run personalized marketing campaigns for your BigCommerce customers.

Integration Details

  • Implementation Type: Server-side Integration.
  • Implementation Technique: REST API Integration.
  • Frequency: Batch Integration
  • Resulting data: User profiles and raw event data

This integration utilizes the BigCommerce API to import user and activity data. Once the import is started, the job will:

  1. From the start-date, import new customers from your BigCommerce account into the bicommerce_users stream.
  2. From the start-date, import new orders and related product activity from your BigCommerce account into the bigcommerce_orders stream.
  3. Continue to import any new customers and activity on an hourly basis.

Fields

The following fields are included in the default mapping of the bigcommerce_users stream:

Source FieldLytics User FieldDescriptionType
accepts_product_review_abandoned_cart_emailsbigcommerce_accepts_marketingBigCommerce Accepts Marketingbool
companycompanyCompanystring
customer_group_idbigcommerce_customer_group_idBigCommerce Customer Group IDint
date_createdbigcommerce_created_tsBigCommerce Customer Created Timedate
date_modifiedbigcommerce_modified_tsBigCommerce Customer Modified Timedate
email(email)email unique idEmail Addressstring
first_namefirst_nameFirst Namestring
idbigcommerce_customer_id unique idBigCommerce Customer Idstring
last_namelast_nameLast Namestring
phonephonePhone Numberstring
registration_ip_addressip_addressIP addressstring
set(addresses.address1)bigcommerce_address_1sBigCommerce Customer Address 1[]string
set(addresses.address2)bigcommerce_address_2sBigCommerce Customer Address 2[]string
set(addresses.address\_type)bigcommerce_address_typesBigCommerce Customer Address Type[]string
set(addresses.city)bigcommerce_citiesBigCommerce Customer City[]string
set(addresses.country\_code)country_codesCustomer Country Code[]string
set(addresses.country)bigcommerce_countriesBigCommerce Customer Country[]string
set(addresses.id)bigcommerce_address_idsBigCommerce Customer Address ID[]string
set(addresses.postal\_code)bigcommerce_postal_codesBigCommerce Customer Zip[]string
set(addresses.state\_or\_province)bigcommerce_statesBigCommerce Customer State[]string
set(attributes.attribute\_id)bigcommerce_attr_idBigCommerce Attribute ID[]string
set(attributes.attribute\_value)bigcommerce_attr_valueBigCommerce Attribute Value[]string
set(attributes.date\_created)bigcommerce_attr_created_tsBigCommerce Attribute Created Time[]string
set(attributes.date\_modified)bigcommerce_attr_modified_tsBigCommerce Attribute Modified Time[]string
set(form\_fields.name)bigcommerce_field_nameBigCommerce Form Field Name[]string
set(form\_fields.value)bigcommerce_field_valueBigCommerce Form Field Value[]string
set(store_credit_amounts.amount)bigcommerce_credit_amountsBigCommerce Store Credit Amounts[]string
tax_exempt_categorybigcommerce_tax_exemptBigCommerce Tax Exemptstring

The following fields are included in the default mapping of the bigcommerce_orders stream:

Source FieldLytics User FieldDescriptionType
base_handling_costbigcommerce_base_handling_costBigCommerce Base Handling Costnumber
base_shipping_costbigcommerce_base_shipping_costBigCommerce Base Shipping Costnumber
coupon_discountbigcommerce_coupon_discountBigCommerce Coupon Discountnumber
customer_idbigcommerce_customer_id unique idBigCommerce Customer Idstring
discount_amountbigcommerce_discount_amountBigCommerce Discount Amountnumber
gift_certificate_amountbigcommerce_gift_certificate_amountBigCommerce Gift Certificate Amountnumber
is_email_opt_inbigcommerce_is_email_opt_inBigCommerce Customer Selected Email Opt-Inbool
items_shippedbigcommerce_items_shippedBigCommerce Number of Items Shippednumber
items_totalbigcommerce_items_totalBigCommerce Total Items in the Ordernumber
max(todate(date_created))last_purchase_tsMost Recent Order Timedate
min(todate(date_created))bigcommerce_first_order_tsBigCommerce First Order Timedate
payment_methodbigcommerce_payment_methodBigCommerce payment methodstring
refunded_amountbigcommerce_refund_amountBigCommerce Transaction Refund Amountnumber
set(id)bigcommerce_order_product_idsBigCommerce Product ID within Order[]string
set(name_customer)bigcommerce_name_customersBigCommerce Product Name Shown to Customer[]string
set(name_merchant)bigcommerce_name_merchantsBigCommerce Product Name Shown to Merchant[]string
set(order_id)bigcommerce_order_idsBigCommerce Order IDs[]string
set(product_id)bigcommerce_product_idsBigCommerce Product ID[]string
store_credit_amountbigcommerce_store_credit_amountBigCommerce Store Credit Amountnumber

Configuration

Follow these steps to set up and configure an import job for BigCommerce in the Lytics platform. If you are new to creating jobs in Lytics, see the Data Sourcesdocumentation for more information.

  1. Select BigCommerce from the list of providers.
  2. Select the Import Users & Activity Data from the list.
  3. Select the Authorization you would like to use or create a new one.
  4. Enter a Label to identify this job you are creating in Lytics.
  5. (Optional) Enter a Description for further context on your job.
  6. Complete the configuration steps for your job.
    BigCommerce Config
  7. (Optional) From the Additional Customer Fields input, select additional customer fields to import.
  8. (Optional) Select the Skip importing customer profiles checkbox to skip importing customer profiles.
  9. (Optional) Select the Skip importing customer order data checkbox to skip importing customer orders.
  10. (Optional) In the Start Date text box, enter a date to start your import from. If no date is selected, all users and activity data will be imported. Please use the format yyyy-mm-dd, e.g. 2021-01-25.
  11. (Optional) Select the Keep Updated checkbox to continuously import data.
  12. Click Start Import.

Export Audience

Sync Lytics audiences with BigCommerce to identify and target the right users to improve the performance of your store campaigns.

Integration Details

  • Implementation Type: Server-side Integration.
  • Implementation Technique: REST API Integration, Audience Trigger Integration
  • Frequency: Real-time Integration with an optional one-time Backfill of the audience after job setup.
  • Resulting data: BigCommerce Customer Accounts updated with user data from Lytics.

This integration utilizes the BigCommerce API to export Lytics users. Once the export is started, the job will:

  1. Scan the selected Lytics audience. BigCommerce standard fields and customer attributes will be sent as part of each user's profile if configured to do so. If you don't select an Audience Attribute, Lytics will create a Lytics-Audience customer attribute (i.e. LyticsAudience_{Job_Id}) in your account. The attribute value will be set to the Lytics Audience Slug. Users are exported using BigCommerce's Update Customer's Endpoint. Only users with BigCommerce Customer IDs will be exported.
  2. The export job will run continuously. As users enter the Lytics audience, they will be added to the queue. The queue will be sent to BigCommerce every minute or or when the queue reaches 100 users.

Fields

By default, Lytics exports the following fields to BigCommerce:

Lytics User FieldDescriptionBigCommerce FieldType
emailEmail AddressEmailstring

Configuration

Follow these steps to set up and configure an export job for BigCommerce in the Lytics platform.

  1. Select BigCommerce from the list of providers.

  2. Select the export job type from the list.

  3. Select the Authorization you would like to use or create a new one.

  4. Enter a Label to identify this job you are creating in Lytics.

  5. (Optional) Enter a Description for further context on your job.

  6. Select the audience to export.

  7. Complete the configuration steps for your job.
    BigCommerce Export Config

  8. From the ID Field input, select the field that contains the user's BigCommerce ID field.

  9. (optional) From the Audience Attribute Field input, select the attribute field that should contain the Lytics audience name. If none is selected, one with the name 'LyticsAudience_{Job_Id}' will be created for your account.

  10. (optional) From the Map Standard Fields input, map standard fields from Lytics to BigCommerce by selecting the Lytics field on the left, and its BigCommerce destination on the right.

  11. (optional) From the Map Custom Attributes input, map custom attributes from Lytics to BigCommerce by selecting the Lytics field on the left, and its BigCommerce destination on the right.

  12. (optional) Select the Existing Users checkbox to send users who already exist in the selected Lytics audience.

  13. Click the Start job button to start the job