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.
- Select BigCommerce from the list of providers.
- Select the BigCommerce Access Token method for authorization.
- In the Label text box, enter a name for the authorization.
- (optional) In the Description text box, enter a description for this authorization.
- In the Store Hash text box, enter your unique store hash ID.
- 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.
- 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:
- From the start-date, import new customers from your BigCommerce account into the
bicommerce_users
stream. - From the start-date, import new orders and related product activity from your BigCommerce account into the
bigcommerce_orders
stream. - 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 Field | Lytics User Field | Description | Type |
---|---|---|---|
accepts_product_review_abandoned_cart_emails | bigcommerce_accepts_marketing | BigCommerce Accepts Marketing | bool |
company | company | Company | string |
customer_group_id | bigcommerce_customer_group_id | BigCommerce Customer Group ID | int |
date_created | bigcommerce_created_ts | BigCommerce Customer Created Time | date |
date_modified | bigcommerce_modified_ts | BigCommerce Customer Modified Time | date |
email(email) | email unique id | Email Address | string |
first_name | first_name | First Name | string |
id | bigcommerce_customer_id unique id | BigCommerce Customer Id | string |
last_name | last_name | Last Name | string |
phone | phone | Phone Number | string |
registration_ip_address | ip_address | IP address | string |
set(addresses.address1 ) | bigcommerce_address_1s | BigCommerce Customer Address 1 | []string |
set(addresses.address2 ) | bigcommerce_address_2s | BigCommerce Customer Address 2 | []string |
set(addresses.address\_type ) | bigcommerce_address_types | BigCommerce Customer Address Type | []string |
set(addresses.city ) | bigcommerce_cities | BigCommerce Customer City | []string |
set(addresses.country\_code ) | country_codes | Customer Country Code | []string |
set(addresses.country ) | bigcommerce_countries | BigCommerce Customer Country | []string |
set(addresses.id ) | bigcommerce_address_ids | BigCommerce Customer Address ID | []string |
set(addresses.postal\_code ) | bigcommerce_postal_codes | BigCommerce Customer Zip | []string |
set(addresses.state\_or\_province ) | bigcommerce_states | BigCommerce Customer State | []string |
set(attributes.attribute\_id ) | bigcommerce_attr_id | BigCommerce Attribute ID | []string |
set(attributes.attribute\_value ) | bigcommerce_attr_value | BigCommerce Attribute Value | []string |
set(attributes.date\_created ) | bigcommerce_attr_created_ts | BigCommerce Attribute Created Time | []string |
set(attributes.date\_modified ) | bigcommerce_attr_modified_ts | BigCommerce Attribute Modified Time | []string |
set(form\_fields.name ) | bigcommerce_field_name | BigCommerce Form Field Name | []string |
set(form\_fields.value ) | bigcommerce_field_value | BigCommerce Form Field Value | []string |
set(store_credit_amounts.amount) | bigcommerce_credit_amounts | BigCommerce Store Credit Amounts | []string |
tax_exempt_category | bigcommerce_tax_exempt | BigCommerce Tax Exempt | string |
The following fields are included in the default mapping of the bigcommerce_orders
stream:
Source Field | Lytics User Field | Description | Type |
---|---|---|---|
base_handling_cost | bigcommerce_base_handling_cost | BigCommerce Base Handling Cost | number |
base_shipping_cost | bigcommerce_base_shipping_cost | BigCommerce Base Shipping Cost | number |
coupon_discount | bigcommerce_coupon_discount | BigCommerce Coupon Discount | number |
customer_id | bigcommerce_customer_id unique id | BigCommerce Customer Id | string |
discount_amount | bigcommerce_discount_amount | BigCommerce Discount Amount | number |
gift_certificate_amount | bigcommerce_gift_certificate_amount | BigCommerce Gift Certificate Amount | number |
is_email_opt_in | bigcommerce_is_email_opt_in | BigCommerce Customer Selected Email Opt-In | bool |
items_shipped | bigcommerce_items_shipped | BigCommerce Number of Items Shipped | number |
items_total | bigcommerce_items_total | BigCommerce Total Items in the Order | number |
max(todate(date_created)) | last_purchase_ts | Most Recent Order Time | date |
min(todate(date_created)) | bigcommerce_first_order_ts | BigCommerce First Order Time | date |
payment_method | bigcommerce_payment_method | BigCommerce payment method | string |
refunded_amount | bigcommerce_refund_amount | BigCommerce Transaction Refund Amount | number |
set(id) | bigcommerce_order_product_ids | BigCommerce Product ID within Order | []string |
set(name_customer) | bigcommerce_name_customers | BigCommerce Product Name Shown to Customer | []string |
set(name_merchant) | bigcommerce_name_merchants | BigCommerce Product Name Shown to Merchant | []string |
set(order_id) | bigcommerce_order_ids | BigCommerce Order IDs | []string |
set(product_id) | bigcommerce_product_ids | BigCommerce Product ID | []string |
store_credit_amount | bigcommerce_store_credit_amount | BigCommerce Store Credit Amount | number |
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.
- Select BigCommerce from the list of providers.
- Select the Import Users & Activity Data from the list.
- Select the Authorization you would like to use or create a new one.
- Enter a Label to identify this job you are creating in Lytics.
- (Optional) Enter a Description for further context on your job.
- Complete the configuration steps for your job.
- (Optional) From the Additional Customer Fields input, select additional customer fields to import.
- (Optional) Select the Skip importing customer profiles checkbox to skip importing customer profiles.
- (Optional) Select the Skip importing customer order data checkbox to skip importing customer orders.
- (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
. - (Optional) Select the Keep Updated checkbox to continuously import data.
- 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:
- 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. - 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 Field | Description | BigCommerce Field | Type |
---|---|---|---|
Email Address | string | ||
Configuration
Follow these steps to set up and configure an export job for BigCommerce in the Lytics platform.
-
Select BigCommerce from the list of providers.
-
Select the export job type from the list.
-
Select the Authorization you would like to use or create a new one.
-
Enter a Label to identify this job you are creating in Lytics.
-
(Optional) Enter a Description for further context on your job.
-
Select the audience to export.
-
Complete the configuration steps for your job.
-
From the ID Field input, select the field that contains the user's BigCommerce ID field.
-
(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.
-
(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.
-
(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.
-
(optional) Select the Existing Users checkbox to send users who already exist in the selected Lytics audience.
-
Click the Start job button to start the job
Updated 12 months ago