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
Important Note: Ensure your BigCommerce store is fully set up before connecting.
The recommended connection method is BigCommerce API App (OAuth2). Use the API Bearer Token method only if OAuth2 is not suitable for your setup.
Verify that your BigCommerce store has the necessary API access enabled in the store settings.
If using the Bearer Token method, double-check your API credentials (Client ID, Client Secret, and Access Token) to avoid connection issues.
Many steps in this setup process can be skipped and configured later from the channel settings if needed.
Step 1: Log in to your Flxpoint account and navigate to Sales Channels.
Step 2: Click Create Channel (or Add Channel) and select BigCommerce from the channel list.
Step 3: In the Configure Integration Type screen, choose the processes you want to enable:
Sync Listings
Publish Listings
Get Orders
Sync Orders
Enter a Channel Name (e.g., "BigCommerce"), then click Save & Next.
Step 4: On the Connect Channel screen, set up a new BigCommerce connection:
Select your preferred connection type. We recommend BigCommerce API App (OAuth2) for most users.
For OAuth2: Enter your Store Hash and click Initiate OAuth2 Flow to log in to your BigCommerce account and grant access to Flxpoint.
For Bearer Token (if OAuth2 is not suitable): Enter your Store Hash, Client ID, and Access Token from BigCommerce.
Click Save Connection and optionally Test Connection to verify the setup.
Step 5: In the Confirm Integrations screen, verify your selected processes (e.g., Sync Listings, Publish Listings, Get Orders, Sync Orders) and the BigCommerce connection. Check the box to acknowledge the information is correct, then click Save & Next.
Step 6: In the Pricing & Quantity screen, create rules to set pricing and/or quantity for your listings:
Click Add Rule to create a new pricing or quantity rule if needed.
If no rules are needed, you can skip this step by clicking Skip and configure it later from the channel settings.
Click Save & Next to proceed.
Step 7: In the Link Listings: Settings screen, manage how to connect your listings in Flxpoint to those already listed on BigCommerce:
Choose whether to use default settings: Yes, Use Default or No, Customize.
Under Link After Building Listings, decide if Flxpoint should automatically attempt to link listings to existing ones on the channel after building (default is No).
You can skip this step by clicking Skip and configure it later from the channel settings.
Click Save & Next to proceed.
Step 8: In the Sync Listings: Settings screen, configure the price, quantity, and/or status of listings on your BigCommerce channel:
Set the Linking Priority (e.g., Listing Variant SKU) to determine how Flxpoint matches listings (options include GTIN, MPN, SKU, UPC, etc.).
Select a Mapping Template (e.g., "Sync Listings 1") or create a new one if needed.
You can skip this step by clicking Skip and configure it later from the channel settings.
Click Save & Next to proceed.
Step 9: In the Get Orders: Settings screen, configure how to import orders and customer invoices from your BigCommerce channel:
Under Import FFL Details from BigCommerce via Automatic FFL App, choose Yes or No.
Select the Order Status to import (e.g., Incomplete, Pending, Awaiting Payment, Awaiting Pickup, Awaiting Shipment, Awaiting Fulfillment, Partially Refunded).
In Advanced Settings, set the Personal Identifying Information Retention (e.g., Indefinitely) and specify how far back to fetch orders with Get Orders Created Within the Last X Days (e.g., 14 days).
Select a Mapping Template (e.g., "Get Orders 4") or create a new one if needed.
You can skip this step by clicking Skip and configure it later from the channel settings.
Click Save & Next to proceed.
Step 10: In the Automate Integrations screen, schedule how often integrations should run:
For Sync Listings, choose Yes to schedule automatic syncing of price, quantity, and/or status changes to existing listings.
For Publish Listings, choose Yes to schedule automatic publishing of new listings or overwriting existing ones.
For Get Orders, choose Yes to schedule automatic importing of orders into Flxpoint.
For Sync Orders, choose Yes to schedule automatic syncing of tracking updates to orders on your channel.
You can skip this step by clicking Skip and configure it later from the channel settings.
Click Save & Next to proceed.
Step 11: Complete the remaining setup steps as needed:
In Publish Settings, configure settings for publishing listings if selected in Step 3.
In Order Fulfillment, set up order settings and shipping mappings.
In Advanced Workflows, configure custom automation for listing statuses or order handling.
In Listing Status, set up rules for managing listing statuses.
In Invoicing, configure invoice adjustments if needed.
These steps can be skipped by clicking Skip and configured later from the channel settings.
Click Save & Next to proceed through each step.
Final Step: Your BigCommerce channel is now set up! You can revisit it in Sales Channels to:
Start Import Listings to create and update listings and products in Flxpoint.
Start Get Orders to import new orders and send back acknowledgments.
Configure additional settings like Send Accounting Shipments, Publish Listings, Sync Orders, and Sync Listings as needed.
Adjust any skipped steps (e.g., Pricing & Quantity, Link Settings, Sync Settings, Automate Integrations) from the channel settings.
×
Listing Operations
Flxpoint allows you to manage product listings on eBay by syncing inventory, updating product details, and controlling pricing and availability. This ensures accurate and real-time updates across your eBay 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, navigate to the Integrations section and select BigCommerce as the integration type. You can activate the Import Listings feature during the advanced setup process without using the channel wizard.
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, GTIN). 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 how 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, GTIN) 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 how fields from your system map to BigCommerce fields for syncing (e.g., mapping your system’s “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, navigate to the Integrations section, select BigCommerce as the integration type, and choose the “Sync Listings” operation.
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: Define how fields from your system map to BigCommerce fields (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 defines how data from your system is synced to BigCommerce. For example, you can map your system’s “Quantity” field to 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: Delete, Duplicate, and Save.
- 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 choose from the following options for each field:
- Don’t Map: Ignore the field entirely.
- Set To Empty: Clear any existing data in that field.
- Field: Map a field from your system (e.g., Listing Variant’s “Quantity”) to a BigCommerce field.
- Value: Set a constant value for all products.
- Mapping Set: Apply a predefined transformation or mapping table.
- Rules: Use conditional logic to modify fields based on specific criteria (more advanced).
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 sample list of fields you can map to BigCommerce:
Availability Description: Describes the product’s availability status.
- Suggested Mapping: Don’t Map (default) or map to a custom field if needed.
Cost Price: The cost price of the variant.
- Example: “10.50”
- Suggested Mapping: Map to Listing Variant’s “Estimated Cost” using Field.
Inventory Level: The stock quantity of the variant.
- Example: “100”
- Suggested Mapping: Map to Listing Variant’s “Quantity” using Field.
Map Price: The minimum advertised price.
- Example: “15.99”
- Suggested Mapping: Map to Listing Variant’s “MAP” using Field.
Price: The selling price of the variant.
- Example: “19.99”
- Suggested Mapping: Map to Listing Variant’s “List Price” using Field.
Retail Price: The MSRP of the variant.
- Example: “24.99”
- Suggested Mapping: Map to Listing Variant’s “MSRP” using Field.
Sale Price: The discounted price of the variant.
- Example: “17.99”
- Suggested Mapping: Map to Listing Variant’s “List Price” using Field (or a custom sale price field if available).
Practice Mapping Here’s a quick example—if you map the “Price” field:
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 fields are correctly mapped (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 defines how your system’s fields (e.g., title, price) are mapped 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 new 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, navigate to the Integrations section, select BigCommerce as the integration type, and choose the “Publish Listings” operation.
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: Define how fields from your system map to BigCommerce fields (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 mapped 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 mapped 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 your system’s quantity field is mapped correctly 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 mapped to BigCommerce’s inventory fields 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 are mapped using fields like Category 1, Category 2, and Category 3 in the mapping template. 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 mapped to BigCommerce’s Description field. Ensure your system’s description field is mapped correctly in the mapping template 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 defines how data from your system is published to BigCommerce. For example, you can map your system’s “Title” field to 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: Delete, Duplicate, and Save.
- 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 choose from the following options for each field:
- Don’t Map: Ignore the field entirely (useful if your store’s structure is well-defined and you don’t want to overwrite existing data).
- Set To Empty: Clear any existing data in that field on BigCommerce.
- Field: Map a field from your system (e.g., Listing Parent’s “Title”) to a BigCommerce field.
- Value: Set a constant value for all products.
- Mapping Set: Apply a predefined transformation or mapping table.
- Rules: Use conditional logic to modify fields based on specific criteria (more advanced).
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 sample list of fields you can map to BigCommerce:
Name: The product name (required).
- Example: “Luxury Toy Set”
- Suggested Mapping: Map to Listing Parent’s “Title” using Field.
SKU: The parent SKU of the product.
- Example: “TOY-001”
- Suggested Mapping: Map to Listing Parent’s “Parent SKU” using Field.
UPC: Universal Product Code.
- Example: “123456789012”
- Suggested Mapping: Map to Listing Variant’s “UPC” using Field.
Retail Price: The MSRP of the product.
- Example: “24.99”
- Suggested Mapping: Map to Listing Variant’s “MSRP” using Field.
Sale Price: The discounted price of the product.
- Example: “19.99”
- Suggested Mapping: Map to Listing Variant’s “List Price” using Field.
Width: The width of the product in centimeters.
- Example: “12”
- Suggested Mapping: Map to Listing Variant’s “Width” using Field.
Weight: The weight of the product in kilograms (required).
- Example: “2.5”
- Suggested Mapping: Map to Listing Variant’s “Weight” using Field.
Categories: The product’s category (up to 3 levels).
- Example: “Toys > Educational > Building Sets”
- Suggested Mapping: Map to Listing Parent’s “Category 1,” “Category 2,” and “Category 3” using Field.
Practice Mapping Here’s a quick example—if you map the “Name” field:
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 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 how your data is published!
Order Operations
Flxpoint imports orders from eBay into your system, automating order processing, tracking updates, and inventory adjustments. This streamlines fulfillment and ensures efficient handling of eBay 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 how BigCommerce order data (e.g., billing address, line items) is mapped to 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, navigate to the Integrations section, select BigCommerce as the integration type, and choose the “Get Orders” operation.
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: Define how fields from BigCommerce (e.g., billing address, line items) map to your system’s fields (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 mapped in Flxpoint’s shipping management section to align with your system’s shipping workflows. Custom Fields
Custom fields from BigCommerce orders (e.g., customer notes, staff notes) can be mapped to your system using the mapping template. This ensures any additional order metadata is imported 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 your mapping template aligns these fields 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 defines how data from BigCommerce orders is imported into your system. For example, you can map BigCommerce’s “Street Address 1” to your system’s billing address field, or map order line item details like “Quantity” to track purchased items. 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: Delete, Duplicate, and Save.
- 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 choose from the following options for each field:
- Don’t Map: Ignore the field entirely.
- Set To Empty: Clear any existing data in that field in your system.
- Field: Map a field from BigCommerce (e.g., BigCommerce Billing Address’s “Street Address 1”) to a field in your system.
- Value: Set a constant value for all orders.
- Mapping Set: Apply a predefined transformation or mapping table.
- Rules: Use conditional logic to modify fields based on specific criteria (more advanced).
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 map to your system:
Billing Address - City: The city in the billing address.
- Example: “San Francisco”
- Suggested Mapping: Map to BigCommerce Billing Address’s “City” using Field.
Billing Address - Company: The company name in the billing address.
- Example: “TechCorp Inc.”
- Suggested Mapping: Map to BigCommerce Billing Address’s “Company” using Field.
Billing Address - Country: The country in the billing address.
- Example: “United States”
- Suggested Mapping: Map to BigCommerce Billing Address’s “Country” using Field.
Billing Address - Country Iso 2: The 2-letter country code in the billing address.
- Example: “US”
- Suggested Mapping: Map to BigCommerce Billing Address’s “Country Iso 2” using Field.
Billing Address - Email: The email address in the billing address.
- Example: “customer@example.com”
- Suggested Mapping: Map to BigCommerce Billing Address’s “Email” using Field.
Billing Address - First Name: The first name in the billing address.
- Example: “John”
- Suggested Mapping: Map to BigCommerce Billing Address’s “First Name” using Field.
Billing Address - Last Name: The last name in the billing address.
- Example: “Doe”
- Suggested Mapping: Map to BigCommerce Billing Address’s “Last Name” using Field.
Billing Address - Phone: The phone number in the billing address.
- Example: “555-123-4567”
- Suggested Mapping: Map to BigCommerce Billing Address’s “Phone” using Field.
Billing Address - State: The state in the billing address.
- Example: “California”
- Suggested Mapping: Map to BigCommerce Billing Address’s “State” using Field.
Billing Address - State Code: The state code in the billing address (if applicable).
- Example: “CA”
- Suggested Mapping: Map to BigCommerce Billing Address’s “State Code” using Field, or use a mapping set to convert state names to codes if needed.
Billing Address - Street Address 1: The primary street address in the billing address.
- Example: “123 Main St”
- Suggested Mapping: Map to BigCommerce Billing Address’s “Street Address 1” using Field.
Billing Address - Street Address 2: The secondary street address in the billing address (e.g., apartment number).
- Example: “Apt 4B”
- Suggested Mapping: Map to BigCommerce Billing Address’s “Street Address 2” using Field.
Billing Address - Zip: The ZIP code in the billing address.
- Example: “94105”
- Suggested Mapping: Map to BigCommerce Billing Address’s “Zip” using Field.
Shipping Address - City: The city in the shipping address.
- Example: “Los Angeles”
- Suggested Mapping: Map to BigCommerce Shipping Address’s “City” using Field.
Shipping Address - Company: The company name in the shipping address.
- Example: “TechCorp Inc.”
- Suggested Mapping: Map to BigCommerce Shipping Address’s “Company” using Field.
Shipping Address - Country: The country in the shipping address.
- Example: “United States”
- Suggested Mapping: Map to BigCommerce Shipping Address’s “Country” using Field.
Shipping Address - Country Iso 2: The 2-letter country code in the shipping address.
- Example: “US”
- Suggested Mapping: Map to BigCommerce Shipping Address’s “Country Iso 2” using Field.
Shipping Address - Email: The email address in the shipping address.
- Example: “customer@example.com”
- Suggested Mapping: Map to BigCommerce Shipping Address’s “Email” using Field.
Shipping Address - First Name: The first name in the shipping address.
- Example: “Jane”
- Suggested Mapping: Map to BigCommerce Shipping Address’s “First Name” using Field.
Shipping Address - Last Name: The last name in the shipping address.
- Example: “Smith”
- Suggested Mapping: Map to BigCommerce Shipping Address’s “Last Name” using Field.
Shipping Address - Phone: The phone number in the shipping address.
- Example: “555-987-6543”
- Suggested Mapping: Map to BigCommerce Shipping Address’s “Phone” using Field.
Shipping Address - Shipping Method: The shipping method for the order.
- Example: “Standard Shipping”
- Suggested Mapping: Map to BigCommerce Shipping Address’s “Shipping Method” using Field.
Shipping Address - State: The state in the shipping address.
- Example: “California”
- Suggested Mapping: Map to BigCommerce Shipping Address’s “State” using Field.
Shipping Address - Street Address 1: The primary street address in the shipping address.
- Example: “456 Oak St”
- Suggested Mapping: Map to BigCommerce Shipping Address’s “Street Address 1” using Field.
Shipping Address - Street Address 2: The secondary street address in the shipping address (e.g., apartment number).
- Example: “Suite 200”
- Suggested Mapping: Map to BigCommerce Shipping Address’s “Street Address 2” using Field.
Shipping Address - Zip: The ZIP code in the shipping address.
- Example: “90001”
- Suggested Mapping: Map to BigCommerce Shipping Address’s “Zip” using Field.
Line Item - Base Cost Price: The base cost price of the item (excluding tax).
- Example: “10.00”
- Suggested Mapping: Map to BigCommerce Line Item’s “Base Cost Price” using Field.
Line Item - Base Price: The base price of the item (excluding tax).
- Example: “20.00”
- Suggested Mapping: Map to BigCommerce Line Item’s “Base Price” using Field.
Line Item - Base Total: The base total cost of the item (excluding tax).
- Example: “40.00”
- Suggested Mapping: Map to BigCommerce Line Item’s “Base Total” using Field.
Line Item - Base Wrapping Cost: The base cost of gift wrapping for the item (excluding tax).
- Example: “2.00”
- Suggested Mapping: Map to BigCommerce Line Item’s “Base Wrapping Cost” using Field.
Line Item - Bin Picking Number: The bin picking number for the item.
- Example: “BIN-123”
- Suggested Mapping: Map to BigCommerce Line Item’s “Bin Picking Number” using Field.
Line Item - Brand: The brand of the item.
- Example: “Acme”
- Suggested Mapping: Map to BigCommerce Line Item’s “Brand” using Field.
Line Item - Cost Price Ex Tax: The cost price of the item excluding tax.
- Example: “10.00”
- Suggested Mapping: Map to BigCommerce Line Item’s “Cost Price Ex Tax” using Field.
Line Item - Cost Price Inc Tax: The cost price of the item including tax.
- Example: “10.80”
- Suggested Mapping: Map to BigCommerce Line Item’s “Cost Price Inc Tax” using Field.
Line Item - Cost Price Tax: The tax amount on the cost price of the item.
- Example: “0.80”
- Suggested Mapping: Map to BigCommerce Line Item’s “Cost Price Tax” using Field.
Line Item - Fixed Shipping Cost: The fixed shipping cost for the item.
- Example: “5.00”
- Suggested Mapping: Map to BigCommerce Line Item’s “Fixed Shipping Cost” using Field.
Line Item - Fulfillment Source: The source of fulfillment for the item.
- Example: “Warehouse A”
- Suggested Mapping: Map to BigCommerce Line Item’s “Fulfillment Source” using Field.
Line Item - Id: The unique ID of the line item.
- Example: “1”
- Suggested Mapping: Map to BigCommerce Line Item’s “Id” using Field.
Line Item - Name: The name of the item.
- Example: “Blue Widget”
- Suggested Mapping: Map to BigCommerce Line Item’s “Name” using Field.
Line Item - Price Ex Tax: The price of the item excluding tax.
- Example: “20.00”
- Suggested Mapping: Map to BigCommerce Line Item’s “Price Ex Tax” using Field.
Line Item - Price Inc Tax: The price of the item including tax.
- Example: “21.60”
- Suggested Mapping: Map to BigCommerce Line Item’s “Price Inc Tax” using Field.
Line Item - Price Tax: The tax amount on the price of the item.
- Example: “1.60”
- Suggested Mapping: Map to BigCommerce Line Item’s “Price Tax” using Field.
Line Item - Quantity: The quantity ordered (excluding refunded quantities).
- Example: “2”
- Suggested Mapping: Map to BigCommerce Line Item’s “Quantity” using Field.
Line Item - Quantity Refunded: The quantity of the item that has been refunded.
- Example: “1”
- Suggested Mapping: Map to BigCommerce Line Item’s “Quantity Refunded” using Field.
Line Item - Quantity Shipped: The quantity of the item that has been shipped.
- Example: “1”
- Suggested Mapping: Map to BigCommerce Line Item’s “Quantity Shipped” using Field.
Line Item - Refund Amount: The amount refunded for the item.
- Example: “20.00”
- Suggested Mapping: Map to BigCommerce Line Item’s “Refund Amount” using Field.
Line Item - SKU: The SKU of the ordered product.
- Example: “PROD-001”
- Suggested Mapping: Map to BigCommerce Line Item’s “SKU” using Field.
Line Item - Total Ex Tax: The total cost of the item excluding tax.
- Example: “40.00”
- Suggested Mapping: Map to BigCommerce Line Item’s “Total Ex Tax” using Field.
Line Item - Total Inc Tax: The total cost of the item including tax.
- Example: “43.20”
- Suggested Mapping: Map to BigCommerce Line Item’s “Total Inc Tax” using Field.
Line Item - Total Tax: The total tax amount for the item.
- Example: “3.20”
- Suggested Mapping: Map to BigCommerce Line Item’s “Total Tax” using Field.
Line Item - Type: The type of the item (e.g., physical, digital, giftcertificate).
- Example: “physical”
- Suggested Mapping: Map to BigCommerce Line Item’s “Type” using Field.
Line Item - UPC: The UPC of the item.
- Example: “012345678905”
- Suggested Mapping: Map to BigCommerce Line Item’s “UPC” using Field.
Line Item - Weight: The weight of the item.
- Example: “1.5”
- Suggested Mapping: Map to BigCommerce Line Item’s “Weight” using 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 Mapping: Map to BigCommerce Line Item’s “Wrapping Cost Ex Tax” using Field.
Line Item - Wrapping Cost Inc Tax: The cost of gift wrapping for the item including tax.
- Example: “2.16”
- Suggested Mapping: Map to BigCommerce Line Item’s “Wrapping Cost Inc Tax” using Field.
Line Item - Wrapping Cost Tax: The tax amount on the gift wrapping cost.
- Example: “0.16”
- Suggested Mapping: Map to BigCommerce Line Item’s “Wrapping Cost Tax” using Field.
Line Item - Wrapping Message: The gift wrapping message for the item.
- Example: “Happy Birthday!”
- Suggested Mapping: Map to BigCommerce Line Item’s “Wrapping Message” using Field.
Line Item - Wrapping Name: The name of the gift wrapping option.
- Example: “Festive Wrap”
- Suggested Mapping: Map to BigCommerce Line Item’s “Wrapping Name” using Field.
Order - Base Handling Cost: The base handling cost for the order (excluding tax).
- Example: “3.00”
- Suggested Mapping: Map to BigCommerce Order’s “Base Handling Cost” using Field.
Order - Base Shipping Cost: The base shipping cost for the order (excluding tax).
- Example: “5.00”
- Suggested Mapping: Map to BigCommerce Order’s “Base Shipping Cost” using Field.
Order - Base Wrapping Cost: The base wrapping cost for the order (excluding tax).
- Example: “2.00”
- Suggested Mapping: Map to BigCommerce Order’s “Base Wrapping Cost” using Field.
Order - Coupon Discount: The total coupon discount applied to the order.
- Example: “10.00”
- Suggested Mapping: Map to BigCommerce Order’s “Coupon Discount” using Field.
Order - Currency Code: The currency code of the order.
- Example: “USD”
- Suggested Mapping: Map to BigCommerce Order’s “Currency Code” using Field.
Order - Currency Exchange Rate: The exchange rate used for the order’s currency.
- Example: “1.0”
- Suggested Mapping: Map to BigCommerce Order’s “Currency Exchange Rate” using Field.
Order - Custom Status: A custom status for the order.
- Example: “Custom Processing”
- Suggested Mapping: Map to BigCommerce Order’s “Custom Status” using Field.
Order - Customer Locale: The locale of the customer (e.g., language/region).
- Example: “en-US”
- Suggested Mapping: Map to BigCommerce Order’s “Customer Locale” using Field.
Order - Customer Message: A message from the customer included with the order.
- Example: “Please ship quickly!”
- Suggested Mapping: Map to BigCommerce Order’s “Customer Message” using Field.
Order - Date Created: The date the order was created.
- Example: “2025-04-07T10:00:00Z”
- Suggested Mapping: Map to BigCommerce Order’s “Date Created” using Field.
Order - Date Modified: The date the order was last modified.
- Example: “2025-04-07T12:00:00Z”
- Suggested Mapping: Map to BigCommerce Order’s “Date Modified” using Field.
Order - Date Shipped: The date the order was shipped.
- Example: “2025-04-08T09:00:00Z”
- Suggested Mapping: Map to BigCommerce Order’s “Date Shipped” using Field.
Order - Default Currency Code: The default currency code of the store.
- Example: “USD”
- Suggested Mapping: Map to BigCommerce Order’s “Default Currency Code” using Field.
Order - Discount Amount: The total discount amount applied to the order.
- Example: “5.00”
- Suggested Mapping: Map to BigCommerce Order’s “Discount Amount” using Field.
Order - Ebay Order Id: The eBay order ID if the order originated from eBay.
- Example: “EBAY-12345”
- Suggested Mapping: Map to BigCommerce Order’s “Ebay Order Id” using Field.
Order - External Source: The external source of the order (e.g., marketplace).
- Example: “eBay”
- Suggested Mapping: Map to BigCommerce Order’s “External Source” using Field.
Order - Geo IP Country: The country of the customer’s IP address.
- Example: “United States”
- Suggested Mapping: Map to BigCommerce Order’s “Geo IP Country” using Field.
Order - Geo IP Country Iso2: The 2-letter country code of the customer’s IP address.
- Example: “US”
- Suggested Mapping: Map to BigCommerce Order’s “Geo IP Country Iso2” using Field.
Order - Gift Card Amount: The amount paid using a gift card.
- Example: “25.00”
- Suggested Mapping: Map to BigCommerce Order’s “Gift Card Amount” using Field.
Order - Gift Certificate Amount: The amount paid using a gift certificate.
- Example: “10.00”
- Suggested Mapping: Map to BigCommerce Order’s “Gift Certificate Amount” using Field.
Order - Handling Cost Ex Tax: The handling cost for the order excluding tax.
- Example: “3.00”
- Suggested Mapping: Map to BigCommerce Order’s “Handling Cost Ex Tax” using Field.
Order - Handling Cost Including Tax: The handling cost for the order including tax.
- Example: “3.24”
- Suggested Mapping: Map to BigCommerce Order’s “Handling Cost Including Tax” using Field.
Order - Handling Cost Tax: The tax amount on the handling cost.
- Example: “0.24”
- Suggested Mapping: Map to BigCommerce Order’s “Handling Cost Tax” using Field.
Order - Items Total: The total number of items in the order.
- Example: “3”
- Suggested Mapping: Map to BigCommerce Order’s “Items Total” using Field.
Order - Order ID: The unique ID of the order.
- Example: “12345”
- Suggested Mapping: Map to BigCommerce Order’s “Order ID” using Field.
Order - Order Source: The source of the order (e.g., direct, marketplace).
- Example: “manual”
- Suggested Mapping: Map to BigCommerce Order’s “Order Source” using Field.
Order - Payment Method: The payment method used for the order.
- Example: “Credit Card”
- Suggested Mapping: Map to BigCommerce Order’s “Payment Method” using Field.
Order - Payment Status: The payment status of the order.
- Example: “paid”
- Suggested Mapping: Map to BigCommerce Order’s “Payment Status” using Field.
Order - Refunded Amount: The total amount refunded for the order.
- Example: “20.00”
- Suggested Mapping: Map to BigCommerce Order’s “Refunded Amount” using Field.
Order - Shipping Address Count: The number of shipping addresses for the order.
- Example: “1”
- Suggested Mapping: Map to BigCommerce Order’s “Shipping Address Count” using Field.
Order - Shipping Cost Ex Tax: The shipping cost for the order excluding tax.
- Example: “5.00”
- Suggested Mapping: Map to BigCommerce Order’s “Shipping Cost Ex Tax” using Field.
Order - Shipping Cost Including Tax: The shipping cost for the order including tax.
- Example: “5.40”
- Suggested Mapping: Map to BigCommerce Order’s “Shipping Cost Including Tax” using Field.
Order - Shipping Cost Tax: The tax amount on the shipping cost.
- Example: “0.40”
- Suggested Mapping: Map to BigCommerce Order’s “Shipping Cost Tax” using Field.
Order - Staff Notes: Notes added by staff for the order.
- Example: “Customer requested expedited shipping.”
- Suggested Mapping: Map to BigCommerce Order’s “Staff Notes” using Field.
Order - Status: The status of the order.
- Example: “Awaiting Payment”
- Suggested Mapping: Map to BigCommerce Order’s “Status” using Field.
Order - Store Credit Amount: The amount paid using store credit.
- Example: “15.00”
- Suggested Mapping: Map to BigCommerce Order’s “Store Credit Amount” using Field.
Order - Store Default Currency Code: The default currency code of the store.
- Example: “USD”
- Suggested Mapping: Map to BigCommerce Order’s “Store Default Currency Code” using Field.
Order - Store Default To Transactional Exchange Rate: The exchange rate between the store’s default and transactional currency.
- Example: “1.0”
- Suggested Mapping: Map to BigCommerce Order’s “Store Default To Transactional Exchange Rate” using Field.
Order - Subtotal Ex Tax: The subtotal of the order excluding tax.
- Example: “90.00”
- Suggested Mapping: Map to BigCommerce Order’s “Subtotal Ex Tax” using Field.
Order - Subtotal Including Tax: The subtotal of the order including tax.
- Example: “97.20”
- Suggested Mapping: Map to BigCommerce Order’s “Subtotal Including Tax” using Field.
Order - Subtotal Tax: The tax amount on the subtotal.
- Example: “7.20”
- Suggested Mapping: Map to BigCommerce Order’s “Subtotal Tax” using Field.
Order - Total Ex Tax: The total order amount excluding tax.
- Example: “95.00”
- Suggested Mapping: Map to BigCommerce Order’s “Total Ex Tax” using Field.
Order - Total Incl. Tax: The total order amount including tax.
- Example: “102.60”
- Suggested Mapping: Map to BigCommerce Order’s “Total Incl. Tax” using 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 Mapping: Map to BigCommerce Order’s “Total Tax” using Field.
Order - Wrapping Cost Ex Tax: The wrapping cost for the order excluding tax.
- Example: “2.00”
- Suggested Mapping: Map to BigCommerce Order’s “Wrapping Cost Ex Tax” using Field.
Order - Wrapping Cost Inc Tax: The wrapping cost for the order including tax.
- Example: “2.16”
- Suggested Mapping: Map to BigCommerce Order’s “Wrapping Cost Inc Tax” using Field.
Order - Wrapping Cost Tax: The tax amount on the wrapping cost for the order.
- Example: “0.16”
- Suggested Mapping: Map to BigCommerce Order’s “Wrapping Cost Tax” using Field.
Practice Mapping Here’s a quick example—if you map the “Customer Message” 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 is mapped in the template, as refunded quantities are excluded. Map the “Quantity” and “Quantity Refunded” fields 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 mapping template includes the “BigCommerce Shipping Address” fields 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 how 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 how shipment fields (e.g., Tracking Number, Shipping Method) from your system map 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, navigate to the Integrations section, select BigCommerce as the integration type, and choose the "Sync Orders" operation.
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 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: Define how shipment fields from your system map to BigCommerce shipment fields (details below).
5. Run the Integration: Start the integration manually or let it run on your chosen schedule.
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 defines how shipment data from your system is synced to BigCommerce. For example, you can map your system’s “Tracking Number” field to 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: Delete, Duplicate, and Save.
- 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 choose from the following options for each field:
- Don’t Map: Ignore the field entirely.
- Set To Empty: Clear any existing data in that field.
- Field: Map a field from your system (e.g., Shipment’s “Tracking Number”) to a BigCommerce field.
- Value: Set a constant value for all shipments.
- Mapping Set: Apply a predefined transformation or mapping table.
- Rules: Use conditional logic to modify fields based on specific criteria (more advanced).
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 sample list of fields you can map to BigCommerce:
Comments: Additional notes about the shipment.
- Suggested Mapping: Map to Shipment’s “Note” using Field.
Date Created: The date the shipment was created.
- Suggested Mapping: Map to Shipment’s “Shipped At” using Field.
Merchant Shipping Cost: The shipping cost for the merchant.
- Suggested Mapping: Map to Shipment’s “Shipping Cost” using Field.
Shipping Method: The method used for shipping.
- Suggested Mapping: Map to Shipment’s “Method” using Field.
Shipping Provider: The carrier used for shipping.
- Suggested Mapping: Map to Shipment’s “Carrier” using Field, or set to null if the provider isn’t enabled in your store.
- Accepted Carrier Values: For a complete list of accepted carrier values, please refer to the Accepted Carrier Values CSV.
Tracking Link: The URL for tracking the shipment.
- Suggested Mapping: Map to Shipment’s “Tracking URL” using Field.
Tracking Number: The tracking number for the shipment.
- Suggested Mapping: Map to Shipment’s “Tracking Number” using Field.
Tracking Carrier: The carrier associated with the tracking number.
- Suggested Mapping: Map to Shipment’s “Carrier” using Field.
Shipping Provider Configuration
If a valid shipping provider exists in your BigCommerce store, it should be configured directly in the store’s settings. However, if no valid shipping provider is detected, the recommendation is to use the Set To Empty option to clear the Shipping Provider field and avoid errors.

If a valid shipping provider exists, configure it directly in your BigCommerce settings.

If no valid carrier is detected, use the "Set To Empty" option to clear the field and avoid errors.
×
×
Practice Mapping
Here’s a quick example—if you map the “Tracking Number” field:
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, send the shipping provider as null to 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 fields are correctly mapped (e.g., “Tracking Number” to “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!