
BigCommerce Integration
“Create differentiated commerce experiences on the industry’s most versatile enterprise solution. Meet the platform leading a new era of e-commerce for enterprise brands. A highly-extensible SaaS solution that takes the onus of security and scalability to fast-track your growth“
The BigCommerce integration brings in Customer, Product and Purchase history datasets. The standard set of attributes that are brought for this integration are shown in the table below. If you have made any customisations to your BigCommerce setup then bringing these in can be discussed during Supported Onboarding.
Customer Attributes
Distil.ai Attribute | Mapped BigCommerce Attribute | BigCommerce Attribute Description |
Customer Id | /customers.id | The unique numeric ID of the customer. |
First Name | /customers.first_name | The first name of the customer. |
Last Name | /customers.last_name | The last name of the customer. |
Email Address | /customers.email | The email of the customer. Must be unique. |
Mobile Phone Number | /customers.phone | The phone number of the customer. |
GDPR Status – Marketing Subscribed | ||
GDPR Status – Right of Access Requested | ||
GDPR Status – Anonymise Data | ||
Facebook Slug | ||
Twitter Handle | ||
Instagram Handle | ||
LinkedIn Slug | ||
Postal Address Line 1 | /customers/addresses.address1 | The address 1 line. |
Postal Address Line 2 | /customers/addresses.address2 | The address 1 line. |
Postal Address Town | /customers/addresses.city | The city of the customer address. |
Postal Address Region | /customers/addresses.state_or_province | The state or province name. |
Postal Address Country | /customers/addresses.country | The country name of the customer address. |
Postal Address Postcode | /customers/addresses.postal_code | The postal code of the customer address. |
Billing Address Line 1 | /orders/billing_addresses.street_1 | The customer’s street address, line 1. |
Billing Address Line 2 | /orders/billing_addresses.street_2 | The customer’s street address, line 2. |
Billing Address Town | /orders/billing_addresses.city | The customer’s city/town/suburb. |
Billing Address Region | /orders/billing_addresses.state | The customer’s state/province. |
Billing Address Country | /orders/billing_addresses.country | The customer’s country. Must be the full country name. |
Billing Address Postcode | /orders/billing_addresses.zip | The customer’s ZIP or postal code. |
Additional Customer Attributes available from BigCommerce can be found here. These may added as Custom Attributes into the Distil.ai Customer dataset.
Product Attributes
Distil.ai Attribute | Mapped BigCommerce Attribute | BigCommerce Attribute Description |
Product Id | /catalog/products.sku | User defined product code/stock keeping unit (SKU). |
Product Name | /catalog/products.name | The product name. |
Precis | /catalog/products.description | The product description, which can include HTML formatting. |
Thumbnail URL | /catalog/products/images.url_thumbnail | The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels. |
Image URL | /catalog/products/images.image_url | Must be a fully qualified URL path, including protocol. Limit of 8MB per file. |
Shop URL | /catalog/products/custom_url.url | Category URL on the storefront. |
Available | /catalog/products.availability | Availability of the product. Availability options are: available – the product can be purchased on the storefront; disabled – the product is listed in the storefront, but cannot be purchased; preorder – the product is listed for pre-orders. |
List Price – Excluding Tax | /catalog/products.price | The price of the product. The price should include or exclude tax, based on the store settings. |
List Price – Including Tax | /catalog/products.price | The price of the product. The price should include or exclude tax, based on the store settings. |
Price Breaks Description | /catalog/products.bulk-pricing-rules | Returns a list of Bulk Pricing Rules. Optional parameters can be passed in. |
Category | /catalog/products.categories | An array of IDs for the categories to which this product belongs. When updating a product, if an array of categories is supplied, all product categories will be overwritten. Does not accept more than 1,000 ID values. |
Additional Product Attributes available from BigCommerce can be found here. These may added as Custom Attributes into the Distil.ai Product dataset.
Purchase History Attributes
Distil.ai Attribute | Mapped BigCommerce Attribute | BigCommerce Attribute Description |
Id | /orders/products.id | Numeric ID of this product within this order. |
Customer Id | /orders.customer_id | The ID of the customer placing the order; or 0 if it was a guest order. |
Order Id | /orders/products.order_id | Numeric ID of the associated order. |
Product Id | /orders/products.product_id | Numeric ID of the product. |
Order Timestamp UTC | /orders.date_created | The date this order was created. If not specified, will default to the current time. |
Quantity | /orders/products.quantity | Quantity of the product ordered. |
Line Value Excluding Tax | /orders/products.price_ex_tax | The product’s price excluding tax. |
Line Value Including Tax | /orders/products.price_inc_tax | The product’s price including tax. |
Payment method | /orders.payment_method | The payment method for this order. Can be one of the following: Manual, Credit Card, cash, Test Payment Gateway, etc. |
Currency | /orders.currency_code | The currency code of the currency being used in this transaction. |
Postal Address Line 1 | /orders/shipping_addresses.street_1 | Street address (first line). |
Postal Address Line 2 | /orders/shipping_addresses.street_2 | Street address (second line). |
Postal Address Town | /orders/shipping_addresses.city | Addressee city. |
Postal Address Region | /orders/shipping_addresses.state | The name of the state or province. Should be spelled out in full. |
Postal Address Country | /orders/shipping_addresses.country | Addressee’s country. |
Postal Address Postcode | /orders/shipping_addresses.zip | ZIP or postal code, as a string. |
Billing Address Line 1 | /orders/billing_addresses.street_1 | The customer’s street address, line 1. |
Billing Address Line 2 | /orders/billing_addresses.street_2 | The customer’s street address, line 2. |
Billing Address Town | /orders/billing_addresses.city | The customer’s city/town/suburb. |
Billing Address Region | /orders/billing_addresses.state | The customer’s state/province. |
Billing Address Country | /orders/billing_addresses.country | The customer’s country. Must be the full country name. |
Billing Address Postcode | /orders/billing_addresses.zip | The customer’s ZIP or postal code. |
Additional Purchase History Attributes available from BigCommerce can be found here. These may added as Custom Attributes into the Distil.ai Purchase History dataset.