BigCommerce is a fully supported sales channel in Flxpoint, enabling direct integration with your store to manage product listings, inventory updates, order syncing, and fulfillment operations. This integration helps ensure accurate data flow and efficient operations between your BigCommerce store and Flxpoint.
How To Connect
Step 1: Log into your Flxpoint account and go to the Channels section.
Step 2: Click on + Add Channel to begin your BigCommerce integration.
Step 3: In the popup, choose BigCommerce as your channel and enter a channel name. Then click Continue.
Step 4: Select your preferred authentication method and click Continue.
OAuth2 (Recommended): Choose this method for the easiest setup.
API Key (Advanced): Choose this method if OAuth2 is not suitable, and follow the steps below to obtain your credentials.
Step 5: Authenticate with your BigCommerce channel:
For OAuth2: Enter your BigCommerce Store Hash in the provided field and click Continue.
Your Store Hash can be found in your BigCommerce admin panel URL (e.g.,
store-abc123 in https://store-abc123.mybigcommerce.com).
For API Key: Obtain your Client ID, Access Token, and Store Hash by following these steps:
Log into your BigCommerce admin panel.
Navigate to Settings > API Accounts.
Click Create API Account and select Create V2/V3 API Token.
Enter a name for the API account (e.g., "Flxpoint Integration").
Configure the API scopes with the necessary permissions (e.g., Products, Orders, Customers) and save.
Copy the Client ID, Access Token, and Store Hash from the generated credentials.
In Flxpoint, enter the Store Hash, Client ID, and Access Token in the respective fields and click Continue.
Step 6: Complete the authentication process:
For OAuth2: You’ll be redirected to BigCommerce to install the Flxpoint app. Select Existing BigCommerce store and click Log in, or choose New to BigCommerce? to sign up.
For API Key: Skip this step as no additional redirection is required after entering the credentials.
Step 7: Authorize Flxpoint:
For OAuth2: Log in with your BigCommerce admin credentials and grant the required permissions to Flxpoint to complete the installation.
For API Key: Skip this step as authorization is handled via the API credentials entered in Step 5.
Step 8: Once authenticated, return to Flxpoint. Review the connection details and click Continue to proceed with the setup wizard.
Step 9: Configure your integration settings:
- Import Listings: Enable to import product listings from BigCommerce. Set the Master SKU field (e.g., BigCommerce Field: SKU) and enable Set New Listings to Paused if desired.
- Publish Listings: Enable to create and publish listings to BigCommerce. Configure settings like Parent Images Direct Copy Behavior and Truncate Title to 250.
- Sync Listings: Enable to sync pricing and quantity data with BigCommerce. Set the linking identifier (e.g., Flxpoint Listing: SKU to BigCommerce Listing: Variant - SKU).
- Get Orders: Enable to import orders from BigCommerce. Select order statuses (e.g., Incomplete, Pending) and set the time range (e.g., 14 days).
- Sync Orders: Enable to sync order and shipment data with BigCommerce.
Step 10: Click Continue to finalize the setup. Your BigCommerce channel is now connected, and you can start running integrations manually or on a schedule.
Tip: Review the settings in the Integrations tab under your BigCommerce channel to ensure all desired operations are enabled.
×
![Modal Image]()
Listing Operations
Flxpoint allows you to manage product listings on BigCommerce by syncing inventory, updating product details, and controlling pricing and availability. This ensures accurate and real-time updates across your BigCommerce store.
Import Listings
Supported | BigCommerce - Import Listings
Introduction to BigCommerce Import Listings Integration
This guide walks you through the process of using the BigCommerce Import Listings integration to bring your product catalog into your system. Whether you’re just starting out or managing a large inventory, this integration simplifies syncing product data—such as titles, images, categories, and brands—from your BigCommerce store. The goal is to keep your listings accurate and ready for publishing, saving you time and effort. Let’s dive into how this works and how to set it up.
Purpose of This Integration
The BigCommerce Import Listings integration connects your system to your BigCommerce store to automatically fetch and update your product catalog. It retrieves key information, including:
- Product details (such as titles, descriptions, variants, and images).
- Categories (organized up to 3 levels deep).
- Brands (mapped to products for better organization).
This ensures your system reflects the most up-to-date product data from BigCommerce, making it easier to manage listings across platforms.
How the Integration Works
The integration uses BigCommerce’s API to pull data into your system in a streamlined process:
1. Fetching Brands and Categories: It makes GET calls to the
v3/catalog/brands and v3/catalog/categories endpoints to retrieve brand and category data. This information is used to create a structured list, replicating your store’s category hierarchy (up to 3 levels deep).
2. Fetching Products: A GET call to the
v3/catalog/products endpoint retrieves the full product catalog. Parameters like include=variants,images are passed to ensure all relevant data—such as product variants and images—is included.
3. Mapping Brands and Categories: Using the IDs available in the products endpoint, brands and categories are mapped to their respective products for accurate organization.
4. Syncing Data: The integration imports this data into your system, creating or updating product listings as needed.
5. Keeping It Updated: You can run the integration manually or set it to run automatically on a schedule (e.g., daily or weekly).
Note: If the API connection fails (e.g., due to incorrect credentials or rate limits), the integration will pause and notify you to resolve the issue.
Configuration Options
You can customize the integration to fit your workflow:
- Set New Listings to Paused: Automatically pause newly imported listings to prevent them from syncing back to BigCommerce until you’ve confirmed their data or linked them to your internal inventory. This is useful for managing fields like price and quantity.
- Master SKU Setup: Choose a field from your BigCommerce channel to act as the Master SKU, which serves as the unique identifier for linking inventory across systems.
- Scheduling: Decide whether to run the integration manually or on a schedule (e.g., every day at 6 AM).
- Product Import Scope: Specify how listings should be imported into your system (e.g., create and update products and listings directly).
Setup Instructions
Follow these steps to set up the BigCommerce Import Listings integration:
1. Add the Integration: In your system, go to the Channels section, select BigCommerce, and navigate to the Integrations tab. Choose the "Import Listings" operation to activate it.
2. Connect to BigCommerce: Provide your Store Hash to initiate the OAuth2 authentication process. After saving the connection, install the Flxpoint app in your BigCommerce store to complete the setup.
3. Configure Settings: Adjust settings like pausing new listings or selecting a Master SKU field to match your needs.
4. Run the Integration: Start the integration manually or let it run on your chosen schedule.
Weights & Dimensions (& Units)
Product weights are available in kilograms (KGS), and dimensions are provided in centimeters. These values are pulled directly from the BigCommerce product data and can be used for shipping calculations or listing details.
Images
Product images are hosted on BigCommerce URLs and are retrieved during the import process. These images are associated with the respective products and can be used for listings or further processing in your system.
Categories
The integration replicates your BigCommerce store’s category structure, supporting up to 3 levels of depth. Categories are fetched via the
v3/catalog/categories endpoint and mapped to products using the category IDs provided in the products endpoint.
Troubleshooting
If you encounter issues with the integration, try these steps:
- Verify your Store Hash and ensure the Flxpoint app is installed in your BigCommerce store.
- Check your API credentials and ensure you haven’t hit BigCommerce’s API rate limits.
- Confirm that the
If issues persist, reach out to support for assistance.
v3/catalog/products, v3/catalog/brands, and v3/catalog/categories endpoints are accessible and returning data.
Conclusion
With the BigCommerce Import Listings integration set up, your system will seamlessly pull in product data, including categories, brands, and images, keeping your catalog up to date. This automation lets you focus on growing your business while ensuring your listings are accurate and ready to go!
Sync & Link Listings
Supported | BigCommerce - Sync & Link Listings
Introduction to BigCommerce Sync & Link Listings Integration
This guide explains how to use the BigCommerce Sync & Link Listings integration to keep your product listings in sync with your BigCommerce store. Whether you’re managing a small catalog or a large inventory, this integration ensures that price, quantity, and status (PQS) updates are seamlessly reflected on your BigCommerce store. It also allows you to link listings using specific identifiers, hide products, or delist them as needed. Let’s explore how this works and how to set it up.
Purpose of This Integration
The BigCommerce Sync & Link Listings integration connects your system to your BigCommerce store to:
- Update price, quantity, and status (PQS) for products and variants on BigCommerce.
- Link listings to BigCommerce products using identifiers like SKU, UPC, or MPN.
- Manage visibility by hiding products on the storefront or delisting them entirely.
This ensures your BigCommerce store reflects the most current data, helping you maintain accurate listings and control product visibility.
How the Integration Works
The integration follows a clear process to sync and link listings with your BigCommerce store:
1. Linking Listings: Listings are matched to BigCommerce products using a prioritized list of identifiers (e.g., SKU, UPC, MPN). You define the linking priority to ensure accurate matching.
2. Updating PQS: Price, quantity, and status updates are sent to BigCommerce using a PUT request to the
v3/catalog/products/{productId}/variants/{variantId} endpoint. This updates the product variant’s price, inventory level, and visibility status.
3. Hiding Products: Products can be marked as hidden on the BigCommerce storefront, with options to hide completely, keep the product page accessible, redirect to a category page, or do nothing.
4. Delisting Products: Linked products can be deleted from the BigCommerce store, fully removing them from the storefront. To restore, you’ll need to republish the product.
5. Mapping Data: A mapping template defines which fields from your system (e.g., price, quantity) are synced to BigCommerce fields (e.g., Price, Inventory Level).
6. Running the Integration: You can run the integration manually or schedule it to run automatically (e.g., daily or weekly, using UTC time by default).
Note: If the API request fails (e.g., due to invalid product/variant IDs or rate limits), the integration will pause and notify you to address the issue.
Configuration Options
You can customize the integration to suit your needs:
- Linking Priority: Set the order of identifiers (e.g., SKU, UPC, MPN) to match listings with BigCommerce products.
- Hiding Behavior: Choose what happens when a product is out of stock—hide it, keep the page accessible, redirect to a category, or do nothing.
- Automatic Stock Adjustment: Enable or disable automatic stock level adjustments when you refund or cancel an order.
- Scheduling: Run the integration manually or schedule it to run automatically (e.g., every day at 6 AM UTC).
- Mapping Template: Define which fields from your system are synced to BigCommerce fields for updating (e.g., enabling sync for “Quantity” to BigCommerce’s “Inventory Level”).
Setup Instructions
Follow these steps to set up the BigCommerce Sync & Link Listings integration:
1. Add the Integration: In your system, go to the Channels section, select BigCommerce, and navigate to the Integrations tab. Choose the “Sync Listings” operation to activate it.
2. Connect to BigCommerce: Select an existing BigCommerce connection (e.g., using OAuth2 authentication) or set up a new one by providing your Store Hash and installing the Flxpoint app in your BigCommerce store.
3. Configure Settings: Set the linking priority (e.g., SKU first, then UPC), define hiding behavior for out-of-stock products, and enable scheduling if desired.
4. Create a Mapping Template: Enable the fields you want to sync from your system to BigCommerce (details below).
5. Run the Integration: Start the integration manually or let it run on your chosen schedule.
Hiding
Products can be marked as hidden on the BigCommerce storefront. You can configure the “When a product is out of stock” setting to:
- Hide the product completely.
- Hide the product but keep the product page accessible.
- Redirect to the category page.
- Do nothing (leave the product visible).
This ensures zero-quantity products don’t appear for sale unless you want them to.
Delisting
Linked products can be deleted from the BigCommerce store, fully removing them from the storefront. If you need to restore a delisted product, you must republish it using the “Publish” action in your system.
Mapping Template Details
A mapping template determines which data fields from your system are synced to BigCommerce. For example, you can enable syncing for your system’s “Quantity” field to update BigCommerce’s “Inventory Level” field. Below are the details:
Interface Overview
- The mapping screen is labeled “Sync Listings” at the top. You can name your template (e.g., “Sync Listings 1”).
- Buttons available: Cancel and Save Mapping.
- Two sections:
- From Value: Fields from your system (e.g., Listing Variant fields like Quantity, List Price).
- To BigCommerce Sync Product/Variant Field: Fields in BigCommerce (e.g., Inventory Level, Price).
Mapping Options You can toggle each field to enable or disable syncing:
- Enabled: The field from your system will be synced to the corresponding BigCommerce field.
- Disabled: The field will not be synced, and the corresponding BigCommerce field will remain unchanged.
Available Source Fields Your system provides fields under categories like “Listing Variant,” including:
- Listing Variant: Custom Aggregate Field, Estimated Cost, Estimated Dropship Fee, Estimated Shipping Cost, List Price, MAP, MSRP, Quantity.
Complete Field Mappings Below is a list of fields you can enable for syncing to BigCommerce:
Availability Description: Describes the product’s availability status.
- Suggested Action: Disable unless you have a specific availability description to sync.
Cost Price: The cost price of the variant.
- Example: “10.50”
- Suggested Action: Enable and sync to Listing Variant’s “Estimated Cost.”
Inventory Level: The stock quantity of the variant.
- Example: “100”
- Suggested Action: Enable and sync to Listing Variant’s “Quantity.”
Map Price: The minimum advertised price.
- Example: “15.99”
- Suggested Action: Enable and sync to Listing Variant’s “MAP.”
Price: The selling price of the variant.
- Example: “19.99”
- Suggested Action: Enable and sync to Listing Variant’s “List Price.”
Retail Price: The MSRP of the variant.
- Example: “24.99”
- Suggested Action: Enable and sync to Listing Variant’s “MSRP.”
Sale Price: The discounted price of the variant.
- Example: “17.99”
- Suggested Action: Enable and sync to Listing Variant’s “List Price” (or a custom sale price field if available).
Troubleshooting
If the integration encounters an issue, try these steps:
- Verify your BigCommerce connection (e.g., Store Hash and Flxpoint app installation).
- Ensure the
v3/catalog/products/{productId}/variants/{variantId} endpoint is accessible and the product/variant IDs are correct.
- Check your mapping template to ensure the desired fields are enabled for syncing (e.g., “Quantity” to “Inventory Level”).
- Confirm you haven’t hit BigCommerce’s API rate limits.
If problems persist, contact support for assistance.
Conclusion
With the BigCommerce Sync & Link Listings integration configured, your system will keep your BigCommerce store updated with the latest price, quantity, and status data. You’ll also have control over linking, hiding, and delisting products, ensuring your storefront reflects exactly what you want customers to see—all with minimal manual effort!
Publish Listings
Supported | BigCommerce - Publish Listings
Introduction to BigCommerce Publish Listings Integration
This guide walks you through the process of using the BigCommerce Publish Listings integration to create and publish product listings on your BigCommerce store. Whether you’re launching new products or updating existing ones, this integration streamlines the process by handling categories, brands, variants, and more. It also provides options for managing product data, such as truncating titles or overwriting existing listings. Let’s dive into how this works and how to set it up.
Purpose of This Integration
The BigCommerce Publish Listings integration connects your system to your BigCommerce store to:
- Create new products or update existing ones on BigCommerce.
- Manage categories and brands, creating them if they don’t exist.
- Support variants, custom fields, attributes, and images for comprehensive product listings.
This ensures your BigCommerce store reflects the latest product data, helping you efficiently manage your catalog and reach customers.
How the Integration Works
The integration follows a structured process to publish listings on BigCommerce:
1. Fetching Categories and Brands: A GET request to
v3/catalog/categories/tree and v3/catalog/brands retrieves the category and brand structure. A category map is created to organize products.
2. Creating Categories and Brands: If a category or brand doesn’t exist, it’s created using a POST request to
v3/catalog/categories or v3/catalog/brands.
3. Creating Products: Products are created with a POST request to
v3/catalog/products. Required fields include product name, weight, type, and price.
4. Adding Variants: For variant products, variants are created with a POST request to
v3/catalog/products/{bigCommerceProductId}/variants. Up to 250 variants are supported.
5. Mapping Data: A mapping template determines which fields from your system (e.g., title, price) are published to BigCommerce fields (e.g., Name, Retail Price).
6. Running the Integration: You can run the integration manually or schedule it to run automatically (e.g., daily or weekly).
Note: If required fields (name, weight, type, price) are missing, the product creation will fail, and you’ll be notified to correct the data.
Configuration Options
You can customize the integration to fit your needs:
- Attribute Fields > 250 Characters: Choose to truncate attribute fields to 250 characters, skip custom fields, or fail the product if attributes exceed the limit (default: Fail Product).
- Override Product Name: Decide whether to overwrite the product name with the name from Flxpoint (Yes) or keep the existing name on BigCommerce (No).
- Parent Images Direct Copy Behavior: Select how images are handled: use all parent and variant images for the parent product, use parent images and the first image of each variant, use only parent images, or use only the first parent image.
- Truncate Title To 250: A setting with two options:
- Truncate Title To 250: If the product title exceeds 250 characters, it’s trimmed to 250 characters during publishing.
- Fail Product: If the title exceeds 250 characters, the product fails to publish (default setting).
- Overwrite Support: Enable overwriting to refresh complete product data on BigCommerce with data from your system.
- Scheduling: Run the integration manually or schedule it to run automatically (e.g., every day at 6 AM UTC).
Setup Instructions
Follow these steps to set up the BigCommerce Publish Listings integration:
1. Add the Integration: In your system, go to the Channels section, select BigCommerce, and navigate to the Integrations tab. Choose the “Publish Listings” operation to activate it.
2. Connect to BigCommerce: Select an existing BigCommerce connection (e.g., using OAuth2 authentication) or set up a new one by providing your Store Hash and installing the Flxpoint app in your BigCommerce store.
3. Configure Settings: Adjust settings like title truncation, product name override, image behavior, and scheduling as needed.
4. Create a Mapping Template: Enable the fields you want to publish to BigCommerce (details below).
5. Run the Integration: Start the integration manually or let it run on your chosen schedule.
Custom Fields
Variant and parent custom fields can be uploaded to BigCommerce as parent custom fields only. These can be enabled in the mapping template to ensure they’re associated with the parent product.
Attributes / Tags
Attributes can be uploaded as either metafields or custom fields on BigCommerce. This selection is available in the mapping template, giving you flexibility to choose the appropriate format for your store.
Variations / Options
Up to 250 variants are supported per product. Variants are created using the
v3/catalog/products/{bigCommerceProductId}/variants endpoint, ensuring all variant-specific data (e.g., SKU, price) is published correctly.
Generic Pricing (& Currency)
The integration sends cost, MSRP, and list price to BigCommerce. Currency is determined by Flxpoint settings, and you can apply rules for currency conversion if needed (e.g., converting prices to the store’s currency).
Client Pricing (& Currency)
Client-specific pricing can be enabled in the mapping template. Currency follows the same rules as generic pricing, with Flxpoint settings determining the currency and conversion rules as applicable.
Quantity
Quantity data is mapped from your system to BigCommerce’s inventory fields (e.g., Inventory Level). Ensure the quantity field is enabled in the mapping template to reflect accurate stock levels.
Multiple Warehouses
The integration supports quantity updates from multiple warehouses if configured in Flxpoint. Aggregate quantities can be enabled in the mapping template to reflect total stock across warehouses.
Weights & Dimensions (& Units)
Weights are uploaded in kilograms (KGS), and dimensions are uploaded in centimeters. These values are mapped to BigCommerce’s respective fields (e.g., Weight, Width, Height, Length) for shipping and listing purposes.
Images
Multiple images can be uploaded for both parent and variant products. Variants display a single image, while the remaining images are associated with the parent product. The maximum image size is 8 MB. The “Parent Images Direct Copy Behavior” setting determines how images are assigned (e.g., all images for parent, parent and first variant image, etc.).
Categories
Categories can be uploaded with up to 3 levels of depth. The integration fetches the category tree using
v3/catalog/categories/tree and creates new categories if needed via v3/catalog/categories. Categories can be enabled in the mapping template using fields like Category 1, Category 2, and Category 3.
Overwriting Supported
Complete product data can be refreshed on BigCommerce using the overwrite option. This allows you to update all fields (e.g., name, price, images) with the latest data from your system, ensuring consistency.
Offerings vs Creation
The integration supports creating new products on BigCommerce. If a product already exists, the overwrite option can be used to update it; otherwise, a new product is created using the
v3/catalog/products endpoint.
Option Limitations
Up to 250 variants/options are supported per product. Ensure your product data adheres to this limit to avoid publishing errors.
Image Limitations
Images are limited to a maximum size of 8 MB. Ensure all images are within this limit to avoid upload failures. The integration supports multiple images for parent and variant products, as configured in the “Parent Images Direct Copy Behavior” setting.
HTML Descriptions
HTML descriptions are supported and can be enabled in the mapping template to sync to BigCommerce’s Description field. Ensure your system’s description field is enabled to include HTML formatting if desired.
Limitations
The following are required to publish a product on BigCommerce:
- Product name
- Weight
- Type
- Price
Additionally, titles are limited to 250 characters (configurable via the “Truncate Title To 250” setting), attributes are limited to 250 characters, and up to 250 variants are supported per product.
Mapping Template Details
A mapping template determines which data fields from your system are published to BigCommerce. For example, you can enable syncing for your system’s “Title” field to update BigCommerce’s “Name” field. Below are the details:
Interface Overview
- The mapping screen is labeled “Publish Listings” at the top. You can name your template (e.g., “Publish Listings 1”).
- Buttons available: Cancel and Save Mapping.
- Two sections:
- From Value: Fields from your system (e.g., Listing Parent fields like Title, Parent SKU; Listing Variant fields like UPC, MSRP).
- To BigCommerce Product Field: Fields in BigCommerce (e.g., Name, UPC, Retail Price).
Mapping Options You can toggle each field to enable or disable syncing:
- Enabled: The field from your system will be published to the corresponding BigCommerce field.
- Disabled: The field will not be published, and the corresponding BigCommerce field will remain unchanged.
Available Source Fields Your system provides fields under categories like “Listing Parent” and “Listing Variant,” including:
- Listing Parent: Attribute, Brand, Category 1, Category 2, Category 3, Custom Field, Description, Image, Parent SKU, Title.
- Listing Variant: ASIN, Custom Aggregate Field, Custom Field, Description, Dimensional Weight, Estimated Cost, Estimated Dropship Fee, Estimated Shipping Cost, GTIN, Height, Image, Length, List Price, MAP, MPN, MSRP, Master SKU, Option, Quantity, SKU, Title, UPC, Weight, Width.
Complete Field Mappings Below is a list of fields you can enable for publishing to BigCommerce:
Name: The product name (required).
- Example: “Luxury Toy Set”
- Suggested Action: Enable and sync to Listing Parent’s “Title.”
SKU: The parent SKU of the product.
- Example: “TOY-001”
- Suggested Action: Enable and sync to Listing Parent’s “Parent SKU.”
UPC: Universal Product Code.
- Example: “123456789012”
- Suggested Action: Enable and sync to Listing Variant’s “UPC.”
Retail Price: The MSRP of the product.
- Example: “24.99”
- Suggested Action: Enable and sync to Listing Variant’s “MSRP.”
Sale Price: The discounted price of the product.
- Example: “19.99”
- Suggested Action: Enable and sync to Listing Variant’s “List Price.”
Width: The width of the product in centimeters.
- Example: “12”
- Suggested Action: Enable and sync to Listing Variant’s “Width.”
Weight: The weight of the product in kilograms (required).
- Example: “2.5”
- Suggested Action: Enable and sync to Listing Variant’s “Weight.”
Categories: The product’s category (up to 3 levels).
- Example: “Toys > Educational > Building Sets”
- Suggested Action: Enable and sync to Listing Parent’s “Category 1,” “Category 2,” and “Category 3.”
Troubleshooting
If the integration encounters an issue, try these steps:
- Verify your BigCommerce connection (e.g., Store Hash and Flxpoint app installation).
- Ensure required fields (name, weight, type, price) are enabled and provided in your data.
- Check that titles and attributes are within the 250-character limit, or adjust the “Truncate Title To 250” and “Attribute Fields > 250 Characters” settings.
- Confirm images are under 8 MB and that variant counts don’t exceed 250.
- Verify API access to endpoints like
If problems persist, contact support for assistance.
v3/catalog/products and v3/catalog/categories, and ensure you haven’t hit BigCommerce’s API rate limits.
Conclusion
With the BigCommerce Publish Listings integration set up, you can efficiently create and update product listings on your BigCommerce store. From managing categories and brands to handling variants, images, and custom fields, this integration ensures your store’s catalog is accurate and ready for customers—all with the flexibility to customize which data is published!
Order Operations
Flxpoint imports orders from BigCommerce into your system, automating order processing, tracking updates, and inventory adjustments. This streamlines fulfillment and ensures efficient handling of BigCommerce transactions.
Get Orders
Supported | BigCommerce - Get Orders
Introduction to BigCommerce Get Orders Integration
This guide explains how to use the BigCommerce Get Orders integration to retrieve orders from your BigCommerce store and import them into your system. Whether you’re managing a few orders or a large volume, this integration simplifies the process by fetching order details, products, shipping addresses, and more. It also supports advanced features like multi-status imports, FFL details retrieval, and handling of digital items and gift certificates. Let’s explore how this works and how to set it up.
Purpose of This Integration
The BigCommerce Get Orders integration connects your system to your BigCommerce store to:
- Retrieve orders based on their status, including support for multiple statuses.
- Fetch associated products, shipping addresses, and FFL details (if enabled).
- Handle special cases like refunded items, gift certificates, and digital items.
This ensures your system stays up to date with the latest order data, helping you manage sales, fulfillment, and customer information efficiently.
How the Integration Works
The integration follows a structured process to retrieve orders from BigCommerce:
1. Fetching Orders: A GET request to
v2/orders retrieves orders, passing the status_id parameter to filter by status. Orders are fetched in batches of 50 for efficiency.
2. Fetching Products: For each order, a GET request to
v2/orders/{orderId}/products retrieves all products associated with the order, including details like SKU, quantity, and price.
3. Fetching Shipping Addresses: A GET request to
v2/orders/{orderId}/shipping_addresses retrieves shipping addresses. If multiple shipping addresses are enabled in the store, each order line item can have its own shipping address.
4. Importing FFL Details (Optional): If the “Import FFL details from BigCommerce via Automatic FFL app” setting is enabled, FFL details are retrieved from the Order Comments section of the BigCommerce order.
5. Mapping Data: A mapping template defines which BigCommerce order data (e.g., billing address, line items) is imported into your system’s fields.
6. Running the Integration: You can run the integration manually or schedule it to run automatically (e.g., daily or weekly).
Note: Orders are imported based on order status; payment information is ignored for filtering purposes.
Configuration Options
You can customize the integration to fit your needs:
- Import FFL Details from BigCommerce via Automatic FFL App: Enable this setting to retrieve FFL details from the Order Comments section of BigCommerce orders. When disabled, FFL details are not imported.
- Select Order Status: Choose one or more order statuses to import (e.g., Incomplete, Pending, Awaiting Payment). This supports multi-status imports for greater flexibility.
- Personal Identifying Information Retention: Set the retention period for PII on orders (e.g., Indefinitely, 30 days after shipment, 60 days after shipment, 90 days after shipment). After this period, PII is redacted.
- Get Orders Created Within the Last X Days: Specify the time range for fetching orders (default: 14 days). Only orders created within this period are imported.
- Scheduling: Run the integration manually or schedule it to run automatically (e.g., every day at 6 AM UTC).
Setup Instructions
Follow these steps to set up the BigCommerce Get Orders integration:
1. Add the Integration: In your system, go to the Channels section, select BigCommerce, and navigate to the Integrations tab. Choose the “Get Orders” operation to activate it.
2. Connect to BigCommerce: Select an existing BigCommerce connection (e.g., using OAuth2 authentication) or set up a new one by providing your Store Hash and installing the Flxpoint app in your BigCommerce store.
3. Configure Settings: Enable FFL details import if needed, select the order statuses to import, set the PII retention period, specify the time range for fetching orders, and enable scheduling if desired.
4. Create a Mapping Template: Enable the fields you want to import from BigCommerce into your system (details below).
5. Run the Integration: Start the integration manually or let it run on your chosen schedule.
Order & Payment Statuses
Orders are imported based on their status (e.g., Incomplete, Pending, Awaiting Payment). Payment information is ignored when filtering orders, allowing you to focus on order status for import criteria. The multi-status support feature lets you select multiple statuses to import, providing a more comprehensive view of your orders.
Order Acknowledgement
Once orders are imported into your system, you can acknowledge them as needed within Flxpoint. The integration ensures all relevant order details (e.g., products, shipping addresses) are available for processing and acknowledgment.
Order Receipt / Invoice (& Currency)
Currency is configured based on the store’s geographical location (e.g., as set in BigCommerce). To convert order totals to USD (or another currency), you can add currency conversion rules in the mapping template. Order receipt and invoice details, such as totals and taxes, are imported from fields like Total Inc Tax, Total Tax, and Subtotal Ex Tax.
Shipping Selection
BigCommerce provides a unique shipping method for each customer, which is retrieved via the
v2/orders/{orderId}/shipping_addresses endpoint. This can be enabled in the mapping template to align with your system’s shipping workflows.
Custom Fields
Custom fields from BigCommerce orders (e.g., customer notes, staff notes) can be enabled in the mapping template to import into your system. This ensures any additional order metadata is captured as needed.
PII Restrictions
Personally Identifiable Information (PII) is managed with the “Personal Identifying Information Retention” setting. You can choose to retain PII indefinitely or redact it after 30, 60, or 90 days post-shipment to comply with data privacy requirements.
Digital Items / Donations
The integration supports digital items and gift certificates on orders:
- Digital Items: Digital items are imported as part of the order line items, with their type identified (e.g., “digital”).
- Gift Certificates: Gift certificate items are imported with a generated SKU if not provided:
- If the product type is “giftcertificate” and no SKU is available, the SKU is generated as:
- If product name is available:
SKU = name + "-" + order item ID.
- If multiple gift certificates have the same name:
SKU = type + "-" + order item ID.
Weights & Dimensions (& Units)
Weights and dimensions for order line items are retrieved from BigCommerce (e.g., via the Weight field in line items). These are typically in the units configured in your BigCommerce store (e.g., kilograms for weight, centimeters for dimensions). Ensure these fields are enabled in the mapping template to align with your system’s requirements.
Limitations
The following limitations apply:
- If an SKU is not available for an order line item, the order will not be saved in Flxpoint.
- BigCommerce supports multiple shipping addresses on a single order. If this setting is enabled in your store, the integration will save a shipping address for each order line item.
Mapping Template Details
A mapping template determines which data fields from BigCommerce orders are imported into your system. For example, you can enable importing BigCommerce’s “Street Address 1” into your system’s billing address field. Below are the details:
Interface Overview
- The mapping screen is labeled “Get Orders” at the top. You can name your template (e.g., “Get Orders 1”).
- Buttons available: Cancel and Save Mapping.
- Sections include mappings for:
- Billing Address: Fields like Street Address 1, City, State, State Code.
- Shipping Address: Fields like Shipping Method, Country, State.
- Line Items: Fields like SKU, Quantity, Price Ex Tax, Quantity Shipped.
- Order Details: Fields like Order ID, Date Created, Total Inc Tax, Customer Message.
Mapping Options You can toggle each field to enable or disable importing:
- Enabled: The field from BigCommerce will be imported into the corresponding field in your system.
- Disabled: The field will not be imported, and the corresponding field in your system will remain unchanged.
Available Source Fields BigCommerce provides fields under categories like “BigCommerce Billing Address,” “BigCommerce Shipping Address,” “BigCommerce Line Item,” and “BigCommerce Order,” including:
- BigCommerce Billing Address: City, Company, Country, Country Iso 2, Email, First Name, Last Name, Phone, State, State Code, Street Address 1, Street Address 2, Zip.
- BigCommerce Shipping Address: City, Company, Country, Country Iso 2, Email, First Name, Last Name, Phone, Shipping Method, State, Street Address 1, Street Address 2, Zip.
- BigCommerce Line Item: Base Cost Price, Base Price, Base Total, Base Wrapping Cost, Bin Picking Number, Brand, Cost Price Ex Tax, Cost Price Inc Tax, Cost Price Tax, Fixed Shipping Cost, Fulfillment Source, Id, Name, Price Ex Tax, Price Inc Tax, Price Tax, Quantity, Quantity Refunded, Quantity Shipped, Refund Amount, SKU, Total Ex Tax, Total Inc Tax, Total Tax, Type, UPC, Weight, Wrapping Cost Ex Tax, Wrapping Cost Inc Tax, Wrapping Cost Tax, Wrapping Message, Wrapping Name.
- BigCommerce Order: Base Handling Cost, Base Shipping Cost, Base Wrapping Cost, Coupon Discount, Currency Code, Currency Exchange Rate, Custom Status, Customer Locale, Customer Message, Date Created, Date Modified, Date Shipped, Default Currency Code, Discount Amount, Ebay Order Id, External Source, Geo IP Country, Geo IP Country Iso2, Gift Card Amount, Gift Certificate Amount, Handling Cost Ex Tax, Handling Cost Including Tax, Handling Cost Tax, Items Total, Order ID, Order Source, Payment Method, Payment Status, Refunded Amount, Shipping Address Count, Shipping Cost Ex Tax, Shipping Cost Including Tax, Shipping Cost Tax, Staff Notes, Status, Store Credit Amount, Store Default Currency Code, Store Default To Transactional Exchange Rate, Subtotal Ex Tax, Subtotal Including Tax, Subtotal Tax, Total Ex Tax, Total Incl. Tax, Total Tax, Wrapping Cost Ex Tax, Wrapping Cost Inc Tax, Wrapping Cost Tax.
Complete Field Mappings Below is a comprehensive list of fields you can enable for importing into your system:
Billing Address - City: The city in the billing address.
- Example: “San Francisco”
- Suggested Action: Enable to import into your system’s billing city field.
Billing Address - Company: The company name in the billing address.
- Example: “TechCorp Inc.”
- Suggested Action: Enable to import into your system’s billing company field.
Billing Address - Country: The country in the billing address.
- Example: “United States”
- Suggested Action: Enable to import into your system’s billing country field.
Billing Address - Country Iso 2: The 2-letter country code in the billing address.
- Example: “US”
- Suggested Action: Enable to import into your system’s billing country code field.
Billing Address - Email: The email address in the billing address.
- Example: “customer@example.com”
- Suggested Action: Enable to import into your system’s billing email field.
Billing Address - First Name: The first name in the billing address.
- Example: “John”
- Suggested Action: Enable to import into your system’s billing first name field.
Billing Address - Last Name: The last name in the billing address.
- Example: “Doe”
- Suggested Action: Enable to import into your system’s billing last name field.
Billing Address - Phone: The phone number in the billing address.
- Example: “555-123-4567”
- Suggested Action: Enable to import into your system’s billing phone field.
Billing Address - State: The state in the billing address.
- Example: “California”
- Suggested Action: Enable to import into your system’s billing state field.
Billing Address - State Code: The state code in the billing address (if applicable).
- Example: “CA”
- Suggested Action: Enable to import into your system’s billing state code field.
Billing Address - Street Address 1: The primary street address in the billing address.
- Example: “123 Main St”
- Suggested Action: Enable to import into your system’s billing street address field.
Billing Address - Street Address 2: The secondary street address in the billing address (e.g., apartment number).
- Example: “Apt 4B”
- Suggested Action: Enable to import into your system’s billing street address 2 field.
Billing Address - Zip: The ZIP code in the billing address.
- Example: “94105”
- Suggested Action: Enable to import into your system’s billing ZIP code field.
Shipping Address - City: The city in the shipping address.
- Example: “Los Angeles”
- Suggested Action: Enable to import into your system’s shipping city field.
Shipping Address - Company: The company name in the shipping address.
- Example: “TechCorp Inc.”
- Suggested Action: Enable to import into your system’s shipping company field.
Shipping Address - Country: The country in the shipping address.
- Example: “United States”
- Suggested Action: Enable to import into your system’s shipping country field.
Shipping Address - Country Iso 2: The 2-letter country code in the shipping address.
- Example: “US”
- Suggested Action: Enable to import into your system’s shipping country code field.
Shipping Address - Email: The email address in the shipping address.
- Example: “customer@example.com”
- Suggested Action: Enable to import into your system’s shipping email field.
Shipping Address - First Name: The first name in the shipping address.
- Example: “Jane”
- Suggested Action: Enable to import into your system’s shipping first name field.
Shipping Address - Last Name: The last name in the shipping address.
- Example: “Smith”
- Suggested Action: Enable to import into your system’s shipping last name field.
Shipping Address - Phone: The phone number in the shipping address.
- Example: “555-987-6543”
- Suggested Action: Enable to import into your system’s shipping phone field.
Shipping Address - Shipping Method: The shipping method for the order.
- Example: “Standard Shipping”
- Suggested Action: Enable to import into your system’s shipping method field.
Shipping Address - State: The state in the shipping address.
- Example: “California”
- Suggested Action: Enable to import into your system’s shipping state field.
Shipping Address - Street Address 1: The primary street address in the shipping address.
- Example: “456 Oak St”
- Suggested Action: Enable to import into your system’s shipping street address field.
Shipping Address - Street Address 2: The secondary street address in the shipping address (e.g., apartment number).
- Example: “Suite 200”
- Suggested Action: Enable to import into your system’s shipping street address 2 field.
Shipping Address - Zip: The ZIP code in the shipping address.
- Example: “90001”
- Suggested Action: Enable to import into your system’s shipping ZIP code field.
Line Item - Base Cost Price: The base cost price of the item (excluding tax).
- Example: “10.00”
- Suggested Action: Enable to import into your system’s line item cost price field.
Line Item - Base Price: The base price of the item (excluding tax).
- Example: “20.00”
- Suggested Action: Enable to import into your system’s line item base price field.
Line Item - Base Total: The base total cost of the item (excluding tax).
- Example: “40.00”
- Suggested Action: Enable to import into your system’s line item base total field.
Line Item - Base Wrapping Cost: The base cost of gift wrapping for the item (excluding tax).
- Example: “2.00”
- Suggested Action: Enable to import into your system’s line item wrapping cost field.
Line Item - Bin Picking Number: The bin picking number for the item.
- Example: “BIN-123”
- Suggested Action: Enable to import into your system’s line item bin picking number field.
Line Item - Brand: The brand of the item.
- Example: “Acme”
- Suggested Action: Enable to import into your system’s line item brand field.
Line Item - Cost Price Ex Tax: The cost price of the item excluding tax.
- Example: “10.00”
- Suggested Action: Enable to import into your system’s line item cost price ex tax field.
Line Item - Cost Price Inc Tax: The cost price of the item including tax.
- Example: “10.80”
- Suggested Action: Enable to import into your system’s line item cost price inc tax field.
Line Item - Cost Price Tax: The tax amount on the cost price of the item.
- Example: “0.80”
- Suggested Action: Enable to import into your system’s line item cost price tax field.
Line Item - Fixed Shipping Cost: The fixed shipping cost for the item.
- Example: “5.00”
- Suggested Action: Enable to import into your system’s line item fixed shipping cost field.
Line Item - Fulfillment Source: The source of fulfillment for the item.
- Example: “Warehouse A”
- Suggested Action: Enable to import into your system’s line item fulfillment source field.
Line Item - Id: The unique ID of the line item.
- Example: “1”
- Suggested Action: Enable to import into your system’s line item ID field.
Line Item - Name: The name of the item.
- Example: “Blue Widget”
- Suggested Action: Enable to import into your system’s line item name field.
Line Item - Price Ex Tax: The price of the item excluding tax.
- Example: “20.00”
- Suggested Action: Enable to import into your system’s line item price ex tax field.
Line Item - Price Inc Tax: The price of the item including tax.
- Example: “21.60”
- Suggested Action: Enable to import into your system’s line item price inc tax field.
Line Item - Price Tax: The tax amount on the price of the item.
- Example: “1.60”
- Suggested Action: Enable to import into your system’s line item price tax field.
Line Item - Quantity: The quantity ordered (excluding refunded quantities).
- Example: “2”
- Suggested Action: Enable to import into your system’s line item quantity field.
Line Item - Quantity Refunded: The quantity of the item that has been refunded.
- Example: “1”
- Suggested Action: Enable to import into your system’s line item quantity refunded field.
Line Item - Quantity Shipped: The quantity of the item that has been shipped.
- Example: “1”
- Suggested Action: Enable to import into your system’s line item quantity shipped field.
Line Item - Refund Amount: The amount refunded for the item.
- Example: “20.00”
- Suggested Action: Enable to import into your system’s line item refund amount field.
Line Item - SKU: The SKU of the ordered product.
- Example: “PROD-001”
- Suggested Action: Enable to import into your system’s line item SKU field.
Line Item - Total Ex Tax: The total cost of the item excluding tax.
- Example: “40.00”
- Suggested Action: Enable to import into your system’s line item total ex tax field.
Line Item - Total Inc Tax: The total cost of the item including tax.
- Example: “43.20”
- Suggested Action: Enable to import into your system’s line item total inc tax field.
Line Item - Total Tax: The total tax amount for the item.
- Example: “3.20”
- Suggested Action: Enable to import into your system’s line item total tax field.
Line Item - Type: The type of the item (e.g., physical, digital, giftcertificate).
- Example: “physical”
- Suggested Action: Enable to import into your system’s line item type field.
Line Item - UPC: The UPC of the item.
- Example: “012345678905”
- Suggested Action: Enable to import into your system’s line item UPC field.
Line Item - Weight: The weight of the item.
- Example: “1.5”
- Suggested Action: Enable to import into your system’s line item weight field. Ensure unit alignment (e.g., kilograms).
Line Item - Wrapping Cost Ex Tax: The cost of gift wrapping for the item excluding tax.
- Example: “2.00”
- Suggested Action: Enable to import into your system’s line item wrapping cost ex tax field.
Line Item - Wrapping Cost Inc Tax: The cost of gift wrapping for the item including tax.
- Example: “2.16”
- Suggested Action: Enable to import into your system’s line item wrapping cost inc tax field.
Line Item - Wrapping Cost Tax: The tax amount on the gift wrapping cost.
- Example: “0.16”
- Suggested Action: Enable to import into your system’s line item wrapping cost tax field.
Line Item - Wrapping Message: The gift wrapping message for the item.
- Example: “Happy Birthday!”
- Suggested Action: Enable to import into your system’s line item wrapping message field.
Line Item - Wrapping Name: The name of the gift wrapping option.
- Example: “Festive Wrap”
- Suggested Action: Enable to import into your system’s line item wrapping name field.
Order - Base Handling Cost: The base handling cost for the order (excluding tax).
- Example: “3.00”
- Suggested Action: Enable to import into your system’s order base handling cost field.
Order - Base Shipping Cost: The base shipping cost for the order (excluding tax).
- Example: “5.00”
- Suggested Action: Enable to import into your system’s order base shipping cost field.
Order - Base Wrapping Cost: The base wrapping cost for the order (excluding tax).
- Example: “2.00”
- Suggested Action: Enable to import into your system’s order base wrapping cost field.
Order - Coupon Discount: The total coupon discount applied to the order.
- Example: “10.00”
- Suggested Action: Enable to import into your system’s order coupon discount field.
Order - Currency Code: The currency code of the order.
- Example: “USD”
- Suggested Action: Enable to import into your system’s order currency code field.
Order - Currency Exchange Rate: The exchange rate used for the order’s currency.
- Example: “1.0”
- Suggested Action: Enable to import into your system’s order currency exchange rate field.
Order - Custom Status: A custom status for the order.
- Example: “Custom Processing”
- Suggested Action: Enable to import into your system’s order custom status field.
Order - Customer Locale: The locale of the customer (e.g., language/region).
- Example: “en-US”
- Suggested Action: Enable to import into your system’s order customer locale field.
Order - Customer Message: A message from the customer included with the order.
- Example: “Please ship quickly!”
- Suggested Action: Enable to import into your system’s order customer message field.
Order - Date Created: The date the order was created.
- Example: “2025-04-07T10:00:00Z”
- Suggested Action: Enable to import into your system’s order date created field.
Order - Date Modified: The date the order was last modified.
- Example: “2025-04-07T12:00:00Z”
- Suggested Action: Enable to import into your system’s order date modified field.
Order - Date Shipped: The date the order was shipped.
- Example: “2025-04-08T09:00:00Z”
- Suggested Action: Enable to import into your system’s order date shipped field.
Order - Default Currency Code: The default currency code of the store.
- Example: “USD”
- Suggested Action: Enable to import into your system’s order default currency code field.
Order - Discount Amount: The total discount amount applied to the order.
- Example: “5.00”
- Suggested Action: Enable to import into your system’s order discount amount field.
Order - Ebay Order Id: The eBay order ID if the order originated from eBay.
- Example: “EBAY-12345”
- Suggested Action: Enable to import into your system’s order eBay order ID field.
Order - External Source: The external source of the order (e.g., marketplace).
- Example: “eBay”
- Suggested Action: Enable to import into your system’s order external source field.
Order - Geo IP Country: The country of the customer’s IP address.
- Example: “United States”
- Suggested Action: Enable to import into your system’s order geo IP country field.
Order - Geo IP Country Iso2: The 2-letter country code of the customer’s IP address.
- Example: “US”
- Suggested Action: Enable to import into your system’s order geo IP country code field.
Order - Gift Card Amount: The amount paid using a gift card.
- Example: “25.00”
- Suggested Action: Enable to import into your system’s order gift card amount field.
Order - Gift Certificate Amount: The amount paid using a gift certificate.
- Example: “10.00”
- Suggested Action: Enable to import into your system’s order gift certificate amount field.
Order - Handling Cost Ex Tax: The handling cost for the order excluding tax.
- Example: “3.00”
- Suggested Action: Enable to import into your system’s order handling cost ex tax field.
Order - Handling Cost Including Tax: The handling cost for the order including tax.
- Example: “3.24”
- Suggested Action: Enable to import into your system’s order handling cost inc tax field.
Order - Handling Cost Tax: The tax amount on the handling cost.
- Example: “0.24”
- Suggested Action: Enable to import into your system’s order handling cost tax field.
Order - Items Total: The total number of items in the order.
- Example: “3”
- Suggested Action: Enable to import into your system’s order items total field.
Order - Order ID: The unique ID of the order.
- Example: “12345”
- Suggested Action: Enable to import into your system’s order ID field.
Order - Order Source: The source of the order (e.g., direct, marketplace).
- Example: “manual”
- Suggested Action: Enable to import into your system’s order source field.
Order - Payment Method: The payment method used for the order.
- Example: “Credit Card”
- Suggested Action: Enable to import into your system’s order payment method field.
Order - Payment Status: The payment status of the order.
- Example: “paid”
- Suggested Action: Enable to import into your system’s order payment status field.
Order - Refunded Amount: The total amount refunded for the order.
- Example: “20.00”
- Suggested Action: Enable to import into your system’s order refunded amount field.
Order - Shipping Address Count: The number of shipping addresses for the order.
- Example: “1”
- Suggested Action: Enable to import into your system’s order shipping address count field.
Order - Shipping Cost Ex Tax: The shipping cost for the order excluding tax.
- Example: “5.00”
- Suggested Action: Enable to import into your system’s order shipping cost ex tax field.
Order - Shipping Cost Including Tax: The shipping cost for the order including tax.
- Example: “5.40”
- Suggested Action: Enable to import into your system’s order shipping cost inc tax field.
Order - Shipping Cost Tax: The tax amount on the shipping cost.
- Example: “0.40”
- Suggested Action: Enable to import into your system’s order shipping cost tax field.
Order - Staff Notes: Notes added by staff for the order.
- Example: “Customer requested expedited shipping.”
- Suggested Action: Enable to import into your system’s order staff notes field.
Order - Status: The status of the order.
- Example: “Awaiting Payment”
- Suggested Action: Enable to import into your system’s order status field.
Order - Store Credit Amount: The amount paid using store credit.
- Example: “15.00”
- Suggested Action: Enable to import into your system’s order store credit amount field.
Order - Store Default Currency Code: The default currency code of the store.
- Example: “USD”
- Suggested Action: Enable to import into your system’s order store default currency code field.
Order - Store Default To Transactional Exchange Rate: The exchange rate between the store’s default and transactional currency.
- Example: “1.0”
- Suggested Action: Enable to import into your system’s order exchange rate field.
Order - Subtotal Ex Tax: The subtotal of the order excluding tax.
- Example: “90.00”
- Suggested Action: Enable to import into your system’s order subtotal ex tax field.
Order - Subtotal Including Tax: The subtotal of the order including tax.
- Example: “97.20”
- Suggested Action: Enable to import into your system’s order subtotal inc tax field.
Order - Subtotal Tax: The tax amount on the subtotal.
- Example: “7.20”
- Suggested Action: Enable to import into your system’s order subtotal tax field.
Order - Total Ex Tax: The total order amount excluding tax.
- Example: “95.00”
- Suggested Action: Enable to import into your system’s order total ex tax field.
Order - Total Incl. Tax: The total order amount including tax.
- Example: “102.60”
- Suggested Action: Enable to import into your system’s order total inc tax field. Add currency conversion rules if needed (e.g., to USD).
Order - Total Tax: The total tax amount for the order.
- Example: “7.60”
- Suggested Action: Enable to import into your system’s order total tax field.
Order - Wrapping Cost Ex Tax: The wrapping cost for the order excluding tax.
- Example: “2.00”
- Suggested Action: Enable to import into your system’s order wrapping cost ex tax field.
Order - Wrapping Cost Inc Tax: The wrapping cost for the order including tax.
- Example: “2.16”
- Suggested Action: Enable to import into your system’s order wrapping cost inc tax field.
Order - Wrapping Cost Tax: The tax amount on the wrapping cost for the order.
- Example: “0.16”
- Suggested Action: Enable to import into your system’s order wrapping cost tax field.
Troubleshooting
If the integration encounters an issue, try these steps:
- Verify Connection: Ensure your BigCommerce connection (e.g., Store Hash and Flxpoint app installation) is active and OAuth2 credentials are valid.
- Check API Access: Confirm access to endpoints like
v2/orders, v2/orders/{orderId}/products, and v2/orders/{orderId}/shipping_addresses. Ensure you haven’t hit BigCommerce’s API rate limits.
- SKU Issues: If an order fails to save due to a missing SKU, verify the order line item in BigCommerce. For gift certificates, ensure the SKU is generated correctly:
- If product type is “giftcertificate” and no SKU is available:
- If product name is available: SKU should be
name + "-" + order item ID.
- If multiple gift certificates have the same name: SKU should be
type + "-" + order item ID.
- Refunded Items: Refunded items are downloaded into Flxpoint. Ensure the line item quantity and quantity refunded fields are enabled in the mapping template to calculate the effective quantity.
- FFL Details: If FFL details are not importing, confirm the “Import FFL details from BigCommerce via Automatic FFL app” setting is enabled and that the details exist in the Order Comments section of the BigCommerce order.
- Multiple Shipping Addresses: If multiple shipping addresses are enabled in your store but not reflected in Flxpoint, ensure the “BigCommerce Shipping Address” fields are enabled in the mapping template for each line item.
If problems persist, contact support for assistance.
Conclusion
With the BigCommerce Get Orders integration configured, you can seamlessly retrieve orders from your BigCommerce store into your system. The integration’s support for multi-status imports, FFL details, digital items, and gift certificates ensures you have the flexibility to manage diverse order types. By customizing the mapping template and settings, you can align the integration with your business workflows, making order management more efficient and accurate!
Sync Orders
Supported | BigCommerce - Sync Orders
Introduction to BigCommerce Sync Orders Integration
This guide explains how to use the BigCommerce Sync Orders integration to manage order synchronization and shipment updates with your BigCommerce store. This integration allows you to sync order data, update shipment details (e.g., tracking numbers, shipping providers), and ensure accurate order statuses in your store. It leverages the BigCommerce v2 API for all order operations, ensuring seamless communication between your system and BigCommerce. Let’s dive into how this works and how to set it up.
Purpose of This Integration
The BigCommerce Sync Orders integration connects your system to your BigCommerce store to:
- Sync order data and update shipment details, such as tracking numbers and shipping providers.
- Use the BigCommerce v2 API to perform order operations, including creating shipments via POST requests to
v2/orders/{order_id}/shipments.
- Automatically update order statuses (e.g., "Partially Shipped" or "Shipped") based on shipment progress.
- Ensure BigCommerce automatically notifies customers of shipment updates if store notifications are enabled.
This integration helps you streamline order fulfillment and keep your BigCommerce store in sync with your system’s shipment data.
How the Integration Works
The integration follows a structured process to sync orders and update shipments in your BigCommerce store:
1. Connecting to BigCommerce: Establish a connection using OAuth2 authentication to access your BigCommerce store.
2. Syncing Orders: Orders are synchronized between your system and BigCommerce, ensuring both platforms have up-to-date order data.
3. Updating Shipments: Shipment details (e.g., tracking number, shipping provider) are sent to BigCommerce using a POST request to the
v2/orders/{order_id}/shipments endpoint.
4. Partial Shipments: For partial order shipments, the order status is updated to "Partially Shipped." Once all items are shipped, the status changes to "Shipped."
5. Customer Notifications: BigCommerce automatically sends a shipment email to the customer if the store’s notifications are enabled. This integration does not interact with the "Notify Customer" flag.
6. Mapping Data: A mapping template defines which shipment fields from your system (e.g., Tracking Number, Shipping Method) are synced to BigCommerce shipment fields.
Note: Ensure the shipping provider used in your system matches one available in your BigCommerce store to avoid errors.
Configuration Options
You can customize the integration to fit your workflow:
- Shipping Provider Handling: Send the shipping provider as null if the provider isn’t enabled in your BigCommerce store to avoid errors.
- Partial Shipment Updates: Enable partial shipment updates to mark orders as "Partially Shipped" until fully shipped.
- Mapping Template: Define which shipment fields from your system are synced to BigCommerce shipment fields.
- Scheduling: Run the integration manually or schedule it to run automatically (e.g., daily at 6 AM UTC).
Setup Instructions
Follow these steps to set up the BigCommerce Sync Orders integration:
1. Add the Integration: In your system, go to the Channels section, select BigCommerce, and navigate to the Integrations tab. Choose the "Sync Orders" operation to activate it.
2. Connect to BigCommerce: Select an existing BigCommerce connection (e.g., using OAuth2 authentication) or set up a new one by providing your Store Hash and installing the Flexport app in your BigCommerce store.
3. Configure Settings: Set up any necessary configurations, such as handling for shipping providers (e.g., send as null if unavailable) and scheduling options.
4. Create a Mapping Template: Enable the shipment fields you want to sync from your system to BigCommerce (details below).
5. Run the Integration: Start the integration manually or let it run on your chosen schedule.
Standard Account Shipping Provider Setup
Ensure that your order shipments are synchronized correctly by configuring the shipping provider directly in your BigCommerce store:
- Access Your BigCommerce Settings: Log into your BigCommerce admin panel and navigate to the Shipping Settings.
- Verify or Add Your Shipping Provider: Confirm that the appropriate shipping provider (e.g., “U.P.S.”) is configured in your store.
- Internal Note: In rare instances where additional troubleshooting is needed, our support team may temporarily switch your account to Pro to apply an advanced rule and then revert it back to Standard. This process is managed internally and requires no action on your part.
Partial Order Shipments
The integration supports partial order shipments:
- When a partial shipment is uploaded, the order status in BigCommerce is updated to "Partially Shipped."
- Once all items in the order are shipped, the status is updated to "Shipped."
Partial Order Item Shipments
For individual items within an order:
- You can ship items incrementally, and the integration will update the order status accordingly.
- The integration tracks which items have been shipped and updates the overall order status as needed.
Post Shipment Status Updates
After a shipment is updated:
- Partial shipments are marked as "Partially Shipped" in BigCommerce.
- Once the complete shipment is uploaded, the order is marked as "Shipped."
Manual Order Item Limitations
When manually updating order items:
- Ensure all shipment details (e.g., tracking number, shipping provider) are provided to avoid errors.
- Manual updates may not trigger automatic customer notifications unless configured in BigCommerce.
Platform “Notify Customer” Flow
The integration does not directly interact with the "Notify Customer" flag in BigCommerce:
- If a shipment is updated and your store’s notifications are enabled, BigCommerce will automatically send a shipment email to the end user.
- You can verify this behavior in your BigCommerce store settings under notifications.
Mapping Template Details
A mapping template determines which shipment data fields from your system are synced to BigCommerce. For example, you can enable syncing for your system’s “Tracking Number” field to update BigCommerce’s “Tracking Number” field. Below are the details:
Interface Overview
- The mapping screen is labeled “Sync Orders” at the top. You can name your template (e.g., “Sync Orders 1”).
- Buttons available: Cancel and Save Mapping.
- Two sections:
- From Value: Fields from your system (e.g., Shipment fields like Tracking Number, Shipping Method).
- To BigCommerce Shipment Field: Fields in BigCommerce (e.g., Tracking Number, Shipping Method).
Mapping Options
You can toggle each field to enable or disable syncing:
- Enabled: The field from your system will be synced to the corresponding BigCommerce field.
- Disabled: The field will not be synced, and the corresponding BigCommerce field will remain unchanged.
Available Source Fields
Your system provides fields under categories like “Shipment,” including:
- Shipment: Carrier, Fulfillment Request Number, Method, Note, Shipped At, Shipping Cost, Tracking Number, Tracking URL.
Complete Field Mappings
Below is a list of fields you can enable for syncing to BigCommerce:
Comments: Additional notes about the shipment.
- Suggested Action: Enable to sync to Shipment’s “Note.”
Date Created: The date the shipment was created.
- Suggested Action: Enable to sync to Shipment’s “Shipped At.”
Merchant Shipping Cost: The shipping cost for the merchant.
- Suggested Action: Enable to sync to Shipment’s “Shipping Cost.”
Shipping Method: The method used for shipping.
- Suggested Action: Enable to sync to Shipment’s “Method.”
Shipping Provider: The carrier used for shipping.
- Suggested Action: Enable to sync to Shipment’s “Carrier,” or disable if the provider isn’t enabled in your store to send as null.
Tracking Link: The URL for tracking the shipment.
- Suggested Action: Enable to sync to Shipment’s “Tracking URL.”
Tracking Number: The tracking number for the shipment.
- Suggested Action: Enable to sync to Shipment’s “Tracking Number.”
Tracking Carrier: The carrier associated with the tracking number.
- Suggested Action: Enable to sync to Shipment’s “Carrier.”
- Accepted Carrier Values: For a list of accepted carrier values, please refer to the Accepted Carrier Values CSV.
Troubleshooting
If the integration encounters an issue, try these steps:
- The field 'shipping_provider' is invalid: Ensure the shipping provider is available in your BigCommerce store. If the provider isn’t enabled, disable the “Shipping Provider” field in the mapping template to send as null and update tracking on the store.
- Verify your BigCommerce connection (e.g., OAuth2 authentication and Store Hash).
- Ensure the
v2/orders/{order_id}/shipments endpoint is accessible and the order ID is correct.
- Check your mapping template to ensure the necessary fields are enabled (e.g., “Tracking Number”).
- Confirm you haven’t hit BigCommerce’s API rate limits.
If problems persist, contact support for assistance.
Conclusion
With the BigCommerce Sync Orders integration configured, your system will keep your BigCommerce store updated with the latest order and shipment data. You’ll be able to manage partial shipments, update tracking information, and ensure customers are notified automatically—all while maintaining accurate order statuses with minimal manual effort!