Professional Documents
Culture Documents
Commerce
2022 R2
Contents | 2
Contents
Copyright...............................................................................................................................................9
Integration with BigCommerce.............................................................................................................. 10
Initial Configuration of a BigCommerce Store............................................................................................... 10
Initial Configuration: General Information............................................................................................10
Initial Configuration: Implementation Checklist.................................................................................. 14
Initial Configuration: Setting Up a BigCommerce Store.......................................................................17
Initial Configuration: To Set Up a BigCommerce Store........................................................................ 19
Initial Configuration: To Prepare the Acumatica ERP Instance............................................................ 22
Initial Configuration: To Capture Store Connection Information........................................................ 25
Initial Configuration: To Establish and Configure the Store Connection.............................................27
Overview of Data Synchronization................................................................................................................. 30
Data Synchronization: General Information......................................................................................... 30
Data Synchronization: Synchronization Statuses.................................................................................35
Data Synchronization: Manual Synchronization...................................................................................35
Data Synchronization: To Perform the First Synchronization..............................................................36
Preparing Entities for Synchronization.......................................................................................................... 44
Preparing Entities for Synchronization: General Information..............................................................44
Preparing Entities for Synchronization: Updating Product Details..................................................... 46
Preparing Entities for Synchronization: Filtering................................................................................. 47
Preparing Entities for Synchronization: Field Mapping........................................................................50
Preparing Entities for Synchronization: Implementation Activity....................................................... 54
Automating Synchronization.......................................................................................................................... 57
Automated Synchronization: General Information.............................................................................. 57
Automated Synchronization: Scheduled Synchronization.................................................................. 58
Automated Synchronization: Real-Time Synchronization................................................................... 60
Automated Synchronization: Recommended Setup............................................................................ 62
Automated Synchronization: To Configure a New Automation Schedule...........................................63
Automated Synchronization: To Turn On Real-Time Synchronization ............................................... 65
Automated Synchronization: Business Events for Aborted Records................................................... 66
Automated Synchronization: To Activate a Predefined Business Event..............................................67
Synchronizing Customers................................................................................................................................70
Synchronizing Customers: General Information...................................................................................70
Synchronizing Customers: Implementation Checklist......................................................................... 75
Synchronizing Customers: To Perform Bidirectional Synchronization................................................77
Contents | 3
Copyright
No part of this document may be reproduced, copied, or transmitted without the express prior consent of
Acumatica, Inc.
3933 Lake Washington Blvd NE, # 350, Kirkland, WA 98033
Restricted Rights
The product is provided with restricted rights. Use, duplication, or disclosure by the United States Government is
subject to restrictions as set forth in the applicable License and Services Agreement and in subparagraph (c)(1)(ii)
of the Rights in Technical Data and Computer Soware clause at DFARS 252.227-7013 or subparagraphs (c)(1) and
(c)(2) of the Commercial Computer Soware-Restricted Rights at 48 CFR 52.227-19, as applicable.
Disclaimer
Acumatica, Inc. makes no representations or warranties with respect to the contents or use of this document, and
specifically disclaims any express or implied warranties of merchantability or fitness for any particular purpose.
Further, Acumatica, Inc. reserves the right to revise this document and make changes in its content at any time,
without obligation to notify any person or entity of such revisions or changes.
Trademarks
Acumatica is a registered trademark of Acumatica, Inc. HubSpot is a registered trademark of HubSpot, Inc.
Microso Exchange and Microso Exchange Server are registered trademarks of Microso Corporation. All other
product names and services herein are trademarks or service marks of their respective companies.
In this section, you will learn about the initial configuration that must be performed in a BigCommerce store and in
Acumatica ERP to set up integration between these systems.
Before you can start using the e-commerce functionality of Acumatica ERP Retail-Commerce Edition, you need to
set up a BigCommerce store, establish a connection between the Acumatica ERP instance and the BigCommerce
store, and perform the initial configuration of the connection.
Learning Objectives
In this section, you will learn what general steps are involved in establishing a connection between Acumatica ERP
and the BigCommerce store and in performing the initial configuration of these systems.
Steps for Establishing the Store Connection and Performing the Initial Configuration
In order to connect the Acumatica ERP instance to the BigCommerce store, you perform the following general
steps:
1. Set up a BigCommerce store.
2. Obtain the BigCommerce API keys and WebDAV information.
3. Prepare the Acumatica ERP instance.
4. Establish the connection to the BigCommerce store.
5. Perform the initial configuration of the store connection.
6. Configure the entities enabled for synchronization.
7. Start synchronizing data.
• Prepare & Process: As soon as a push notification about a change to data is received, the
corresponding synchronization record is placed in the processing queue, and the data
synchronization process is immediately started for the synchronization record.
• Max. Number of Failed Attempts: The maximum number of errors that are allowed during the import or
export before the record is automatically skipped. By default, 5 attempts are allowed.
Although all settings except Real-Time Import and Real-Time Export can be changed, we recommend that
you leave the default values during the initial configuration. For more information about configuring
synchronization, see Data Synchronization: General Information.
2. On the Customer Settings tab, you specify the following settings, which will be applied to customers and
customer locations imported from the BigCommerce store to Acumatica ERP:
• Customer Class: The customer class from which default customer settings will be populated for new
customers that are imported from the BigCommerce store.
If the Multiple Base Currencies feature is enabled on the Enable/Disable Features (CS100000) form, the
Restrict Visibility To value of the customer class on the Customer Classes (AR201000) form should
be set to the branch selected in the Branch box on the Order Settings tab of the BigCommerce Stores
(BC201000) form or to the company this branch belongs to.
• Customer Auto-Numbering: The numbering sequence the system will use to automatically generate the
identifiers of the customers that are imported from the BigCommerce store.
• Location Auto-Numbering: The numbering sequence the system will use to automatically generate
identifiers of the customer locations (that is, addresses) that are imported from the BigCommerce store.
• Generic Guest Customer: The customer account to be used in orders placed in the BigCommerce store
by non-registered customers. This customer account is used only if guest orders are allowed in the
BigCommerce store.
If your company uses segmented keys that consist of multiple segments for customers and customer
locations, you also need to specify the numbering templates in the Customer Numbering Template and
Location Numbering Template boxes.
3. On the Inventory Settings tab, you specify the following settings that apply to inventory items:
• Default Stock Categories and Default Non-Stock Categories: The sales item categories that are
assigned to stock and non-stock items, respectively, when the items are exported to the BigCommerce
store, if these items are not assigned any item sales category in Acumatica ERP.
• Related Items: The types of related items information about which can be exported to the BigCommerce
store. In the drop-down list, you select the check box of each type of related items to be exported, and
the system displays the selected categories in the box, separated by commas.
If an item is specified as a related item of any of the selected types for a stock item or non-stock item on
the Related Items tab of the Stock Items (IN202500) or Non-Stock Items (IN202000) form, information
about this item is exported to the BigCommerce store during the synchronization of the Stock Item or
Non-Stock Item entity, respectively.
• Default Availability: The default availability assigned to stock and non-stock items exported from
Acumatica ERP. You can select any of the following options:
• Set as Available (Track Qty.): The exported items will be available in the store, and their quantity will
be tracked.
• Set as Available (Don't Track Qty.): The exported items will be available in the store, and their quantity
will not be tracked.
• Set as Pre-Order: The exported items will be available for pre-order—that is, the Purchasability of the
items in BigCommerce will be set to This product is coming soon but I want to take pre-orders.
• Set as Unavailable: The exported items will not be available for purchase—that is, the Purchasability
setting of the items in BigCommerce will be set to This product cannot be purchased in my online store.
The default availability can be overridden for each particular item on the eCommerce tab
of the Stock Items or Non-Stock Items form.
Integration with BigCommerce | 13
If you select Set as Available (Track Qty.), in the When Qty. Unavailable box, you also need to select
the action to be taken if aer the synchronization of the Product Availability entity the item's available
quantity becomes zero. You can select one of the following actions:
• Do Nothing: The system should perform no action.
• Set as Unavailable: The system should make the item unavailable for purchase.
• Set as Pre-Order: The system should make the item unavailable for purchase but available for pre-
order.
• Availability Mode: You select which item quantities need to be synchronized with the BigCommerce
store: all available items, items available for shipping, or items on hand.
• Warehouse Mode: You specify if you want to use all warehouses or only specific warehouses for quantity
calculations. In the latter case, you need to specify the warehouses whose quantities are to be included
in calculations.
4. On the Order Settings tab, you define default settings for the BigCommerce store as follows:
• In the General section, you select the branch that will appear on sales orders imported from the
BigCommerce store. The base currency of the branch must match the default currency of the
BigCommerce store, which is displayed in the Default Currency box of the Store Properties section on
the Connection Settings tab.
• In the Order section, you select the order types to be assigned to sales orders and return orders
imported from the BigCommerce store and order types that should be exported to the store. Here you
also specify if discounts should be aggregated on the level of the entire document or for particular items
in the order (if discounts are provided), and select the non-stock item that will represent gi certificates
that you can sell in the BigCommerce store and accept as payment. For more information about order
synchronization, see Order Synchronization: General Information. For details about importing refunds
from the BigCommerce store, see Importing Non-Card Refunds: General Information and Importing Card
Refunds: General Information.
• In the Taxes section, you specify if taxes need to be synchronized with the BigCommerce store. If
synchronization of taxes is enabled—that is, if the Tax Synchronization check box is selected—you
can also specify in the Default Tax Zone box, the tax zone that the system will assign to imported sales
orders if no tax zone was identified during the order import. In some cases, for example, if you use an
external tax calculation service, you might need to always assign a particular tax zone to imported
orders. In this case, you select the Use as Primary Tax Zone check box. For more information about tax
synchronization, see Import of Taxes: General Information.
• In the Substitution Lists section, you can select the substitution lists that you will use to map tax codes
and tax categories between Acumatica ERP and the BigCommerce store.
• In the Shipping Option Mapping section, you specify the Ship Via options for the combinations of the
shipping zone and shipping method configured in the BigCommerce store. For each combination of
the store shipping zone and store shipping method, you can optionally specify the shipping zone and
shipping terms to make the mapping more granular. The values specified in this table appear on the
Shipping tab of orders imported to Acumatica ERP from the BigCommerce store.
5. On the Payment Settings tab, you map the payment methods defined in the BigCommerce store (that is,
the values in the Store Payment Methods column) to the combination of the payment method and cash
account defined in Acumatica ERP (that is, with the values in the ERP Payment Method and Cash Account
columns, respectively). To indicate that payments by a specific payment method should be processed
in Acumatica ERP, you select the Active check box for a particular store payment method; you can also
indicate that payments based on a specific payment method that are imported from the BigCommerce store
should be released on import automatically by selecting the check box in the Release Payments column.
6. On the form toolbar, you click Save to save the settings.
Integration with BigCommerce | 14
Synchronization of Data
Aer you have performed the initial configuration, you can start to synchronize data between Acumatica ERP and
the BigCommerce store. First, you perform manual synchronization for entities in a specific order. Then you set up
synchronization to run automatically, either in real-time or according to a specific schedule. For information about
synchronization, see Data Synchronization: General Information.
You can use the information in this topic to quickly check what needs to be configured in the BigCommerce store
and in the Acumatica ERP instance, and what information must be obtained before you can start implementing the
integration with the BigCommerce store.
Store Admin Path The permanent URL of the e-commerce store followed by /manage.
This path is used for navigating to BigCommerce pages from the Sync History
(BC301000) and Process Data (BC501500) forms.
REST Settings
Access Token An access token provided by BigCommerce when a new store is set up on the
BigCommerce platform.
For synchronization to work properly, the access token should have the nec-
essary access permissions in BigCommerce. We recommend that you grant
the maximum access permissions, as described in Initial Configuration: To
Capture Store Connection Information
WebDAV Settings
Integration with BigCommerce | 15
WebDAV Path The URL of the store used for file management, which facilitates the ex-
change of data between the e-commerce store and the users and external
systems. This URL is the store's permanent URL followed by DAV. This URL
is used by Acumatica ERP to upload files and images to the BigCommerce
store.
WebDAV Username The email address of the registered owner of the BigCommerce store, which
is used to connect to the BigCommerce store.
WebDAV Password The password that is used to connect to the BigCommerce file storage.
The WebDAV password is a string of random letters and numbers, which you
can find on the File Access page in your BigCommerce store.
Store profile The basic information about the online store, including the store name, ad-
dress, country, and contact details.
The store country is important because it determines which payment and
shipping options are available for your store.
Default currency The default currency in which prices are displayed to users and which trans-
actions are made. The default currency should be the same as the base cur-
rency in the Acumatica ERP instance.
Payment methods for the de- The payment methods that can be used for transactions in the default cur-
fault currency rency.
Shipping rules The shipping zones and rates that you want to use in your store.
Enable/Disable Features The following required features are enabled: See Preparing an Instance:
(CS100000) Acumatica ERP Features.
• Business Account Locations
• Commerce Integration
• BigCommerce Connector
Integration with BigCommerce | 16
Customer Classes The customer class for e-commerce customers See Accounts Receivable:
(AR201000) has been created. This customer class is used Customer Classes.
for creating customer records in Acumatica ERP
for customers imported from the BigCommerce
store.
Customers (AR303000) The customer account for importing to Acumati- See Customers: General Infor-
ca ERP orders placed in the online store by guest mation.
users has been created.
Numbering Sequences • A numbering sequence has been defined See Use of Numbering Se-
(CS201010) for the auto-numbered segment that will be quences.
used for generating customer IDs on import.
• A numbering sequence has been defined
for the auto-numbered segment that will be
used for generating customer location IDs on
import.
Item Sales Categories The sales categories under which the stock items See Managing the Invento-
(IN204060) and non-stock items are placed have been con- ry Catalog in the Self-Service
figured and assigned to individual items. Portal: General Information.
Order Types (SO201000) A unique order type has been created for orders See Sales Order Types: Gen-
imported from the online store. eral Information.
Integration with BigCommerce | 17
Taxes (TX205000) The sales taxes applicable to the products that See Sales Taxes: General In-
you sell have been configured. formation.
Ship via Codes (CS207500) The ship via codes for the delivery services that See To Create a Ship via
the company uses have been created. Code.
Cash Accounts The cash accounts associated with payment See Cash Management: To
methods used in the e-commerce transactions Create Cash Accounts.
have been created.
Payment Methods The payment methods used in the e-commerce See Cash Management: Pay-
transactions have been configured. ment Methods.
Processing Centers The Authorize.Net processing center to be used See Setup of Card Payment
for processing credit card payments has been Processing.
configured.
Before you start configuring the integration between Acumatica ERP and BigCommerce, you should set up the
BigCommerce store, prepare entities in Acumatica ERP, and obtain store connection information. In this topic, you
will learn about the minimum settings of the BigCommerce store that you need to configure.
This topic covers only the essential settings that you need to configure in BigCommerce for
integration with the Acumatica ERP instance. For details on the configuration of other settings, refer
to the BigCommerce documentation.
For information about the detailed steps that you need to complete to create a trial account, see the BigCommerce
documentation.
Configuring Taxes
You set up tax zones, tax calculation rules, the way of displaying taxes in the storefront, and the way of specifying
prices for products (that is, whether prices are entered inclusive or exclusive of tax) on the Tax page. To access the
page, you click Settings in the le pane, and on the Settings page, in the Setup section, you click Tax.
For more information about configuring taxes, see Tax Overview in the BigCommerce documentation.
Configuring Shipping
BigCommerce provides a wide range of shipping options that you can flexibly configure to your needs. You specify
the place where you will ship your products from, as well as the shipping zones and shipping rules on the Shipping
Manager page. To access the page, you click Settings in the le pane, and on the Settings page, in the Setup
section, you click Shipping.
For information about configuring shipping, see Shipping Setup in the BigCommerce documentation.
Deleting Existing Orders, Products, Product Categories, Customers, and Customer Groups
When you first create a BigCommerce store, it might contain some pre-populated data to help you get started.
Before you begin implementing the BigCommerce integration with Acumatica ERP, you might want to delete
customers, customer groups, products, product categories, and orders that already exist in the store. Deleting
these entities from the store will reduce the amount of data that needs to be synchronized; thus, you can more
Integration with BigCommerce | 19
easily see which data comes from which system when you configure synchronization between Acumatica ERP and
the BigCommerce store.
You delete customers, products, product categories, and orders as follows:
• To delete customers, you click Customers > View in the le pane to open the Customers page. On this
page, you select the unlabeled check box for all customers in the list and click the Delete button on the table
toolbar; then in the confirmation dialog box that opens, you click OK.
• To delete customer groups, you click Customers > Customer Groups in the le pane to open the Customer
Groups page. On this page, you select the unlabeled check box for all customer groups in the list and click
the Delete button on the table toolbar; then in the confirmation dialog box that opens, you click OK.
• To delete product categories and products in them, you click Products > Product Categories in the le
pane to open the Product Categories page. On this page, you select the unlabeled check box for all product
categories in the list and then click the Delete button. In the Reassign Products in Categories Marked for
Deletion dialog box, which opens, you select the Delete products in these categories option button and
click OK.
• To delete orders, you click Orders > View in the le pane to open the Orders page. On this page, you select
the unlabeled check box for all orders in the list and click the Delete button on the table toolbar; then in the
confirmation dialog box that opens, you click OK.
This activity will guide you through the process of signing up for a BigCommerce trial account and performing the
minimum configuration of a BigCommerce store so that it can be connected with the Acumatica ERP instance.
Story
The SweetLife company is planning on opening an online store built on the BigCommerce platform. The store's
warehouse, from which the goods sold online will be shipped, is based in New York. The company maintains the
prices of its products in U.S. dollars and delivers products across New York by using the company's own vehicles.
For orders in the amount of $100 and more, the company offers free shipping.
As an implementation consultant helping SweetLife to implement the integration between BigCommerce
and Acumatica ERP, you want to set up a new store and perform the minimum required configuration of the
BigCommerce store that will be sufficient to proceed with the configuration of the integration.
This activity covers the creation and basic configuration of a new BigCommerce store. The results of
performing the instructions presented below are used in subsequent activities. We recommend that
you sign up for a new trial account and create a new store for testing purposes. If you have an existing
test store and do not want to set up another one, make sure that in the subsequent activities, you
make the necessary adjustments where the results of the current activity are used.
Integration with BigCommerce | 20
Process Overview
In this activity, you will perform the following steps in BigCommerce:
1. Signing up for a BigCommerce trial account
2. Completing the store profile
3. Specifying the default currency
4. Configuring the shipping rules
5. Turning off notifications about changes to customer accounts
Make sure that you have selected the correct country because it affects the range of payment,
shipping, and tax options available for your store.
3. On the Currencies page, which opens, in the Default Currency section, make sure that the default currency
(which is determined by BigCommerce automatically) is US Dollar - USD. If the default currency is anything
other than US Dollar - USD, do the following:
a. In the Allow shoppers to purchase in their currency section, click Add new currency.
b. In the Add Currency dialog box, which opens, in the Currency code box, select USD - US Dollar and click
Next.
c. On the USD - US Dollar page, leave the default settings, and click Save.
d. On the Currencies page, in the Additional Currencies section, click the button in the rightmost column
in the row for the US Dollar - USD currency, and in the menu that opens, select Set as default.
e. In the Set USD as your default currency dialog box, click Set as default again.
f. In the Additional Currencies section, click the button in the rightmost column in the row for an
additional currency, and in the menu that opens, select Delete.
g. In the Delete <additional currency> dialog box, which opens, click Delete.
Because SweetLife wants to display prices and sell products only in United States dollars, the configuration
of other currencies is not needed.
For the purposes of the initial configuration and first synchronization, which you will perform in Data
Synchronization: To Perform the First Synchronization, you do not need to set up any payment methods at this time.
d. Delete any other shipping rules by clicking the Delete button in the row with this shipping rule.
5. In the row of New York State, click Configure.
6. On the New York State page, in the Static shipping quotes section, switch on the toggle to enable the Free
Shipping rule.
7. In the Free Shipping Options dialog box, which opens, specify the following settings:
• Limit to order over: Selected
• Amount (USD): 100.00
• Use discounted order subtotal (Recommended): Selected
With these settings, the orders in the amount of $100 or more will be eligible for free shipping.
8. In the lower right, click Submit to save your changes.
For simplicity, you do not need to specify any other shipping rules at this time. In a production environment,
you are most likely to configure the shipping options on a more granular level.
You have specified the minimum set of store settings that you will need for the basic configuration of the
BigCommerce integration.
Now you should proceed to review the configuration of your Acumatica ERP instance, as described in Initial
Configuration: To Prepare the Acumatica ERP Instance.
In this activity, you will go through the settings that need to be specified in the Acumatica ERP instance before you
set up the connection to the BigCommerce store.
This activity is based on the U100 dataset. If you are using another dataset, or if any system settings
have been changed in U100, these changes can affect the workflow of the activity and the results of
the processing. To avoid any issues, restore the U100 dataset to its initial state.
Story
The SweetLife company is planning on opening an online store built on the BigCommerce platform. The warehouse
from which the goods will be shipped is based in New York. The company maintains the prices of its products
in United States dollars and delivers products across New York by using the company's own vehicles. As an
implementation consultant helping SweetLife to implement the integration between BigCommerce and Acumatica
ERP, you want to make sure that the features required for the e-commerce functionality are enabled and the
necessary entities are created and configured in the Acumatica ERP instance.
Integration with BigCommerce | 23
Process Overview
The Acumatica ERP instance with the U100 dataset already contains most of the settings and data that you will
need to specify when you start configuring the store connection. In this activity, you will review the following
settings or entities on the following forms of the Acumatica ERP instance:
• Enable/Disable Features (CS100000) form: The features that have been enabled to support e-commerce
functionality
• Customer Classes (AR201000) form: The customer class for the customers imported from the BigCommerce
store
• Numbering Sequences (CS201010) form: The numbering sequences to be used for generating the identifiers
for new customers and customer locations imported from the BigCommerce store
• Customers (AR303000) form: The customer account to be used for guest orders (orders placed by
unregistered users) in the online store
• Item Sales Categories (IN204060) form: The item sales category to be used as the default sales category;
items that have no item sales category in Acumatica ERP will be displayed under this category in the online
store
• Order Types (SO201000) form: The order type to be used for orders imported from the BigCommerce store,
and the order type to be used for handling returns of online purchases
• Ship via Codes (CS207500): The carrier to be used for handling shipping
• Cash Accounts (CA202000): The cash account to be used for e-commerce orders
• Payment Methods (CA204000): The payment method to which payment methods from the BigCommerce
store will be mapped
System Preparation
Sign in to the Acumatica ERP instance with the U100 dataset preloaded by using the following credentials:
• Username: gibbs
• Password: 123
Depending on the setup of your BigCommerce store and the inventory and order management
processes in your company, you might need to enable additional features. For more
information, see Initial Configuration: Implementation Checklist.
Step 2: Reviewing the Customer Class for Customers Imported from BigCommerce
During the process of establishing and configuring the connection between Acumatica ERP and the BigCommerce
store, you will need to specify the customer class that will be used for creating customer records for customers
Integration with BigCommerce | 24
imported from the BigCommerce store. You can use an existing customer class or create a new one with a different
set of default settings to be used specifically for online customers. In the instance with the U100 data preloaded, a
dedicated customer class for online customers has already been created.
To review the customer class that will be used for customers imported from the BigCommerce store, do the
following:
1. Open the Customer Classes (AR201000) form.
2. In the Class ID box, select ECCUSTOMER.
In a subsequent activity, you will specify this customer class in the store settings so that the system will use
the settings of this customer class to populate customer records for new customers that will be imported
from the BigCommerce store to Acumatica ERP.
Step 3: Reviewing the Numbering Sequences for Customers and Customer Locations
To review the numbering sequences that Acumatica ERP will use to assign identifiers to customers and customer
locations (addresses) imported from the BigCommerce store, do the following:
1. Open the Numbering Sequences (CS201010) form.
2. In the Numbering ID box, select ECCUSTOMER.
Review the settings of the numbering sequence that will be used to automatically generate the identifiers
of the customers imported from the BigCommerce store to Acumatica ERP. With these settings, these
customers will be assigned identifiers that start with the letter C followed by a numerical portion.
3. In the Numbering ID box, select ECLOCATION.
Review the settings of the numbering sequence that will be used to automatically generate the identifiers of
the customer locations imported from the BigCommerce store to Acumatica ERP. With these settings, these
customer locations will be assigned identifiers that start with the letter L followed by a numerical portion.
In a subsequent activity, you will specify these numbering sequences in the store settings so that the system will
use them to create identifiers for customers and addresses imported from the BigCommerce store to Acumatica
ERP.
Notice that no stock or non-stock items are currently assigned to this category. You will select this category
in a subsequent activity to make stock and non-stock items that do not have their own categories appear
under the Other category aer they are imported to the BigCommerce store.
In the next activity, Initial Configuration: To Capture Store Connection Information, you will learn how to capture the
store's API and WebDAV information required for establishing the connection between your instance of Acumatica
ERP and the BigCommerce store.
Before you can start setting up a connection to the BigCommerce store in Acumatica ERP, you need to obtain the
following BigCommerce connection information:
• The store admin path, which is the URL of the BigCommerce store followed by /manage
• The API credentials (API path, client ID, and access token)
Integration with BigCommerce | 26
Process Overview
In this activity, you will perform the following steps:
1. Obtaining the API credentials of the BigCommerce store
2. Obtaining the WebDAV information to be used for the BigCommerce store
System Preparation
1. Before you start this activity, make sure that you have completed the instructions in Initial Configuration: To
Set Up a BigCommerce Store.
2. Sign in to the control panel of the BigCommerce store as the store administrator.
Make sure to securely store these API credentials. If you lose this information, you will have to
delete the account and create a new one.
On the API accounts page, the information about the Acumatica ERP Integration account is now displayed.
Now you can move on to establish a connection between Acumatica ERP and the BigCommerce store and perform
the minimum configuration of the connection. To do so, follow the steps described in Initial Configuration: To
Establish and Configure the Store Connection.
In this activity, you will learn how to connect your Acumatica ERP instance to the BigCommerce store and perform
the initial configuration of the connection.
The following activity is based on the U100 dataset. If you are using another dataset, or if any system
settings have been changed in U100, these changes can affect the workflow of the activity. To avoid
any issues, restore the U100 dataset to its initial state.
Story
Suppose that the manager of the SweetLife company wants to sell jam in its online store deployed on the
BigCommerce platform. SweetLife is already using Acumatica ERP and now needs to integrate it with a new
BigCommerce store. As SweetLife's implementation consultant, you need to configure the connection to the
BigCommerce store and perform the minimum configuration required for synchronization of data between
Acumatica ERP and the BigCommerce store.
Configuration Overview
In the U100 dataset, the following tasks have been performed for the purposes of this activity:
• On the Enable/Disable Features (CS100000) form, the Commerce Integration and BigCommerce Connector
features have been enabled.
• On the Customer Classes (AR201000) form, the ECCUSTOMER customer class has been defined.
• On the Numbering Sequences (CS201010) form, the ECCUSTOMER numbering sequence has been defined,
• On the Customers (AR303000) form, the ECOMGUEST customer record has been created.
• On the Non-Stock Items (IN202000) form, the REFUNDAMT non-stock item has been defined.
• On the Item Sales Categories (IN204060) form, the Other sales category has been created.
• On the Order Types (SO201000) form, the EO - eCommerce Order has been defined based on the SO order
template.
• On the Ship via Codes (CS207500) form, the SWEETSHIP ship via code has been created.
• On the Cash Accounts (CA202000) form, the 10250ST cash account has been configured for the RETAIL branch
and the USD currency.
• On the Payment Methods (CA204000) form, the ONLINE payment method has been set up to be used with the
10250ST cash account.
Integration with BigCommerce | 28
Process Overview
On the BigCommerce Stores (BC201000) form, you will create a new connection to the online store by using the
information you captured in Initial Configuration: To Capture Store Connection Information. Aer the connection is
successfully established, you will perform the minimum configuration of the store settings.
System Preparation
Before you start this activity, do the following:
1. Make sure that you have completed the following activities:
• Initial Configuration: To Set Up a BigCommerce Store
• Initial Configuration: To Capture Store Connection Information
You will need to specify the captured information in Step 1 below.
• Initial Configuration: To Prepare the Acumatica ERP Instance
2. Sign in to the Acumatica ERP instance with the U100 dataset preloaded by using the following credentials:
• Username: gibbs
• Password: 123
3. Sign in to the control panel of the BigCommerce store as the store administrator.
Step 1: Establishing a Connection Between Acumatica ERP and the BigCommerce Store
To establish a connection with the BigCommerce store in your instance of Acumatica ERP, do the following:
1. On the BigCommerce Stores (BC201000) form, add a new record.
2. In the Store Name box of the Summary area, type SweetStore - BC.
3. On the Connection Settings tab, use the information that you have captured while completing Initial
Configuration: To Capture Store Connection Information to specify the settings as follows:
• In the Store Admin Path box, enter the URL of your BigCommerce store.
Notice that the system automatically appends /manage to the store URL.
• In the REST Settings section, specify API Path, Client ID, and Access Token.
Notice that the system automatically removes the API version at the end of the API path.
• In the WebDAV Settings section, make sure the WebDAV Path is specified.
• Specify WebDAV Username and WebDAV Password.
4. On the form toolbar, click Save.
5. On the form toolbar, click Test Connection to check if you have specified the connection settings correctly.
If the connection test is successful, you can proceed to specifying the required settings for entities,
customers, inventory, orders, and payments.
2. In the table, select the Active check box for the following entities:
• Customer
• Sales Category
• Stock Item
• Sales Order
• Shipment
• Payment
Leave the default settings of the activated entities as they are.
For simplicity, you do not need to configure the synchronization of taxes at this point.
5. In the Shipping Option Mapping table, add a new row, and specify the following settings in the added row:
• Active: Selected
• Store Shipping Zone: New York State
• Store Shipping Method: Free Shipping
• Ship Via: SWEETSHIP
In this chapter, you will learn how the synchronization of data between Acumatica ERP and BigCommerce works,
how to enable real-time synchronization for some or all of the activated entities, and how to configure the
synchronization to start according to a schedule.
Aer the connection between Acumatica ERP and the BigCommerce store has been established and the initial
configuration performed, you can start synchronizing data between the two systems.
Learning Objectives
In this chapter, you will learn how data synchronization works and how to synchronize data manually.
Integration with BigCommerce | 31
Applicable Scenarios
You synchronize data between Acumatica ERP and the BigCommerce store manually in the following cases:
• During the implementation of the integration between Acumatica ERP and the BigCommerce store, when
you test how the synchronization works
• When you troubleshoot synchronization issues and need to resynchronize specific data manually
During the processing of out-of-sync data, the system performs the following operations for each synchronization
record:
1. Pulling the record details from Acumatica ERP and the external e-commerce system.
2. Determining the direction of the synchronization—that is, if data should be imported to Acumatica ERP,
exported to the external system, or synchronized in both directions.
3. Determining if any other records should be synchronized as a prerequisite for the synchronization of the
current record, and attempting to synchronize the prerequisite records.
4. Applying the standard field mapping for the entity.
The default field mapping for each entity is detailed in Retail-Commerce Edition Entity Reference.
5. Applying the field mapping configured for the entity on the Entities (BC202000) form.
6. Saving the synchronized data in the destination system or systems.
7. Changing the status of the synchronization record to Processed.
When a synchronization record is prepared and processed, the system assigns it one of the statuses described in
the following table. You can review the synchronization status of any synchronization record on the Sync History
(BC301000) form.
Status Description
Prepared The synchronization record has been created or updated, but out-of-sync data
has not been saved in the destination system or systems.
Processed The synchronization record has been processed, and data has been recorded
to the destination system or systems according to the synchronization settings
configured for the entity.
Failed The processing of the synchronization record has failed and data could not be
recorded to the destination system or systems.
Aborted The synchronization record was excluded from synchronization by the system.
The system automatically assigns the Aborted status to a synchronization
record if the processing of the synchronization record has failed the number
of times specified for the entity in the Max. Number of Failed Attempts box
on the Entities (BC202000) form. The information about the error that occurred
during the synchronization is available for the synchronization record in the
Last Error column of the table on the Sync History form.
Deleted The record in the synchronization record has been deleted in Acumatica ERP, in
the external system, or in both systems.
Filtered The entity has been filtered as a result of applying a filter defined in the code or
on the Entities form.
Manual synchronization might be useful when you need to synchronize data during the initial configuration or
when data has not been synchronized for some reason and manual troubleshooting is needed.
To manually start the data preparation process, you perform the following general steps:
1. You open the Prepare Data (BC501000) form.
2. In the Summary area of the form, in the Store box, you select the online store with which you are
synchronizing data.
3. In the Prepare Mode box, you select one of the following options:
Integration with BigCommerce | 36
• Incremental: You select this mode to prepare for processing only the synchronization records that have
changed since the last successful data preparation.
• Full: You select this mode to prepare for processing all records of the selected entity, even if they have
been synchronized previously.
• Incremental by Date: You select this mode to prepare for processing only records that have been modified
during the specified date range and that have not yet been processed.
If you are starting the data preparation process for an entity for the first time, Full mode is used, regardless
of the mode selected in the Prepare Mode box.
4. In the table, you select the unlabeled check box in the rows of the needed entities, and on the form toolbar,
you click Prepare.
To manually start data processing, you perform the following general steps:
1. You open the Process Data (BC501500) form.
2. In the Summary area, in the Store box, you select the online store with which you are synchronizing data.
The table shows only the synchronization records that require processing (that is, the synchronization
records with the Prepared and Failed status).
3. In the Entity box, you select the entity for which you want to display synchronization records in the table.
If you want to process out-of-sync synchronization records for all entities, leave the box empty.
4. In the table, you select the unlabeled check box in the rows of the synchronization records that you need to
process.
5. On the form toolbar, you click Process to synchronize the selected synchronization records.
If you want to process all synchronization records in the table, you click Process All on the form toolbar.
For an example with step-by-step instructions on how to synchronize data manually, see Data Synchronization: To
Perform the First Synchronization.
The following activity will walk you through the process of manually exporting items from Acumatica ERP to the
BigCommerce store. You will also perform the instructions to place a test order online in the BigCommerce store
and then synchronize the order with Acumatica ERP. Finally, you will create a shipment for the order in Acumatica
ERP and synchronize the created shipment with the BigCommerce store.
Story
Suppose that you are an implementation consultant helping the SweetLife Fruits & Jams company to set up an
online store. You have completed the minimum initial configuration of the integration with BigCommerce and now
want to explore how synchronization works. You will configure synchronization for and then synchronize a subset
of stock items that are maintained in Acumatica ERP (stock items of the Jam item class) with the BigCommerce
store, where the term products describes what are called items in Acumatica ERP. You will then perform a test
purchase of one of the synchronized products and explore how the online order is processed in the BigCommerce
store and in Acumatica ERP.
Process Overview
In this activity, you will perform the following steps:
1. On the Stock Items (IN202500) form of Acumatica ERP, review the stock items that need to be exported to
the BigCommerce store.
Integration with BigCommerce | 37
2. On the Entities (BC202000) form, configure the filtering options for the Stock Item entity to include in the
synchronization only the stock items of the Jam item class.
3. On the Prepare Data (BC501000) form, start the data preparation process for the Stock Item entity to prepare
out-of-sync data for export.
4. On the Sync History (BC301000) form, review the result of the data preparation process.
5. On the Process Data (BC501500) form, start data processing for the Stock Item entity to save the
synchronized product data in the BigCommerce store.
6. On the Sync History form, review the results of data processing.
7. In the BigCommerce store, review the products that have been imported from Acumatica ERP.
8. By using the control panel of the store, place an order for one of the products that have been imported from
Acumatica ERP.
9. On the Prepare Data form of Acumatica ERP, start the data preparation process for the Sales Order entity to
prepare out-of-sync order data for import; on the Process Data form, synchronize the prepared sales order
data.
10.On the Sync History form, review the results of data synchronization.
11.On the Sales Orders (SO301000) form, review the details of the imported sales order.
12.On the Sales Orders form, create a shipment for the imported order, and on the Shipments (SO302000) form,
confirm the shipment.
13.On the Prepare Data form, start the data preparation process for the Shipment entity; on the Process Data
form, synchronize the prepared shipment data.
14.In the control panel of the BigCommerce store, review the updated order details and the shipment exported
from Acumatica ERP.
System Preparation
Do the following:
1. Make sure that the following prerequisites have been met:
• The BigCommerce store has been created and configured, as described in Initial Configuration: To Set Up
a BigCommerce Store.
• The connection to the BigCommerce store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Establish and Configure the Store Connection.
2. Launch the Acumatica ERP website, and sign in as an administrator by using the following credentials:
• Username: gibbs
• Password: 123
3. Sign in to the control panel of the BigCommerce store as the store administrator.
Now all stock items of the Jam item class are displayed. Notice how many items are in the class; scan the list
so you are familiar with the stock items that you need to export to the BigCommerce store.
Filtering rules are not applied to data that has already been synchronized. For example, if
you synchronize the Stock Item entity without filters (which will result in exporting all stock
items to the online store), apply the filter described above, and prepare and process the Stock
Item entity again, all previously synchronized stock items that no longer match the filtering
conditions will remain synchronized.
You can click the link in the Ready to Process column to open the Process Data (BC501500)
form with the store and the entity selected; you can click the link in the Processed Records
column to open the Sync History (BC301000) form with the store and the entity selected and
the list of processed synchronization records (that is, records that have been successfully
synchronized and assigned the Processed status) displayed on the Drilldown filter tab.
7. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
Step 10: Reviewing the Synchronization Status of the Imported Sales Order
To review the synchronization status of the order you imported in the previous step, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area of the form, select the following settings:
• Store: SweetStore - BC
• Entity: Leave empty
In the table on the Processed filter tab, notice that three new synchronization records were created when
the sales order was processed:
• Sales Order: The sales order that you placed in the BigCommerce store. The ERP ID column displays the
order type (EO) and the order ID. The order type is based on the value selected in the Order Type for
Import box on the Order Settings tab of the BigCommerce Stores (BC201000) form.
• Customer: The customer that you created during the placement of the order in the BigCommerce store.
The ERP ID column displays the customer ID and the name of the customer. The customer ID was
assigned to the customer record based on the numbering sequence specified in the Customer Auto-
Numbering box on the Customer Settings tab of the BigCommerce Stores form. The customer name was
imported from the BigCommerce store.
• Payment: The payment used to pay the order in the BigCommerce store. The ERP ID column displays the
payment type (Prepayment) and the payment identifier.
The payment has been imported because the payment method you used to pay the order has been
mapped to an Acumatica ERP payment method and the mapping has been activated on the Payment
Settings tab of the BigCommerce Stores form.
• The imported order has the EO type (shown in the Order Type), which is configured on the BigCommerce
Stores (BC201000) form to be assigned to all sales orders imported from the SweetStore - BC store.
• In the External Reference box, the order number assigned to the order in the BigCommerce store and
the name of the store are displayed.
• The Date of the sales order is the same as the date on which the order was created in the BigCommerce
store.
• In the Description box, the store name, the order number, and the payment status of the order are
displayed.
• The Customer and Location boxes display the information about the customer and customer location
that were created in Acumatica ERP during the import of the sales order; both were created during the
order placement in the BigCommerce store.
On the Details tab, review the only line in the table. Notice the following:
• Branch is set to RETAIL, which is the default branch configured on the BigCommerce Stores form to
appear on sales orders imported from the SweetStore - BC store.
• The inventory ID, quantity, unit price, and extended price of the item are exactly the same as the values
on the order in the BigCommerce store.
On the Payments tab, notice that a prepayment in the order amount has been applied to the sales order.
The shipment is assigned the Confirmed status. The sales order is assigned the Completed status.
You have now performed the first manual synchronization of products, sales orders, and shipments.
In this chapter, you will learn how to prepare entities in Acumatica ERP for synchronization—that is, how to
configure additional mapping of fields to be synchronized, set up filters, and add e-commerce-related information
to stock and non-stock items.
Acumatica ERP Retail-Commerce Edition provides flexible tools that you can use to prepare the data for
synchronization with your BigCommerce store and configure the synchronization settings.
Learning Objectives
In this chapter, you will learn the following:
• How to filter data that needs to be synchronized between Acumatica ERP and the BigCommerce store
• How to configure mapping of standard and custom fields that need to be synchronized
• How to update stock items and non-stock items with e-commerce-related data
Applicable Scenarios
You might want to configure additional mapping if you have defined custom fields in Acumatica ERP, in the
BigCommerce store, or in both systems, and you want these fields to be synchronized between the two systems.
For example, you might want to define an extra field on the customer registration form in the online store and map
this field to a user-defined field or an attribute in a customer record in Acumatica ERP.
Filtering is useful if you do not want to synchronize all data of a particular entity. For example, you might want to
define a subset of items in Acumatica ERP (which are referred to as products in BigCommerce) that you want to
Integration with BigCommerce | 45
export to the online store, or exclude from export the customers that have incomplete information in Acumatica
ERP (that is, the customers that have the On Hold status).
You might want to update e-commerce-related information about items in Acumatica ERP if you want to override
default inventory settings related to export that have been configured for the store on the BigCommerce Stores
(BC201000) form or if you want to maintain all product data, e-commerce-related or otherwise, in one system.
• The direction of the synchronization. For each entity, you specify whether data should be exported to
BigCommerce, imported to Acumatica ERP, or synchronized in both directions.
• The primary system. You indicate which of the systems, ERP (that is, Acumatica ERP) or External System (that
is, BigCommerce), should be used as the source of data if conflicts occur during the synchronization of a
particular entity.
• The real-time synchronization mode. You indicate whether the synchronization records for a particular
entity should be processed immediately aer the data is prepared by selecting either of the following
options:
• Prepare: As soon as a push notification about a change to data is received, the corresponding
synchronization record is placed in the processing queue.
• Prepare & Process: As soon as a push notification about a change to data is received, the corresponding
synchronization record is placed in the processing queue, and data processing is immediately started for
the synchronization record.
• The number of attempts when an error occurs. You specify the number of times the system will try to
process each synchronization record before the synchronization record is assigned the Aborted status and
excluded from synchronization.
You can also change these settings for each particular entity by using the Entities (BC202000) form.
On these tabs, you can change the order of any row in the table by dragging it to its new position.
The display of the listed tabs is determined by the entity selected in the Summary area. The table below shows the
availability of filtering and mapping functionality for particular entities.
Price List No No No No
Product Image No No No No
Product Availability No No No No
For information about standard mapping of entities, see Retail-Commerce Edition Entity Reference. For details
about filtering and mapping for the export and import processes, see Preparing Entities for Synchronization: Filtering
and Preparing Entities for Synchronization: Field Mapping.
Before you export stock items and non-stock items to the online store, you might want to specify commerce-related
settings that are specific to a particular product or specify commerce-related information.
If the Commerce Integration feature is enabled on the Enable/Disable Features (CS100000) form, the eCommerce
tab appears on the Stock Items (IN202500) and Non-Stock Items (IN202000) forms. On this tab, you can specify
the settings that are applied to the items exported from Acumatica ERP to the BigCommerce store. The settings
you specify on this tab for a particular item override the default settings specified on the BigCommerce Stores
(BC201000) form.
If the Matrix Items feature is enabled on the Enable/Disable Features form, the eCommerce tab is also
displayed on the Template Items (IN203000) form.
For each stock or non-stock item, on the eCommerce tab, you can define the following:
• The visibility of the product in the online store.
You define visibility by selecting the appropriate option in the Visibility box: Visible to make the product
visible on the storefront, Invisible to hide it from customers, or Featured to make the product visible and add
it to the Featured sales category.
• The availability assigned to the item when it is exported to the online store.
Integration with BigCommerce | 47
You define the availability of the item by selecting the needed option in the Availability box. You select
Store Default to apply the availability option selected in the store settings to be used by default for exported
products. To make the product available and not track its quantity, you select Set as Available (Don't Track
Qty.). If you want to make the product available for pre-order, you select Set as Pre-Order. To make the
product unavailable aer import, you select Set as Unavailable. For a stock item whose quantity you want to
track, you select Set as Available (Track Qty.).
For stock items whose availability is tracked (that is, for the items for which the Availability is set to Set as
Available (Track Qty.)), you can also specify what action should be performed if the item runs out of stock. To
do this, you select in the When Qty. Unavailable box one of the following options:
• Store Default: To apply the default value configured in the store settings
• Do Nothing: To not perform any action
• Set as Unavailable: To make the item unavailable for purchase in the online store
• Set as Pre-Order: To change the item's availability to Pre-Order
• The custom URL of the product page in the online store.
You specify the custom URL of the product page in the Custom URL box.
By default, product URLs are generated in the BigCommerce store automatically, based on the URL
generation rules configured in the Product URL Settings section on the Store Settings page in the control
panel of your BigCommerce store. The URL specified in the Custom URL box, when the product is exported,
is copied into the Product URL box in the Search Engine Optimization section of the View Products page
of for the product. The URL in the Product URL box overrides the automatically generated URL.
• The title of the product page.
You can specify the title of the product page in the Page Title box. Aer the product is imported to the
BigCommerce store, the text you have specified in this box is copied into the Page Title box in the Search
Engine Optimization section of the View Products page for the product. This text is used in the <title>
tag in the HTML code of the product page.
• Search keywords.
You specify the keywords and search terms that are relevant to the item in the Search Keywords box.
Search keywords are used when a customer searches from within the online store.
• Meta keywords.
You specify meta keywords in the Meta Keywords box. Meta keywords are included in the <meta> tag in
the HTML code of the product page.
• Meta description.
You specify the meta description in the Meta Description box. Aer the product is imported into the
BigCommerce store, the meta description you have specified in this box will be displayed in the Meta
Description box in the Search Engine Optimization section of the View Products page for the product. The
meta description is included in the <meta> tag in the HTML code of the product page.
In this topic, you will learn how you can define export and import filtering settings.
Export Filtering
You can configure the rules according to which data from Acumatica ERP should or should not be exported to the
online store by using the Export Filtering tab of the Entities (BC202000) form.
To define a filter, you need to specify at least one filtering condition. Each condition includes the following
components:
Integration with BigCommerce | 48
• Field Name: The data field by which data needs to be filtered. The list of options you can select from
depends on the selected entity.
• Condition: The logical operation to apply to the value of the selected data field.
• Value: The value you enter for the logical condition used to filter the data, if the selected condition requires
a value.
• Value 2: The second value for the logical condition, if the selected logical condition requires a second value.
For example, the Is Between logical condition requires a second value.
A filter may contain multiple simple conditions or lines combined into one logical expression with brackets and
logical operators (And and Or).
Example
Suppose that you want to maintain customers of a particular customer class, INTL, only in Acumatica ERP, and
you want to exclude such customers from synchronization with the BigCommerce store. To do this, you select the
Customer entity in the Summary area of the Entities form, and on the Export Filtering tab, you specify the condition
corresponding to the settings shown in the following table.
The particular fields that you can select in the Field Name column depend on the selected entity.
If you change the export filter settings aer an export has been completed, the synchronization
records that have been previously processed and are no longer included in the filter, will remain
synchronized but will be assigned the Filtered status.
To avoid typing errors, you can copy the name of the needed field from the API Advanced list as
follows:
1. On the Export Mapping tab, in the Source Object column, select the <Entity> → Advanced
option.
2. In the Source Field / Value column, click the down arrow, and then select and copy the
needed field name.
In some situations, a custom field used in a filtering condition may become unavailable during
export, for example, if a customization project that added the field has been unpublished. In this
case, the system will treat the value in the condition that contains the missing field as null. To avoid
issues during the export, the Is Not Empty condition should be added to each filtering condition that
includes custom fields.
Integration with BigCommerce | 49
In some situations, an attribute used in a filtering condition may become unavailable during export,
for example, if an attribute has been removed from an item class or a customer class of an item or a
customer, respectively, being exported. In this case, the system will treat the value in the condition
that contains the missing field as null. To avoid issues during the export, the Is Not Empty condition
should be added to each filtering condition that includes attributes.
Import Filtering
You can configure the rules according to which data from the online store should or should not be imported into
Acumatica ERP by using the Import Filtering tab of the Entities (BC202000) form.
To define a filter, you need to specify at least one filtering condition. Each condition includes the following
components:
• Field Name: The data field by which data needs to be filtered. The list of options you can select from
depends on the selected entity.
• Condition: The logical operation to apply to the value of the selected data field.
• Value: The value you enter for the logical condition used to filter the data, if the selected condition requires
a value.
• Value 2: The second value for the logical condition, if the selected logical condition requires a second value.
For example, the Is Between logical condition requires a second value.
A filter may contain multiple simple conditions or lines combined into one logical expression with brackets and
logical operators (And and Or).
Example
Suppose that you do not want to import into Acumatica ERP orders placed in the online store by a particular
customer, Morning Cafe. To do this, you select the Order entity in the Summary area of the Entities form, and on the
Import Filtering tab, you specify the condition corresponding to the settings shown in the following table.
The particular fields that you can select in the Field Name column depend on the selected entity.
If you change the import filter settings aer an import has been completed, the synchronization
records that have been previously processed and are no longer included in the filter, will remain
synchronized but will be assigned the Filtered status.
Integration with BigCommerce | 50
In this topic, you will learn how you can map fields between Acumatica ERP and BigCommerce to override the
standard field mapping or define an additional mapping to suit your synchronization requirements.
Active Target Object Target Field Source Object Source Field / Val-
ue
With this mapping, when you synchronize stock items with the BigCommerce store, the alternate ID of a stock item
will be exported to the SKU field of the item in the BigCommerce store.
You define the mappings of fields that should be processed during the import of data from BigCommerce into
Acumatica ERP on the Import Mapping tab of the Entities (BC202000) form. During the import process, data from
the specified fields is prepared and processed according to the defined mappings.
To map two fields that will be processed during the import process, you specify values in the following columns:
• Target Object: An Acumatica ERP object, which is a related set of fields, for the entity. The list of objects
available for selection depends on the entity selected in the Summary area.
• Target Field: A field related to the selected target object. The fields that are displayed in the list depend on
the selected object.
• Source Object: An object in the e-commerce system, which is a related set of fields, for the entity. The list of
objects available for selection depends on the entity selected in the Summary area.
• Source Field / Value: A field related to the selected source object. The fields that are displayed in the list
depend on the selected object. In this field, you can also define a particular value for the mapped field.
Example
Suppose that you want to provide the customers of your BigCommerce store the ability to add a note when signing
up for a new account. You also want this note to be imported into Acumatica ERP during the synchronization of
customer data. The standard customer sign-up form available in the BigCommerce store does not contain a field for
a note. To add a note field in BigCommerce and map it to an attribute field in Acumatica ERP, you need to perform
the following steps:
1. In the BigCommerce store, you open the Form Fields page by clicking Advanced Settings > Account
Signup Form in the le pane, and you create a new field of the text type, Message for Admin.
2. In Acumatica ERP, on the Attributes (CS205000) form, you define an attribute with the following settings:
• Attribute ID: MESSAGE
• Description: Message for Admin
• Control Type: Text
3. On the Customer Classes (AR201000) form, you select a customer class based on which customer records
are created when BigCommerce customers are imported to Acumatica ERP—that is, the customer class
specified for the store in the Customer Class box on the Customer Settings tab of the BigCommerce Stores
(BC201000) form—and on the Attributes tab, you add the created attribute.
4. On the Entities form, you select the store and the Customer entity, and on the Import Mapping tab, you
specify the following settings.
Active Target Object Target Field Source Object Source Field / Val-
ue
With this mapping, the text that a customer enters in the Message to Admin field in the customer
registration form in the BigCommerce store will be imported to Acumatica ERP during the synchronization
of customer data, and will be displayed for the customer in the row of the Message for Admin attribute on
the Attributes tab of the Customers (AR303000) form.
For step-by-step instructions on mapping a nonstandard field for customers, see Preparing Entities for
Synchronization: Implementation Activity.
Auto-Mapping of Fields
When configuring the mapping of fields of the Stock Item, Non-Stock Item, and Template Item entities, instead of
selecting a particular target field, you can type <<Auto_Mapping>> in the Target Field column. During the
synchronization process, the system looks for a field similar to the source field and does one of the following:
Integration with BigCommerce | 52
If <<Auto_Mapping>> is entered in the target field, you cannot use a formula in the source field.
Only custom fields created on the Customers (AR303000), Non-Stock Items (IN202000), and
Stock Items (IN202500) forms can be used for mapping with BigCommerce.
• Attribute fields: You define an attribute (that is, additional properties) of customers on the Attributes
(CS205000) form. Then you add the attribute to a customer class on the Attributes tab of the Customer
Classes (AR201000) form. Aer that, you specify the appropriate attribute values for particular customers
on the Attributes tab of the Customers form. Similarly, you add attributes of inventory items to an item
class on the Item Classes (IN102000) form, and then specify the appropriate attribute values for particular
Integration with BigCommerce | 53
stock items, non-stock items, and template items on the Non-Stock Items, Stock Items, and Template Items
(IN203000) forms, respectively.
For more information about attributes, see Attributes.
• User-defined fields: User-defined fields are similar to attribute fields but are represented differently on
Acumatica ERP forms.
User-defined fields are not supported on the Stock Items and Non-Stock Items forms but are
supported on the Customers and Customer Locations (AR303020) forms. Thus, you can use in
mappings only the user-defined fields created on these forms.
4. In the Source Field / Value column, select a field from the list of fields holding information about products
in BigCommerce orders.
In this activity, you will define a subset of stock items maintained in Acumatica ERP that should be synchronized
with the BigCommerce store. You will also learn how to exclude a particular customer from synchronization, and
map a custom field on the customer registration form in BigCommerce to the corresponding attribute form in
Acumatica ERP.
Story
As an implementation consultant helping SweetLife to set up the integration between Acumatica ERP and the
online store deployed on the BigCommerce platform, you need to configure the synchronization of only a subset of
stock items that will be available for sale on the e-commerce website. The SweetLife store is going to sell jams, and
all stock items that need to be prepared for synchronization belong to the Jam item class.
You also need to configure the generic retail customer, RETSALE, to be excluded from the synchronization
processes.
Additionally, you want to update the customer registration form in the BigCommerce store to have an additional
field that you use to collect information about the size of your business customers. You want this information to be
imported to Acumatica ERP along with the other customer data.
Process Overview
In this activity, you will first review the stock items that need to be exported to the BigCommerce store on the Stock
Items (IN202500) form. Then on the Entities (BC202000) form, you will configure the filtering options for the Stock
Item entity to include in the synchronization only stock items of the Jam item class.
While remaining on the Entities form, you will set up the filtering options for the Customer entity to exclude the
RETSALE customer from synchronization.
Finally, you will create a custom field on the customer registration form in the BigCommerce store, add the ORGSIZE
attribute to the customer class of e-commerce customers (that is, the ECCUSTOMER class) on the Customer Classes
(AR201000) form, and map the attribute to the BigCommerce organization size field on the Entities form.
System Preparation
Before you start the synchronization process, do the following:
• Make sure the connection to the BigCommerce store has been established and the minimum configuration
has been performed, as described in Initial Configuration: To Establish and Configure the Store Connection.
Integration with BigCommerce | 55
• Sign in to the Acumatica ERP instance with the U100 dataset preloaded by using the gibbs username and the
123 password.
Step 2: Configuring the Stock Item Entity to Export a Subset of Stock Items
To configure the Stock Item entity to export to the BigCommerce store only stock items of the Jam item class, do
the following:
1. Open the Entities (BC202000) form.
2. In the Store box, select SweetStore.
3. In the Entity box, select Stock Item.
Notice that this entity is configured to be only exported to the BigCommerce store (the Sync Direction is set
to Export), and only two tabs, Export Mapping and Export Filtering, are displayed.
4. On the Export Filtering tab, add a row to the table, and in the row, specify the following settings to define
the filtering condition:
• Active: Selected
• Field Name: Item Class
• Condition: Equals
• Value: Jam
5. On the form toolbar, click Save to save your changes.
Now when you synchronize the Stock Item entity, only the stock items of the Jam item class will be exported
to the BigCommerce store.
Filtering rules do not affect data that has already been synchronized. For example, if you first
synchronize the Stock Item entity without filters, apply the filter described above, and run
the synchronization again, previously synchronized stock items will remain synchronized;
however, they will be excluded from subsequent synchronizations.
Step 3: Configuring the Customer Entity to Not Sync a Particular Customer Record
To configure the Customer entity to exclude the RETSALE customer from synchronization, do the following:
1. Open the Entities (BC202000) form.
2. In the Store box, select SweetStore.
3. In the Entity box, select Customer.
Integration with BigCommerce | 56
Notice that this entity is configured to be both imported and exported (that is, Sync Direction is set to
Bidirectional), so four tabs—Import Mapping, Import Filtering, Export Mapping, and Export Filtering—are
displayed on the form.
4. On the Export Filtering tab, add a row to the table, and in the row, specify the following settings to define
the filtering condition:
• Active: Selected
• Field Name: Customer ID
• Condition: Does Not Equal
• Value: RETSALE
5. On the form toolbar, click Save to save your changes.
Now when you synchronize the Customer entity, the RETSALE customer will be excluded from the process.
Step 6: Mapping the ORGSIZE Customer Attribute in Acumatica ERP to the Custom Organization
Size Field in BigCommerce
To map the ORGSIZE customer attribute that you configured in Step 4 to the Organization Size field that you
configured in Step 5, do the following:
1. Open the Entities (BC202000) form.
2. In the Store box, select SweetStore.
3. In the Entity box, select Customer.
4. On the Import Mapping tab, specify the following condition:
• Active: Selected
• Target Object: Customer → Attributes
• Target Field: Organization size
• Source Object: Customer → Form Fields
• Source Field / Value: Organization size
5. Click Save on the form toolbar to save your changes.
Now if a customer selects a value in the Organization size drop-down box on the BigCommerce registration
form, aer the Customer entity is synchronized with Acumatica ERP, the selected option will appear on the
Attributes tab of the Customers (AR303000) form.
Now that you have configured the filtering and mapping settings for customers and stock items, you can proceed to
the synchronization of these entities.
Automating Synchronization
In this chapter, you will learn how to automate the synchronization of entities between Acumatica ERP and the
BigCommerce store by setting up automation schedules or by turning on real-time synchronization.
Aer you have performed the initial synchronization between Acumatica ERP and the BigCommerce store for
the needed entities, you might want to set up some of the entities to be synchronized in real time or at regular
intervals. For example, you can configure sales orders, payments, and shipments to be imported from the
BigCommerce store into Acumatica ERP as soon as each order is completed, whereas you can configure the export
of customers from Acumatica ERP to the BigCommerce store to be performed only once a month.
Learning Objectives
In this chapter, you will learn how to do the following:
• Set up automation schedules for data preparation and processing
• Turn on real-time synchronization of entities
• Configure automated synchronization for optimized performance
Integration with BigCommerce | 58
Applicable Scenarios
You automate the synchronization of entities aer you have configured and manually tested the synchronization
between Acumatica ERP and the BigCommerce store to ensure that in your production environment, all needed
data is exported and imported to the appropriate system in a timely manner.
Scheduled synchronization is the process in which each of the synchronization operations—that is, data
preparation and data processing—for an entity is executed by an automation schedule. Because data preparation
and data processing processes are independent of each other, they are scheduled separately and can be performed
in parallel.
Before a predefined schedule can be executed, you need to update it to meet your needs and then activate it. To
activate and modify a predefined schedule, you do the following:
1. You open the Automation Schedules form.
You can open this form by clicking Schedule > View or Schedule > View on the form toolbar
of the Prepare Data (BC501000) form and on the Process Data (BC501500) form.
The execution frequency of each predefined schedule has been specified according to the
general scheduling recommendations and should be fine-tuned to meet the needs of the
particular business.
3. You activate the schedule by selecting the Active check box in the Summary area.
4. You save your changes to the schedule.
Once the store has been specified in the filter settings and the schedule has been activated, the process for which
the schedule was defined will be automatically executed according to the schedule's settings.
For detailed instructions on activating a predefined automation schedule, see Automated Synchronization: To
Configure a New Automation Schedule.
Defining Automation Schedules for Data Preparation and Data Processing from Scratch
You might need to define an automation schedule from scratch for entities that do not need frequent
synchronization (for example, Sales Category or Customer Price Class). Acumatica ERP does not provide predefined
automation schedules for such entities.
You set up automation schedules for synchronizing specific entities between the two systems by using the
Automation Schedules (SM205020) form, which you can open directly or by clicking Schedule > Add on the form
toolbar of the Prepare Data (BC501000) and Process Data (BC501500) forms.
To configure a schedule for data preparation, you do the following:
1. On the Prepare Data form, in the Summary area, you specify the BigCommerce store with which you are
configuring synchronization, as well as the data preparation mode.
2. In the table, you select the unlabeled check box for each entity that should be processed when the schedule
is executed.
Integration with BigCommerce | 60
To configure a schedule for processing synchronization records with the Pending and Failed statuses, you do the
following:
1. In the Summary area of the Process Data form, you specify the BigCommerce store for which you are
configuring synchronization and the entity that needs to be processed.
For step-by-step instructions on creating a schedule for preparing and processing data, see Automated
Synchronization: To Configure a New Automation Schedule.
With real-time synchronization, Acumatica ERP attempts to prepare data or prepare and process data as soon
as a change occurs in Acumatica ERP or in the e-commerce system. Depending on the entity involved and your
company's processes, real-time synchronization can involve import or export or can be bidirectional. (For some
entities, the direction of the synchronization is system-specified and cannot be changed.)
Real-time import relies on webhooks that Acumatica ERP receives from an e-commerce system, and real-time
export makes use of the push notification mechanism available in Acumatica ERP. For general information about
webhooks in Acumatica ERP, see Configuring Webhooks. For general information about push notifications, see
Configuring Push Notifications.
Real-Time Mode
Before you turn on real-time synchronization for an entity, you specify how changes to records of the entity should
be handled. To do so, in the Summary area of the Entities (BC202000) form, in the Real-Time Mode box, you select
one of the following options:
• Prepare: As soon as a push notification about a change to data is received, the corresponding
synchronization record is placed in the processing queue. The synchronization record appears on the
Sync History (BC301000) form, but the change is not recorded to the destination system unless the
synchronization record is processed manually or by an automation schedule.
• Prepare & Process: As soon as a push notification about a change to data is received, the corresponding
synchronization record is placed in the processing queue. At the same time, a background process will
immediately start processing synchronization records from that queue.
Integration with BigCommerce | 61
Depending on the volume of orders processed by your company, we recommend that you configure entities to be
synchronized automatically as indicated in the following tables.
The schedules in the following table are recommended for companies that process no more than 1,000 orders daily.
Stock Item, Non-Stock Started Daily, once a night Daily, once a night
Item, Template Item
Real-time mode: Prepare &
Process
We recommend that you not enable real-time synchronization if you plan to change configuration
settings or to perform mass-addition, mass-deletion, and mass-update operations, including by
means of import scenarios. We also recommend that you start real-time synchronization only aer
you begin production use to avoid unnecessary server traffic during the implementation.
The schedules in the following table are recommended for companies that process 1,000 or more online orders
daily.
Stock Item, Non-Stock Stopped Daily, once a night Daily, every 60 minutes
Item, Template Item
Integration with BigCommerce | 63
The following activity will walk you through the process of creating an automation schedule from scratch. To gain
greater familiarity with the process, you will create two automation schedules: one that starts data preparation,
and one that starts data processing for the customer data.
Story
Suppose that as an implementation consultant helping SweetLife to set up integration with BigCommerce, you
want to configure continuous synchronization of entities. As part of the setup, you need to configure the system
to synchronized new and updated customers between Acumatica ERP and the BigCommerce store once a day (at
night). Because Acumatica ERP does not provide any predefined automation schedules for the Customer entity, you
will need to create two automation schedules from scratch. The first schedule will prepare the customer data for
processing, and the second schedule will start the processing of the prepared data.
Process Overview
You will do the following:
1. On the Prepare Data (BC501000) form, define the conditions for preparing data of the Customer entity.
2. On the Automation Schedules form, create an automation schedule to start data preparation for the
Customer entity once a day.
3. On the Process Data (BC501500) form, define the conditions for processing data of the Customer entity.
4. On the Automation Schedules form, create an automation schedule to start data processing for the Customer
entity once a day.
System Preparation
Before you perform the instructions of this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The BigCommerce store has been created and configured, as described in Initial Configuration: To Set Up
a BigCommerce Store.
• The connection to the BigCommerce store has been established and the initial configuration has been
performed, as detailed in the steps in Initial Configuration: To Establish and Configure the Store Connection.
2. Sign in to the Acumatica ERP instance with the U100 dataset preloaded by using the following credentials:
• Username: gibbs
• Password: 123
Integration with BigCommerce | 64
On the Filter Values tab, the system has added the settings summarized in the following table, which
correspond to the selections you have made on the Prepare Data form earlier in this step.
6. On the Details tab, specify the additional settings of the schedule as follows:
• In the Starts On box, leave the default value, which is the current business date.
• Select the No Execution Limit check box.
7. On the Schedule tab, specify the execution dates and times as follows:
a. In the Schedule Type section, select the Daily option button.
b. In the Execution Time section, in the Starts On box, select 11:30 PM.
With these settings, the schedule execution will be started every day at 11:30 PM.
8. On the form toolbar, click Save & Close to save the changes to the automation schedule.
Integration with BigCommerce | 65
5. On the Details tab, specify the additional settings of the schedule as follows:
• In the Starts On box, leave the default value, which is the current business date.
• Select the No Execution Limit check box.
6. On the Schedule tab, specify the execution dates and times as follows:
• In the Schedule Type section, select the Daily option button.
• In the Execution Time section, in the Starts On box, select 12:30 AM.
With these settings, the schedule execution will be started every day at 12:30 AM.
7. On the form toolbar, click Save & Close to save your changes to the automation schedule.
You have configured two automation schedules for the Customer entity. Now the first automation schedule
will start the data preparation process every night at 11:30 PM to retrieve the changed data if any changes have
occurred in customers in Acumatica ERP since the previous data preparation, and will place it in the processing
queue. The second schedule will start the data processing for the Customer entity to process the synchronization
records that are out of sync. During data processing, the system will also attempt to synchronize the customer
synchronization records that could not be processed before (that is, the synchronization records that have the
Failed status).
In this activity, you will learn how to turn on real-time synchronization for an entity.
Story
Suppose that as an implementation consultant helping SweetLife to set up integration with BigCommerce, you
want to configure continuous synchronization of particular entities. As part of the setup, you need to turn on real-
Integration with BigCommerce | 66
time synchronization of shipments so that they are exported to the BigCommerce store as soon as they are created
or updated in Acumatica ERP.
Process Overview
In this activity, you will turn on real-time synchronization for the Shipment entity on the Entities (BC202000) form so
that the system immediately exports the changes in shipments to the BigCommerce store.
System Preparation
Before you perform the instructions of this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The BigCommerce store has been created and configured, as described in Initial Configuration: To Set Up
a BigCommerce Store.
• The connection to the BigCommerce store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Establish and Configure the Store Connection.
2. Sign in to the Acumatica ERP instance with the U100 dataset preloaded by using the following credentials:
• Username: gibbs
• Password: 123
We recommend that you test the configuration by creating a new shipment for a sales order imported
from the SweetStore - BC store to Acumatica ERP, and then reviewing the corresponding shipment
in the SweetStore - BC store. If for some reason the changes have not been synchronized, review the
corresponding synchronization record on the Sync History (BC301000) form.
Acumatica ERP provides a set of predefined business events that can be activated to trigger the sending of an email
notification to the administrator of an online store about aborted synchronization records. Each of the predefined
business events is defined for one of the following entities: Sales Order, Payment, Shipment, or Refund. The
Integration with BigCommerce | 67
notification is sent when the commerce connector fails to process a synchronization record related to the entity if
the maximum allowed number of failed attempts has been exceeded. The administrator specifies the maximum
allowed number of failed attempts for each entity on the Entities (BC202000) form or on the BigCommerce Stores
(BC201000) form.
To cause any of the predefined business events to start triggering email notifications about aborted
synchronization records of the entity whose synchronization records are monitored by the business event, you
need to perform the following general steps:
• On the Connection Settings tab of the BigCommerce Stores form, specify the administrator of the store in
the Administrator box.
• On the Business Events (SM302050) form, activate the needed business event by selecting the Active check
box in the Selection area for the event.
Once the business event has been activated and the administrator of the store has been specified, the system will
automatically start sending the store administrator email notifications each time a synchronization record of the
corresponding entity is aborted.
The following table lists the predefined business events that you can activate on the Business Events form, the
description of the business event, the underlying generic inquiry (that is, the inquiry that defines the data the
system should monitor, which is aborted synchronization records of the entity, to detect whether this business
event has occurred), and the notification template that has been specified as a subscriber to the business event.
For information about email notifications that are triggered by business events, see Business Events: Email
Notifications.
The following activity will walk you through the process of configuring a business event that sends an email
notification to the store administrator when the synchronization of an order placed in the e-commerce system is
aborted.
Story
Suppose that you have configured the automated import of sales orders from the e-commerce store and want
Jerald Stevens, an e-commerce manager of SweetLife, to be notified when the system has failed to process a
synchronization record of a sales order too many times (based on the setting specified in the system) and has
set its status to Aborted, which excludes the record from synchronization. To receive a notification every time the
synchronization of a sales order is aborted, you need to activate a predefined business event that will trigger the
sending of an email message to the store administrator every time the status of a synchronization record of a sales
order changes to Aborted. You also want to review the notification template to make sure it is sent to the correct
recipient and contains the necessary data about the aborted records.
Configuration Overview
In the U100 dataset, the following tasks have been performed for the purposes of this activity:
• On the Email Templates (SM204003) form, the Aborted Synchronization Record notification template has
been defined.
• On the Users (SM201010) form, the stevens user record has been created.
Process Overview
You will do the following:
1. On the BigCommerce Stores (BC201000) form, specify the store administrator who should receive email
notifications about aborted synchronization records.
2. On the Business Events (SM302050) form, activate a predefined business event that will trigger the sending
of an email when the system fails to process a sales order synchronization record more than the maximum
number of synchronization attempts allowed, which by default is five.
3. On the Email Templates (SM204003) form, review the notification template used for notifications about
aborted sales orders.
System Preparation
Do the following:
1. Make sure that the following prerequisites have been met:
a. The BigCommerce store has been created and configured, as described in Initial Configuration: To Set Up
a BigCommerce Store.
b. The connection to the BigCommerce store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Establish and Configure the Store Connection.
2. Sign in to Acumatica ERP by using the following credentials:
• Username: gibbs
• Password: 123
3. On the Connection Settings tab, in the Administrator box (the Store Administrator Details section), select
stevens.
The user you select in this box will become the recipient of email notifications sent by the business event
that you will activate in the next step.
4. On the form toolbar, click Save.
You have activated the business event that will trigger sending an email notification to Jerald Stevens every time a
synchronization record of the Sales Order entity is assigned the Aborted status.
In this activity, you have activated the predefined business event that will trigger the sending of an email to the
store administrator about aborted synchronization of sales orders.
Integration with BigCommerce | 70
Synchronizing Customers
In the topics of this chapter, you will read about customer synchronization between Acumatica ERP and the
BigCommerce store.
In Acumatica ERP Retail-Commerce Edition, you can synchronize customer records between Acumatica ERP and
the BigCommerce store.
Learning Objectives
In this chapter, you will learn how to do the following:
• Set up the synchronization of customers and customer locations (addresses) so that they can be both
exported to the BigCommerce store and imported from the BigCommerce store to Acumatica ERP.
• Define the filtering of customers based on various conditions.
• Synchronize customers that have multiple locations.
Applicable Scenarios
You configure the import of customers if you want to synchronize changes to customer information made in the
BigCommerce store to Acumatica ERP. The synchronization of customers is a prerequisite for the synchronization
of orders. So if you plan to import online orders placed in the BigCommerce store by new, existing, or guest
customers and then further process these orders in Acumatica ERP, you need to synchronize customers first.
You configure the export of customers from Acumatica ERP to the BigCommerce store if you maintain records of
customers in Acumatica ERP and want the details of these customers to be available in the BigCommerce store
so that the up-to-date customer information, such as customer billing and address details, is available when
registered customers place orders online.
The groups of underscores represent the constant segments, and the number signs represent the auto-
numbered segment.
You replace the underscores with the values of the constant segments to be used in the identifiers of the
customers imported from the BigCommerce store, as shown in the following example: ECUS-RET1-######.
With this setting, the identifiers of all customers imported from BigCommerce to Acumatica ERP would start
with ECUS-RET1, for easy identification, and the system would automatically assign the numerical part of
the identifier according to the numbering sequence selected in the Customer Auto-Numbering box. These
settings do not affect the assignment of identifiers to other customers in the system (those that already exist
or those that are created directly in Acumatica ERP).
• Customer Auto-Numbering: The numbering sequence that the system uses to automatically generate
identifiers for customers imported from the BigCommerce store.
If the CUSTOMER segmented key consists of more than one segment, the numbering sequence that you
select in this box applies to the automatically numbered segment (a group of number signs in the Customer
Numbering Template box). The length of the numbering sequence must match the length of the auto-
numbered segment.
Selecting a numbering sequence in this box does not change the Numbering ID setting of the CUSTOMER
segmented key on the Segmented Keys form. The selected numbering sequence applies only to customers
that are imported from the BigCommerce store and does not affect the assignment of identifiers to other
customers in the system (those that already exist or those that are created directly in Acumatica ERP).
For more information about segmented keys and numbering sequences, see Managing Segmented Keys.
• Generic Guest Customer (optional): The generic customer account that appears on imported sales orders
that were placed in the BigCommerce store as guest orders. This customer account is not exported to
the BigCommerce store during the synchronization of customers. For more information about creating a
customer, see Customers: General Information.
If the Customer entity is activated and the Customer Location entity is not activated on the BigCommerce Stores
form, when the Customer entity is synchronized between the BigCommerce store and Acumatica ERP, the customer
location (address) data is not copied from one system to the other.
When a sales order created in the BigCommerce store is imported, the address information (that is, the billing
address and shipping address) specified in the order is imported to Acumatica ERP as part of sales order data;
however, new locations are not created and existing locations are not updated with the imported data.
Before you can start synchronizing customer records along with customer location (address) records between
Acumatica ERP and the BigCommerce store, you need to activate the Customer Location entity for the store. To do
this, on the BigCommerce Stores (BC201000) form, you select the store, and on the Entity Settings tab, you select
the Active check box for the Customer Location entity. Then on the Customer Settings tab, you need to also fill in
the following boxes:
• Location Numbering Template (available for editing only if the LOCATION segmented key has more than
one segment): The template that is used to provide the identifiers of new customer locations imported to
Acumatica ERP from the BigCommerce store. This character string, such as ____-____-######, initially shows
the number and length of segments in the LOCATION segmented key, which is configured on the Segmented
Keys form and defines the structure of the identifiers used for customer locations in Acumatica ERP. The
underscores represent the constant segments, and the number signs represent the automatically numbered
segment.
You replace the underscores with values of the constant segments to be used in the identifiers of the
customer locations imported from the BigCommerce store, as shown in the following example: ECOM-
RET1-######. With this setting, the identifiers of all customer locations imported from BigCommerce to
Acumatica ERP would start with ECOM-RET1, for easy identification, and the system would automatically
Integration with BigCommerce | 72
assign the numerical part of the identifier according to the numbering sequence selected in the Location
Auto-Numbering box. These settings do not affect the assignment of identifiers to other customer locations
in the system (those that already exist or those that are created directly in Acumatica ERP).
If you will be importing customer locations from an online store, one of the segments of the LOCATION
segmented key must be automatically numbered.
• Location Auto-Numbering: The numbering sequence that the system uses to automatically generate
identifiers for customer locations imported from the BigCommerce store.
If the LOCATION segmented key consists of more than one segment, the numbering sequence that you
select in this box applies to the automatically numbered segment (a group of number signs in the Location
Numbering Template box). The length of the numbering sequence must match the length of the auto-
numbered segment.
Selecting a numbering sequence in this box does not change the Numbering ID setting of the LOCATION
segmented key on the Segmented Keys form. The selected numbering sequence applies only to customer
locations that are imported from the BigCommerce store and does not affect the assignment of identifiers
to other customer locations in the system (those that already exist or those that are created directly in
Acumatica ERP).
For more information about segmented keys and numbering sequences, see Managing Segmented Keys.
When the Customer entity is synchronized between the BigCommerce store and Acumatica ERP, customer location
(address) data is copied from one system to the other along with the customer data. The remaining sections of
this topic describe what happens during the synchronization if a customer was created without an address or if an
address was created, updated, or deleted in either system.
1. If the customer location is active—that is, if the Active check box is selected for it on the Customer Locations
(AR303020) form—the corresponding customer address in the BigCommerce store is updated based on the
changes to the customer location.
2. If the customer location is inactive (that is, if the Active check box is cleared for it), the synchronization
proceeds as follows:
• If the location's synchronization record has a status other than Deleted, the corresponding customer
address in the BigCommerce store is updated based on the changes to the customer location.
• If the location's synchronization record has the Deleted status or the location has not been synchronized
previously, the location is not synchronized with the BigCommerce store.
The following diagram illustrates the synchronization of an updated customer address.
The following sections provide details you can use to ensure that the system is configured properly for the
synchronization of customers and customer locations between Acumatica ERP and the BigCommerce store, and to
understand (and change, if needed) the settings that affect the processing workflow.
Implementation Checklist
We recommend that before you initially synchronize customers and customer locations between Acumatica
ERP and the BigCommerce store, you make sure the needed features have been enabled and settings have been
specified, as summarized in the following checklist.
Customer Classes (AR201000) The customer class for e-commerce customers has been creat-
ed. This customer class is used for creating customer records in
Acumatica ERP for customers imported from the BigCommerce
store.
See Accounts Receivable: Customer Classes.
Customers (AR303000) The customer account for importing to Acumatica ERP orders
placed in the online store by guest users has been created.
See Customers: General Information.
Numbering Sequences (CS201010) • A numbering sequence has been defined for the auto-numbered
segment that will be used for generating customer IDs on im-
port.
• A numbering sequence has been defined for the auto-numbered
segment that will be used for generating customer location IDs
on import.
See Use of Numbering Sequences.
BigCommerce Stores (BC201000) form • The connection to the BigCommerce store has been established
as described in Initial Configuration of a BigCommerce Store.
• On the Entity Settings tab, the following entities have been acti-
vated:
• Customer
• Customer Location (if customer locations should be synchro-
nized together with customers)
• On the Customer Settings tab, the following boxes have been
filled in:
• Customer Class
• Customer Numbering Template (if the CUSTOMER segment-
ed key has more than one segment)
• Customer Auto-Numbering
• Location Numbering Template (if the LOCATION segmented
key has more than one segment)
• Location Auto-Numbering
• Generic Guest Customer
Entities (BC202000) • The filtering conditions for the export and import of the Cus-
tomer entity have been defined, if necessary.
• The additional mappings for the export and import of the Cus-
tomer entity have been defined, if necessary.
Validation of Configuration
To make sure that all configuration has been performed correctly, we recommend that in your system, you perform
instructions similar to those described in Synchronizing Customers: To Perform Bidirectional Synchronization and
Synchronizing Customers: To Synchronize Customers with Multiple Locations.
Integration with BigCommerce | 77
The following activity will walk you through the process of setting up the bidirectional synchronization of
customers and performing the synchronization of customers between Acumatica ERP and the BigCommerce store.
Story
Suppose that the SweetLife Fruits & Jams company has multiple corporate customers from the United States and
Canada in the system. The company management wants customer records for US customers to be exported from
Acumatica ERP to the BigCommerce store. At the same time, new customers that place orders in the BigCommerce
store should be imported to Acumatica ERP.
Because an email address is a key field for a customer in BigCommerce, customers that do not have it specified in
Acumatica ERP will not be saved in the BigCommerce store during the export.
Acting as an implementation consultant helping SweetLife to set up the integration of Acumatica ERP with the
BigCommerce store, you need to configure the bidirectional synchronization of customers, and configure the
filtering conditions to export only records for US customers that have an email specified.
Configuration Overview
In the U100 dataset, the following tasks have been performed for the purposes of this activity:
• On the Customer Classes (AR201000) form, the COMMERCEBB and ECCUSTOMER customer classes have been
configured. The COMMERCEBB customer class is assigned to local (US) customers that need to be exported
to the external system.
• On the Customers (AR303000) form, the following customer records have been created and assigned the
COMMERCEBB customer class:
• FRUITICO: On the General tab, notice that no details have been specified in the boxes of the Primary
Contact section. In the Additional Account Info section, the account's email address and phone number
have been specified.
• JAMIFIQUE: On the General tab, notice that in the Primary Contact section, the name of the contact
(Colleen Plunkett) has been filled in. In the Additional Account Info section, the account's email address
and phone number have been specified.
• On the Numbering Sequences (CS201010) form, the ECCUSTOMER numbering sequence has been defined.
Process Overview
In this activity, you will perform the following steps:
1. On the BigCommerce Stores (BC201000) form, review the settings of the Customer entity.
2. On the Entities (BC202000) form, configure the filtering condition for the export of customers from
Acumatica ERP to the BigCommerce store.
3. On the Customers (AR303000) form, review some of the customers that need to be exported.
4. On the Prepare Data (BC501000) form, start the data preparation process for the Customer entity to prepare
out-of-sync data for export.
5. On the Process Data (BC501500) form, start data processing for the Customer entity to save the
synchronized customer data in the BigCommerce store.
6. On the Sync History (BC301000) form, review the synchronization status of the processed synchronization
records.
Integration with BigCommerce | 78
7. In the BigCommerce store, review the customers that have been imported from Acumatica ERP.
System Preparation
Before you complete the instructions in this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The BigCommerce store has been created and configured, as described in Initial Configuration: To Set Up
a BigCommerce Store.
• The connection to the BigCommerce store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Establish and Configure the Store Connection.
2. Launch the Acumatica ERP website with the U100 dataset preloaded, and sign in with the following
credentials:
• Username: gibbs
• Password: 123
3. Sign in to the control panel of the BigCommerce store as the store administrator.
System Preparation
Before you complete the instructions in this activity, do the following:
1. Open the BigCommerce Stores (BC201000) form.
2. In the Store Name box, select SweetStore - BC.
3. On the Entity Settings tab, in the row with the Customer entity, make sure Sync Direction is set to
Bidirectional and Primary System is set to External System.
4. On the form toolbar, click Save to save your changes.
The Process Data (BC501500) form opens with the SweetStore - BC store and the Customer entity selected in
the Summary area. The table displays all synchronization records of the Customer entity that the system has
prepared in the previous step.
2. On the form toolbar, click Process All to process both synchronization records displayed in the table.
3. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
If you are not signed in to the control panel of the BigCommerce store in the same browser,
you will need to enter your sign-in credentials.
Notice that the details that have been filled in for the customer based on the information from the General
tab of the Customers (AR303000) form. The name from the Primary Contact section has been imported as
the customer's first name and last name. And the Email Address and Phone Number have been filled in
with the email address and the phone number from the Additional Account Info section of the same tab.
Integration with BigCommerce | 81
If other customers have been created in the control panel of the BigCommerce store or have
been exported from Acumatica ERP previously, the list of customers displayed on this page
may differ.
The following activity will walk you through the process of setting up the synchronization of customer locations
and performing the synchronization of customers with locations between Acumatica ERP and the BigCommerce
store.
Story
Suppose that the SweetLife Fruits & Jams company works with corporate customers that order items to be
delivered to multiple locations. The company's sales managers keep track of customer addresses by using the
customer address book functionality in the BigCommerce store and need the addresses from the BigCommerce
store to be in sync with customer locations in Acumatica ERP.
Acting as an implementation consultant helping SweetLife to set up the integration of Acumatica ERP with the
BigCommerce store, you need to set up the synchronization of customer locations between the two systems, as
well as test it and explore how the synchronization works in both systems.
Configuration Overview
In the U100 dataset, the following tasks have been performed for the purposes of this activity:
• On the Enable/Disable Features (CS100000) form, the Business Account Locations feature has been enabled.
• On the Customer Classes (AR201000) form, the ECCUSTOMER customer class has been defined.
• On the Numbering Sequences (CS201010) form, the ECCUSTOMER and ECLOCATION numbering sequences
have been defined.
Process Overview
In this activity, you will do the following:
Integration with BigCommerce | 82
1. On the BigCommerce Stores (BC201000) form, update the settings of the Customer and Customer Locations
entities.
2. In the control panel of the BigCommerce store, create a new customer with two addresses.
3. On the Prepare Data (BC501000) form, prepare the customer and customer address data for
synchronization.
4. On the Process Data (BC501500) form, process the customer and customer address data prepared for
synchronization.
5. On the Customers (AR303000) form, review the imported customer data.
6. On the Customer Locations (AR303020) form, review the imported customer address data and update one of
the customer locations.
7. By using the Sync History (BC301000) form, synchronize the updated customer location with the
BigCommerce store.
8. In the control panel of the BigCommerce store, review the updated customer address.
System Preparation
Before you perform the instructions in this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The BigCommerce store has been created and configured, as described in Initial Configuration: To Set Up
a BigCommerce Store.
• The connection to the BigCommerce store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Establish and Configure the Store Connection.
2. Launch the Acumatica ERP website with the U100 dataset preloaded, and sign in with the following
credentials:
• Username: gibbs
• Password: 123
3. Sign in to the control panel of the BigCommerce store as the store administrator.
Step 1: Configuring the Synchronization Settings of the Customer and Customer Location Entities
To review the synchronization settings of the Customer and Customer Locations entities, do the following:
1. Open the BigCommerce Stores (BC201000) form.
2. In the Store Name box of the Summary area, select SweetStore - BC.
3. On the Entity Settings tab, do the following:
a. In the row of the Customer entity, make sure that Sync Direction is set to Bidirectional.
b. In the row of the Customer Location entity, select the Active check box.
All settings of the Customer Location entity (including the synchronization direction) are the
same as those of the Customer entity and cannot be edited.
4. On the Customer Settings tab, make sure that the following settings have been specified:
• Customer Class: ECCUSTOMER
When a new customer is imported from the BigCommerce store to Acumatica ERP, its default settings are
defined based on the customer class selected in this box.
• Customer Auto-Numbering: ECCUSTOMER
Integration with BigCommerce | 83
Each new customer imported from the BigCommerce store will be assigned an identifier based on the
numbering sequence selected in this box.
• Location Auto-Numbering: ECLOCATION
Each new customer location imported from the BigCommerce store will be assigned an identifier based
on the numbering sequence selected in this box.
5. On the form toolbar, click Save to save your changes.
Step 1: Configuring the Synchronization Settings of the Customer and Customer Location Entities
To update the synchronization settings of the Customer and Customer Locations entities, do the following:
1. Open the BigCommerce Stores (BC201000) form.
2. In the Store Name box of the Summary area, select SweetStore - BC.
3. On the Entity Settings tab, do the following:
a. In the row of the Customer entity, make sure that Sync Direction is set to Bidirectional.
b. In the row of the Customer Location entity, select the Active check box.
All settings of the Customer Location entity (including the synchronization direction) are the
same as those of the Customer entity and cannot be edited.
4. On the Customer Settings tab, specify ECLOCATION in the Location Auto-Numbering box.
Each new customer location imported from the BigCommerce store will be assigned an identifier based on
the numbering sequence selected in this box.
5. On the form toolbar, click Save to save your changes.
2. On the Edit Customer page, which opens with the details of Isabelle Bober, on the Customer Address Book
tab, click Add an Address.
3. On the Add Customer Address page, which opens, in the Customer Address Details section, specify the
following settings:
• First Name: Isabelle
• Last Name: Bober
• Company Name: Hoppy Place Coffee and Cakes
• Phone Number: 212-555-0143
• Address Line 1: 3690 Taylor Street
• Suburb/City: New York
• Country: United States
• State/Province: New York
• Zip/Postcode: 10007
4. In the lower right, click Save & Add Another.
5. To add a second address for the customer, on the Add Customer Address page, which opens, specify the
following settings:
• First Name: William
• Last Name: Duncan
• Company Name: Hoppy Wellby
• Phone Number: 212-555-0164
• Address Line 1: 2671 Simons Hollow Road
• Suburb/City: New York
• Country: United States
• State/Province: New York
• Zip/Postcode: 10001
6. In the lower right, click Save & Exit.
The system saves the second address and displays the list of addresses in the customer's address book.
4. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box and return to the Prepare Data form.
Notice that the Prepared Records column shows the number of synchronization records that have been
prepared and are ready to be processed.
The empty ERP ID indicates that the record has been created in the BigCommerce store but
has not yet been synchronized with Acumatica ERP.
3. On the form toolbar, click Process to process the selected synchronization record.
4. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
When you change a location of a customer, the e-commerce connector recognizes the
customer record as having been modified as well. So in this step, you could have selected
the synchronization record for the Hoppy Place Coffee and Cakes customer and clicked Sync,
and the updated customer location would have been synchronized as part of the customer
synchronization process. Alternatively, you could have prepared the Customer entity for
synchronization on the Prepare Data (BC501000) form and then processed the prepared
synchronization records on the Process Data (BC501500) form.
If you are not signed in to the control panel of the BigCommerce store in the same browser,
you will need to enter your sign-in credentials.
2. In the Customer Address Details section, review the updated details of the customer address.
Notice that the First Name box now displays Gail, Last Name is set to Anderson, and the Address Line 1 has
been changed to 3650 Taylor Street.
Synchronizing Products
In the topics of this chapter, you will read about product synchronization between Acumatica ERP and the
BigCommerce store.
Acumatica ERP Retail-Commerce Edition provides you with the ability to export product data (that is, data of stock
and non-stock items) from Acumatica ERP to the BigCommerce store.
Learning Objectives
In this chapter, you will learn how to export stock and non-stock items to the BigCommerce store.
Applicable Scenarios
You export items from Acumatica ERP to the BigCommerce store in the following cases:
• When you are initially configuring the BigCommerce store and need to transfer stock and non-stock items
that have already been defined in Acumatica ERP
• If you have updated any of the item settings in Acumatica ERP aer the item was synchronized with the
BigCommerce store so that the changes are reflected in the product settings in the store
Integration with BigCommerce | 88
When you set up a connection to a BigCommerce store on the BigCommerce Stores (BC201000) form, you specify
the availability and visibility settings that are applied by default to all items synchronized with the BigCommerce
store.
• Set as Pre-Order: The non-stock and stock items exported to the BigCommerce store are not available
for purchase but customers can pre-order them. In BigCommerce, on the product management page for
each of these items, the This product is coming soon but I want to take pre-orders option button (in the
Purchasability section) is selected.
• Do Not Update: The availability settings and quantity of the item in the BigCommerce store are not updated.
• Set as Unavailable: The non-stock and stock items exported to the BigCommerce store are not available for
purchase. In BigCommerce, on the product management page for each of these items, the This product
cannot be purchased in my online store option button (in the Purchasability section) is selected.
The Default Availability setting applies if the Availability setting for a particular item is set to Store
Default on the Non-Stock Items (IN202000) or Stock Items (IN202500) form.
If you select the Set as Available (Track Qty.) option in the Default Availability box, you need to also specify what
action the system should perform with out-of-stock items (that is, with stock items whose quantities become zero).
To do so, in the When Qty. Unavailable box, you select one of the following options:
• Do Nothing: The system does not change the availability settings of the item. In BigCommerce, in the
Purchasability section of the product management page, the This product can be purchased in my online
store option button remains selected. However, the item cannot be included in sales orders.
• Set as Unavailable: The system makes the item unavailable for purchase via the storefront. In BigCommerce,
in the Purchasability section of the product management page, the This product cannot be purchased in
my online store option button becomes selected.
• Set as Pre-Order: The system makes the item unavailable for purchase but available for pre-order. In
BigCommerce, in the Purchasability section of the product management page, the This product is coming
soon but I want to take pre-orders option button becomes selected.
If you have synchronized the Product Availability entity, when you modify any of the settings described in this
section, the system resets the availability synchronization status for all synchronized items in the BigCommerce
store, and you need to perform the full synchronization of the Product Availability entity again.
By default, the availability and visibility settings defined for the store on the BigCommerce Stores (BC201000) form
are applied to all stock and non-stock items exported to the BigCommerce store. However, you can override the
default values for a particular item, as described in the sections below.
The status of an item in Acumatica ERP affects the purchasability status of the item in BigCommerce. If the item's
status in Acumatica ERP is Inactive, No Sales, or Marked for Deletion—that is, if any of these options is selected in
Integration with BigCommerce | 90
the Status box in the Summary area of the Non-Stock Items or Stock Items form—aer the synchronization of the
relevant entity, in the Purchasability section of the product management page of the item in the BigCommerce
store, the This product cannot be purchased in my online store option button is selected, regardless of the
Availability setting of this item in Acumatica ERP.
• To make the item available for purchase via the storefront, you select Set as Available (Don't Track Qty.). In
BigCommerce, on the product management page, the This product can be purchased in my online store
option button is selected.
• To make the item unavailable for purchase via the storefront but available for pre-order, you select Set as
Pre-Order. In BigCommerce, on the product management page, the This product is coming soon but I
want to take pre-orders option button is selected.
• To make the item unavailable for purchase via the storefront, you select Set as Unavailable. In
BigCommerce, on the product management page, the This product cannot be purchased in my online
store option button is selected.
The option selected in the Availability box for a particular item takes precedence over the default setting specified
for the store in the Default Availability box on the Inventory Settings tab of the BigCommerce Stores (BC201000)
form. If Store Default is selected, the store's default visibility setting applies.
For information about tracking quantities of exported stock items, see Product Availability: General Information.
Items' sales categories are exported during the synchronization of the Sales Category entity. To synchronize the
Sales Category entity with a BigCommerce store, it should be activated for the store on the Entity Settings tab of
the BigCommerce Stores (BC201000) form.
If the Sales Category entity has been activated, during the synchronization of a stock or non-stock item, the system
does the following:
• If any sales categories are assigned to the item in Acumatica ERP and have been exported to the
BigCommerce store (or created there), assigns the exported item to these categories in the BigCommerce
store
• If no sales categories are assigned to the item, the default sales category or categories have been specified
on the Inventory Settings tab of the BigCommerce Stores store, and the default sales categories have
Integration with BigCommerce | 91
been synchronized with the BigCommerce store, assigns the exported item to these categories in the
BigCommerce store
• If no sales categories are assigned to the item and no default categories have been specified, exports the
item and does not assign it to any sales categories in the BigCommerce store.
Any categories that have been assigned to the item in the BigCommerce store become
unassigned.
For details about the information exported to the BigCommerce store and imported from the BigCommerce store
during the synchronization of the Sales Category entity, see Sales Category Entity.
The following activity will walk you through the processes of creating an attribute for a stock item and for a non-
stock item and synchronizing these items with the BigCommerce store.
Story
Suppose that the SweetLife Fruits & Jams company is going to start selling training courses in a few months.
However, it wants to let the shoppers of its online store know when the courses will be available for purchase.
Further suppose that you want to display the sugar levels of jams the company sells in the online store on the
product detail pages on the storefront.
Acting as an implementation consultant helping SweetLife to set up the integration of Acumatica ERP with the
BigCommerce store, you need to define an attribute for the course availability date and an attribute for the sugar
level and then export these dates and sugar levels to the BigCommerce store.
Configuration Overview
In the U100 dataset, the following tasks have been performed for the purposes of this activity:
• On the Item Classes (IN201000) form, the TRAINING and JAM item classes have been defined.
• On the Non-Stock Items (IN202000), the ONLCOURSE non-stock item of the TRAINING item class has been
created.
• On the Stock Items (IN202500) form, the CHERJAM96 stock item of the JAM item class has been created.
Process Overview
In this activity, you will perform the following:
1. On the Attributes (CS205000) form, create an attribute for the course release date.
2. On the Item Classes (IN201000) form, add the attribute to the TRAINING item class.
3. On the Non-Stock Items (IN202000) form, assign a value to the created attribute for a particular non-stock
item.
4. On the Entities (BC202000) form, map the attribute field with a product field in the BigCommerce store.
5. On the Attributes form, create an attribute for the sugar level of the products.
6. On the Item Classes form, add the attribute to the JAM item class.
7. On the Stock Items (IN202500) form, assign a value to the created attribute for a particular stock item.
8. On the Entities form, map the attribute field with a product field in the BigCommerce store.
9. On the Prepare Data (BC501000) form, prepare product data for synchronization.
Integration with BigCommerce | 92
10.On the Process Data (BC501500) form, process the product data prepared for synchronization.
11.In the control panel of the BigCommerce store, review the exported products.
System Preparation
Before performing the instructions of this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The BigCommerce store has been created and configured, as described in Initial Configuration: To Set Up
a BigCommerce Store.
• The connection to the BigCommerce store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Establish and Configure the Store Connection.
2. Launch the Acumatica ERP website with the U100 dataset preloaded, and sign in with the following
credentials:
• Username: gibbs
• Password: 123
3. Sign in to the control panel of the BigCommerce store as the store administrator.
4. On the BigCommerce Stores (BC201000) form, open the SweetStore - BC record.
5. On the Entity Settings tab, select the Active check box in the row of the Non-Stock Item entity.
6. Save your changes.
3. On the Attributes tab, in the row of the Attributes table with the Pre-Order Release Date attribute, set Value
to 1/1/2024.
4. On the eCommerce tab, in the Availability box, select Set as Pre-Order.
5. On the form toolbar, click Save.
If you are not signed in to the control panel of the BigCommerce store in the same browser,
you will need to enter your sign-in credentials.
4. On the View Products page, which opens for the Home canning courses online (website session) product,
review the details of the exported item. This item corresponds to the ONLCOURSE non-stock item in
Acumatica ERP.
Integration with BigCommerce | 96
Notice that in the Purchasability section, the This product is coming soon but I want to take pre-orders
option button is selected, and in the Release Date box, the pre-order release date that you specified for the
ONLCOURSE non-stock item has been inserted (1 Jan 2024).
5. In the le pane (above the Home menu item), click View Store to open the storefront.
6. On the storefront, in the list of categories, click Training.
7. On the page that lists products, click the link of the Home canning courses online (website session) product.
On the page for the Home canning courses online (website session) product, notice that it is only available
for pre-order, and that the message to customers indicates that the product will be available starting 1
January 2024. This date was specified as an attribute value in Acumatica ERP and exported during the
synchronization of the Non-Stock Item entity.
8. Return to BigCommerce control panel, and in the le pane, click Products > View.
9. On the View Products page, locate the CHERJAM96 stock item, and click the link for this item in the Product
Name column.
You can locate the inventory ID of the stock item in the Product SKU column.
10.On the View Products page, which opens for the Cherry jam 96 oz product, review the details of the
exported item.
Notice that in the Custom Fields section, the Sugar Level custom field has been created and set to Sugar-
free.
11.In the le pane, click View Store to open the storefront.
12.On the storefront, in the list of categories, click Jams.
13.On the page that lists products of the Jams category, click the link of the Cherry jam 96 oz product.
On the page for the Cherry jam 96 oz product, notice that the name of the custom field (Sugar Level) and the
assigned value (Sugar-free) are displayed, as shown in the following screenshot.
Integration with BigCommerce | 97
Acumatica ERP Retail-Commerce Edition provides you with the ability to export product images from Acumatica
ERP to the BigCommerce store.
Learning Objectives
In this chapter, you will learn how to export product images from Acumatica ERP to the BigCommerce store.
Applicable Scenarios
You export product images from Acumatica ERP to your BigCommerce store in the following cases:
• You maintain product information in Acumatica ERP, export this information to the BigCommerce store, and
use Acumatica ERP to store images of exported stock and non-stock items.
• You maintain product information in Acumatica ERP, export this information to the BigCommerce store,
store images of exported stock and non-stock items in an external storage but keep links to the image files in
Acumatica ERP.
Integration with BigCommerce | 98
The following activity will walk you through the process of synchronizing product images.
Story
Suppose that the SweetLife Fruits & Jams company wants to store some images of the products they sell in the
online store in an external storage. Some of the images, however, are attached to items in the Acumatica ERP
instance. Acting as an implementation consultant helping SweetLife to set up the integration of Acumatica ERP
with the BigCommerce store, you want to test how images stored in Acumatica ERP and externally are exported to
the BigCommerce store.
Configuration Overview
In the U100 dataset, for the purposes of this activity, on the Stock Items (IN202500) form, the APJAM08 stock item of
the JAM item class been created.
Process Overview
In this activity, you will do the following:
1. On the Stock Items (IN202500) form, add images to the APJAM08 stock item.
2. On the Prepare Data (BC501000) form, prepare the stock item data for synchronization.
3. On the Process Data (BC501500) form, process the stock item data prepared for synchronization.
4. In the control panel of the BigCommerce store, review the exported stock item.
5. On the BigCommerce Stores (BC201000) form, activate the Product Image entity.
Integration with BigCommerce | 99
6. On the Prepare Data form, prepare the product image data for synchronization.
7. On the Process Data form, process the product image data prepared for synchronization.
8. In the control panel of the BigCommerce store, review the exported images.
System Preparation
Before you complete the instructions in this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The BigCommerce store has been created and configured, as described in Initial Configuration: To Set Up
a BigCommerce Store.
• The connection to the BigCommerce store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Establish and Configure the Store Connection.
2. Download the AppleJam1.png and AppleJam2.png files to your device.
3. Launch the Acumatica ERP website with the U100 dataset preloaded, and sign in with the following
credentials:
• Username: gibbs
• Password: 123
4. Sign in to the control panel of the BigCommerce store as the store administrator.
5. Open the BigCommerce Stores (BC201000) form.
6. In the Store Name box of the Summary area, select SweetStore - BC.
7. On the Entity Settings tab, select the Active check box in the row of the Product Image entity.
8. On the form toolbar, click Save.
• Store: SweetStore - BC
• Prepare Mode: Incremental
This setting controls which data will be loaded. Incremental indicates that records that match the
filtering conditions will be prepared for synchronization only if they have been changed aer the
previous synchronization.
3. In the table, select the Selected check box in the row of the Stock Item entity, and on the form toolbar, click
Prepare.
4. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box and return to the Prepare Data form.
Notice that the Prepared Records column shows the number of synchronization records that have been
prepared and are ready to be processed.
Note that images are synchronized only for stock and non-stock items that have been
synchronized with the BigCommerce store. If an item has not been synchronized, images
added to it will not be exported during the synchronization of the Product Image entity.
3. In the table, select the Selected check box in the row of the Product Image entity, and on the form toolbar,
click Prepare.
4. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box and return to the Prepare Data form.
Notice that the Prepared Records column shows the number of synchronization records that have been
prepared and are ready to be processed.
The ERP ID column displays the item type (stock item) and identifier (APJAM08) followed by
the backslash and then the name of the image file. You can click the link in this column to open
the file details on the File Maintenance (SM202510) form.
2. On the form toolbar, click Process All to process both synchronization records displayed in the table.
3. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
4. In the first row of the table, click the link in the External ID column to review the item in the BigCommerce
store. The product management page opens for the Apple jam 8 oz. product.
If you are not signed in to the control panel of the BigCommerce store in the same browser,
you will need to enter your sign-in credentials.
Notice that the Images subsection now contains three images. One was added as an external link in the
Media URLs table on the eCommerce tab of the Stock Items (IN202500) form, and exported as part of the
synchronization of the Stock Item entity. The other two were uploaded on the Attributes tab of the Stock
Items form, and exported as part of the synchronization of the Product Image entity. The main product
image (for which the Thumbnail option button is selected) is the image that is visible in the Image area of
the Attributes tab.
5. In the le pane, click View Store to open the storefront.
6. Click Search in the top right, and start typing apple in the search box.
7. Click Apple jam 8 oz. in the search results to open the product details page. Notice that a thumbnail image is
displayed for this product, and review how the other images are displayed.
The display of images may differ depending on the theme applied to the store.
For each stock and non-stock item in Acumatica ERP, an organization can maintain a list of related items that
shoppers might be interested in buying in addition to or instead of the original item. These items might include
items complementary to the original item (for example, a cover case or a mouse may be offered to the customer
when a laptop is purchased), additional services (such as, assembly services for sold furniture), items that are
purchased by other shoppers with similar buying habits, and higher-priced variants of the original item.
When the Related Items feature is enabled on the Enable/Disable Features (CS100000) form, the Related Items
tab is displayed on the Stock Items (IN202500) and Non-Stock Items (IN202000) forms. On this tab, you can list the
items related to the original item (which is the stock or non-stock item that is selected on the form) and specify the
relation.
If the BigCommerce Connector features is enabled on the Enable/Disable Features (CS100000) form and the
integration between the Acumatica ERP instance and the BigCommerce store has been configured, you can export
stock and non-stock items from Acumatica ERP to the BigCommerce store along with the list of related items that
have been defined for each item.
During the configuration of a BigCommerce store, on the Inventory Settings tab of the BigCommerce Stores
(BC201000) form, you can select the types of related items whose information needs to be exported to the
BigCommerce store during the synchronization of stock and non-stock items. You select the check box for any or all
of the following options:
• Cross-Sell
• Up-Sell
• Substitute
• Other
By default, none of these options is selected, and during the synchronization of stock, non-stock, and items with
the BigCommerce store, information about related items is not exported to the BigCommerce store, even if the
item relations have been specified in Acumatica ERP. If an option is selected in this box and any related items
are specified for the original stock or non-stock item with a relation that corresponds to the selected option, the
information about the related item is exported to the BigCommerce store when the original item is exported.
Integration with BigCommerce | 103
Aer the original item has been exported to the BigCommerce store, all its related items are listed in the Related
Products section of the product management page. When a shopper browses the original item on the storefront,
they can see the list of its related items at the bottom of the product page (depending on the theme applied to the
store).
In this chapter, you will learn how sales prices are synchronized between Acumatica ERP and the BigCommerce
store.
Acumatica ERP Retail-Commerce Edition provides flexible ways of managing sales prices. You can assign prices to
stock and non-stock items, maintain specific prices for particular customers or groups of customers with similar
buying habits, or assign discounted prices for customers buying in bulk. For more information about the types of
prices supported in Acumatica ERP, see Sales Prices: General Information.
Learning Objectives
In this section, you will learn how to synchronize sales prices between Acumatica ERP and the BigCommerce store.
Applicable Scenarios
You might want to synchronize sales prices from Acumatica ERP with the BigCommerce store in the following cases:
• You maintain base prices of non-stock and stock items in Acumatica ERP and want to quickly update sales
prices of the corresponding products in BigCommerce.
• You offer special prices to customers that are assigned to a particular customer price class and want to
continue offering the same prices in the BigCommerce store.
• Prices specific to a customer price class: Prices that are effective for a particular group of customers—that is,
prices that have the Customer Price Class type—are defined on the Sales Prices (AR202000) form or the Sales
Price Worksheets (AR202010) form and are exported to the BigCommerce store as a separate entity, Price
List.
Customer Price Classes maintained in Acumatica ERP correspond to customer groups on the Customer
Groups page, which you open by clicking Customers > Customer Groups in the le pane. Prices of the
Customer Price Class type defined for a particular price class imported from Acumatica ERP are saved in the
BigCommerce store as a price list for the corresponding customer group on the View Price Lists page.
Prices in a price list are similar to sales prices but are created to be specific to a customer group in
BigCommerce. The price of a product defined in a price list for a customer group has a higher priority than
the default price or the sales price of the product specified on the product page. The price specific to a
customer group is displayed to a customer on the storefront if the customer belongs to the customer group
and is signed in.
Before you can export the list of prices specific to a customer price class (that is, to synchronize the Price
List entity) from Acumatica ERP, you must first synchronize the Customer Price Class entity. For the price
list specific to a customer group to be functional in BigCommerce, you must export customers (that is,
synchronize the Customer entity) assigned to the corresponding customer price class in Acumatica ERP.
You can export price lists from Acumatica ERP only to BigCommerce stores on the Enterprise
subscription plan. For information about BigCommerce subscription plans and available
features, see the Pricing page.
Volume prices are exported to the BigCommerce store according to their type, as described in the previous section.
Imported volume-dependent prices of the Base type defined for a product appear in BigCommerce as a table under
Bulk Pricing in the Pricing subsection on the View Products page of a particular product. This table contains the
Min Quantity column (which corresponds to a quantity break point in Acumatica ERP) and the Unit Price column.
These prices override the sales price when the quantity of the purchase is higher than the minimum quantity
specified for the unit price in the table.
Imported volume-dependent prices of the Customer Price Class defined for a product appear in BigCommerce in a
price list for a particular customer group. To open the price list, you select Products > Price Lists in the le pane
to open the Price Lists page, and then click the name of the price list that corresponds to the customer group. To
bring up a table for volume-dependent prices for a particular product, you click the cell in the New Bulk Pricing
column for this product. The volume-dependent prices defined for a product in a price list for a particular group
override all other prices when the right combination of the customer, product, and quantity is met (that is, when
the customer belonging to the customer group is signed in, and buys the product in quantities corresponding to
one of the quantity tiers for which volume-based prices have been defined).
• UOM-specific prices: In Acumatica ERP, if the Multiple Units of Measure feature is enabled on the Enable/
Disable Features (CS100000) form, you can define a sales price of an item for each of the units of measure
in which your company sells this item. However, only prices defined for the sales UOM can be exported to
BigCommerce.
• Warehouse-specific prices: If the Multiple Warehouses feature is enabled on the Enable/Disable Features form,
prices that are defined to apply only when products are sold from a particular warehouse—that is, when a
specific warehouse ID is selected in the Warehouse column for a particular price—are not exported to the
BigCommerce store.
Only prices that are effective on the date of the synchronization are exported; historical prices and
prices with an effective date in the future are not synchronized. If an item has multiple prices of
the same type that are effective on the date of the synchronization, the price of the highest priority
is imported. For example, if a regular base price of $5 and a promotional base price of $4.50 for
the same item are effective on January 31, 2022, which is the date when you synchronize the Base
Sales Price entity, the promotional price of $4.50 will be exported to the BigCommerce store. For
more information about price priorities, see Automatic Price Selection: Rules of Price Selection and
Automatic Price Selection: To Explore Regular and Promotional Prices.
In this activity, you will explore how sales prices of the Base type are exported from Acumatica ERP to and saved in
the BigCommerce store.
Story
Suppose that SweetLife Fruits & Jams wants to maintain all of its sales prices, including the prices of products sold
in the BigCommerce store, in Acumatica ERP.
SweetLife's pricing manager has added a new base price for 96-ounce jars of pear jam ($45) and the following
quantity-specific prices for 96-ounce jars of banana jams:
• From 1 to 4 pieces: $45
• From 5 to 9 pieces: $43
• More than 9 pieces: $40
The new prices are effective as of July 1, 2022.
As an implementation consultant, you want to export the effective sales prices for the jams from Acumatica ERP to
the BigCommerce store.
Configuration Overview
In the U100 dataset, the following tasks have been performed for the purposes of this activity:
• On the Enable/Disable Features (CS100000) form, the Volume Pricing feature has been enabled.
• On the Stock Items (IN202500) form, the PEARJAM96 and BANJAM96 stock items have been created.
• On the Sales Prices (AR202000) form, the sales prices listed in the following table have been defined.
Process Overview
In this activity, you will do the following:
1. On the BigCommerce Stores (BC201000) form, activate the Base Sales Price entity.
2. On the Sales Prices (AR202000) form, review the sales prices of the Base type, including volume-dependent
prices, defined for particular items.
3. On the Prepare Data (BC501000) form, prepare the base sales price data for synchronization; on the Process
Data (BC501500) form, process the prepared data.
4. In the control panel of the BigCommerce store, review the exported prices of items.
System Preparation
Before you start this activity, do the following:
1. Make sure that the following prerequisite activities have been performed:
a. Initial Configuration: To Establish and Configure the Store Connection
b. Data Synchronization: To Perform the First Synchronization
2. Sign in to the control panel of the BigCommerce store as the store administrator.
3. Sign in to the Acumatica ERP instance with the U100 dataset preloaded by using the following credentials:
• Username: gibbs
• Password: 123
4. Open the BigCommerce Stores (BC201000) form.
5. On the Entity Settings tab, select the Active check box in the row of the Base Sales Price entity.
When you process this entity, the sales prices of the Base type defined on the Sales Prices (AR202000) form
are exported.
6. On the form toolbar, click Save.
Step 1: Reviewing the Base Sales Prices Defined for Stock Items
To review the sales prices of the Base type defined for stock items in Acumatica ERP, do the following:
1. Open the Sales Prices (AR202000) form.
2. In the Selection area, specify the following settings:
• Price Type: Base
• Inventory ID: PEARJAM96
In the table, notice that there is one effective price of the Base type for this stock item ($45.00), which is
effective for all customers starting from 7/1/2022.
3. In the Inventory ID box of the Selection area, select BANJAM96.
Notice that for the BANJAM96 stock item, the table contains three different prices of the Base type, which
depend on the value in the Break Qty column. When a customer buys 1 to 4 jars of banana jam, each jar will
Integration with BigCommerce | 107
cost $45; for the purchase of 5 to 9 jars, the effective price will be $43, and if a customer buys 10 or more jars,
each will cost $40.
Figure: Base prices and default price specified for the item
You have exported base sales prices, including volume-based sales prices, to the BigCommerce store.
In this activity, you will explore how sales prices of the Customer Price Class type are exported from Acumatica ERP
to and saved in the BigCommerce store.
Story
Suppose that SweetLife Fruits & Jams wants to maintain all of its sales prices, including the prices of products sold
in the BigCommerce online store, in Acumatica ERP. As an implementation consultant, you want to export sales
prices of the Customer Price Class type for different types of jam from Acumatica ERP to the BigCommerce store so
that you can offer a product to various groups of customers at different prices.
Configuration Overview
In the U100 dataset, the following tasks have been performed for the purposes of this activity:
• On the Stock Items (IN202500) form, the PEARJAM96 stock item has been configured.
• On the Customer Price Classes (AR208000) form, the LOCAL (for local customers) and INTERN (for
international customers) customer price classes have been configured.
• On the Customers (AR303000) form, the COFFEESHOP customer has been configured. On the Shipping tab
(Other Settings section), LOCAL is selected in the Price Class box, which means that all prices defined for
the LOCAL customer price class are applicable to this customer.
• On the Sales Prices (AR202000) form, the sales prices listed in the following table have been defined. Both
prices are effective.
Process Overview
In this activity, you will do the following:
1. On the Prepare Data (BC501000) form, prepare the customer price class, customer, and sales price list data
for synchronization.
2. On the Process Data (BC501500) form, process the prepared data of customer price classes, customers, and
price lists.
3. In the control panel of the BigCommerce store, review the customer groups.
Integration with BigCommerce | 110
4. In the control panel of the BigCommerce store, review the exported prices of the item.
5. In the control panel of the BigCommerce store, review the exported price list.
6. In the control panel of the BigCommerce store, create a password for the customer account.
7. On the storefront, view the product page as a signed-in customer.
System Preparation
Before you start this activity, do the following:
1. Make sure that the following prerequisite activities have been performed:
a. Initial Configuration: To Establish and Configure the Store Connection
b. Data Synchronization: To Perform the First Synchronization
2. Sign in to the control panel of the BigCommerce store as the store administrator.
3. Sign in to the Acumatica ERP instance with the U100 dataset preloaded by using the following credentials:
• Username: gibbs
• Password: 123
4. Open the BigCommerce Stores (BC201000) form.
5. In the Store Name box of the Summary area, select SweetStore - BC.
6. On the Entity Settings tab, select the unlabeled check box in the row of the Price List entity. Notice that the
system has automatically selected this check box for Customer Price Class entity.
You select the Price List entity to export prices specific to customer price classes.
7. On the form toolbar, click Save.
If the New Sale Price column is not displayed in the table, click Edit column in the upper right
of the table and select the check box for the New Sale Price column.
The topics of this chapter explain the availability settings of stock items, non-stock items, and template items that
are exported to the BigCommerce store.
Acumatica ERP Retail-Commerce Edition provides you with the ability to track the available quantities of stock
items that you sell via the BigCommerce store and maintain in Acumatica ERP. You have the flexibility to configure
which quantities of a stock item should be included in calculations of the quantity available for sale in the online
store.
Learning Objectives
In this chapter, you will learn how to do the following:
• Define how the available quantities of items exported to the BigCommerce store should be calculated
• Set up quantity tracking for stock items exported to the BigCommerce store
• Synchronize the available quantities of exported stock items for which quantity tracking is turned on
Applicable Scenarios
You track available quantities of stock items exported to the BigCommerce store if you want to make these items
available for purchase by shoppers through the storefront only if there is a sufficient quantity in stock.
• In the Purchasability section, the This product can be purchased in my online store option button is
selected.
• In the Inventory section, the Track inventory check box is selected.
Under the Track inventory check box, the On the product level option button is also selected because
stock items do not have product variants and the available quantities of exported stock items are tracked for
the entire product.
If you select the Set as Available (Track Qty.) option in the Availability box, you need to also specify the action that
the system should perform with stock items whose quantities become zero, as follows:
• To make the item unavailable for purchase via the storefront, select Set as Unavailable in the When Qty.
Unavailable box. In BigCommerce, in the Purchasability section of the product management page, the
This product cannot be purchased in my online store option button becomes selected.
• To make the item unavailable for purchase via the storefront but available for pre-order, select Set as Pre-
Order/Continue Selling in the When Qty. Unavailable box. In BigCommerce, the This product is coming
soon but I want to take pre-orders option button becomes selected.
• To keep the current purchasability settings of the item, select Do Nothing. In BigCommerce, the This
product can be purchased in my online store option button remains selected. However, the item cannot
be included in sales orders on the storefront.
To avoid discrepancies in sales orders imported into Acumatica ERP, we recommend that before
changing an item's sales UOM you make sure that there are no unsynchronized sales orders that
contain the item. Also, you should synchronize the item's available quantity immediately aer
changing its sales UOM so that new orders for the item are created in the BigCommerce store with the
updated UOM.
During the configuration of a BigCommerce store, you specify which item quantity in Acumatica ERP you want to
be synchronized with the store for the items whose quantities are tracked. To do so, you select one of the following
options in the Availability Mode box on the Inventory Settings tab of the BigCommerce Stores (BC201000) form:
• On Hand: The system synchronizes the on-hand quantity stored at particular warehouses or warehouse
locations.
• Available for Shipping: The system synchronizes the quantity available for shipping, which is calculated as
the quantity on hand minus the quantities shipped, minus the quantities allocated for sales, production,
and service orders, minus the quantities in locations for which the Include in Qty. Available check box is
cleared on the Locations tab of the Warehouses (IN204000) form, minus the quantities on issues that have
not been released yet.
• Available: The system synchronizes the available quantity. You can configure the way the available quantity
is calculated by using an availability calculation rule. For more information, see Configuration of Availability
Calculation Rules: General Information.
You also select whether quantity calculations should include available quantities from all warehouses or from only
the specified warehouses or warehouse locations. To do so, in the Warehouse Mode box on the Inventory Settings
tab of the BigCommerce Stores form, you select one of the following options:
• All Warehouses: To use for calculation the quantities of the item from all warehouses
• Specific Warehouses: To use for calculation the quantities from only the specified warehouses or warehouse
locations.
When you select this option, the system displays a table in which you should specify the needed warehouses
and warehouse locations. If you specify a warehouse but do not specify any of its locations, quantities
available from the entire warehouse are used for quantity calculations. If you specify multiple warehouses
and warehouse locations, the quantities available from all specified warehouses and warehouse locations
are used for quantity calculations.
The functionality of multiple warehouses and multiple warehouse locations is available if the
Multiple Warehouses and Multiple Warehouse Locations features are enabled on the Enable/
Disable Features (CS100000) form.
If you have previously synchronized the Product Availability entity, when you modify any of the settings described
in this section, the system resets the availability synchronization status for all items synchronized with the
BigCommerce store, and you need to perform the full synchronization of the Product Availability entity again.
In this activity, you will specify the default availability settings for the BigCommerce store, specify the availability
settings for particular stock items, export product availability data to the BigCommerce store, and review the
results of the export.
Integration with BigCommerce | 116
Story
Suppose that the SweetLife Fruits & Jams company sells several kinds of jams in its online store. The jams can be
ordered in the online store as follows:
• Banana jams (BANJAM96 and BANJAM08) should always be available for purchase regardless of the quantity
in stock.
• Pear jams (PEARJAM96 and PEARJAM08) should be available for purchase only if there is a sufficient quantity
in stock, If there is no quantity in stock, the item becomes unavailable for purchase.
• Plum jams (PLUMJAM96 and PLUMJAM08) should be available for purchase when there is sufficient quantity
in stock. If there is no quantity in stock, the availability to purchase the item should determined by the
settings specified for the item on the product management page in the BigCommerce store.
• Cherry jam in 96-ounce jars (CHERJAM96) is currently unavailable for purchase but you expect it to be
restocked soon and want to accept orders for it regardless of its available quantities.
Acting as an implementation consultant helping SweetLife to set up the integration of Acumatica ERP with the
BigCommerce store, you need to configure the system so that the items' availability will be tracked according to the
business needs.
Configuration Overview
In the U100 dataset, the following tasks have been performed for the purposes of this activity:
• On the Enable/Disable Features (CS100000) form, the following features have been enabled:
• Multiple Warehouses, which provides the functionality of working with several warehouses (including
virtual warehouses)
• Multiple Warehouse Locations, which supports multiple locations for each warehouse
• On the Warehouses (IN204000) form, the RETAIL warehouse and the JS1 warehouse location have been
configured.
• On the Stock Items (IN202500) form, the stock items have been created in the system and assigned the
availability settings as listed in the following table.
Process Overview
In this activity, you will do the following:
Integration with BigCommerce | 117
1. On the BigCommerce Stores form, update the default availability settings for the BigCommerce store.
2. On the Storage Details by Item Warehouse Location (IN408055) form, review the quantities of stock items
available in the RETAIL warehouse.
3. On the Prepare Data (BC501000) form, prepare the product availability data for synchronization, and on the
Process Data (BC501500) form, process the prepared product availability data.
4. In the BigCommerce store, review the availability settings and quantities of the exported stock items.
System Preparation
Before you complete the instructions in this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The BigCommerce store has been created and configured, as described in Initial Configuration: To Set Up
a BigCommerce Store.
• The connection to the BigCommerce store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Establish and Configure the Store Connection.
2. Launch the Acumatica ERP website with the U100 dataset preloaded, and sign in with the following
credentials:
• Username: gibbs
• Password: 123
3. Sign in to the control panel of the BigCommerce store as the store administrator.
4. Open the BigCommerce Stores (BC201000) form.
5. In the Store Name box of the Summary area, select SweetStore - BC.
6. On the Entity Settings tab, select the Active check box in the row of the Product Availability entity.
7. On the form toolbar, click Save.
CHERJAM96 Track inventory check box The box is hidden This product is coming soon
cleared but I want to take pre-or-
ders option button selected
You have now configured the synchronization of product availability data and exported the items' availability
settings and available quantities to the BigCommerce store.
Synchronizing Orders
In the topics of this chapter, you will read about the main features of the synchronization of orders between
Acumatica ERP and the BigCommerce store.
You can import sales orders placed in the BigCommerce store to Acumatica ERP for further processing.
Learning Objectives
In this chapter, you will learn how to do the following:
• Configure the synchronization of orders between Acumatica ERP and the BigCommerce store
• Configure the synchronization of payments between Acumatica ERP and the BigCommerce store
• Import sales orders with payments from the BigCommerce store to Acumatica ERP
• Configure the card payment processing in Acumatica ERP and BigCommerce
Applicable Scenarios
The synchronization of orders is the main scenario for the integration between an ERP system and an external e-
commerce system. You set up the import of orders from the BigCommerce store to Acumatica ERP so that you can
process the imported orders further, for example, create a shipment for it, invoice the customer, and process the
payment.
tab, you activate the Sales Order and Customer entities, as well as the Stock Item entity, Non-Stock Item entity, or
both entities. If shipments created and processed in Acumatica ERP for the imported order should be synchronized
with the BigCommerce store, you need to activate the Shipment entity.
You specify the minimal required settings for the activated entities as follows:
• Customer: You specify the settings for customer synchronization on the Customer Settings tab. For
information, see Synchronizing Customers: General Information.
• Stock Item and Non-Stock Item: You specify the settings for the synchronization of stock and non-stock items
on the Inventory Settings tab. For details, see Product Synchronization: General Information.
• Sales Order: On the Order Settings tab, in the Branch box, you specify the branch the system will insert in
imported sales orders. In the Order Type for Import box, you specify the order type that will be assigned
to and provide the default settings for the imported sales orders. In the Shipping Option Mapping table
on the Order Settings tab, you map each shipping option (which is a combination of a shipping zone and
shipping method) defined in the BigCommerce store with the ship via code and, optionally, shipping zone
and shipping terms defined in Acumatica ERP.
For each store payment method—that is, each payment method defined and activated in the BigCommerce store—
payments by which should be imported to Acumatica ERP, you need to create a mapping with a payment method
defined in Acumatica ERP on the Payment Settings tab. The system automatically adds a row with the store
payment method and the currency it was defined for specified (in the Store Payment Method and the Store
Currency boxes, respectively) for each store payment method that is active in the BigCommerce store.
To map the combination of the store payment method and the store currency with the Acumatica ERP payment
method, in the table of the Payment Settings tab, you specify the following settings:
• To indicate that payments by a specific store payment method should be imported to Acumatica ERP, you
select the Active check box.
• In the ERP Payment Method column, you select the payment method defined in Acumatica ERP for the
store payment method. Payments imported from the BigCommerce store to Acumatica ERP will have this
payment method inserted. For information about setting up payment methods in Acumatica ERP, see Cash
Management: Payment Methods.
• In the Cash Account column, you select a cash account associated with the payment method. The cash
account must be in the currency of the store payment method and belong to the branch selected on
the Order Settings tab. For information about setting up cash accounts in Acumatica ERP, see Cash
Management: Cash Accounts and Configuring Cash Accounts.
You can also indicate that payments that are imported from the BigCommerce store should be automatically
released as soon as they are imported by selecting the check box in the Release Payments column. If refunds
issued in the store should be imported to Acumatica ERP, you select the Process Refunds check box.
Note that orders that have the Archived status in the BigCommerce store are filtered during
the order import. That is, for each order with this status, the system creates a synchronization
record and assigns it the Filtered status on the Sync History (BC301000) form.
2. Searches for products (that is, stock and non-stock items) included in the sales order.
Products included in a sales order must be synchronized with or created in Acumatica ERP. During the
import of a sales order, the system searches for an inventory ID of an inventory item in Acumatica ERP that
matches the product's SKU in the BigCommerce store. If no matching inventory ID has been found, the
system continues to search for a matching alternate ID. An alternate ID is an additional identifier of the
item, which can be an identifier used by your company's customer or vendor, that is specified on the Cross-
Reference tab of the Stock Items (IN202500) form for a stock item and of the Non-Stock Items (IN202000)
form for a non-stock item. If the matching alternate ID has been found, the system inserts in the imported
order an inventory item associated with this alternate ID.
3. Searches for a customer that placed the order, and inserts it in the sales order. If the customer has been
updated in the BigCommerce store, updates the customer record in Acumatica ERP. If the customer has not
been found, creates a new customer on the Customers (AR303000) form, and inserts it in the sales order.
4. Creates a document of the Prepayment type on the Payments and Applications (AR302000) form, if the
payment method used for paying the sales order in the BigCommerce store has an active mapping with a
payment method defined in Acumatica ERP on the BigCommerce Stores (BC201000) form, and applies it to
the sales order.
If the mapping of the store payment method is inactive or has not been configured, the system creates a
synchronization record for the payment on the Sync History form and assigns it the Filtered status. In this
case, the prepayment document is not created on the Payments and Applications form.
Integration with BigCommerce | 123
Synchronization of Payments
You can import payments independently of orders by preparing and processing the Payment entity.
Integration with BigCommerce | 125
During the synchronization of the Payment entity, the system creates a document of the Prepayment type on the
Payments and Applications (AR302000) form and applies it to the sales order if the following conditions are met:
• The store payment method with which the order was paid is mapped to an Acumatica ERP payment method
and the mapping is active on the BigCommerce Stores (BC201000) form.
• The sales order has the Open status and has an unbilled balance, or the sales order has the Canceled status.
If the mapping of the store payment method is inactive or has not been configured, the system creates a
synchronization record for the payment on the Sync History (BC301000) form and assigns it the Filtered status. In
this case, the prepayment document is not created on the Payments and Applications form.
If the sales order has been fully invoiced, the system cannot apply the prepayment to the sales order. In this case,
the prepayment is applied to the invoice or invoices created for the sales order.
If the sales order has been partially invoiced, the prepayment is applied to the sales order only in the amount equal
to the unbilled amount of the sales order. You need to manually apply the remaining amount to the invoice or
invoices.
The following sections provide details you can use to ensure that the system is configured properly for importing
sales orders, and to understand (and change, if needed) the settings that affect the processing workflow.
Implementation Checklist
We recommend that before you initially import orders from the BigCommerce store, you make sure the needed
features have been enabled, settings have been specified, and entities have been created, as summarized in the
following checklist.
BigCommerce Stores (BC201000) The necessary settings have been specified, as demonstrated in the ex-
ample of Initial Configuration: To Establish and Configure the Store Con-
nection.
Processing Centers (CA205000) The processing center for processing payments has been created, as
demonstrated in the example of Order Synchronization: To Configure and
Import Authorize.Net Payments.
Integration with BigCommerce | 126
BigCommerce Stores (BC201000) • The necessary settings have been specified, as demonstrated in the
example of Initial Configuration: To Establish and Configure the Store
Connection.
• On the Payment Settings tab, the payment mapping has been de-
fined for store payment methods representing payment gateways, as
demonstrated in the example of and Order Synchronization: To Config-
ure and Import Authorize.Net Payments.
Validation of Configuration
To make sure that all configuration has been performed correctly, we recommend that in your system, you perform
instructions similar to those described in .Order Synchronization: To Configure and Import Authorize.Net Payments
In Acumatica ERP Retail-Commerce Edition, users can import and, if necessary, process debit and credit card
payments from external e-commerce systems through integration with payment gateways. The ability to use card-
processing features, such as authorization, capture, voiding, and refunding card transactions, is available if the
Integrated Card Processing feature is enabled on the Enable/Disable Features (CS100000) form. This topic explains
how to configure the Authorize.Net payment provider for processing of payments made in the BigCommerce store
aer they are imported to Acumatica ERP.
For step-by-step instructions on configuring and importing payments based on the Authorize.Net payment method,
see Order Synchronization: To Configure and Import Authorize.Net Payments.
When the payment is imported from BigCommerce to Acumatica ERP (as part of the synchronization of the
Sales Order entity or the Payment entity), on the Payments and Applications (AR302000) form, the system creates
a document of the Prepayment type with the Pending Processing status. In the Summary area of the created
document, the system inserts the following information:
• Payment Method: The payment method that has been mapped to the store payment method on the
Payment Settings tab of the BigCommerce Stores (BC201000) form
• Cash Account: The cash account selected for the mapped payment method
• Payment Ref.: The number of the related credit card transaction in the processing center
• Processing Status: The processing status of the credit card transaction. Depending on the last successful
operation with the transaction, the processing status can be one of the following:
• Pre-Authorized: The payment has been authorized but the funds have not been captured. The last
successful operation was Authorize Only.
• Captured: The funds have been captured. The last successful operation with the credit card transaction
was either Authorize and Capture or Capture Authorized.
• Pre-Auth./Capture Pending Validation: The last successful operation with the credit card transaction is
unknown. To get the correct processing status of the credit card transaction, you can use the Validate
Card Payment action on the Payments and Applications form.
On the Card Processing tab on the Payments and Applications form, the system creates a row for the last successful
operation with the credit card transaction. In the Proc. Center Response Reason box, Imported External
Transaction indicates that the information about the credit card transaction operation has been imported from the
external e-commerce system.
In the Tran. Type box, the transaction operation can have one of the following types:
• Authorize Only: The payment was authorized when the order was placed but has not yet been captured.
• Authorize and Capture: The payment was captured when the order was placed.
• Capture Authorized: The payment was authorized when the order was placed, and then the funds were
captured in the control panel of the store.
• Unknown: The status of the operation with the credit card transaction is unknown.
The following diagram illustrates the workflow of importing a sales order to Acumatica ERP from a BigCommerce
store where it was placed and paid by a card based on a payment method for which integrated card processing has
been configured in Acumatica ERP.
Integration with BigCommerce | 129
• If the customer entered the details of a new card and selected the Save this card for future transactions
check box during checkout
• If the last operation on the credit card transaction has the Unknown status
External credit card transactions that require validation are displayed on the Deferred Processing Required tab of
the Validate Card Payments (AR513000) form and have the Load Payment Profile check box selected.
When the validation process is started, the system performs the following actions:
1. On the Customer Payment Methods (AR303010) form, creates a customer payment method based on the
payment profile from the processing center.
2. Links the customer payment method to the credit card transaction.
3. Links the customer payment method to the imported payment.
4. Requests the status of the credit card transaction, and updates the processing status of the transaction and
the status of the prepayment, if necessary.
If the updated processing status of the transaction is Captured, the status of the prepayment changes
to Balanced. If on the General tab of the Accounts Receivable Preferences (AR101000) form, the Enable
Integrated CC Processing check box is selected, the system releases the prepayment.
Customizations may support forced validation of all imported credit card transactions. In this case, all credit card
transactions imported from external systems will be displayed on the Deferred Processing Required tab of the
Validate Card Payments form and will need to be validated.
A sales order can be fulfilled only if the credit card payment imported for it from an external e-
commerce system has been validated. To streamline shipping of orders, you can set up an automation
schedule on the Validate Card Payments form to regularly process imported card transactions that
require validation. For information about automation schedules, see Automated Processing: General
Information.
The following activity will walk you through the process of configuring the system so that you can import card
payments from the BigCommerce store to Acumatica ERP and then further process them, if necessary.
Story
Suppose that the SweetLife Fruits & Jams company wants to accept card payments in the BigCommerce store. The
company already has the Authorize.Net account for processing card payments.
Acting as an implementation consultant helping SweetLife to set up the integration of Acumatica ERP with the
BigCommerce store, you need to configure Authorize.Net as a card payment provider in the BigCommerce store,
configure the card payment processing in Acumatica ERP, and then configure the import of card payments from the
BigCommerce store to Acumatica ERP.
Configuration Overview
In the U100 dataset, the following tasks have been performed for the purposes of this activity:
• On the Enable/Disable Features (CS100000) form, the Integrated Card Processing feature has been enabled.
• On the Cash Accounts (CA202000) form, the 10250ST cash account has been created.
Integration with BigCommerce | 131
Process Overview
In this activity, you will do the following:
1. On the Accounts Receivable Preferences (AR101000) form, activate integrated card processing.
2. On the Processing Centers (CA205000) form, define a processing center.
3. On the Processing Centers form, connect the processing center to the Authorize.Net payment gateway.
4. On the Payment Methods (CA204000) form, define a payment method that will represent all card payments
in the BigCommerce store.
5. In the control panel of the BigCommerce store, enable the Authorize.Net payment gateway for accepting
card payments.
6. On the BigCommerce Stores (BC201000) form, map the Authorize.Net store payment method with the
payment method defined in Acumatica ERP for all card payments.
7. On the storefront of the BigCommerce store, create a test order paid by card.
8. In the control panel of the BigCommerce store, review the created test sales order.
9. On the Prepare Data (BC501000) form, prepare the sales order for synchronization; on the Process Data
(BC501500) form, process the sales order data prepared for synchronization.
10.On the Sales Orders (SO301000) form, review the imported sales order.
System Preparation
Before you complete the instructions in this activity, do the following:
1. Sign up for an Authorize.Net sandbox account at https://developer.authorize.net/hello_world/sandbox.html.
Aer you create an account, you will get the credentials to use in payment processing (API Login ID and
Transaction Key). You will use these credentials in this activity.
2. Make sure that the following prerequisites have been met:
• The BigCommerce store has been created and configured, as described in Initial Configuration: To Set Up
a BigCommerce Store.
• The connection to the BigCommerce store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Establish and Configure the Store Connection.
3. Launch the Acumatica ERP website with the U100 dataset preloaded, and sign in with the following
credentials:
• Username: gibbs
• Password: 123
4. Sign in to the control panel of the BigCommerce store as the store administrator.
ID Value
SIGNKEY Leave as is
TESTMODE 1
Step 6: Creating the Mapping for the Authorize.Net Store Payment Method
To configure the mapping for the Authorize.Net store payment method in Acumatica ERP, do the following:
1. Open the BigCommerce Stores (BC201000) form.
2. In the Store Name box of the Summary area, select SweetStore - BC.
3. In the table of the Payment Settings tab, update the settings in the row with the AUTHORIZENET
(CREDIT_CARD) payment method as follows:
• Active: Selected
• Store Currency: USD
• ERP Payment Method: ALLCARDS
• Cash Account: 10250ST
• Proc. Center ID: AUTHNETCOM
4. On the form toolbar, click Save to save your changes.
4. On the Sales Orders (SO301000) form, which opens for the imported order in a pop-up window, review the
settings of the order.
In the Summary area, notice that the External Reference and Description boxes include the order number
from BigCommerce. In the Customer box, the system has inserted the ID of the generic guest customer that
you have selected on the BigCommerce Stores (BC201000) form.
5. On the Payments tab, review the details of the created payment document.
Notice that the payment document has the Prepayment type. It includes the external credit card transaction
associated with the purchase. The number of the transaction is displayed in the Payment Ref. column and
its status, which is Pre-Authorized, is displayed in the Proc. Status column.
Next you would proceed to create and confirm the related shipment, prepare the related invoice, release the
payment, and synchronize the shipment back to the BigCommerce store. For the purposes of this activity, you do
not have to perform any of these operations.
In a BigCommerce store, a merchant can provide its customers with the option of having their purchase gi-
wrapped. The BigCommerce gi-wrapping functionality supports creating gi-wrapping options for specific
products or for all products, for free or at various pricing levels. If a customer purchases an item for which gi-
wrapping options have been configured, they have the option to add gi wrapping and a gi message to their
purchase while viewing their shopping cart.
2. On the Order Settings tab of the BigCommerce Stores (BC201000) form, select the non-stock item that
represents gi wrapping in the new Gi Wrapping Item box. The non-stock item selected in this box is
excluded from synchronization and is not exported when the Non-Stock Item entity is synchronized with the
BigCommerce store.
When a sales order that includes gi-wrapped items is imported from the BigCommerce store to Acumatica ERP,
on the Details tab of the Sales Orders (SO301000) form, the imported sales order contains a line for gi wrapping
for each of the gi-wrapped items. In the line for the gi-wrapping item, the system inserts the same warehouse
as is assigned to the main item. The line number of the item to which the gi wrapping pertains is shown in the
Associated Order Line Nbr. column.
Active Target Object Target Field Source Object Source Field / Val-
ue
Selected Sales Order → Details Gi Message Order Data → Order Products Wrapping Mes-
sage
In this chapter, you will learn how to configure tax synchronization between Acumatica ERP and the BigCommerce
store.
During the implementation of the integration between Acumatica ERP and the BigCommerce store, you decide if
taxes should be synchronized during the export or import of sales orders.
Learning Objectives
In this chapter, you will learn how to set up tax synchronization if you collect tax on products you sell in the
BigCommerce store.
Integration with BigCommerce | 138
Applicable Scenarios
You set up tax synchronization during the configuration of the connection between Acumatica ERP and the
BigCommerce store to make sure that taxes collected on online orders are reflected in an imported order and then
correctly recalculated when a shipment and an invoice are created for the order.
2. Configure the integration of Acumatica ERP with the external tax provider by using the same account as was
used in the previous step. For instructions on how to integrate Acumatica ERP with Avalara AvaTax or Vertex,
see Integrating Acumatica ERP with External Tax Providers.
3. Specify the tax synchronization settings on the Order Settings of the BigCommerce Stores (BC201000) form
as follows:
• Tax Synchronization: Selected
• Default Tax Zone: The tax zone that you have configured for the external tax provider
• Use as Primary Tax Zone: Selected
Because the primary tax zone has the highest priority for tax calculation, if the tax zone configured for the
external tax provider is specified in this box, it will always be used for tax calculation regardless of whether
the system has identified any other tax zone during the order import.
The following activity will walk you through the process of configuring the synchronization of taxes between the
BigCommerce store and Acumatica ERP.
Story
Suppose that SweetLife is using only Acumatica ERP (without an external tax provider) for calculating and
reporting taxes on the goods and services it sells. As an implementation consultant helping SweetLife to set up a
BigCommerce store, you need to set up taxes in the store and then make sure that the taxes on online sales orders
are correctly passed to Acumatica ERP when the orders are imported.
Configuration Overview
In the U100 dataset, the following tasks have been performed for the purposes of this activity:
• On the Tax Zones (TX206000) form, the NYSTATE tax zone has been configured.
Integration with BigCommerce | 141
• On the Tax Categories (TX205500) form, the TAXABLE and EXEMPT tax categories have been configured.
These tax categories have been assigned to item classes on the Item Classes (IN201000) form, and to
individual stock and non-stock items on the Stock Items (IN202500) and Non-Stock Items (IN202000) forms,
respectively.
• On the Taxes (TX205000) form, the NYSTATETAX tax has been set up.
Process Overview
In this activity, you will do the following:
1. In the control panel of the BigCommerce store, define a sales tax that you will collect on products sold to
customers in New York State.
2. On the Tax Categories (TX205500), Tax Zones (TX206000), and Taxes (TX205000) forms, review some of the
tax-related entities that have been predefined in the U100 dataset.
3. On the BigCommerce Stores (BC201000) form, specify the tax synchronization settings for your
BigCommerce store.
4. On the Substitution Lists (SM206026) form, map tax categories in Acumatica ERP to tax classes in the
BigCommerce store.
5. Also on the Substitution Lists form, map the sales tax defined in Acumatica ERP to the sales tax defined in the
BigCommerce store.
6. On the Entities (BC202000) form, update the export filtering settings to include stock items of one more item
class.
7. On the Prepare Data (BC501000) form, prepare the stock item data for synchronization; on the Process Data
(BC501500) form, process the prepared data.
8. In the control panel of the BigCommerce store, review the exported items.
9. To make sure that the tax applied to a sales order in the BigCommerce store is imported to Acumatica ERP
correctly, create an online order in the control panel of the BigCommerce store.
10.Import the sales order to Acumatica ERP by using the Prepare Data and Process Data forms.
11.On the Sales Orders (SO301000) form, review the imported sales order.
System Preparation
Do the following:
1. Make sure the connection to the BigCommerce store is established and the minimum configuration is
performed as described in the prerequisite activity, Initial Configuration: To Establish and Configure the Store
Connection.
2. Sign in to the control panel of the BigCommerce store as the store administrator.
Tax classes in BigCommerce correspond to tax categories in Acumatica ERP. You should not delete any of
the default classes, even though you do not collect tax on shipping or gi wrapping.
5. On the Tax Rates & Zones tab, click Add a Tax Zone.
6. On the Add a Tax Zone (Step 1 of 2) page, specify the following settings:
• Tax Zone Name: New York State
• This tax zone is based on one or more states (under Tax Zone Type): Selected
• Country: United States
• States: New York
• All customers in my store (under Tax Zone Applies to): Selected
• Enable this tax zone: Selected
7. In the lower right, click Save.
8. On the Tax Rates tab, which opens, click Add a Tax Rate.
9. On the Edit New York State page, which opens, in the Add new tax rate section, specify the following
settings:
• Tax Rate Name: New York State Tax
• % for products marked as Default Tax Class: 8.875
• % for products marked as Non-Taxable Products: 0
• % for products marked as Shipping: 0
• % for products marked as Gi Wrapping: 0
• Enable this tax rate: Selected
10.At the lower right, click Save.
For the purposes of this activity, you do not need to add any other tax rates.
1. While you are still viewing the Substitution Lists (SM206026) form, in the Substitution List box, select
BCCTAXCODES.
2. On the table toolbar, click Add Row, and in the added row, specify the following values:
• Original Value: New York State Tax
• Substitution Value: NYSTATETAX
With this mapping, when New York State Tax is applied to products in an online order in the SweetStore -
BC store, its name will be replaced with NYSTATETAX in the order imported from the BigCommerce store to
Acumatica ERP.
• During the import of an order to Acumatica ERP, if the system cannot find any tax applied
to the order in the BigCommerce store or a tax mapped to this order in the substitution list,
the import will fail.
• Taxes that have the same name in the BigCommerce store and Acumatica ERP (or that
have been mapped via the substitution list) should be defined with exactly the same rates.
Although an order for which the taxes have different rates will be imported successfully,
when an invoice is prepared for this imported sales order, the taxes are recalculated based
on the tax settings configured in Acumatica ERP. If the tax rates differ, there will be a
discrepancy between the amount of the invoice created in Acumatica ERP and the amount
of the order created in the BigCommerce store.
You can verify that the tax category is assigned correctly to non-stock items by completing instructions
similar to those described above.
6. In the row of the Sales Order entity, click the link in the Ready to Process column.
7. On the Process Data (BC501500) form, which opens with the SweetStore - BC store and the Sales Order entity
selected, select the unlabeled check box in the row of the sales order that you created earlier in this activity,
and on the form toolbar, click Process.
8. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
To avoid discrepancies between the tax amount calculated in the BigCommerce store when an
order is placed and the tax amount calculated in Acumatica ERP when an invoice is generated
for an imported order, make sure that product data (which includes the information about the
product's tax category) is in sync between the two systems before the order is created.
Integration with BigCommerce | 147
In this chapter, you will learn how to set up the import of orders with discounts from the BigCommerce store to
Acumatica ERP.
You may offer customers of your BigCommerce store discounts of various types. If the Customer Discounts feature
is enabled on the Enable/Disable Features (CS100000) form, you can select the level at which the discounts will be
displayed in orders imported to Acumatica ERP from the BigCommerce store.
Learning Objectives
In this chapter, you will learn how to set up the import of sales orders with discounts from the BigCommerce store
to Acumatica ERP.
Applicable Scenarios
You specify the level at which discounts should be displayed in imported orders if the Customer Discounts feature is
enabled on the Enable/Disable Features (CS100000) form.
The following activity will walk you through the process of importing orders that contain items with discounts.
Story
Suppose that the SweetLife sales manager decided to offer discounts for some of the products that the company
sells in its BigCommerce store. Starting from today, the company provides the following discounts:
• An extra gi item for purchases of 96-ounce jar of banana jam
• A 10 percent discount on purchases of 96-ounce jar of plum jam
• A 5 percent discount on orders of $100 or more
Integration with BigCommerce | 148
As SweetLife's implementation consultant, you need to define these discounts in the BigCommerce store and make
sure that orders that contain discounts or items with discounts are imported to Acumatica ERP with the discounts
applied correctly.
Configuration Overview
In the U100 dataset, on the Stock Items (IN202500) form, the BANJAM96 and PLUMJAM96 stock items have been
created for the purposes of this activity.
Process Overview
In this activity, you will do the following:
1. On the BigCommerce Stores (BC201000) form, update the discount-related settings.
2. In the control panel of the BigCommerce store, define three discounts of different types.
3. In the control panel, create a sales order with the automatically applied discounts.
4. On the Prepare Data (BC501000) form, prepare the sales order data for synchronization; on the Process Data
(BC501500) form, process the sales order data prepared for synchronization.
5. On the Sales Orders (SO301000) form, review the imported sales order and applied discounts.
System Preparation
Before you complete the instructions in this activity, do the following:
1. Make sure that the following prerequisite activities have been performed:
• Initial Configuration: To Establish and Configure the Store Connection
• Synchronizing Customers: To Perform Bidirectional Synchronization
• Price Synchronization: To Export Base Prices
2. Launch the Acumatica ERP website with the U100 dataset preloaded, and sign in with the following
credentials:
• Username: gibbs
• Password: 123
3. Open the Enable/Disable Features (CS100000) form.
4. On the form toolbar, click Modify.
5. Under Advanced Financials, select the Customer Discounts check box.
6. On the form toolbar, click Enable.
c. In the Search box, start typing banana, and in the list of search results, select Banana jam 96 oz.
Notice that two lines were added for the Banana jam 96 oz product. The price in the first line is $45. In the
second line, the price is zero, because this is the free item that you specified for the first discount.
d. In the line of the Plum jam 96 oz, change the quantity to 2.
e. Notice that the Item Total has changed for the items (except the free item) because the order total now
exceeds the $100 threshold and the order-level discount has been applied. The order subtotal is $135.30.
f. In the lower right, click Next.
4. On the Add an Order > Fulfillment page, in the Shipping Method section, click the Fetch Shipping Quotes
link.
5. In the box with the list of shipping options, click Free Shipping ($0.00).
6. In the lower right, click Next.
7. On the Add an Order > Finalize page, review the information in the Customer Billing Details, Shipping
Details, and Summary sections, and make sure that the order grand total aer applying all discounts is
$119.50.
8. In the Finalize section, select the Manual Payment payment method.
9. In the lower right, click Save & Process Payment.
10.On the View Orders page, which opens, make a note of the reference number of the created order.
3. On the Processed tab, in the row of the sales order that you have just imported (which you can locate by its
external ID), click the link in the ERP ID column.
4. On the Sales Orders (SO301000) form, which opens, review the settings of the order.
On the Details tab, notice that for the free item, Banana jam 96 oz, a separate line has been created with
the Free Item check box selected. In the Discount Amount and Discount Percent column, the system has
inserted zeros in all lines.
On the Discounts tab, notice that one line has been created for all discounts applied to the order in
the BigCommerce store (as shown in the following screenshot). The text in the Type column (External
Document) reflects the fact that the discounts were not applied in Acumatica ERP but were instead imported
from an external system. The amount in the Discount Amt. column corresponds to the Discount value of
the order in the BigCommerce store ($15.80).
You have created automatic discounts of different types in the BigCommerce store, explored how they are applied
to an order in the store, and reviewed how they are displayed on the order aer it has been imported to Acumatica
ERP. If you were to continue processing the order, you would also notice that the document-level discounts are
posted to a separate expense account specified for the customer in the Discount Account box on the GL Accounts
tab of the Customers (AR303000) form.
The topics of this chapter provide information about the representation of freight charges in sales orders imported
to Acumatica ERP from the BigCommerce store.
When you provide delivery service to customers of your organization, you need to calculate the freight prices to
charge customers. When a sales order is placed in the BigCommerce store, the freight price, which is calculated
based on the shipping rules configured in the store, is added to the sales order.
Integration with BigCommerce | 153
Learning Objectives
In this chapter, you will learn how to configure shipping rules to charge customers for freight and how freight fees
are represented in sales orders imported from BigCommerce to Acumatica ERP for fulfillment.
In Acumatica ERP, when an invoice is created for a sales order imported from the online store, the
system recalculates the freight price amount based on the freight information from the sales order
or the shipment. If the freight price is calculated based on shipments, there might be a discrepancy
between the freight amount in the invoice generated in Acumatica ERP and the order amount paid
by the customer in the online store. To present customers with the correct amount to be paid in
the online store and avoid the discrepancy, you need to be sure that the shipping terms mapped
to the shipping method selected by the customer at checkout stipulate that freight in a sales order
invoice be calculated based on a sales order rather than shipment—that is, in the Summary area of
the Shipping Terms (CS208000) form, the Invoice Freight Price Based On box should be set to Sales
Order.
When the sales order is imported from the BigCommerce store to Acumatica ERP, the shipping fees and handling
fees are added together and the resulting amount is displayed in the Freight Price box on the Totals tab of the
Sales Orders (SO301000) form.
When you create a sales order on the Sales Orders form of Acumatica ERP, you specify additional
freight charges for handling an order in the Premium Freight Price box on the Totals tab. However,
in orders imported from BigCommerce, handling fees are included in the freight price and are not
displayed in this box.
The following activity will walk you through the process of configuring a shipping method in the BigCommerce
store and mapping it to an existing ship via code in Acumatica ERP. You will also create a sales order for stock items
that need to be shipped to the customer's location, import the order to Acumatica ERP, and then review the results
of the import.
Integration with BigCommerce | 154
This activity is based on the U100 dataset. If you are using another dataset, or if any system settings
have been changed in U100, these changes can affect the workflow of the activity and the results of
the processing. To avoid any issues, restore the U100 dataset to its initial state.
Story
Suppose that you are an implementation consultant helping the SweetLife Fruits & Jams company to configure the
integration with the BigCommerce store. As part of the implementation process, you want to explore how freight
charges added to an online order in the BigCommerce store are imported to Acumatica ERP. For testing purposes,
you need to configure a shipping zone that will correspond to Manhattan, where SweetLife's head office and main
warehouse are also located. For shipments to this area, you will charge a small handling fee of $5. You need to
create at least one shipping method for the shipping zone. For simplicity, you will charge a $30 shipping fee per
order. Before processing an order placed with the shipping method, you need to map it to the ship via code and
shipping terms defined in Acumatica ERP.
To test the configuration, you need to create a BigCommerce order that requires shipment; you will then
synchronize it with Acumatica ERP and review the details of the imported order. For training purposes, you will
process a purchase of a cherry jam for the GoodFood One Restaurant customer. GoodFood is located in Manhattan
and the shipping option corresponding to the created shipping rule will be available to this customer in the cart
and at checkout.
Process Overview
In this activity, you will do the following:
1. In the BigCommerce store, on the Shipping Manager page, you will create a shipping zone for Manhattan
and configure a shipping rule for this shipping zone based on a flat fee.
2. On the BigCommerce Stores (BC201000) form of Acumatica ERP, you will map the shipping rule you created
to the LOCAL ship via code, which has been preconfigured in Acumatica ERP.
3. By using the control panel of the BigCommerce store, you will create a sales order for the GoodFood
customer.
4. On the Prepare Data (BC501000) form of Acumatica ERP, you will prepare sales order data for import from
BigCommerce to Acumatica ERP.
5. On the Process Data (BC501500) form, you will synchronize sales order data.
6. On the Sales Orders (SO301000) form, you will review the imported sales order and analyze how the freight
fees have been imported to Acumatica ERP.
System Preparation
Before you complete the steps described in this activity, do the following:
• Make sure that the following prerequisites have been met:
• The BigCommerce store has been created and configured, as described in Initial Configuration: To Set Up
a BigCommerce Store.
• The connection to the BigCommerce store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Establish and Configure the Store Connection.
• The entities have been prepared for synchronization, as described in Preparing Entities for
Synchronization: Implementation Activity.
• The first synchronization of data has been completed manually, as described in Data Synchronization: To
Perform the First Synchronization.
• Sign in to the control panel of the BigCommerce store as an administrator.
Integration with BigCommerce | 155
In this chapter, you will learn how to configure the Acumatica ERP instance for importing non-card refunds from the
BigCommerce store. You will also explore how non-card refunds are imported and applied to imported sales orders.
You can import to Acumatica ERP non-card refunds: that is, refunds issued for orders in your BigCommerce store
that have been paid and refunded with non-card payment methods or with card payment methods that are
mapped to an Acumatica ERP payment method for which integrated card processing is not configured.
Learning Objectives
In this chapter, you will learn how to do the following:
• Configure the import of refunds for non-card payment methods from a BigCommerce store to Acumatica
ERP
• Import refunds for non-card payment methods from a BigCommerce store to Acumatica ERP
Applicable Scenarios
You import refunds of payments based on a non-card payment method from BigCommerce to Acumatica ERP
so that you can keep track of refunded payments and restocked items. You may issue non-card refunds in the
BigCommerce store if any of the following events has occurred:
• A customer has been overcharged in error and part of the order amount needs to be refunded.
• A customer has not received the purchased item or has received an excessive quantity of the item.
Integration with BigCommerce | 158
• A customer has received the purchased item but is not satisfied with its quality or performance and wants to
return it.
• The original sales order has not been shipped at all or has been shipped in full. If the sales order has been
shipped partially, the refund will not be imported.
• The payment for the original sales order to which the refund pertains has been imported and released.
For information about the synchronization process, see Data Synchronization: General Information. For information
about the import of various types of refunds, see Importing Non-Card Refunds: Order-Level Refunds and Importing
Non-Card Refunds: Item-Level Refunds.
The following activity will walk you through the configuration of refund import so that you can import to Acumatica
ERP refunds and returns issued to a customer in the BigCommerce store for orders paid with non-card payment
methods.
Story
Suppose that the SweetLife Fruits & Jams company sells several kinds of jams in its BigCommerce store and wants
Acumatica ERP to keep information about the returns and refunds issued in the BigCommerce store. Acting as an
implementation consultant, you need to set up the import of refunds from the BigCommerce store to Acumatica
ERP.
Configuration Overview
In the U100 dataset, for the purposes of this activity, the following features have been enabled on the Enable/
Disable Features (CS100000) form:
• Commerce Integration
• BigCommerce Connector
• Custom Order Types
The following entities, which you will use in this activity, have been predefined in the U100 dataset:
• The ER order type on the Order Types (SO201000) form
• The REFUNDAMT non-stock item on the Non-Stock Items (IN202000) form
• The EREFUND reason code on the Reason Codes (CS211000) form
Process Overview
In this activity, you will do the following:
1. On the Entity Settings tab of the BigCommerce Stores (BC201000) form, activate the Refund entity.
2. On the Order Settings tab, review the settings related to refund import.
3. On the Payment Settings tab, activate the import of refunds for a non-card payment method.
System Preparation
To prepare the system for the steps of this activity, do the following:
1. Make sure the connection to the BigCommerce store has been established and the minimum configuration
has been performed, as described in Initial Configuration: To Establish and Configure the Store Connection.
2. Sign in to the Acumatica ERP instance with the U100 dataset preloaded. You should sign in as an
administrator an administrator by using the following credentials:
Integration with BigCommerce | 160
• Username: gibbs
• Password: 123
1. While you are still viewing the BigCommerce Stores (BC201000) form, go to the Payment Settings tab.
2. In the table of this tab, select the Process Refunds check box in the rows of the CUSTOM and CUSTOM
(CUSTOM) store payment methods.
The resulting settings related to the mapping of the payment method are shown in the following table.
Active Store Store Cur- ERP Pay- Cash Ac- Release Process Re-
Payment rency ment count Payments funds
Method Method
You have now configured the import of refunds from the BigCommerce store to Acumatica ERP for payments made
by using a non-card payment method (Manual Payment).
The following sections provide details you can use to ensure that the system is configured for importing refunds
for non-card payment methods from the BigCommerce store to Acumatica ERP, and to understand (and change, if
needed) the settings that affect the processing workflow.
Implementation Checklist
We recommend that before you import refunds issued in the BigCommerce store for non-card payment methods,
you make sure the needed features have been enabled, settings have been specified, and entities have been
created, as summarized in the following checklist.
Order Types (SO201000) An order type for return orders has been defined.
Non-Stock Items (IN202000) A non-stock item has been created to represent the amounts of re-
funds imported from the BigCommerce store to Acumatica ERP.
Reason Codes (CS211000) A reason code for imported refunds has been defined.
BigCommerce Stores (BC201000) • On the Entities tab: The Refund entity has been activated.
• On the Order Settings tab:
• The order type you created for returns has been selected in
the Return Order Types box.
• The reason code you created for refunds has been specified in
the Refund Reason Code box.
• The non-stock item you created to represent refunded
amounts has been specified in the Refund Amount box.
• On the Payment Settings tab: The Process Refunds check box
has been selected for a non-card payment method or card pay-
ment method that is mapped to an Acumatica ERP payment
method for which integrated card processing is not configured.
Validation of Configuration
To make sure that all configuration has been performed correctly, we recommend that in your system, you import
refunds from your BigCommerce store by performing instructions similar to those described in Importing Non-Card
Refunds: To Process a Refund for a Not-Yet-Shipped Order and Importing Non-Card Refunds: To Process a Refund for
a Shipped Order.
Integration with BigCommerce | 162
An order-level refund may be issued, for example, if a customer has been overcharged or is not content with the
quality of the product or service and needs to be partially reimbursed.
During the import of refunds on order amounts, if the original sales order has the Open or On Hold status on the
Sales Orders (SO301000) form, the system does the following:
• On the Payments and Applications (AR302000) form, creates a payment of the Customer Refund type in the
refunded amount and applies it to the original payment.
• In the original sales order, on the Details tab of the Sales Orders form, inserts a line for the non-stock item
that was specified in the Refund Amount Item box on the Order Settings tab of the BigCommerce Stores
(BC201000) form. In the Unit Price and Ext. Price columns, the system inserts the reversed refund amount
(that is, the amount with the minus sign). In the Reason Code column, the system inserts the reason code
that was specified on the Order Settings tab of the BigCommerce Stores form.
The following diagram illustrates the processing of an order-level refund for a non-card payment method when the
refund is issued before the sales order has been shipped.
Integration with BigCommerce | 163
If the original sales order has the Completed status on the Sales Orders form, the following actions are performed:
• On the Sales Orders form, the system creates a return order of the type selected in the Return Order Type
box on the Order Settings tab of the BigCommerce Stores form. In the External Reference box of the
Summary area, the system inserts the identifier of the refund that is used in the BigCommerce store.
• In the return order, on the Details tab of the Sales Orders form, the system inserts a line with the non-stock
item that was specified in the Refund Amount Item box on the Order Settings tab of the BigCommerce
Stores form. In the Unit Price and Ext. Price columns, the system inserts the refund amount. In the Reason
Code column, the system inserts the reason code that was specified on the Order Settings tab of the
BigCommerce Stores form.
• On the Payments and Applications (AR302000) form, creates a payment of the Customer Refund type in the
refunded amount and links it to the return order.
The following diagram illustrates the processing of an order-level refund for a non-card payment method when this
refund is issued aer the sales order has been shipped.
Integration with BigCommerce | 164
If the original sales order has a status other than Open, On Hold, or Completed on the Sales Orders form, the system
displays an error message saying that the refund cannot be applied.
A refund of an ordered item may be issued if, for example, a customer wants to amend a not-yet-shipped order
to decrease the quantity of a purchased item or because they want to return the item whose condition or
performance is unsatisfactory.
During the import of item refunds, if the original sales order has the Open or On Hold status on the Sales Orders
(SO301000) form, the system does the following:
• On the Payments and Applications (AR302000) form, creates a payment of the Customer Refund type in the
refunded amount and applies it to the original payment.
• In the original sales order, on the Details tab of the Sales Orders form, updates the order line or lines to
decrease the item quantities. If discounts and taxes have been applied, they are recalculated accordingly.
The following diagram illustrates the processing of an item refund for a non-card payment method when the refund
is issued before the sales order has been shipped.
Integration with BigCommerce | 165
If the original sales order has the Completed status on the Sales Orders form, the following actions occur:
• On the Sales Orders form, the system creates a return order of the type that was specified in the Return
Order Type box on the Order Settings tab of the BigCommerce Stores (BC201000) form. In the External
Reference box of the Summary area, the system inserts the identifier of the refund that is used in the
BigCommerce store.
• In the return order, on the Details tab of the Sales Orders form, the system inserts a line with the applicable
quantity of the returned item. In the Reason Code column, the system inserts the reason code that was
specified on the Order Settings tab of the BigCommerce Stores form.
• On the Payments and Applications (AR302000) form, creates a payment of the Customer Refund type in the
refunded amount and links it to the return order.
The following diagram illustrates the processing of an item return for non-card payment methods when this return
is issued aer the sales order has been shipped.
Integration with BigCommerce | 166
If the original sales order has a status other than Open, On Hold, or Completed on the Sales Orders form, the system
displays an error message saying that the refund cannot be applied.
The following activity will walk you through the process of importing a partial refund from the BigCommerce store
to Acumatica ERP. This is a partial refund of an order that has been paid by a non-card payment method and has
not yet been shipped.
Story
Suppose that a representative of the GoodFood One Restaurant customer placed an order for 10 jars of banana
jam in the SweetLife Fruits & Jams retail store and paid the entire order amount upfront in cash. The jam was to
be delivered from the SweetLife Fruits & Jams warehouse within seven days. Later the same day, before the jam
was shipped, the representative of GoodFood One Restaurant showed up in the retail store. The representative
informed the store manager that an error had occurred and only 5 jars of banana jam should have been purchased,
and asked the manager to refund the cost of the remaining quantity of banana jam. As the store manager, you need
to refund the cost of 5 jars of banana jam and import this refund to Acumatica ERP so that the correct quantities of
jam will be issued from SweetLife Fruits & Jams's warehouse.
Configuration Overview
In the U100 dataset, for the purposes of this activity, the following features have been enabled on the Enable/
Disable Features (CS100000) form:
• Commerce Integration
Integration with BigCommerce | 167
• BigCommerce Connector
• Custom Order Types
The following entities, which you will use in this activity, have been predefined in the system:
• The ER order type on the Order Types (SO201000) form
• The REFUNDAMT non-stock item on the Non-Stock Items (IN202000) form
• The EREFUND reason code on the Reason Codes (CS211000) form
Process Overview
In this activity, you will do the following:
1. In the control panel of the BigCommerce store, place a sales order for a customer.
2. On the Prepare Data (BC501000) form, prepare the sales order data for processing, and on the Process Data
(BC501500) form, process the sales order data.
3. On the Sales Orders (SO301000) form, review the imported sales order.
4. On the Payments and Applications (AR302000) form, release the prepayment related to the imported sales
order.
5. In the control panel of the BigCommerce store, update the order quantities, and issue a refund to the
customer.
6. On the Prepare Data form, prepare the refund data for processing, and on the Process Data form, process
the refund data.
7. On the Sales Orders form, review the updated sales order, and on the Payments and Applications form,
review the updated prepayment.
8. On the Payments and Applications form, review and release the customer refund.
System Preparation
To prepare the system for the steps of this activity, do the following:
1. Make sure that the following prerequisite activities have been performed:
• Initial Configuration: To Establish and Configure the Store Connection
• Data Synchronization: To Perform the First Synchronization
• Importing Non-Card Refunds: Implementation Activity
2. Sign in to the control panel of the BigCommerce store as the store administrator.
The elements of the billing address are populated with the settings from the previously saved address of
this customer.
d. In the bottom right, click Next.
3. On the Add an Order page (Items step), under Add Products, do the following:
a. In the Search box, start typing banana; in the list of search results, select Banana jam 96 oz.
b. In the line of the Banana jam 96 oz, change the quantity to 10.
c. At the bottom of the page, click Next.
4. On the Add an Order page (Shipping step), in the Shipping Method section, click the Fetch Shipping Quotes
link.
5. In the box with the list of shipping options, select Free Shipping.
You created this shipping option during the completion of the Data Synchronization: To Perform the First
Synchronization prerequisite activity.
For the purposes of this activity, you should assume that the billing address and shipping address are the
same.
6. In the bottom right, click Next.
7. On the Add an Order page (Finalize step), do the following:
• Review the information in the Customer Billing Details, Shipping Details, and Summary sections
• In the Finalize section, select the Manual Payment payment method.
8. In the bottom right, click Save & Process Payment.
The system creates an order and opens the View Orders page with the last order displayed at the top of
the order list. Make a note of the order number of the last created order (which is shown in the Order ID
column).
Because you have already accepted the payment outside of BigCommerce, the status of the order is
Awaiting Fulfillment.
10.In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
7. On the View Orders page, which opens for the partially refunded order, notice that the number of refunded
items (which is 5) is now displayed under the number of ordered banana jam jars. The refunded amount is
also displayed under Grand Total.
You have now imported a partial refund for ordered items in an order that has not yet been shipped and processed
this partial refund.
The following activity will walk you through the process of importing a partial refund from the BigCommerce store
to Acumatica ERP. This partial refund is for a shipped order that has already been fully delivered.
Story
Suppose that a representative of the West BBQ Restaurant customer placed an order for 10 jars of plum jam in the
SweetLife Fruits & Jams retail store, and paid the entire order amount upfront in cash. Four days later, aer the
purchased jam has already been delivered, a representative of West BBQ Restaurant returned 2 jars of plum jam. As
the store manager, you need to process the return of 2 jars of plum jam. You also want to reimburse the customer
$10 for the inconvenience of returning part of the purchase in person.
Configuration Overview
In the U100 dataset, for the purposes of this activity, the following features have been enabled on the Enable/
Disable Features (CS100000) form:
• Commerce Integration
• BigCommerce Connector
• Custom Order Types
The following entities, which you will use in this activity, have been predefined in the U100 dataset:
• The ER order type on the Order Types (SO201000) form
• The REFUNDAMT non-stock item on the Non-Stock Items (IN202000) form
• The EREFUND reason code on the Reason Codes (CS211000) form
Integration with BigCommerce | 172
Process Overview
In this activity, you will do the following:
1. In the control panel of the BigCommerce store, place a sales order for a customer.
2. On the Prepare Data (BC501000) form, prepare the sales order data for processing, and on the Process Data
(BC501500) form, process the sales order data.
3. On the Sales Orders (SO301000) form, review the imported sales order.
4. On the Payments and Applications (AR302000) form, release the prepayment related to the imported sales
order.
5. Using the Sales Orders form as a starting point, create a shipment.
6. On the Shipments (SO302000) form, confirm the shipment.
7. On the Prepare Data form, prepare the shipment data for processing, and on the Process Data form, process
the shipment data.
8. In the control panel of the BigCommerce store, issue a refund for a returned item.
9. In the control panel of the BigCommerce store, issue an order-level refund.
10.On the Prepare Data form, prepare the refund data for processing, and on the Process Data form, process
the refund data.
11.On the Sales Orders form, review the return orders the system created aer the refunds were imported.
12.On the Payments and Applications form, review the customer refunds created for each of the return orders.
System Preparation
To prepare the system for the steps of this activity, do the following:
1. Make sure the following prerequisite activities have been performed:
a. Initial Configuration: To Establish and Configure the Store Connection
b. Data Synchronization: To Perform the First Synchronization
c. Importing Non-Card Refunds: Implementation Activity
2. Sign in to the control panel of the BigCommerce store as the store administrator.
a. In the Search box, start typing plum; in the list of search results, select Plum jam 96 oz.
b. In the line of the Plum jam 96 oz, change the quantity to 10.
c. In the bottom right, click Next.
4. On the Add an Order page (Shipping step), in the Shipping Method section, click the Fetch Shipping Quotes
link.
5. In the box with the list of shipping options, select Free Shipping.
You created this shipping option during the completion of the Initial Configuration: To Establish and Configure
the Store Connection prerequisite activity.
For the purposes of this activity, you should assume that the billing address and shipping address are the
same.
6. In the bottom right, click Next.
7. On the Add an Order page (Finalize step), do the following:
• Review the information in the Customer Billing Details, Shipping Details, and Summary sections.
• In the Finalize section, select the Manual Payment payment method.
8. In the bottom right, click Save & Process Payment.
The system creates an order and opens the View Orders page with the created order displayed at the top
of the order list. Make a note of the order number of the last created order (which is shown in the Order ID
column).
Notice that the status of the order is Awaiting Fulfillment.
Notice that the shipment has been assigned the Confirmed status. Make a note of the shipment number; you will
use it to identify the shipment to be exported to the BigCommerce store in the next step.
Because you have confirmed the shipment, on the Sales Orders (SO301000) form, the status of the imported sales
order has changed to Completed.
In the Reference Nbr. box, select the number of the second customer refund created for the WESTBBQ
customer. Notice that it has the same settings as the first customer refund, except for the refund identifier
(which is shown in the Payment Ref. box and in the Description box), and the available balance (which
reflects an order-level refund of $10 issued in the BigCommerce store).
On the Sales Orders tab, notice that the customer refund has been linked to the second return order.
You have now imported to Acumatica ERP a refund for a returned item and a partial refund of the order amount.
For the purposes of this activity, you do not need to process the return orders or customer refunds further.
In this chapter, you will learn how to configure the Acumatica ERP instance for importing card refunds from the
BigCommerce store,. You will also explore how card refunds are imported and applied to imported sales orders.
You can import to Acumatica ERP refunds issued for orders paid with card-based payment methods to customers in
your BigCommerce store.
Learning Objectives
In this chapter, you will learn how to do the following:
• Configure the import of refunds for card-based payment methods (Authorize.Net) from a BigCommerce
store to Acumatica ERP
• Import refunds for card-based payment methods from a BigCommerce store to Acumatica ERP
Applicable Scenarios
You import refunds of payments based on a card-based payment method from BigCommerce to Acumatica ERP
to keep track of refunded payments and restocked items. You may issue refunds in the BigCommerce store in the
following cases:
• A customer has been overcharged in error and part of the order amount needs to be refunded.
• A customer has not received the purchased item or has received an excessive quantity of the item.
• A customer has received the purchased item but is not satisfied with its quality or performance and wants to
return it.
The following activity will walk you through the configuration of refund import so that you can import to Acumatica
ERP refunds issued to a customer in the BigCommerce store for an order paid by a credit card and processed by
using the Authorize.Net payment gateway.
Integration with BigCommerce | 180
Story
Suppose that the SweetLife Fruits & Jams company sells several kinds of jams in its BigCommerce store and
wants to track returns and refunds issued in the BigCommerce store from within Acumatica ERP. Acting as an
implementation consultant, you need to set up the import of returns and refunds issued in the BigCommerce store
for orders paid by a card and processed by using the Authorize.Net payment gateway. Further suppose that the
Authorize.Net payment gateway is configured to be used for processing card payments both in the BigCommerce
store and in Acumatica ERP.
Configuration Overview
For the purposes of this activity, the following features have been enabled on the Enable/Disable Features
(CS100000) form:
• Commerce Integration
• BigCommerce Connector
• Custom Order Types
The following entities, which you will use in this activity, have been predefined in the system:
• The ER order type on the Order Types (SO201000) form
• The REFUNDAMT non-stock item on the Non-Stock Items (IN202000) form
• The EREFUND reason code on the Reason Codes (CS211000) form
Process Overview
In this activity, you will do the following:
1. On the Entity Settings tab of the BigCommerce Stores (BC201000) form, activate the Refund entity.
2. On the Order Settings tab, you will review the settings of refund import.
3. On the Payment Settings tab, you will activate the import of refunds for the Authorize.Net payment
method.
System Preparation
Do the following:
1. Make sure the connection to the BigCommerce store has been established and the minimum configuration
has been performed, as described in Initial Configuration: To Establish and Configure the Store Connection.
2. Make sure that the mapping of the Authorize.Net payment method has been set up as described in Order
Synchronization: To Configure and Import Authorize.Net Payments.
3. Launch the Acumatica ERP website, and sign in as an administrator by using the following credentials:
• Username: gibbs
• Password: 123
2. In the Store Name box, select SweetStore - BC, which is the store that you created in Initial Configuration: To
Establish and Configure the Store Connection.
3. On the Entity Settings tab, make sure that the Active check box has been selected for the Refund entity.
You select the Active check box for an entity to indicate that the entity data needs to be synchronized
between Acumatica ERP and the BigCommerce store.
4. On the form toolbar, click Save to save your changes.
Step 3: Reviewing the Refund Import Settings for the Authorize.Net Payment Method
To import refunds for the Authorize.Net payment method, which you have configured in Order Synchronization: To
Configure and Import Authorize.Net Payments, do the following:
1. While you are still viewing the BigCommerce Stores (BC201000) form, open the Payment Settings tab.
2. In the table of this tab, make sure that the mappings are defined for the AUTHORIZENET (BIGPAY_TOKEN) and
AUTHORIZE.NET (CREDIT_CARD) store payment methods as shown in the following table.
Active Store Store Cur- ERP Pay- Cash Ac- Proc. Cen- Release Process
Payment rency ment count ter ID Payments Refunds
Method Method
Notice that the Process Refunds check box is selected for these store payment methods and is not available
for editing.
3. On the form toolbar, click Save to save your changes.
Integration with BigCommerce | 182
You have now configured the import of refunds to Acumatica ERP for payments made in the BigCommerce store
with a card by using the Authorize.Net payment gateway.
The following sections provide details you can use to ensure that the system is configured for importing refunds for
card-based payment methods from the BigCommerce store to Acumatica ERP, and to understand (and change, if
needed) the settings that affect the processing workflow.
Implementation Checklist
We recommend that before you import refunds issued in the BigCommerce store for card-based payment methods,
you make sure the needed features have been enabled, settings have been specified, and entities have been
created, as summarized in the following checklist.
Order Types (SO201000) The order type for return orders has been defined.
Non-Stock Items (IN202000) The non-stock item has been created to represent the amounts of re-
funds imported from the BigCommerce store to Acumatica ERP.
Reason Codes (CS211000) The reason code for imported refunds has been defined.
BigCommerce Stores (BC201000) • On the Entities tab: The Refund entity has been activated.
• On the Order Settings tab:
• The order type to be used for returns has been selected in the
Return Order Types box.
• The reason code for refunds has been specified in the Refund
Reason Code box.
• The non-stock item that represents refunded amounts has
been specified in the Refund Amount box.
Validation of Configuration
To make sure that all configuration has been performed correctly, we recommend that in your system, you import
refunds from your BigCommerce store by performing instructions similar to those described in Importing Card
Refunds: To Process a Refund for a Not-Yet-Shipped Order and Importing Card Refunds: To Import a Refund for a
Shipped Order.
An order-level refund may be issued, for example, if a customer has been overcharged or is not content with the
quality of the product or service and needs to be partially reimbursed.
Integration with BigCommerce | 183
During the import of refunds on order amounts, if the original sales order has the Open or On Hold status on the
Sales Orders (SO301000) form, the following actions occur:
• On the Payments and Applications (AR302000) form, the system creates a payment of the Customer Refund
type in the refunded amount and applies it to the original payment. If the sales order is fully refunded or
canceled and the processing status of the original payment is Authorized, the original payment is voided.
• In the original sales order, on the Details tab of the Sales Orders form, the system inserts a line for the
non-stock item that was specified in the Refund Amount Item box on the Order Settings tab of the
BigCommerce Stores (BC201000) form. In the Unit Price and Ext. Price columns, the system inserts the
reversed refund amount (that is, the amount with the minus sign). In the Reason Code column, the system
inserts the reason code that was specified on the Order Settings tab of the BigCommerce Stores form.
The following diagram illustrates the processing of an order-level refund for a card-based payment method that is
issued before the sales order has been shipped.
Integration with BigCommerce | 184
If the original sales order has the Completed status on the Sales Orders form, the following actions are performed:
• On the Sales Orders form, the system creates a return order of the type selected in the Return Order Type
box on the Order Settings tab of the BigCommerce Stores form. In the External Reference box of the
Summary area, the system inserts the identifier of the refund in the BigCommerce store.
• In the return order, on the Details tab, the system inserts a line with the non-stock item that was specified in
the Refund Amount Item box on the Order Settings tab of the BigCommerce Stores form. In the Unit Price
and Ext. Price columns, the system inserts the refund amount. In the Reason Code column, the system
inserts the reason code that was specified on the Order Settings tab of the BigCommerce Stores form.
• On the Payments and Applications (AR302000) form, creates a payment of the Customer Refund type in the
refunded amount and links it to the return order.
Integration with BigCommerce | 185
The following diagram illustrates the processing of an order-level refund for a card-based payment method that is
issued aer the sales order has been shipped.
If the original sales order has a status other than Open, On Hold, or Completed on the Sales Orders form, the system
displays an error message saying that the refund cannot be applied.
A refund of an ordered item may be issued if, for example, a customer wants to amend the order to decrease
the quantity of a purchased item or because they want to return the item whose condition or performance is
unsatisfactory.
During the import of item refunds, if the original sales order has the Open or On Hold status, the following actions
occur:
• On the Payments and Applications (AR302000) form, the system creates a payment of the Customer Refund
type in the refunded amount and applies it to the original payment.
• In the original sales order, on the Details tab of the Sales Orders (SO301000) form, the system updates
the order line or lines to decrease the item quantities. Discounts and taxes, if applied, are recalculated
accordingly.
• If the sales order is fully refunded or canceled and the processing status of the original payment is
Authorized, then the original payment is voided.
• If the sales order is fully refunded or canceled and the processing status of the original payment is Captured
or Settled, then a new voided payment is created against the original payment.
The following diagram illustrates the processing of an item return for a card-based payment method that is issued
before the sales order has been shipped.
Integration with BigCommerce | 186
If the original sales order has the Completed status, the following actions occur:
• On the Sales Orders form, the system creates a return order of the type that was specified in the Return
Order Type box on the Order Settings tab of the BigCommerce Stores (BC201000) form. In the External
Reference box of the Summary area, the system inserts the identifier of the refund in the BigCommerce
store.
Integration with BigCommerce | 187
• In the return order, on the Details tab of the Sales Orders form, the system inserts a line with the applicable
quantity of the returned item. In the Reason Code column, the system inserts the reason code that was
specified on the Order Settings tab of the BigCommerce Stores form.
• In the return order, on the Details tab of the Sales Orders form, the system inserts a line with the non-stock
item that was specified in the Refund Amount Item box on the Order Settings tab of the BigCommerce
Stores form. In the Unit Price and Ext. Price columns, the system inserts the refund amount. In the Reason
Code column, the system inserts the reason code that was specified on the Order Settings tab of the
BigCommerce Stores form.
• On the Payments and Applications (AR302000) form, creates a payment of the Customer Refund type in the
refunded amount and links it to the return order.
The following diagram illustrates the processing of an item return for a non-card payment method that is issued
aer the sales order has been shipped.
If the original sales order has a status other than Open, On Hold, or Completed, the system displays an error
message saying that the refund cannot be applied.
The following activity will walk you through the process of importing from the BigCommerce store to Acumatica
ERP a partial refund of an order that has been paid by a card-based payment method and has not yet been shipped.
Integration with BigCommerce | 188
For card-based payments processed through the Authorize.Net payment gateway, before you can
issue a refund, the original card transaction must be settled in the Authorize.Net processing center.
Captured transactions are automatically settled once every 24 hours aer the transaction cut-off
time, which you can configure in your Authorize.Net merchant account. Therefore, you will need to
wait for about 24 hours aer performing Step 2 and before moving on to Step 6 of this activity.
Story
Suppose that a customer placed an order for 10 jars of kiwi jam in the online store and paid for it by card. The
jam was to be delivered later by the SweetLife Fruits & Jams within 7 days of purchase. Later the same day, the
customer called the store to inform the store manager that an error had occurred and only 7 jars of kiwi jam were to
be purchased, and asked the remaining 3 jars of kiwi jam to be refunded. As the store manager, you need to refund
3 jars of kiwi jam and import this refund to Acumatica ERP so that the correct quantities of jam will be issued from
the SweetLife Fruits & Jams warehouse.
Configuration Overview
For the purposes of this activity, the following features have been enabled on the Enable/Disable Features
(CS100000) form:
• Commerce Integration
• BigCommerce Connector
• Custom Order Types
The following entities, which you will use in this activity, have been predefined in the system:
• The ER order type on the Order Types (SO201000) form
• The REFUNDAMT non-stock item on the Non-Stock Items (IN202000) form
• The EREFUND reason code on the Reason Codes (CS211000) form
Process Overview
In this activity, you will do the following:
1. In the BigCommerce store, place a sales order for a customer through the storefront and pay for it with a
credit card.
2. In the control panel of the BigCommerce store, capture the card payment.
3. On the Prepare Data (BC501000) form, prepare the sales order data for processing, and on the Process Data
(BC501500) form, process the sales order data.
4. On the Sales Orders (SO301000) form, review the imported sales order.
5. On the Payments and Applications (AR302000) form, review the prepayment created for the imported sales
order and then release the prepayment.
6. In the control panel of the BigCommerce store, issue a refund for an individual item.
7. On the Prepare Data form, prepare the refund data for processing, and on the Process Data form, process
the refund data.
8. On the Sales Orders form, review the updated sales order, and on the Payments and Applications form,
review the updated prepayment.
9. On the Payments and Applications form, review and release the customer refund.
Integration with BigCommerce | 189
System Preparation
To prepare the system for the steps of this activity, do the following:
1. Make sure that the following prerequisite activities have been performed:
• Initial Configuration: To Establish and Configure the Store Connection
• Data Synchronization: To Perform the First Synchronization
• Importing Non-Card Refunds: Implementation Activity
2. Sign in to the control panel of the BigCommerce store as the store administrator.
1. While you are signed in to the control panel of the BigCommerce store, in the le pane, click Orders > View.
2. On the View Orders page, which opens, expand the order of the Melody Keys customer, and review the order
details.
Notice that the Status of the order is set to Awaiting Payment and in the Billing Section, the Capture Funds
link is displayed. Because the Authorize.Net payment option was configured to only authorize the payment
amount when the order is placed, the payment funds have not yet been captured.
3. Click the Capture Funds link.
4. If the Fraud Status Warning dialog box is displayed, select the Yes, I understand and would like to
proceed check box in this dialog box, and click Capture Payment.
In the order details, notice that the payment status has changed to Captured.
1. While you are still viewing the imported order on the Sales Orders (SO301000) form, open the Payments
tab.
In the only row of the table, review the details of the prepayment that was created and applied to the sales
order when the sales order was imported. Notice that the Payment Method and Cash Account columns
show the payment method and cash account defined in Acumatica ERP and mapped to the Authorize.Net
payment method set up in the BigCommerce store.
In the Payment Ref. column, the system displays the reference number of the card transaction in the
Authorize.Net processing center (that is, the reference number of the card transaction that was used to pay
the order in the BigCommerce store).
Because you captured the payment in the BigCommerce store before importing the order, the prepayment
has the Balanced status and the processing status of the card transaction is Captured.
2. Click the link with the prepayment number in the Reference Nbr. column.
3. On the toolbar of the Payments and Applications (AR302000) form, which opens in a pop-up window with the
prepayment selected, click Release.
Once the prepayment is successfully released, its status is changed to Open.
10.In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
You have now imported to Acumatica ERP a partial refund for the ordered items for the order that has not yet been
shipped.
The following activity will walk you through the process of importing from the BigCommerce store to Acumatica
ERP a partial refund of an order that has already been fully delivered.
Integration with BigCommerce | 193
For card-based payments processed through the Authorize.Net payment gateway, before you can
issue a refund, the original card transaction must be settled in the Authorize.Net processing center.
Captured transactions are automatically settled once every 24 hours aer the transaction cut-off
time, which you can configure in your Authorize.Net merchant account. Therefore, you will need to
wait for about 24 hours aer performing Step 2 and before moving on to Step 6 of this activity.
Story
Suppose that a customer placed an order for 10 jars of pear jam in the SweetLife Fruits & Jams online store, and
paid the entire order by card. Four days later, aer the purchased jam has already been delivered, the customer
returned 2 jars of pear jam to the store. As the store manager, you need to process the return of 2 jars of pear jam.
You also want to reimburse the customer for returning part of the purchase in person.
Configuration Overview
In the U100 dataset, for the purposes of this activity, the following features have been enabled on the Enable/
Disable Features (CS100000) form:
• Commerce Integration
• BigCommerce Connector
• Custom Order Types
The following entities, which you will use in this activity, have been predefined in the U100 dataset:
• The ER order type on the Order Types (SO201000) form
• The REFUNDAMT non-stock item on the Non-Stock Items (IN202000) form
• The EREFUND reason code on the Reason Codes (CS211000) form
Process Overview
In this activity, you will do the following:
1. In the BigCommerce store, place a sales order for a customer through the storefront and pay for it with a
credit card.
2. In the control panel of the BigCommerce store, capture the card payment.
3. On the Prepare Data (BC501000) form, prepare the sales order data for processing, and on the Process Data
(BC501500) form, process the sales order data.
4. On the Sales Orders (SO301000) form, review the imported sales order.
5. On the Payments and Applications (AR302000) form, review and release the prepayment created for the
imported sales order.
6. On the Sales Orders form, create a shipment.
7. On the Shipments (SO302000) form, confirm the shipment.
8. On the Prepare Data (BC501000) form, prepare the shipment data for processing, and on the Process Data
(BC501500) form, process the shipment data.
9. In the control panel of the BigCommerce store, issue a refund for an individual item.
10.In the control panel of the BigCommerce store, issue a partial refund of the order amount.
11.On the Prepare Data form, prepare the refund data for processing, and on the Process Data form, process
the refund data.
12.On the Sales Orders form, review the return orders the system created aer the refunds were imported.
Integration with BigCommerce | 194
13.On the Payments and Applications form, review the customer refunds created for each of the return orders.
System Preparation
To prepare the system for the steps of this activity, do the following:
1. Make sure the following prerequisite activities have been performed:
a. Initial Configuration: To Establish and Configure the Store Connection
b. Data Synchronization: To Perform the First Synchronization
c. Importing Non-Card Refunds: Implementation Activity
2. Sign in to the control panel of the BigCommerce store as the store administrator.
Notice that the shipment has been assigned the Confirmed status. Note the shipment number; you will use it to
identify the shipment to be exported to the BigCommerce store in the next step.
On the Sales Orders (SO301000) form, the imported sales order's status has changed to Completed.
• Store: SweetStore - BC
• Prepare Mode: Incremental
2. In the table, select the unlabeled check box for the Shipment entity.
3. On the form toolbar, click Prepare.
4. In the Processing dialog box, which opens, review the results of the processing, and click Close when the
processing has completed.
5. Click the link in the Ready to Process column in the row of the Shipment entity.
6. On the Process Data (BC501500) form, which opens with the SweetStore - BC store and the Shipment entity
selected, select the unlabeled check box for the shipment created and confirmed in the previous steps
(which you can identify by the shipment order in the ERP ID column).
7. On the form toolbar, click Process.
8. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
Notice that the refunded amount under Grand Total has increased by $10.
because it was specified in Refund Amount Item box on the Order Settings tab of the BigCommerce Stores
form in Importing Card Refunds: Implementation Activity.
You have now imported to Acumatica ERP a refund for a returned item and a partial refund of the order amount
for the order that has been shipped in full. For the purposes of this activity, you do not need to process the return
orders or customer refunds further.
In this chapter, you will learn how to configure the gi certificate functionality to be able to sell gi certificates in
the BigCommerce store and accept the gi certificates as payment.
Integration with BigCommerce | 200
You can sell gi certificates in the BigCommerce store and then accept them as full or partial payments.
Learning Objectives
In this chapter, you will learn how to do the following:
• Create gi certificates so that you can sell them in the BigCommerce store
• Set up a payment method to use gi certificate balance to pay orders placed in the BigCommerce store
Applicable Scenarios
You set up gi certificates if you want to offer customers the ability to buy a gi certificate and then accept the sold
gi certificates as payments for orders.
In this activity, you will learn how to implement gi certificates in the BigCommerce store and explore how gi
certificates can be used to pay, in full or in part, for an online purchase in the BigCommerce store.
Story
Suppose that a sales manager of SweetLife wants to give its online customers the ability to purchase gi
certificates and use these certificates when purchasing goods in the SweetLife online store. You also want to track
payments made with gi certificates in Acumatica ERP by using a dedicated payment method.
As an implementation consultant, you need to set up a non-stock item that will be used to record a sale of a gi
certificate as well as a payment method that will be used to track payments made with gi certificates.
Configuration Overview
In the U100 dataset, the following tasks have been performed for the purposes of this activity:
• On the Non-Stock Items (IN202000) form, the GIFTCERT non-stock item has been created to represent gi
certificates sold in the online store.
• On the Payment Methods (CA204000) form, the GIFTCARDS payment method has been created.
Process Overview
You will do the following:
1. On the BigCommerce Stores (BC201000) form, configure the gi certificate settings.
2. In the control panel of the BigCommerce store, enable the gi certificate functionality and define gi
certificates in various amounts to be sold in the online store.
3. On the storefront, purchase a gi certificate.
4. In the control panel of the BigCommerce store, capture the payment and complete the order (aer which
the system will send the certificate to its recipient).
5. On the Prepare Data (BC501000) form, prepare the sales order data for synchronization, and on the Process
Data (BC501500) form, you will process the prepared data.
6. On the Sales Orders (SO301000) form, review the imported sales order.
7. On the storefront, you will create an order and pay part of it with the purchased gi certificate.
8. On the Prepare Data form, prepare the sales order data for synchronization, and on the Process Data form,
you will process the prepared data.
9. On the Sales Orders form, review the imported sales order corresponding to your order on the storefront
that was partially paid for with the gi certificate.
System Preparation
Before you start configuring the gi certificates, do the following:
1. Make sure the connection to the BigCommerce store is established and the minimum configuration is
performed as described in Initial Configuration: To Establish and Configure the Store Connection.
2. Make sure that the PLUMJAM08 stock item has been exported to the BigCommerce store during the
synchronization of the Stock Item entity (as described in Product Synchronization: To Synchronize Items with
Attributes).
3. Make sure that integration with Authorize.Net has been implemented as described in Order Synchronization:
To Configure and Import Authorize.Net Payments.
4. Sign in to the Acumatica ERP instance with the U100 dataset preloaded by using the following credentials:
• Username: gibbs
Integration with BigCommerce | 202
• Password: 123
You must specify a real email address to which you have access. The gi certificate code will
be sent to this email when the order is complete.
• Amount: $25.00
• I agree that Gi Certificates are nonrefundable: Selected
• Gi Certificate Theme: Celebration
4. Click Add Gi Certificate to Cart.
5. In the cart, click Check out.
6. On the checkout page, complete the process of creating the order as follows:
a. In the Customer section, in the Email Address box, specify melody@example.com, and click Continue.
b. In the Billing section, fill in the shipping address boxes as follows:
• First Name: Melody
• Last Name: Keys
• Address: 3402 Angus Road
• City: New York
• Country: United States
• State/Province: New York
• Postal Code: 10003
c. Click Continue.
d. In the Payment section, select the Authorize.Net option button, and specify the following card details:
• Credit Card Number: 4111 1111 1111 1111
• Expiration: 12/23
• Name on Card: Melody Keys
e. Click Place Order to place your order.
Your order has been created, and on the confirmation page, the order number is displayed. Note the
number because you will process the order with this number further in this activity.
If the system displays the Fraud Status Warning dialog box, select the Yes, I understand and
would like to proceed check box, and click Capture Payment.
If you have not received the email with the gi certificate code, you can find the code by
clicking Orders > Gi Certificates in the le pane while you are signed in to the control panel
of the BigCommerce store. The code is displayed on the Gi Certificates page, in the Code
column of the table on the All Gi Certificates tab.
Step 6: Importing the Sales Order Paid with the Gi Certificate
To import the sales order, in Acumatica ERP, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Summary area of the form, specify the following settings:
• Store: SweetStore - BC
• Prepare Mode: Incremental
3. In the table, select the Selected check box in the row of the Sales Order entity, and on the form toolbar, click
Prepare.
4. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
5. In the row of the Sales Order entity, click the link with the number of prepared synchronization records in
the Ready to Process column.
6. On the Process Data (BC501500) form, which opens with the SweetStore - BC store and the Sales Order entity
selected, select the unlabeled check box in the row of the order that you created earlier in this activity.
7. On the form toolbar, click Process.
8. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
On the Payments tab, notice that two prepayments have been applied to the order: a credit card payment
(mapped to the ALLCARDS payment method) and a gi card payment (mapped to the GIFTCARDS payment
method).
Figure: The prepayment and the gi certificate applied to the order
5. In the row of the gi card payment, which has an applied amount of $25, click the link in the Reference Nbr.
box.
6. On the Payments and Applications (AR302000) form, which opens in a pop-up window, review the payment
details.
Notice that in the Payment Ref. box of the Summary area, the payment identifier assigned to the payment
in the BigCommerce store is displayed. The Description box contains the store payment method, the code
of the gi certificate that was applied to the order, the order number, and the payment ID.
The prepayment has the Balanced status because the Release Payments check box was cleared for the
GIFTCARDS payment method in the mapping table on the Payment Settings tab of the BigCommerce Stores
(BC201000) form. For the purposes of this activity, you do not have to release the prepayment.
In the topics of this chapter, you will read about how to export matrix items created in Acumatica ERP to a
BigCommerce store and how to import orders with matrix items from BigCommerce to Acumatica ERP.
Acumatica ERP Retail-Commerce Edition provides you with the ability to export template items, along with the
matrix items that were generated based on these template items, from Acumatica ERP to the BigCommerce store.
For details about managing template items in Acumatica ERP, see Managing Matrix Items.
Learning Objectives
In this chapter, you will learn how to export template items and matrix items from Acumatica ERP to the
BigCommerce store.
Integration with BigCommerce | 207
Applicable Scenarios
You export matrix items from Acumatica ERP to the BigCommerce store in the following cases:
• You are initially configuring the BigCommerce store and need to transfer template items (and matrix items
based on these template items) that have already been defined in Acumatica ERP.
• You have updated any of the settings of a template item or matrix item in Acumatica ERP aer the template
item was synchronized with the BigCommerce store, and you need the changes to be reflected in the
product settings in the store.
synchronization of the template item, it will be deleted from the Variants table on the product management page
of the template item.
If the matrix item's status in Acumatica ERP is Inactive, No Sales, or Marked for Deletion—that is, if the matrix item
has one of these statuses selected in the Status box of the Summary area of the Non-Stock Items form or the Stock
Items form—it is not exported and does not appear in the Variants table on the product management page of the
template item.
page of the template item. With any other option selected in the Availability box, the Purchasable check box
becomes selected for the matrix item.
The following activity will walk you through the process of exporting a template item (and the matrix items based
on this template item) defined in Acumatica ERP to the BigCommerce store.
Story
Suppose that SweetLife Fruits & Jams company is going to sell juices in its BigCommerce online store. Acting as an
implementation consultant helping SweetLife to set up the integration of Acumatica ERP with the BigCommerce
store, you need to export the JUICE template item to the BigCommerce store.
Configuration Overview
In the U100 dataset, for the purposes of this activity, the following entities have been created:
• On the Enable/Disable Features (CS100000) form, the Matrix Items feature has been enabled.
• On the Item Classes (IN201000) form, the MJUICE item class
• On the Template Items (IN203000) form, the JUICE template item
• On the Stock Items (IN202500) form, the matrix items listed in the following table
Inventory ID Description
• On the Attributes (CS205000) form, the attributes and the attribute values listed in the following table
Ingredient APL (Apple), CHR (Cherry), ORG (Orange), PCH (Peach), PNL (Pineapple), SWB
(Strawberry), and TMT (Tomato)
Package BOX (Box), GBT (Glass bottle), JAR (Jar), PBT (Plastic bottle), and TIN (Tin)
Integration with BigCommerce | 210
Volume 08OZ (08 fl oz), 12OZ (12 fl oz), 16OZ (16 fl oz), 32OZ (32 fl oz), and 96OZ (96 fl oz)
Process Overview
In this activity, you will do the following:
1. On the Template Items (IN203000) form, review the JUICE template item.
2. On the BigCommerce Stores (BC201000) form, activate the Template Item entity.
3. On the Entities (BC202000) form, update the filtering conditions to export the template items of the MJUICE
item class.
4. On the Prepare Data (BC501000) form, prepare the template item data for synchronization.
5. On the Process Data (BC501500) form, process the template item data that has been prepared for
synchronization.
6. In the control panel of the BigCommerce store, review the exported item.
System Preparation
Before you complete the instructions in this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The BigCommerce store has been created and configured, as described in Initial Configuration: To Set Up
a BigCommerce Store.
• The connection to the BigCommerce store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Establish and Configure the Store Connection.
• The sales categories have been synchronized with the BigCommerce store, as described in the steps of
the following activity: Data Synchronization: To Perform the First Synchronization.
2. Launch the Acumatica ERP website with the U100 dataset preloaded, and sign in with the following
credentials:
• Username: gibbs
• Password: 123
3. On the Enable/Disable Features (CS100000) form, make sure that the Matrix Items feature is enabled as
follows:
a. On the form toolbar, click Modify, and select the Matrix Items check box under Inventory and Order
Management.
b. On the form toolbar, click Enable.
• Ingredient
• Package
• Volume
See the Configuration Overview section for details on the values defined for these attributes.
4. In the Inventory ID Segment Settings table, notice the settings for the automatic generation of the
identifiers that have been assigned to matrix items. The segments are generated based on the attribute
values (Segment Type is set to Attribute Value for all segments), and the length of each segment is
determined by the value in the Number of Characters column.
5. On the Matrix Items tab, review the list of matrix items that have been generated based on the attributes
configured for the Juice template item.
In the subsequent steps of this activity, you will export these items to the BigCommerce store.
On the product page, which opens for the Juice product, notice three boxes (Ingredient, Package, and
Volume), which correspond to product options on the product management page and attributes of the
Variant type assigned to the JUICE template item in Acumatica ERP.
Product images and videos can help customers select the most suitable products and choose variants, such as
colors or patterns. In Acumatica ERP, you can save images and videos of template items (such as a video showing
the use of a particular model of running shoes) and images of particular matrix items (such as the colors of this
model of running shoes). You can then export the saved images and videos to the BigCommerce store.
Learning Objectives
In this chapter, you will learn how to do the following:
1. Export images for template and matrix items from Acumatica ERP to the BigCommerce store
2. Export videos for template items from Acumatica ERP to the BigCommerce store
Applicable Scenarios
You export images and videos for template items and images for matrix items from Acumatica ERP to the
BigCommerce store in the following cases:
• You are initially configuring the BigCommerce store and need to export template items and matrix items
(including images and videos that have been saved for them) from Acumatica ERP to the store.
• You have updated the images and videos of a template item or the images of a matrix item in Acumatica
ERP aer the template item was synchronized with the BigCommerce store, and you need the changes to be
reflected in the product settings in the store.
management page of the exported template item in BigCommerce. You can specify the full URL or the Share URL
(that is, the short URL generated when you click the Share button under the video). For successful synchronization,
videos must be publicly accessible (that is, access to them should not require authentication or authorization).
During the synchronization of the Product Image entity, one of the images attached to a matrix item is exported to
the BigCommerce store. The exported image is added to the Image column in the Variants table of the Variations
section of the product management page of the template item the matrix item is based on. The template item and
the matrix item must be synchronized with the BigCommerce store or created in the BigCommerce store before
images attached to the matrix item can be exported. Only the files with extensions for which the Image check box is
selected on the File Upload Preferences (SM202550) form can be exported.
If images are added for a matrix item as links in the Media URLs table on the eCommerce tab of the
Stock Items (if the matrix item is a stock item) or Non-Stock Items form (if the matrix item is a non-
stock item), these images are not exported to BigCommerce.
The following activity will walk you through the process of exporting product images in Acumatica ERP to the
BigCommerce store. These images have been added for a template and for a matrix item.
Story
Suppose that the SweetLife Fruits & Jams company wants to export to the BigCommerce store the images it has
added for the JUICE template and for one of its variants. Some images of the template item are stored in external
storage. The others, however, are attached to items in Acumatica ERP. Acting as an implementation consultant
helping SweetLife to set up the integration of Acumatica ERP with the BigCommerce store, you need to export to
the BigCommerce store an image of the JUICE template item and an image of a matrix item generated from this
template item.
Configuration Overview
In the U100 dataset, for the purposes of this activity, the following items have been created:
• On the Template Items (IN203000) form, the JUICE template item
• On the Stock Items (IN202500) form, the PCH-32OZ-GBT stock item, which is a matrix item generated from the
JUICE template
Process Overview
In this activity, you will do the following:
1. On the Template Items (IN203000) form, add an image for the template item.
2. On the Stock Items (IN202500) form, add an image for the stock item (which is a matrix item generated from
the JUICE template).
3. On the Prepare Data (BC501000) form, prepare the template item data for synchronization; on the Process
Data (BC501500) form, process the template item data.
4. In the control panel of the BigCommerce store, review the exported images.
Integration with BigCommerce | 215
5. On the BigCommerce Stores (BC201000) form, activate the Product Image entity.
6. On the Prepare Data (BC501000) form, prepare the product image data for synchronization; on the Process
Data (BC501500) form, process the product image data.
7. In the admin area of the BigCommerce store, review the exported images.
System Preparation
Before you complete the instructions in this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The BigCommerce store has been created and configured, as described in Initial Configuration: To Set Up
a BigCommerce Store.
• The connection to the BigCommerce store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Establish and Configure the Store Connection.
2. Download the following files to your local computer:
• http://acumatica-builds.s3.amazonaws.com/builds/University/CommerceTraining/Juice1.png
• http://acumatica-builds.s3.amazonaws.com/builds/University/CommerceTraining/Juice2.png
3. Launch the Acumatica ERP website with the U100 dataset preloaded, and sign in with the following
credentials:
• Username: gibbs
• Password: 123
4. On the Enable/Disable Features (CS100000) form, make sure that the Matrix Items feature is enabled as
follows:
a. On the form toolbar, click Modify, and select the Matrix Items check box under Inventory and Order
Management.
b. On the form toolbar, click Enable.
URL Type
https://acumatica-builds.s3.amazonaws.com/builds/Universi- Image
ty/CommerceTraining/Juice3.png
Acumatica ERP Retail-Commerce Edition provides you with the ability to track the available quantities of template
items (and matrix items based on them) that you sell in the BigCommerce store and maintain in Acumatica ERP.
Integration with BigCommerce | 218
You have the flexibility to specify which quantities of items should be included in calculations of the quantities
available for sale in the online store.
Learning Objectives
In this chapter, you will learn how to do the following:
• Determine how the available quantities of template and matrix items exported to the BigCommerce store
should be calculated
• Set up quantity tracking for template and matrix items exported to the BigCommerce store
• Synchronize the available quantities of exported template and matrix items for which quantity tracking is
turned on
Applicable Scenarios
You track available quantities of template items and matrix items exported to the BigCommerce store if you want to
make these items available for purchase by shoppers through the storefront only if there is a sufficient quantity in
stock.
• To make the item unavailable for purchase via the storefront but available for pre-order, select Set as Pre-
Order in the When Qty. Unavailable box. In BigCommerce, the This product is coming soon but I want to
take pre-orders option button becomes selected.
• To keep the current purchasability settings of the item, select Do Nothing. In BigCommerce, the This
product can be purchased in my online store option button remains selected. However, the item cannot
be included in sales orders on the storefront.
The available quantity of an exported template item is calculated as a sum of available quantities of its exported
matrix items. To track the available quantity of an exported matrix item, on the eCommerce tab of the Stock Items
(IN202500) form, you select Set as Available (Track Qty.) in the Availability box. With this setting selected, you need
to specify the action that the system should perform with matrix item whose quantity becomes zero. If you select
Set as Unavailable in the When Qty. Unavailable box, the Purchasable check box will be cleared for the matrix
item. With any other option specified in this box, the check box will remain selected.
To avoid discrepancies in sales orders imported into Acumatica ERP, we recommend that before
changing an item's sales UOM you make sure that there are no unsynchronized sales orders that
contain the item. Also, you should synchronize the item's available quantity immediately aer
changing its sales UOM so that new orders for the item are created in the BigCommerce store with the
updated UOM.
In this activity, you will specify the default availability settings for the BigCommerce store, as well as the availability
settings for a particular template item and the matrix items generated based on this template item. You will then
export the product availability data to the BigCommerce store and review the results of the export.
Integration with BigCommerce | 220
Story
Suppose that the SweetLife Fruits & Jams company wants to sell several variants of juices in its online store.
The company needs to track the quantity of juice available for shipping from a particular location of its retail
warehouse.
Acting as an implementation consultant helping SweetLife to set up the integration of Acumatica ERP with the
BigCommerce store, you need to export to the BigCommerce store the availability settings and data of the JUICE
template item and the matrix items based on this template item. You also need to export the quantities of matrix
items available for shipping from the JS3 warehouse location of the RETAIL warehouse.
To explore how various availability settings specified for the store, template item, and matrix items in Acumatica
ERP affect the availability settings of the exported template item and matrix items in BigCommerce, you will
become familiar with various availability settings for items.
Configuration Overview
For the purposes of this activity, the following tasks have been performed in the U100 dataset:
• On the Enable/Disable Features (CS100000) form, the Multiple Warehouses and Multiple Warehouse Locations
features have been enabled.
• On the Warehouses (IN204000) form, the RETAIL warehouse and the JS3 warehouse location have been
configured.
• On the Template Items (IN203000) form, the JUICE template item has been defined.
• On the Stock Items (IN202500) form, the matrix items based on the JUICE template item have been defined.
Process Overview
In this activity, you will do the following:
1. On the BigCommerce Stores (BC201000) form, review the default availability settings.
2. On the Template Items (IN203000) form, update the availability settings of the JUICE template item.
3. On the Stock Items (IN202500) form, update the availability settings of the matrix items that have been
generated based on the JUICE template item.
4. On the Storage Details by Item Warehouse Location (IN408055) form, review the quantities of the matrix
items available in the JS3 location of the RETAIL warehouse.
5. On the Prepare Data (BC501000) form, prepare the template item data and the availability data for
synchronization; on the Process Data (BC501500) form, process the prepared data.
6. In the control panel of the BigCommerce store, review the items' settings and exported quantities.
System Preparation
Before you complete the instructions in this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The BigCommerce store has been created and configured, as described in Initial Configuration: To Set Up
a BigCommerce Store.
• The connection to the BigCommerce store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Establish and Configure the Store Connection.
2. Launch the Acumatica ERP website with the U100 dataset preloaded, and sign in with the following
credentials:
Integration with BigCommerce | 221
• Username: gibbs
• Password: 123
3. Activate the Product Availability entity as follows:
a. Open the BigCommerce Stores (BC201000) form.
b. On the Entity Settings tab, select the Active check box in the row of the Product Availability entity.
c. On the form toolbar, click Save.
If this column is not displayed in the table, click Edit Columns right of Variants, and in the
menu, select the Stock check box.
Also in the table, notice that the Purchasable check box is cleared for the SWB-32OZ-GBT variant. (You set
the Availability of this item to Set as Unavailable in Step 3.)
The available quantity is tracked for all items in the table, regardless of the availability settings defined for
each matrix item on the eCommerce tab of the Stock Items (IN202500) form (which was Store Default for
all items except for SWB-32OZ-GBT). The availability settings defined for the JUICE template item on the
eCommerce tab of the Template Items (IN203000) form overrode the default availability settings specified
for the SweetStore - BC store on the BigCommerce Stores (BC201000) form.
In Acumatica ERP, you can add sales prices for matrix items and export these prices to your BigCommerce store.
Learning Objectives
In this section, you will learn how to export the sales prices of matrix items from Acumatica ERP to the
BigCommerce store.
Applicable Scenarios
You export the sales prices of matrix items from Acumatica ERP to the BigCommerce store if you keep the sales
prices of matrix items in Acumatica ERP and want to quickly update the sales prices of the corresponding products
in BigCommerce.
In the BigCommerce store, the default prices of matrix items are displayed in the Variants table (Default
Price column) of the Variations section of the product management page of the template item.
• Base prices: Base prices—that is, sales prices that have the Base type and are not specific to any customer—
are maintained on the Sales Prices (AR202000) form or the Sales Price Worksheets (AR202010) form and are
exported to the BigCommerce store as a separate entity, Base Sales Price. You define prices of this type for
each matrix item the same way you would for other stock or non-stock items.
Sales prices of the Base type imported from Acumatica ERP are saved in BigCommerce in the Sale Price
column of the Variants table of the Variations section on the product management page of the template
item.
In BigCommerce, the sales price has a higher priority than the default price. Therefore, when the Sale Price
column is populated for an item, the price specified in this column is the effective price of the item.
Only prices that are effective on the date of the synchronization are exported; historical prices and
prices with an effective date in the future are not synchronized. If an item has multiple prices of
the same type that are effective on the date of the synchronization, the price of the highest priority
is imported. For example, if a regular base price of $5 and a promotional base price of $4.50 for
the same item are effective on January 31, 2021, which is the date when you synchronize the Base
Sales Price entity, the promotional price of $4.50 will be exported to the BigCommerce store. For
more information about price priorities, see Automatic Price Selection: Rules of Price Selection and
Automatic Price Selection: To Explore Regular and Promotional Prices.
In this activity, you will explore how the base sales prices defined for matrix items are exported from Acumatica ERP
and saved in the BigCommerce store.
Story
Suppose that SweetLife Fruits & Jams keeps all of its sales prices, including the prices of matrix items sold in the
BigCommerce store, in Acumatica ERP. As an implementation consultant, you want to export sales prices of the
Base type for all variants of juice (that is, for all matrix items based on the JUICE template item) from Acumatica
ERP to the BigCommerce store.
Integration with BigCommerce | 225
Configuration Overview
In the U100 dataset, for the purposes of this activity, the following entities have been created:
• On the Template Items (IN203000), the JUICE template item
• On the Stock Items (IN202500) form, the matrix items listed in the following table
Inventory ID Description
• On the Sales Price Worksheets (AR202010) form, a sales price worksheet with the base prices for the matrix
items (juice variants)
Process Overview
In this activity, you will do the following:
1. On the Sales Price Worksheets (AR202010) form, release a sales price worksheet for the matrix items; on the
Sales Prices (AR202000) form, review the added sales prices.
2. On the BigCommerce Stores (BC201000) form, activate the Base Sales Price entity.
3. On the Prepare Data (BC501000) form, prepare the base sales price data for synchronization; on the Process
Data (BC501500) form, process the prepared data.
4. In the control panel of the BigCommerce store, review the exported prices of items.
System Preparation
Before you complete the instructions in this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The BigCommerce store has been created and configured, as described in Initial Configuration: To Set Up
a BigCommerce Store.
• The connection to the BigCommerce store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Establish and Configure the Store Connection.
• The JUICE template item has been synchronized with the BigCommerce store, as described in Selling
Matrix Items: To Export Matrix Items.
Integration with BigCommerce | 226
2. Sign in to the Acumatica ERP instance with the U100 dataset preloaded by using the following credentials:
• Username: gibbs
• Password: 123
7. On the Process Data (BC501500) form, which opens with the SweetStore - BC store and the Base Sales Price
entity selected, click Process All on the form toolbar.
8. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
Acumatica ERP Retail-Commerce Edition provides you with the ability to sell matrix items created in Acumatica ERP
in a BigCommerce store.
Learning Objectives
In this chapter, you will learn how sales orders containing matrix items (also referred to as product variants in
BigCommerce) are imported to Acumatica ERP from a BigCommerce store and how these items appear in imported
sales orders.
Applicable Scenarios
You import a sales order with matrix items if you offer products with variants in your BigCommerce store and a
customer places an order that contains at least one variant.
Sales orders containing matrix items are imported from a BigCommerce store to Acumatica ERP the same way
as any other sales orders placed in the BigCommerce store are. In imported sales orders, on the Details tab
of the Sales Orders (SO301000) form, a line is created for each product variant added to the sales order in the
BigCommerce store. The Inventory ID column shows the identifier of a particular matrix item (that is, the identifier
of the stock or non-stock item) and not the identifier of the template item that was used to generate the matrix
item and that was synchronized with the BigCommerce store.
The following activity will walk you through the processes of purchasing product variants (matrix items) in the
BigCommerce store and importing the sales order containing these products into Acumatica ERP.
Story
Suppose that SweetLife Fruits and Jams sells juices (which are defined in Acumatica ERP as matrix items based on
the JUICE template item) in its BigCommerce store. Acting as an implementation consultant helping SweetLife to
Integration with BigCommerce | 228
set up the integration between Acumatica ERP and the BigCommerce store, you want to explore how online orders
containing matrix items (product variants) are imported to Acumatica ERP and review the results of the import.
Process Overview
In this activity, you will do the following:
1. On the storefront of the BigCommerce store, place an order with two variants of the JUICE product.
2. On the Prepare Data (BC501000) form, prepare the sales order data for synchronization; on the Process Data
(BC501500) form, process the prepared data.
3. On the Sales Orders (SO301000) form, review the imported sales order.
System Preparation
Before you complete the instructions in this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The BigCommerce store has been created and configured, as described in Initial Configuration: To Set Up
a BigCommerce Store.
• The connection to the BigCommerce store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Establish and Configure the Store Connection.
• Integration with Authorize.Net has been implemented, as described in Order Synchronization: To
Configure and Import Authorize.Net Payments.
• The JUICE template item has been exported to the BigCommerce store, as described in Selling Matrix
Items: To Export Matrix Items.
• The available quantities of the matrix items based on the JUICE template item have been exported, ass
described in Selling Matrix Items: To Export Product Availability Data.
• Sales prices of the matrix items based on the JUICE template item have been exported, as described in
Selling Matrix Items: To Export Base Prices.
2. Sign in to the control panel of the BigCommerce store as the store administrator.
• Volume: 16 fl oz
• Quantity: 5
8. Click Add to Cart.
9. In the confirmation pop-up window that opens, click Proceed to checkout.
10.On the checkout page, review your order details in the Order Summary section.
Make sure the order amount exceeds $100; otherwise, you will not be able to proceed with
shipping. In Initial Configuration: To Set Up a BigCommerce Store, you set up only one shipping
option (Free Shipping), which is available only if the order amount is greater than $100.
7. In the row of the Sales Order entity, click the link with the number of prepared synchronization records in
the Ready to Process column.
8. On the Process Data (BC501500) form, which opens with the SweetStore - BC store and the Sales Order entity
selected, select the unlabeled check box in the row of the order that you created in Step 1, and on the form
toolbar, click Process.
9. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
For the purposes of this activity, you do not need to process the sales order.
Integration with Shopify | 231
In this section, you will learn about the initial configuration that must be performed in a Shopify store and in
Acumatica ERP to set up the integration between these systems.
Before you can start using the e-commerce functionality of Acumatica ERP Retail-Commerce Edition, you need
to set up a Shopify store, establish a connection between the Acumatica ERP instance and the Shopify store, and
perform the initial configuration of the connection.
Learning Objectives
In this section, you will learn what general steps are involved in establishing a connection between Acumatica ERP
and the Shopify store and in performing the initial configuration of these systems.
Steps for Establishing the Store Connection and Performing the Initial Configuration
In order to connect the Acumatica ERP instance to the Shopify store, you perform the following general steps:
1. Set up a Shopify store.
2. Prepare the Acumatica ERP instance.
3. Establish the connection to the Shopify store.
4. Configure the entities enabled for synchronization.
5. Start synchronizing data.
To connect a Shopify by using the public app, the URL of your instance must be publicly
accessible from the internet.
• By using a custom app that you create and install in your Shopify store. For detailed instructions, see Initial
Configuration: To Establish the Store Connection with a Custom App.
2. Specifying the settings that apply to the customer synchronization. On the Customer Settings tab, you
specify the settings related to the synchronization of customers and customer locations (addresses). For
details, see Customer Synchronization: General Information.
3. Specifying the settings related to the synchronization of stock, non-stock, and template items. On the
Inventory Settings tab, you can define the following default settings:
• Export of sales categories as tags for the exported items.
You can cause the system to export sales categories assigned to a stock or non-stock item in Acumatica
ERP to be exported to the Shopify store as product tags during the synchronization of the item. To do
this, on the Inventory Settings tab of the Shopify Stores (BC201010) form, you set Sales Category
Export to Export as Product Tags. You can view sales categories on the Item Sales Categories (IN204060)
form.
• Default visibility of items exported to the Shopify store.
To specify that by default items should be visible on the storefront immediately aer they are exported to
the store, you select Visible in the Default Visibility box. To export items but make them hidden from the
storefront, you select Invisible. For information about managing visibility of exported items, see Product
Synchronization: General Information.
• Default availability of items exported to the Shopify store. For details, see Product Availability: General
Information.
4. Specifying the settings related to the synchronization of orders. You define the default order-related settings
on the Order Settings tab as follows:
• In the General section, you select the branch that will appear on sales orders imported from the Shopify
store. The base currency of the branch must match the default currency of the Shopify store, which is
displayed in the Default Currency box of the Store Properties section on the Connection Settings tab.
• In the Order section, you provide the settings for the synchronization of orders, processing of returns
and refunds, importing of orders with discounts (if discounts are provided), selling gi cards, handling
the risky orders, etc. For details, see Order Synchronization: General Information, Gift Cards: General
Information, Import of Orders with Discounts: Process Activity, Importing Card Refunds: General Information,
and
• In the Taxes section, you specify if taxes need to be synchronized with the Shopify store; in the
Substitution Lists section, you can specify the substitution lists to be used for tax synchronization. For
details, see Import of Taxes: General Information.
5. Specifying the settings related to the synchronization of payments. On the Payment Settings tab, you map
the payment methods defined in the Shopify store to the combination of the payment method and cash
account defined in Acumatica ERP. For information, see Order Synchronization: General Information and
Order Synchronization: Card Payments.
6. Specifying the settings related to the synchronization of shipments. On the Shipping Settings tab, you define
the mapping of each shipping option (which is a combination of a shipping zone and shipping method)
defined in Shopify to the ship via code, and optionally, shipping zone and shipping terms defined in
Acumatica ERP. The Store Shipping Zone and Store Shipping Method columns of the table are populated
with the settings from Shopify when the correct API credentials are entered and saved on the Connection
Settings tab.
7. On the form toolbar, you click Save to save the settings.
Synchronization of Data
Aer you have performed the initial configuration, you can start to synchronize data between Acumatica ERP
and the Shopify store. First, you perform manual synchronization for entities in a specific order. Then you set up
synchronization to run automatically, either in real-time or according to a specific schedule. For information about
synchronization, see Data Synchronization: General Information.
You can use the information in this topic to quickly check what needs to be configured in the Shopify store and in
the Acumatica ERP instance before you can start implementing the integration with the Shopify store.
Store Admin URL The permanent URL of the store followed by /admin.
This path is used for navigating to the Shopify store's pages from the
Sync History (BC301000) and Process Data (BC501500) forms.
API Key The API key of the custom app created in the Shopify store to inte-
grate it with Acumatica ERP.
API Access Token The API access token that was generated for the custom app added to
the Shopify store to integrate it with Acumatica ERP.
API Secret Key The API secret key that was generated for the custom app created in
the Shopify store to integrate it with Acumatica ERP.
Store profile The basic information about the online store, including the store
name, business name and address.
The store country is important because it determines which payment
and shipping options are available for your store.
Default currency The default currency in which prices are displayed to users and which
transactions are made. The default currency should be the same as
the base currency in the Acumatica ERP instance.
Integration with Shopify | 235
Payment methods for the default cur- The payment methods that can be used for transactions in the de-
rency fault currency.
Shipping rules The shipping zones and rates that you want to use in your store.
Enable/Disable Features (CS100000) The following required features are See Preparing an Instance: Acumati-
enabled: ca ERP Features.
• Business Account Locations
• Commerce Integration
• Shopify Connector
• Custom Order Types
• Inventory
• Scheduled Processing
The Inventory Subitems feature is
disabled.
Customer Classes (AR201000) The customer class for e-commerce See Accounts Receivable: Customer
customers has been created. This Classes.
customer class is used for creating
customer records in Acumatica ERP
for customers imported from the
Shopify store.
Customers (AR303000) The customer account for import- See Customers: General Information.
ing to Acumatica ERP orders placed
in the online store by guest users
has been created.
Numbering Sequences (CS201010) • A numbering sequence has been See Use of Numbering Sequences.
defined for the auto-numbered
segment that will be used for
generating customer IDs on im-
port.
• A numbering sequence has been
defined for the auto-numbered
segment that will be used for
generating customer location
IDs on import.
Order Types (SO201000) A unique order type has been creat- See Sales Order Types: General In-
ed for orders imported from the on- formation.
line store.
Taxes (TX205000) The sales taxes applicable to the See Sales Taxes: General Informa-
products that you sell have been tion.
configured.
Ship via Codes (CS207500) The ship via codes for the deliv- See To Create a Ship via Code.
ery services that the company uses
have been created.
Cash Accounts (CA202000) The cash accounts associated with See Cash Management: To Create
payment methods used in the e- Cash Accounts.
commerce transactions have been
created.
Payment Methods (CA204000) The payment methods to be See Cash Management: Payment
mapped to store payment methods Methods.
used in the e-commerce transac-
tions have been configured.
Processing Centers (CA205000) The processing center to be used See Setup of Card Payment Pro-
for processing credit card pay- cessing.
ments has been configured.
Integration with Shopify | 237
Before you start configuring the integration between Acumatica ERP and Shopify, you should set up the Shopify
store. In this topic, you will learn about the minimum settings of the Shopify store that you need to configure.
This topic covers only the essential settings that you need to configure in Shopify for integration with
the Acumatica ERP instance. For details on the configuration of other settings, refer to the Shopify
documentation.
In trial accounts, you can create orders other than dra orders only if you have selected a subscription
plan, which requires entering bank card details.
For information about the detailed steps that you need to complete to create a trial account, see the Free trial page
in the Shopify Help Center.
system aer the synchronization. To set up the store time zone, in the Standards and formats section of the Store
details settings page of the Shopify admin area, you select the needed time zone in the Time zone box.
Configuring Taxes
You set up tax rates and tax calculation rules for your store on the Taxes settings page of your Shopify admin area.
For information about configuring taxes, refer to the Taxes articles in the Shopify Help Center.
Configuring Shipping
Shopify provides a wide range of shipping options that you can flexibly configure to your needs. On the Shipping
and delivery settings page of the Shopify admin area, you specify the shipping zones to which you want to offer
delivery as well as shipping rates.
For information about configuring shipping, see Shipping and delivery articles in the Shopify Help Center.
This activity will guide you through the process of signing up for a Shopify trial account and performing the
minimum configuration of a Shopify store so that it can be connected with the Acumatica ERP instance.
Story
The SweetLife company is planning on opening an online store built on the Shopify platform. The store's
warehouse, from which the goods sold online will be shipped, is based in New York. The company maintains the
prices of its products in U.S. dollars and delivers products across New York by using the company's own vehicles.
As an implementation consultant helping SweetLife to implement the integration between Shopify and Acumatica
ERP, you want to set up a new store and perform the minimum required configuration of the Shopify store that will
be sufficient to proceed with the configuration of the integration.
Process Overview
In this activity, you will perform the following steps in Shopify:
1. Sign up for a Shopify trial account
2. Set the store time zone
3. Set up the store currency
4. Review the default shipping options
Integration with Shopify | 239
This activity covers the creation and basic configuration of a new Shopify store. The results of
performing the instructions presented below are used in subsequent activities. We recommend that
you sign up for a new trial account and create a new store for testing purposes. If you have an existing
test store and do not want to set up another one, make sure that in the subsequent activities, you
make the necessary adjustments where the results of the current activity are used.
2. If Store currency is set to any value other than US dollars (USD), change it to US dollars (USD) and click Save.
You have specified the minimum set of store settings that you will need for the basic configuration of the Shopify
integration with Acumatica ERP. Now you should proceed to establish the connection between the Shopify store
and your Acumatica ERP instance, as described in Initial Configuration: To Establish the Store Connection with a
Custom App.
The following activity will walk you through the process of creating a custom Shopify app and connecting your
Shopify store to your Acumatica ERP instance with the credentials of the custom app.
This activity is based on the U100 dataset. If you are using another dataset, or if any system settings
have been changed in U100, these changes can affect the workflow of the activity and the results of
the processing. To avoid any issues, restore the U100 dataset to its initial state.
Story
Suppose that the SweetLife Fruits & Jams company wants to sell jam in its online store , which is deployed on
the Shopify platform. SweetLife is already using Acumatica ERP and now needs to integrate its instance with a
new Shopify store. As SweetLife's implementation consultant, you need to create and install a custom app in
your Shopify store and establish the connection between Acumatica ERP and the Shopify store using the app's
credentials .
Process Overview
In this activity, you will create a custom app in your Shopify store and assign it the necessary access permissions.
Then you will install the app to generate an access token for it. Finally, use will use the app's credentials to connect
Acumatica ERP to your Shopify store.
System Preparation
Before you start this activity, do the following
1. Make sure you have deployed an Acumatica ERP instance and made it publicly accessible through the
internet.
2. Make sure you have set up a Shopify store, as described in Initial Configuration: To Set Up a Shopify Store.
Integration with Shopify | 241
3. Sign in to Acumatica ERP by using the gibbs username and the 123 password.
4. Sign in to the Shopify store as the store owner.
The access token is displayed only once because it provides API access to sensitive store data.
You should save it to a secure location because you will not be able to reveal it again.
In the API key and secret key section, notice the API secret key. You will use it along with the access token
to connect the Shopify store to your Acumatica ERP instance.
Integration with Shopify | 242
The following activity will walk you through the process of connecting your Shopify store to your Acumatica ERP
instance.
This activity is based on the U100 dataset. If you are using another dataset, or if any system settings
have been changed in U100, these changes can affect the workflow of the activity and the results of
the processing. To avoid any issues, restore the U100 dataset to its initial state.
Story
Suppose that the SweetLife Fruits & Jams company wants to sell jam in its online store deployed on the Shopify
platform. SweetLife is already using Acumatica ERP and now needs to integrate its instance with a new Shopify
store. As SweetLife's implementation consultant, you need to install the Acumatica Cloud ERP app from the Shopify
App Store and establish the connection between Acumatica ERP and the Shopify store.
Process Overview
In this activity, you will install the Acumatica Cloud ERP app from the Shopify App Store and then use it to connect
Acumatica ERP to your Shopify store.
System Preparation
Before you start this activity, make sure of the following:
1. You have deployed an Acumatica ERP instance and made it publicly accessible through the internet.
2. You have set up a Shopify store, as described in Initial Configuration: To Set Up a Shopify Store.
Integration with Shopify | 243
You can open the Acumatica Cloud ERP app by clicking the app name in the Installed apps
section of the Apps page. You navigate to this page by clicking Apps in the le menu.
If the app shows a warning that your version of Acumatica ERP is not supported, ignore it and
continue with the configuration.
5. In the Connect your Acumatica ERP Account step, which now shows the question Is this a sandbox?, click
Yes.
You have now connected your Acumatica ERP instance with the Shopify store.
In a production environment, you would need to answer No to the last question and provide additional
details about yourself and your business so that representatives of Acumatica Inc. could contact you and
help you get started.
Integration with Shopify | 244
In this activity, you will go through the settings that need to be specified in the Acumatica ERP instance before you
set up the connection to the Shopify store.
Story
SweetLife Fruits & Jams is planning on opening an online store built on the Shopify platform. The warehouse from
which the goods will be shipped is based in New York. The company maintains the prices of its products in United
States dollars and delivers products across New York by using the company's own vehicles. As an implementation
consultant helping SweetLife to implement the integration between Shopify and Acumatica ERP, you want to make
sure that the features required for the e-commerce functionality are enabled and the necessary entities are created
and configured in the Acumatica ERP instance.
Process Overview
The Acumatica ERP instance with the U100 dataset already contains most of the settings and data that you will
need to specify when you start configuring the store connection. In this activity, you will review the following
settings or entities on the following forms of the Acumatica ERP instance:
• Enable/Disable Features (CS100000) form: The features that have been enabled to support e-commerce
functionality
• Customer Classes (AR201000) form: The customer class for the customers imported from the Shopify store
• Numbering Sequences (CS201010) form: The numbering sequences to be used for generating the identifiers
for new customers and customer locations imported from the Shopify store
• Customers (AR303000) form: The customer account to be used for guest orders (orders placed by
unregistered users) in the online store
• Order Types (SO201000) form: The order type to be used for orders imported from the Shopify store, and the
order type to be used for handling returns of online purchases
• Ship via Codes (CS207500): The carrier to be used for handling shipping
• Cash Accounts (CA202000): The cash account to be used for e-commerce orders
• Payment Methods (CA204000): The payment method to which payment methods from the Shopify store will
be mapped
System Preparation
Sign in to the Acumatica ERP instance with the U100 dataset preloaded by using the following credentials:
• Username: gibbs
• Password: 123
• Commerce Integration
• Shopify Connector
If any of these features is not enabled, click Modify on the form toolbar, select the check box that activates
the feature, and click Enable on the form toolbar.
Depending on the setup of your Shopify store and the inventory and order management
processes in your company, you might need to enable additional features. For more
information, see Initial Configuration: Implementation Checklist.
Step 2: Reviewing the Customer Class for Customers Imported from Shopify
During the process of establishing and configuring the connection between Acumatica ERP and the Shopify store,
you will need to specify the customer class that will be assigned to customer records imported from the Shopify
store and that will provide the default settings for the imported customers. You can use an existing customer
class or create a new one with a different set of default settings to be used specifically for online customers. In the
instance with the U100 data preloaded, a dedicated customer class for online customers has already been created.
To review the customer class that will be used for customers imported from the Shopify store, do the following:
1. Open the Customer Classes (AR201000) form.
2. In the Class ID box, select ECCUSTOMER.
In a subsequent activity, you will specify this customer class in the store settings so that the system will use
the settings of this customer class to populate customer records for new customers that will be imported
from the Shopify store to Acumatica ERP.
Step 3: Reviewing the Numbering Sequences for Customers and Customer Locations
To review the numbering sequences that Acumatica ERP will use to assign identifiers to customers and customer
locations (addresses) imported from the Shopify store, do the following:
1. Open the Numbering Sequences (CS201010) form.
2. In the Numbering ID box, select ECCUSTOMER.
Review the settings of the numbering sequence that will be used to automatically generate the identifiers of
the customers imported from the Shopify store to Acumatica ERP. With these settings, these customers will
be assigned identifiers that start with the letter C followed by a numerical portion.
3. In the Numbering ID box, select ECLOCATION.
Review the settings of the numbering sequence that will be used to automatically generate the identifiers
of the customer locations imported from the Shopify store to Acumatica ERP. With these settings, these
customer locations will be assigned identifiers that start with the letter L followed by a numerical portion.
In a subsequent activity, you will specify these numbering sequences in the store settings so that the system will
use them to create identifiers for customers and customer locations imported from the Shopify store to Acumatica
ERP.
In the Order Template box notice that this order type is based on the SO order template. In a subsequent
activity, you will configure the system to assign this order type to all orders imported from the Shopify store.
In this activity, you will learn how to perform the initial configuration of the synchronization between Acumatica
ERP and the Shopify store.
Story
Suppose that the SweetLife Fruits & Jams company wants to sell jam in its online store deployed on the Shopify
platform. SweetLife has already connected Acumatica ERP and its Shopify store. As SweetLife's implementation
consultant, you need to perform the minimum configuration required for synchronization of data between
Acumatica ERP and the Shopify store.
Configuration Overview
In the U100 dataset, the following tasks have been performed for the purposes of this activity:
• On the Enable/Disable Features (CS100000) form, the Commerce Integration and Shopify Connector features
have been enabled.
• On the Customer Classes (AR201000) form, the ECCUSTOMER customer class has been defined.
• On the Numbering Sequences (CS201010) form, the ECCUSTOMER numbering sequence has been defined,
Integration with Shopify | 247
• On the Customers (AR303000) form, the ECOMGUEST customer record has been created.
• On the Non-Stock Items (IN202000) form, the REFUNDAMT non-stock item has been defined.
• On the Item Sales Categories (IN204060) form, the Other sales category has been created.
• On the Order Types (SO201000) form, the EO - eCommerce Order has been defined based on the SO order
template.
• On the Ship via Codes (CS207500) form, the SWEETSHIP ship via code has been created.
• On the Cash Accounts (CA202000) form, the 10250ST cash account has been configured for the RETAIL branch
and the USD currency.
• On the Payment Methods (CA204000) form, the ONLINE payment method has been set up to be used with the
10250ST cash account.
Process Overview
On the Shopify Stores (BC201010) form, you perform the minimum configuration of the settings required for the
synchronization of data between Acumatica ERP and the Shopify store.
System Preparation
Before you start this activity, do the following:
1. Make sure that you have completed the following activities:
• Initial Configuration: To Set Up a Shopify Store
• Initial Configuration: To Prepare the Acumatica ERP Instance
• Initial Configuration: To Establish the Store Connection with a Public App
2. Sign in to the Acumatica ERP instance with the U100 dataset preloaded by using the following credentials:
• Username: gibbs
• Password: 123
This is the default customer class based on which customer records will be created in Acumatica ERP for
customers imported from the online store.
• Customer Auto-Numbering: ECCUSTOMER
This numbering sequence has been configured in Acumatica ERP to automatically generate identifiers
for customer records imported from the Shopify store.
• Generic Guest Customer: ECOMGUEST
This customer account, which has been created in Acumatica ERP, will appear on orders imported from
the Shopify store that have been created in the admin area of the store without specifying a customer.
Active Store Shipping Store Shipping Ship Via Shipping Zone Shipping
Zone Method Terms
Active Store Payment Store Cur- ERP Payment Cash Ac- Release Payments
Method rency Method count
With these settings, the payments for orders created with the manual payment method in the Shopify store
will be imported to Acumatica ERP for further processing. In imported sales orders and payments made with
this payment method, the mapped payment method, ONLINE, will be displayed. For simplicity, you do not
need to map any other payment methods at this time.
3. On the form toolbar, click Save to save your changes.
Now that the initial configuration is complete, you can move on to synchronize your data for the first time. For
information on data synchronization, see Data Synchronization: General Information and Data Synchronization: To
Perform the First Synchronization.
In this chapter, you will learn how the synchronization of data between Acumatica ERP and Shopify works, how to
enable real-time synchronization for some or all of the activated entities, and how to configure the synchronization
to start according to a schedule.
Aer the connection between Acumatica ERP and the Shopify store has been established and the initial
configuration performed, you can start synchronizing data between the two systems.
Learning Objectives
In this chapter, you will learn how data synchronization works and how to synchronize data manually.
During the processing of out-of-sync data, the system performs the following operations for each synchronization
record:
1. Pulling the record details from Acumatica ERP and the external e-commerce system.
2. Determining the direction of the synchronization—that is, if data should be imported to Acumatica ERP,
exported to the external system, or synchronized in both directions.
3. Determining if any other records should be synchronized as a prerequisite for the synchronization of the
current record, and attempting to synchronize the prerequisite records.
4. Applying the standard field mapping for the entity.
The default field mapping for each entity is detailed in Retail-Commerce Edition Entity Reference.
5. Applying the field mapping configured for the entity on the Entities (BC202000) form.
6. Saving the synchronized data in the destination system or systems.
7. Changing the status of the synchronization record to Processed.
When a synchronization record is prepared and processed, the system assigns it one of the statuses described in
the following table. You can review the synchronization status of any synchronization record on the Sync History
(BC301000) form.
Status Description
Prepared The synchronization record has been created or updated, but out-of-sync data
has not been saved in the destination system or systems.
Processed The synchronization record has been processed, and data has been recorded
to the destination system or systems according to the synchronization settings
configured for the entity.
Failed The processing of the synchronization record has failed and data could not be
recorded to the destination system or systems.
Aborted The synchronization record was excluded from synchronization by the system.
The system automatically assigns the Aborted status to a synchronization
record if the processing of the synchronization record has failed the number
of times specified for the entity in the Max. Number of Failed Attempts box
on the Entities (BC202000) form. The information about the error that occurred
during the synchronization is available for the synchronization record in the
Last Error column of the table on the Sync History form.
Deleted The record in the synchronization record has been deleted in Acumatica ERP, in
the external system, or in both systems.
Filtered The entity has been filtered as a result of applying a filter defined in the code or
on the Entities form.
Manual synchronization might be useful when you need to synchronize data during the initial configuration or
when data has not been synchronized for some reason and manual troubleshooting is needed.
To manually start the data preparation process, you perform the following general steps:
1. You open the Prepare Data (BC501000) form.
2. In the Selection area of the form, in the Store box, you select the online store with which you are
synchronizing data.
3. In the Prepare Mode box, you select one of the following options:
Integration with Shopify | 255
• Incremental: You select this mode to prepare for processing only the synchronization records that have
changed since the last successful data preparation.
• Full: You select this mode to prepare for processing all records of the selected entity, even if they have
been synchronized previously.
• Incremental by Date: You select this mode to prepare for processing only records that have been modified
during the specified date range and that have not yet been processed.
If you are starting the data preparation process for an entity for the first time, Full mode is used, regardless
of the mode selected in the Prepare Mode box.
4. In the table, you select the unlabeled check box in the rows of the needed entities, and on the form toolbar,
you click Prepare.
To manually start data processing, you perform the following general steps:
1. You open the Process Data (BC501500) form.
2. In the Selection area, in the Store box, you select the online store with which you are synchronizing data.
The table shows only the synchronization records that have not been synchronized yet (that is, the
synchronization records with the Prepared and Failed status).
3. In the Entity box, you select the entity for which you want to display synchronization records in the table.
If you want to process out-of-sync synchronization records for all entities, leave the box empty.
4. In the table, you select the unlabeled check box in the rows of the synchronization records that you need to
process.
5. On the form toolbar, you click Process to synchronize the selected synchronization records.
If you want to process all synchronization records in the table, you click Process All on the form toolbar.
For an example with step-by-step instructions on how to synchronize data manually, see Data Synchronization: To
Perform the First Synchronization.
The following activity will walk you through the process of manually exporting items from Acumatica ERP to the
Shopify store. You will also perform the instructions to place a test order online in the Shopify store and then
synchronize the order and the payment with Acumatica ERP. Finally, you will create a shipment for the order in
Acumatica ERP and synchronize the created shipment with the Shopify store.
Story
Suppose that you are an implementation consultant helping the SweetLife Fruits & Jams company to set up an
online store. You have completed the minimum initial configuration of the integration with Shopify and now want
to explore how synchronization works. You will configure synchronization for and then synchronize a subset of
stock items that are maintained in Acumatica ERP (stock items of the Jam item class) with the Shopify store, where
the term products describes what are called items in Acumatica ERP. You will then place a test order for one of the
synchronized products and explore how the online order is processed in the Shopify store and in Acumatica ERP.
Process Overview
In this activity, you will perform the following steps:
1. On the Stock Items (IN202500) form of Acumatica ERP, review the stock items that need to be exported to
the Shopify store.
2. On the Entities (BC202000) form, configure the filtering options for the Stock Item entity to include in the
synchronization only the stock items of the Jam item class.
Integration with Shopify | 256
3. On the Prepare Data (BC501000) form, start the data preparation for the Stock Item entity to prepare the
stock item data for export.
4. On the Sync History (BC301000) form, review the result of the data preparation process.
5. On the Process Data (BC501500) form, start data processing for the Stock Item entity to save the
synchronized product data in the Shopify store.
6. On the Sync History form, review the results of the data processing.
7. In the admin area of the Shopify store, review the products that have been imported from Acumatica ERP.
8. By using the admin area of the Shopify store, place an order for one of the products that have been
imported from Acumatica ERP.
9. On the Prepare Data form of Acumatica ERP, start the data preparation process for the Sales Order entity to
prepare the order data for import; on the Process Data form, process the prepared sales order data.
10.On the Sync History form, review the synchronization status of the imported order data.
11.On the Sales Orders (SO301000) form, review the details of the imported sales order.
12.On the Sales Orders form, create a shipment for the imported order.
13.On the Shipments (SO302000) form, confirm the shipment.
14.On the Prepare Data form, start the data preparation for the Shipment entity; on the Process Data form, start
data processing for the shipment.
15.In the admin area of the Shopify store, review the updated order details and the shipment exported from
Acumatica ERP.
System Preparation
Do the following:
1. Make sure that the following prerequisites have been met:
• The Shopify store has been created and configured, as described in Initial Configuration: To Set Up a
Shopify Store.
• The connection to the Shopify store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Configure the Store Connection.
2. Launch the Acumatica ERP website, and sign in as an administrator by using the following credentials:
• Username: gibbs
• Password: 123
3. Sign in to the admin area of the Shopify store as the store administrator in the same browser.
Filtering rules are not applied to data that has already been synchronized. For example, if
you synchronize the Stock Item entity without filters (which will result in exporting all stock
items to the online store), apply the filter described above, and prepare and process the Stock
Item entity again, all previously synchronized stock items that no longer match the filtering
conditions will remain synchronized.
You can click the link in the Ready to Process column to open the Process Data (BC501500)
form with the store and the entity selected; you can click the link in the Processed Records
column to open the Sync History (BC301000) form with the store and the entity selected and
the list of processed synchronization records (that is, records that have been successfully
synchronized and assigned the Processed status) displayed on the Drilldown filter tab.
Shopify assigns each order an order number, which by default is represented by the prefix # and a
numbering sequence. The order number is displayed at the top of the order page next to the order's
payment status and fulfillment status. If needed, you can change the format of the order number on
the General settings page in the Shopify admin area.
Each order is also assigned a numeric identifier, which you can see in the URL of the Shopify order
page. You can use this identifier to locate the necessary order on the Process Data (BC501500) form
and on the Sync History (BC301000) form (in the External ID column).
• Store: SweetStore - SP
• Entity: Leave empty
In the table of the Processed tab, notice that three synchronization records were created when the sales
order was processed:
• Sales Order: The sales order that you placed in the Shopify store. The ERP ID column displays the order
type (EO) and the order ID. The order type is based on the value selected in the Order Type for Import
box on the Order Settings tab of the Shopify Stores (BC201010) form.
• Customer: The customer that you created in the Shopify store when placing the order. The ERP ID
column displays the customer ID and the name of the customer. The customer ID was assigned to the
customer record based on the numbering sequence specified in the Customer Auto-Numbering box
on the Customer Settings tab of the Shopify Stores form. The customer name was imported from the
Shopify store.
• Payment: The payment used to pay the order in the Shopify store. The ERP ID column displays the
payment type (Prepayment) and the payment identifier.
The payment has been imported because the payment method you used to pay the order has been
mapped to an Acumatica ERP payment method and the mapping has been activated on the Payment
Settings tab of the Shopify Stores form.
For each of the entities created in the system during the synchronization, you can open the
appropriate form with the entity selected by clicking the link in the ERP ID column of the table.
• In the Description box, the store name, the order number and the payment status of the order are
displayed.
• The Customer and Location boxes display the information about the customer and customer location
that were created in Acumatica ERP during the import of the sales order; both were created during the
order placement in the Shopify store.
On the Details tab, review the only line in the table. Notice the following:
• Branch is set to RETAIL, which is the default branch configured to appear on sales orders imported from
the SweetStore - SP store on the Shopify Stores form.
• The inventory ID, quantity, unit price, and extended price of the item are exactly the same as the values
on the order in the Shopify store.
On the Payments tab, notice that a prepayment in the order amount has been applied to the sales order.
In this chapter, you will learn how to prepare entities in Acumatica ERP for synchronization—that is, how to
configure additional mapping of fields to be synchronized, set up filters, and add e-commerce-related information
to stock and non-stock items.
Acumatica ERP Retail-Commerce Edition provides flexible tools that you can use to prepare the data for
synchronization with your Shopify store and configure the synchronization settings.
Learning Objectives
In this chapter, you will learn the following:
• How to filter data that needs to be synchronized between Acumatica ERP and the Shopify store
• How to configure mapping of standard and custom fields that need to be synchronized
• How to update stock items and non-stock items with e-commerce-related data
Applicable Scenarios
You might want to configure additional mapping if you have defined custom fields in Acumatica ERP, in the Shopify
store, or in both systems, and you want these fields to be synchronized between the two systems. For example,
you might want to define an extra field on the customer registration form in the online store and map this field to a
user-defined field or an attribute in a customer record in Acumatica ERP.
Filtering is useful if you do not want to synchronize all data of a particular entity. For example, you might want to
define a subset of items in Acumatica ERP (which are referred to as products in Shopify) that you want to export to
the online store, or exclude from export the customers that have incomplete information in Acumatica ERP (that is,
the customers that have the On Hold status).
Integration with Shopify | 264
You might want to update e-commerce-related information about items in Acumatica ERP if you want to
override default inventory settings related to export that have been configured for the store on the Shopify Stores
(BC201010) form or if you want to maintain all product data, e-commerce-related or otherwise, in one system.
On these tabs, you can change the order of any row in the table by dragging it to its new position.
The display of the listed tabs is determined by the entity selected in the Summary area. The table below shows the
availability of filtering and mapping functionality for particular entities.
Entity in Acumatica Import Mapping Import Filtering Export Mapping Export Filtering
ERP
Customer Yes Yes Yes Yes
Entity in Acumatica Import Mapping Import Filtering Export Mapping Export Filtering
ERP
Stock Item No No Yes Yes
Product Image No No No No
Product Availability No No No No
Refund No No No No
For information about standard mapping of entities, see Retail-Commerce Edition Entity Reference. For details
about filtering and mapping for the export and import processes, see Preparing Entities for Synchronization: Filtering
and Preparing Entities for Synchronization: Field Mapping.
Before you export stock items and non-stock items to the online store, you might want to specify commerce-related
settings that are specific to a particular product or specify commerce-related information.
If the Commerce Integration feature is enabled on the Enable/Disable Features (CS100000) form, the eCommerce
tab appears on the Stock Items (IN202500) and Non-Stock Items (IN202000) forms. On this tab, you can specify the
settings that are applied to the items exported from Acumatica ERP to the Shopify store. The settings you specify
on this tab for a particular item override the default settings specified on the Shopify Stores (BC201010) form.
If the Matrix Items feature is enabled on the Enable/Disable Features form, the eCommerce tab is also
displayed on the Template Items (IN203000) form.
For each stock or non-stock item, on the eCommerce tab, you can define the following:
• The visibility of the product in the online store.
You define visibility by selecting the appropriate option in the Visibility box: Visible to make the product
visible on the storefront, Invisible to hide it from customers.
Shopify does not support featuring products, so the third option, Featured, will make the
product visible on the storefront (same as the Visible option).
• The availability assigned to the item when it is exported to the online store.
You define the availability of the item by selecting the needed option in the Availability box. You select
Store Default to apply the availability option selected in the store settings to be used by default for exported
products. To make the product available and not track its quantity, you select Set as Available (Don't Track
Qty.). If you want to make the product available for pre-order, you select Set as Pre-Order. To make the
product unavailable aer import, you select Set as Unavailable. For a stock item whose quantity you want to
track, you select Set as Available (Track Qty.).
Integration with Shopify | 266
For stock items whose availability is tracked (that is, for the items for which the Availability is set to Set as
Available (Track Qty.)), you can also specify what action should be performed if the item runs out of stock. To
do this, you select in the When Qty. Unavailable box one of the following options:
• Store Default: To apply the default value configured in the store settings
• Do Nothing: To not perform any action
• Set as Unavailable: To make the item unavailable for purchase in the online store
• The title of the product page.
You can specify the title of the product page in the Page Title box. Aer the product is imported to the
Shopify store, the text you have specified in this box is copied into the Page title box in the Search engine
listing preview section of the product management page. This text is used in the <title> tag in the HTML
code of the product page.
• Meta description.
You specify the meta description in the Meta Description box. Aer the product is imported to the Shopify
store, the meta description you have specified in this box will be displayed in the Description box in the
Search engine listing preview section of the product management page. The meta description is included
in the <meta> tag in the HTML code of the product page.
In this topic, you will learn how you can define export and import filtering settings.
Export Filtering
You can configure the rules according to which data from Acumatica ERP should or should not be exported to the
online store by using the Export Filtering tab of the Entities (BC202000) form.
To define a filter, you need to specify at least one filtering condition. Each condition includes the following
components:
• Field Name: The data field by which data needs to be filtered. The list of options you can select from
depends on the selected entity.
• Condition: The logical operation to apply to the value of the selected data field.
• Value: The value you enter for the logical condition used to filter the data, if the selected condition requires
a value.
• Value 2: The second value for the logical condition, if the selected logical condition requires a second value.
For example, the Is Between logical condition requires a second value.
A filter may contain multiple simple conditions or lines combined into one logical expression with brackets and
logical operators (And and Or).
Example
Suppose that you want to maintain customers of a particular customer class, INTL, only in Acumatica ERP, and
you want to exclude such customers from synchronization with the Shopify store. To do this, you select the
Customer entity in the Summary area of the Entities form, and on the Export Filtering tab, you specify the condition
corresponding to the settings shown in the following table.
The particular fields that you can select in the Field Name column depend on the selected entity.
If you change the export filter settings aer an export has been completed, the synchronization
records that have been previously processed and are no longer included in the filter, will remain
synchronized but will be assigned the Filtered status.
To avoid typing errors, you can copy the name of the needed field from the API Advanced list as
follows:
1. On the Export Mapping tab, in the Source Object column, select the <Entity> → Advanced
option.
2. In the Source Field / Value column, click the down arrow, and then select and copy the
needed field name.
In some situations, a custom field used in a filtering condition may become unavailable during
export, for example, if a customization project that added the field has been unpublished. In this
case, the system will treat the value in the condition that contains the missing field as null. To avoid
issues during the export, the Is Not Empty condition should be added to each filtering condition that
includes custom fields.
In some situations, an attribute used in a filtering condition may become unavailable during export,
for example, if an attribute has been removed from an item class or a customer class of an item or a
customer, respectively, being exported. In this case, the system will treat the value in the condition
that contains the missing field as null. To avoid issues during the export, the Is Not Empty condition
should be added to each filtering condition that includes attributes.
Import Filtering
You can configure the rules according to which data from the online store should or should not be imported into
Acumatica ERP by using the Import Filtering tab of the Entities (BC202000) form.
To define a filter, you need to specify at least one filtering condition. Each condition includes the following
components:
• Field Name: The data field by which data needs to be filtered. The list of options you can select from
depends on the selected entity.
Integration with Shopify | 268
• Condition: The logical operation to apply to the value of the selected data field.
• Value: The value you enter for the logical condition used to filter the data, if the selected condition requires
a value.
• Value 2: The second value for the logical condition, if the selected logical condition requires a second value.
For example, the Is Between logical condition requires a second value.
A filter may contain multiple simple conditions or lines combined into one logical expression with brackets and
logical operators (And and Or).
The particular fields that you can select in the Field Name column depend on the selected entity.
If you change the import filter settings aer an import has been completed, the synchronization
records that have been previously processed and are no longer included in the filter, will remain
synchronized but will be assigned the Filtered status.
In this topic, you will learn how you can map fields between Acumatica ERP and Shopify to override the standard
field mapping or define an additional mapping to suit your synchronization requirements.
• Target Field: A field related to the selected target object. The fields that are displayed in the list depend on
the selected object.
• Source Object: An object in the e-commerce system, which is a related set of fields, for the entity. The list of
objects available for selection depends on the entity selected in the Summary area.
• Source Field / Value: A field related to the selected source object. The fields that are displayed in the list
depend on the selected object. In this field, you can also define a particular value for the mapped field.
3. In the Source Object column, select the Order Data → Line Item option.
4. In the Source Field / Value column, select a field from the list of fields holding information about products
in Shopify orders.
Shopify customers can create custom fields in their stores to hold additional information about customers,
products, orders, blog posts, or even the store itself. Data from metafields can be used for internal purposes (for
example, for reporting and analysis) or added to the store's theme to customize the appearance of the storefront
to show more information to customers. For example, you might want to display additional information about a
product on a product page, to add information about a customer (which is or is not visible to the customer in their
store account), or to add an additional box to the checkout page to request information about the urgency of the
order fulfillment. For more information about metafields in Shopify, see the Shopify documentation.
Automating Synchronization
In this section, you will learn how to automate the synchronization of entities between Acumatica ERP and the
Shopify store by setting up automation schedules or by turning on real-time synchronization.
Aer you have performed the initial synchronization between Acumatica ERP and the Shopify store for the needed
entities, you might want to set up some of the entities to be synchronized in real time or at regular intervals. For
example, you can configure sales orders, payments, and shipments to be imported from the Shopify store into
Acumatica ERP as soon as each order is completed, whereas you can configure the export of customers from
Acumatica ERP to the Shopify store to be performed only once a month.
Learning Objectives
In this chapter, you will learn how to do the following:
• Set up automation schedules for data preparation and processing
• Turn on real-time synchronization of entities
• Configure automated synchronization for optimized performance
Integration with Shopify | 272
Applicable Scenarios
You automate the synchronization of entities aer you have configured and manually tested the synchronization
between Acumatica ERP and the Shopify store to ensure that in your production environment, all needed data is
exported and imported to the appropriate system in a timely manner.
Scheduled synchronization is the process in which each of the synchronization operations—that is, data
preparation and data processing—for an entity is executed by an automation schedule. Because data preparation
and data processing processes are independent of each other, they are scheduled separately and can be performed
in parallel.
Before a predefined schedule can be executed, you need to update it to meet your needs and then activate it. To
activate and modify a predefined schedule, you do the following:
1. You open the Automation Schedules form.
You can open this form by clicking Schedule > View or Schedule > View on the form toolbar
of the Prepare Data (BC501000) form and on the Process Data (BC501500) form.
The execution frequency of each predefined schedule has been specified according to the
general scheduling recommendations and should be fine-tuned to meet the needs of the
particular business.
3. You activate the schedule by selecting the Active check box in the Summary area.
4. You save your changes to the schedule.
Once the store has been specified in the filter settings and the schedule has been activated, the process for which
the schedule was defined will be automatically executed according to the schedule's settings.
For detailed instructions on activating a predefined automation schedule, see Automated Synchronization: To
Configure a New Automation Schedule.
Defining Automation Schedules for Data Preparation and Data Processing from Scratch
You might need to define an automation schedule from scratch for entities that do not need frequent
synchronization (for example, Customer). Acumatica ERP does not provide predefined automation schedules for
these entities.
You set up automation schedules for synchronizing specific entities between the two systems by using the
Automation Schedules (SM205020) form, which you can open directly or by clicking Schedule > Add on the form
toolbar of the Prepare Data (BC501000) and Process Data (BC501500) form.
To configure a schedule for data preparation, you do the following:
1. On the Prepare Data form, in the Summary area, you specify the Shopify store with which you are
configuring synchronization, as well as the data preparation mode.
2. In the table, you select the unlabeled check box for each entity that should be processed when the schedule
is executed.
Integration with Shopify | 274
To configure a schedule for processing synchronization records with the Pending and Failed statuses, you do the
following:
1. In the Summary area of the Process Data form, you specify the Shopify store for which you are configuring
synchronization and the entity that needs to be processed.
For detailed instructions on creating a schedule for preparing and processing data, see Automated Synchronization:
To Configure a New Automation Schedule.
With real-time synchronization, Acumatica ERP attempts to prepare data or prepare and process data as soon
as a change occurs in Acumatica ERP or in the e-commerce system. Depending on the entity involved and your
company's processes, real-time synchronization can involve import or export or can be bidirectional. (For some
entities, the direction of the synchronization is system-specified and cannot be changed.)
Real-time import relies on webhooks that Acumatica ERP receives from an e-commerce system, and real-time
export makes use of the push notification mechanism available in Acumatica ERP. For general information about
webhooks in Acumatica ERP, see Configuring Webhooks. For general information about push notifications, see
Configuring Push Notifications.
Real-Time Mode
Before you turn on real-time synchronization for an entity, you specify how changes to records of the entity should
be handled. To do so, in the Summary area of the Entities (BC202000) form, in the Real-Time Mode box, you select
one of the following options:
• Prepare: As soon as a push notification about a change to data is received, the corresponding
synchronization record is placed in the processing queue. The synchronization record appears on the
Sync History (BC301000) form, but the change is not recorded to the destination system unless the
synchronization record is processed manually or by an automation schedule.
• Prepare & Process: As soon as a push notification about a change to data is received, the corresponding
synchronization record is placed in the processing queue. At the same time, a background process will
immediately start processing synchronization records from that queue.
Integration with Shopify | 275
Depending on the volume of orders processed by your company, we recommend that you configure entities to be
synchronized automatically as indicated in the following tables.
The schedules in the following table are recommended for companies that process no more than 1,000 orders daily.
Stock Item, Non-Stock Started Daily, once a night Daily, once a night
Item, Template Item
Real-time mode: Prepare &
Process
We recommend that you not enable real-time synchronization if you plan to change configuration
settings or to perform mass-addition, mass-deletion, and mass-update operations, including by
means of import scenarios. We also recommend that you start real-time synchronization only aer
you begin production use to avoid unnecessary server traffic during the implementation.
The schedules in the following table are recommended for companies that process 1,000 or more online orders
daily.
Stock Item, Non-Stock Stopped Daily, once a night Daily, every 60 minutes
Item, Template Item
Integration with Shopify | 277
The following activity will walk you through the setup and activation of two predefined automation schedules that
start the data preparation and data processing for sales orders.
Story
Suppose that as an implementation consultant helping SweetLife to set up integration with Shopify, you want to
configure continuous synchronization of entities. As part of the setup, you need to configure the system to capture
new and changed sales orders in Shopify every 10 minutes and import these changes to Acumatica ERP.
Process Overview
In this activity, you will set up and activate the predefined automation schedule on the Automation Schedules
(SM205020) form to prepare sales order data. Then on the same form, you will set up and activate the predefined
automation schedule for processing the prepared sales order data.
System Preparation
Before you perform the instructions of this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The Shopify store has been created and configured, as described in Initial Configuration: To Set Up a
Shopify Store.
• The connection to the Shopify store has been established and the initial configuration has been
performed, as detailed in Initial Configuration: To Configure the Store Connection.
2. Sign in to an Acumatica ERP instance with the U100 dataset preloaded. You should sign in by using the
following credentials:
• Username: gibbs
• Password: 123
3. Sign in to the admin area of the Shopify store as the store administrator in the same browser.
On the Details tab, notice that the schedule does not have an expiration date or execution limit (that is,
the No Expiration Date and No Execution Limit check boxes are selected). On the Schedule tab, the Daily
schedule type is selected, and in the Execution Time section, Every is set to 00:10.
3. On the Schedule Details tab, in the Next Execution Date box, make sure the current date (that is, today's
date) is specified.
4. On the Filter Values tab, add a row to the table, and in the added row, specify the following settings:
• Active: Selected
• Field Name: Store
• Value: SweetStore - SP
With these settings, the data preparation process will be started for the SweetStore - SP store.
5. In the Summary area, select the Active check box to activate the automation schedule.
6. On the form toolbar, click Save.
Now when the schedule is executed, which will happen every 10 minutes until you deactivate or delete
the schedule, any changes that have occurred in sales orders in SweetStore - SP since the previous data
preparation, will be pulled to Acumatica ERP and placed in the processing queue. In the next step, you will
set up an automation schedule that will start data processing for the prepared sales order data.
We recommend that you test the configured schedules by creating a new sales order or updating an
existing one in the SweetStore - SP store, waiting for 20 minutes to give the schedules enough time to
be executed, and then reviewing the corresponding sales order in Acumatica ERP. If for some reason
the changes have not been synchronized, review the corresponding synchronization record on the
Sync History (BC301000) form.
Integration with Shopify | 279
The following activity will walk you through the process of creating an automation schedule from scratch. To gain
greater familiarity with the process, you will create two automation schedules: one that starts data preparation,
and one that starts data processing for the customer data.
Story
Suppose that as an implementation consultant helping SweetLife to set up integration with Shopify, you want
to configure continuous synchronization of entities. As part of the setup, you need to configure the system to
synchronize new and updated customers between Acumatica ERP and the Shopify store once a day (at night).
Because Acumatica ERP does not provide any predefined automation schedules for the Customer entity, you need
to create two automation schedules from scratch. The first schedule will prepare the customer data for processing,
and the second schedule will start the processing of the prepared data.
Process Overview
You will do the following:
1. On the Prepare Data (BC501000) form, define the conditions for preparing the data of the Customer entity.
2. On the Automation Schedules (SM205020) form, create an automation schedule to start data preparation for
the Customer entity once a day.
3. On the Process Data (BC501500) form, define the conditions for processing the data of the Customer entity.
4. On the Automation Schedules form, create an automation schedule to start the data processing for the
Customer entity once a day.
System Preparation
Before you perform the instructions of this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The Shopify store has been created and configured, as described in Initial Configuration: To Set Up a
Shopify Store.
• The connection to the Shopify store has been established and the initial configuration has been
performed, as detailed in Initial Configuration: To Configure the Store Connection.
2. Sign in to an Acumatica ERP instance with the U100 dataset preloaded. You should sign in by using the
following credentials:
• Username: gibbs
• Password: 123
3. Sign in to the admin area of the Shopify store as the store administrator in the same browser.
On the Filter Values tab, the system has added the settings summarized in the following table, which
correspond to the selections you have made on the Prepare Data form earlier in this step.
6. On the Details tab, specify the additional settings of the schedule as follows:
• In the Starts On box, leave the default value, which is the current business date.
• Select the No Execution Limit check box.
7. On the Schedule tab, specify the execution dates and times as follows:
• In the Schedule Type section, select the Daily option button.
• In the Execution Time section, in the Starts On box, select 11:30 PM.
With these settings, the schedule execution will be started every day at 11:30 PM.
8. On the form toolbar, click Save & Close to save the changes to the automation schedule.
In the Summary area, the system has inserted Process Data in the Screen ID box and Process All in the
Action Name box.
Also, on the Filter Values tab, the system has added the settings summarized in the following table, which
correspond to the selections you have made on the Process Data form earlier in this step.
5. On the Details tab, specify the additional settings of the schedule as follows:
• In the Starts On box, leave the default value, which is the current business date.
• Select the No Execution Limit check box.
6. On the Schedule tab, specify the execution dates and times as follows:
• In the Schedule Type section, select the Daily option button.
• In the Execution Time section, in the Starts On box, select 12:30 AM.
With these settings, the schedule execution will be started every day at 12:30 AM.
7. On the form toolbar, click Save & Close to save your changes to the automation schedule.
You have configured two automation schedules for the Customer entity. Now the first automation schedule
will start the data preparation process every night at 11:30 PM to retrieve the changed customer data if any
changes have occurred in Acumatica ERP, in the SweetStore - SP store, or in both systems (depending on the
synchronization direction set for the Customer entity) since the previous data preparation, and will place it in
the processing queue. The second schedule will start the data processing for the Customer entity to process the
synchronization records that are out of sync. During data processing, the system will also attempt to synchronize
the customer synchronization records that could not be processed before (that is, the synchronization records that
have the Failed status).
In this activity, you will learn how to turn on real-time synchronization for an entity.
Story
Suppose that as an implementation consultant helping SweetLife to set up integration with Shopify, you want to
configure continuous synchronization of particular entities. As part of the setup, you need to turn on real-time
synchronization of shipments so that they are exported to the Shopify store as soon as they are created or updated
in Acumatica ERP.
Process Overview
In this activity, you will turn on real-time synchronization for the Shipment entity on the Entities (BC202000) form so
that the system immediately exports the changes in shipments to the Shopify store.
System Preparation
Before you perform the instructions of this activity, do the following:
1. Make sure that the following prerequisites have been met:
Integration with Shopify | 282
• The Shopify store has been created and configured, as described in Initial Configuration: To Set Up a
Shopify Store.
• The connection to the Shopify store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Configure the Store Connection.
2. Sign in to an Acumatica ERP instance with the U100 dataset preloaded. You should sign in by using the
following credentials:
• Username: gibbs
• Password: 123
3. Sign in to the admin area of the Shopify store as the store administrator in the same browser.
We recommend that you test the configuration by creating a new shipment for a sales order imported
from the SweetStore - SP store to Acumatica ERP, and then reviewing the corresponding shipment
in the SweetStore - SP store. If for some reason the changes have not been synchronized, review the
corresponding synchronization record on the Sync History (BC301000) form.
Acumatica ERP provides a set of predefined business events that can be activated to trigger the sending of an
email notification to the administrator of an online store about aborted synchronization records. Each of the
predefined business events is defined for one of the following entities: Sales Order, Payment, Shipment, or Refund.
The notification is sent when the commerce connector fails to process a synchronization record related to the
entity if the maximum allowed number of failed attempts has been exceeded. The administrator specifies the
maximum allowed number of failed attempts for each entity on the Entities (BC202000) form or on the Shopify
Stores (BC201010) form.
To cause any of the predefined business events to start triggering email notifications about aborted
synchronization records of the entity whose synchronization records are monitored by the business event, you
need to perform the following general steps:
• On the Connection Settings tab of the Shopify Stores form, specify the administrator of the store in the
Administrator box.
Integration with Shopify | 283
• On the Business Events (SM302050) form, activate the needed business event by selecting the Active check
box in the Selection area for the event.
Once the business event has been activated and the administrator of the store has been specified, the system will
automatically start sending the store administrator email notifications each time a synchronization record of the
corresponding entity is aborted.
The following table lists the predefined business events that you can activate on the Business Events form, the
description of the business event, the underlying generic inquiry (that is, the inquiry that defines the data the
system should monitor, which is aborted synchronization records of the entity, to detect whether this business
event has occurred), and the notification template that has been specified as a subscriber to the business event.
For information about email notifications that are triggered by business events, see Business Events: Email
Notifications.
The following activity will walk you through the process of configuring a business event that sends an email
notification to the store administrator when the synchronization of an order placed in the e-commerce system is
aborted.
Story
Suppose that you have configured the automated import of sales orders from the e-commerce store and want
Jerald Stevens, an e-commerce manager of SweetLife, to be notified when the system has failed to process a
synchronization record of a sales order too many times (based on the setting specified in the system) and has
set its status to Aborted, which excludes the record from synchronization. To receive a notification every time the
synchronization of a sales order is aborted, you need to activate a predefined business event that will trigger the
sending of an email message to the store administrator every time the status of a synchronization record of a sales
order changes to Aborted.
Configuration Overview
In the U100 dataset, the following tasks have been performed for the purposes of this activity:
Integration with Shopify | 284
• On the Email Templates (SM204003) form, the Aborted Synchronization Record notification template has
been defined.
• On the Users (SM201010) form, the stevens user record has been created.
Process Overview
You will do the following:
1. On the Shopify Stores (BC201010) form, specify the store administrator who should receive email
notifications about aborted synchronization records.
2. On the Business Events (SM302050) form, activate the predefined business event that will trigger the
sending of an email when the system fails to process a sales order synchronization record more than the
maximum number of synchronization attempts allowed.
3. On the Email Templates (SM204003) form, review the notification template that is used for notifications
about aborted sales orders.
System Preparation
Before you perform the instructions of this activity, do the following:
1. Make sure that the following prerequisites have been met:
a. The Shopify store has been created and configured, as described in Initial Configuration: To Set Up a
Shopify Store.
b. The connection to the Shopify store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Configure the Store Connection.
2. Sign in to an Acumatica ERP instance with the U100 dataset preloaded. You should sign in by using the
following credentials:
• Username: gibbs
• Password: 123
3. Sign in to the admin area of the Shopify store as the store administrator in the same browser.
In the Summary area, notice that the Screen Name is set to BC-DB-AbortedOrders, which is the generic
inquiry that collects aborted synchronization records of the Sales Order entity for all stores in Acumatica
ERP for which the administrator has been specified.
Also in this area, notice that Raise Event is set to For Each Record; on the Trigger Condition tab, notice that
the operation of the only condition in the table is Record Inserted. With these settings, a business event will
be raised for each synchronization record that is added to the results of the generic inquiry.
On the Subscribers tab, the only subscriber to this business event is Email Notification (the Type column),
which indicates that an email is sent whenever the business event is raised. In the Subscriber ID column,
which holds the ID of the notification template for an email notification, Aborted Order Notification is
selected. In the next step, you will review the template used for the email notifications.
3. In the Summary area, select the Active check box.
4. On the form toolbar, click Save.
You have activated the business event that will trigger sending Jerald Stevens an email notification every time a
synchronization record of the Sales Order entity is assigned the Aborted status.
In this activity, you have activated the predefined business event that will trigger the sending of an email to the
store administrator about aborted synchronization of sales orders.
Synchronizing Customers
In the topics of this chapter, you will read about customer synchronization between Acumatica ERP and the Shopify
store.
In Acumatica ERP Retail-Commerce Edition, you can synchronize customer records between Acumatica ERP and
the Shopify store.
Learning Objectives
In this chapter, you will learn how to do the following:
• Set up the synchronization of customers and customer locations (addresses) so that they can be both
exported to the Shopify store and imported from the Shopify store to Acumatica ERP.
Integration with Shopify | 286
Applicable Scenarios
You configure the import of customers if you want to synchronize changes to customer information made in the
Shopify store to Acumatica ERP.
You configure the export of customers from Acumatica ERP to the Shopify store if you maintain records of
customers in Acumatica ERP and want the details of these customers to be available in the Shopify store so that
the up-to-date customer information, such as customer billing and address details, is available when registered
customers place orders online.
The synchronization of customers is a prerequisite for the synchronization of orders. When an order placed in the
Shopify store is imported to Acumatica ERP, information about the customer that placed the order is imported to
Acumatica ERP during the synchronization of the order.
For more information about segmented keys and numbering sequences, see Managing Segmented Keys.
• Generic Guest Customer (optional): The generic customer account that appears on imported sales orders
that were placed in the Shopify store as guest orders. This customer account is not exported to the Shopify
store during the synchronization of customers. For more information about creating a customer, see
Customers: General Information.
If the Customer entity is activated and the Customer Location entity is not activated on the Shopify Stores form,
when the Customer entity is synchronized between the Shopify store and Acumatica ERP, the customer location
(address) data is not copied from one system to the other.
When a sales order created in the Shopify store is imported, the address information (that is, the billing address
and shipping address) specified in the order is imported to Acumatica ERP as part of sales order data; however,
new locations are not created and existing locations are not updated with the imported data.
When the Customer entity is synchronized between the Shopify store and Acumatica ERP, customer location
(address) data is copied from one system to the other along with the customer data. The remaining sections of
this topic describe what happens during the synchronization if a customer was created without an address or if an
address was created, updated, or deleted in either system.
The following activity will walk you through the process of setting up the bidirectional synchronization of
customers and performing the synchronization of customers between Acumatica ERP and the Shopify store.
Story
Suppose that the SweetLife Fruits & Jams company has multiple corporate customers from the United States and
Canada in the system. The company management wants customer records for US customers to be exported from
Acumatica ERP to the Shopify store. At the same time, new customers that place orders in the Shopify store should
be imported to Acumatica ERP.
Because an email address is a key field for a customer in Shopify, customers that do not have it specified in
Acumatica ERP will not be saved in the Shopify store during the export.
Acting as an implementation consultant helping SweetLife to set up the integration of Acumatica ERP with the
SweetLife store, you need to configure the bidirectional synchronization of customers, and configure the filtering
conditions to export only records for US customers that have an email specified.
Configuration Overview
In the U100 dataset, the following tasks have been performed for the purposes of this activity:
Integration with Shopify | 292
• On the Customer Classes (AR201000) form, the COMMERCEBB and ECCUSTOMER customer classes have been
configured. The COMMERCEBB customer class is assigned to local (US) customers that need to be exported
to the external system.
• On the Customers (AR303000) form, the following customer records have been created and assigned the
COMMERCEBB customer class:
• FRUITICO: On the General tab, notice that no details have been specified in the boxes of the Primary
Contact section. In the Additional Account Info section, the account's email address and phone number
have been specified.
• JAMIFIQUE: On the General tab, notice that in the Primary Contact section, the name of the contact
(Colleen Plunkett) has been filled in. In the Additional Account Info section, the account's email address
and phone number have been specified.
• On the Numbering Sequences (CS201010) form, the ECCUSTOMER numbering sequence has been defined.
Process Overview
In this activity, you will perform the following steps:
1. On the Shopify Stores (BC201010) form, review the settings of the Customer entity.
2. On the Entities (BC202000) form, configure the filtering condition for the export of customers from
Acumatica ERP to the Shopify store.
3. On the Customers (AR303000) form, review some of the customers that need to be exported.
4. On the Prepare Data (BC501000) form, start the data preparation process for the Customer entity to prepare
out-of-sync data for export.
5. On the Process Data (BC501500) form, start data processing for the Customer entity to save the
synchronized customer data in the Shopify store.
6. On the Sync History (BC301000) form, review the synchronization status of the processed synchronization
records.
7. In the Shopify store, review the customers that have been imported from Acumatica ERP.
System Preparation
Before you complete the instructions in this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The Shopify store has been created and configured, as described in Initial Configuration: To Set Up a
Shopify Store.
• The connection to the Shopify store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Configure the Store Connection.
2. Launch the Acumatica ERP website with the U100 data preloaded, and sign in by using the following
credentials:
• Username: gibbs
• Password: 123
3. Sign in to the admin area of the Shopify store as the store administrator in the same browser.
System Preparation
Before you complete the instructions in this activity, do the following:
1. Open the Shopify Stores (BC201010) form.
2. In the Store Name box, select SweetStore - SP.
Integration with Shopify | 293
3. On the Entity Settings tab, in the row with the Customer entity, make sure Sync Direction is set to
Bidirectional and Primary System is set to External System.
4. On the form toolbar, click Save to save your changes.
Now when you prepare the Customer entity for synchronization and process the prepared customer data,
only the customers that have the COMMERCEBB customer class and an email address specified will be
exported to the SweetStore - SP store.
The following activity will walk you through the process of setting up the synchronization of customer locations
and performing the synchronization of customers with locations between Acumatica ERP and the Shopify store.
Story
Suppose that the SweetLife Fruits & Jams company works with corporate customers that order items to be
delivered to multiple locations. The company keeps track of customer addresses in the Shopify store and wants
these addresses to be in sync with customer locations in Acumatica ERP.
Acting as an implementation consultant helping SweetLife to set up the integration of Acumatica ERP with the
Shopify store, you need to configure the synchronization of customer locations between the two systems, as well as
test it and explore how the synchronization works in both systems.
Integration with Shopify | 296
Configuration Overview
In the U100 dataset, the following tasks have been performed for the purposes of this activity:
• On the Enable/Disable Features (CS100000) form, the Business Account Locations feature has been enabled.
• On the Customer Classes (AR201000) form, the DEFAULT and ECCUSTOMER customer classes have been
configured.
• On the Customers (AR303000) form, multiple customer records assigned to the DEFAULT customer class have
been created.
• On the Numbering Sequences (CS201010) form, the ECCUSTOMER and ECLOCATION numbering sequences
have been defined.
Process Overview
In this activity, you will do the following:
1. On the Shopify Stores (BC201010) form, update the settings of the Customer and Customer Locations entities.
2. In the admin area of the Shopify store, create a new customer with two addresses.
3. On the Prepare Data (BC501000) form, prepare the customer and customer address data for
synchronization.
4. On the Process Data (BC501500) form, process the customer and customer address data prepared for
synchronization.
5. On the Customers (AR303000) form, review the imported customer data.
6. On the Customer Locations (AR303020) form, review the imported customer address data and update one of
the customer locations.
7. By using the Sync History (BC301000) form, synchronize the updated customer location with the Shopify
store.
8. In the admin area of the Shopify store, review the updated customer address.
System Preparation
Before you perform the instructions in this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The Shopify store has been created and configured, as described in Initial Configuration: To Set Up a
Shopify Store.
• The connection to the Shopify store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Configure the Store Connection.
2. Launch the Acumatica ERP website with the U100 dataset preloaded, and sign in with the following
credentials:
• Username: gibbs
• Password: 123
3. Sign in to the admin area of the Shopify store as the store administrator in the same browser.
Step 1: Configuring the Synchronization Settings of the Customer and Customer Location Entities
To review the synchronization settings of the Customer and Customer Locations entities, do the following:
1. Open the Shopify Stores (BC201010) form.
Integration with Shopify | 297
2. In the Store Name box of the Summary area, select SweetStore - SP.
3. On the Entity Settings tab, do the following:
a. Make sure that the Active check box is selected in the rows of the Customer and Customer Location
entities.
b. In the row of the Customer entity, make sure that Sync Direction is set to Bidirectional.
Notice that the settings of the Customer Location entity are the same as those of the Customer entity and
cannot be edited.
4. On the Customer Settings tab, make sure that the following settings have been specified:
• Customer Class: ECCUSTOMER
When a new customer is imported from the Shopify store to Acumatica ERP, its default settings are
defined based on the customer class selected in this box.
• Customer Auto-Numbering: ECCUSTOMER
Each new customer imported from the Shopify store will be assigned an identifier based on the
numbering sequence selected in this box.
• Location Auto-Numbering: ECLOCATION
Each new customer location imported from the Shopify store will be assigned an identifier based on the
numbering sequence selected in this box.
5. On the form toolbar, click Save to save your changes.
Step 4: Preparing the Customer and Customer Location Data for Synchronization
To prepare the customer and customer location data for synchronization, in Acumatica ERP, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - SP
• Prepare Mode: Incremental
This setting controls which data will be loaded. Incremental indicates that only the customer records that
match the filtering conditions and have been modified since the previous processing of the data have been
prepared for synchronization.
3. In the table, select the Selected check box in the row of the Customer entity, and on the form toolbar, click
Prepare.
Because customer locations are synchronized along with customers during the synchronization of the
Customer entity, the Customer Location entity is not listed in the table and cannot be prepared separately.
4. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box and return to the Prepare Data form.
Notice that the Prepared Records column shows the number of synchronization records that have been
prepared and are ready to be processed.
Integration with Shopify | 299
Notice that the Company value from the address in Shopify has been imported as the Location Name of the
Location Info section and the Account Name box of the Additional Location Info section.
The address lines, city, state, country, and postal code have been imported to the appropriate boxes of the
Location Address section.
The first and last name of the address in Shopify have been imported to the Attention box of the Additional
Location Info section.
When you change a location of a customer, the e-commerce connector recognizes the
customer record as having been modified as well. So in this step, you could have selected the
synchronization record for the Isabelle Bober customer and clicked Sync, and the updated
customer location would have been synchronized as part of the customer synchronization
process. Alternatively, you could have prepared the Customer entity for synchronization on the
Prepare Data (BC501000) form and then processed the prepared synchronization records on
the Process Data (BC501500) form.
Synchronizing Products
In the topics of this chapter, you will read about product synchronization between Acumatica ERP and the Shopify
store.
Acumatica ERP Retail-Commerce Edition provides you with the ability to export product data (that is, data of stock
and non-stock items) from Acumatica ERP to the Shopify store.
Learning Objectives
In this chapter, you will learn how to export stock and non-stock items to the Shopify store.
Applicable Scenarios
You export items from Acumatica ERP to the Shopify store in the following cases:
• When you are initially configuring the Shopify store and need to transfer stock and non-stock items that
have already been defined in Acumatica ERP
• If you have updated any of the item settings in Acumatica ERP aer the item was synchronized with the
Shopify store so that the changes are reflected in the product settings in the store
When you set up a connection to a Shopify store on the Shopify Stores (BC201010) form, you specify the availability
and visibility settings that are applied by default to all items synchronized with the Shopify store.
The Default Availability setting applies if the Availability setting for a particular item is set to Store
Default on the Non-Stock Items (IN202000) or Stock Items (IN202500) form.
If you select the Set as Available (Track Qty.) option in the Default Availability box, you need to also specify what
action the system should perform with out-of-stock items (that is, with stock items whose quantities become zero).
To do so, in the When Qty. Unavailable box, you select one of the following options:
• Do Nothing: The system does not change the availability settings of the item.
• Set as Unavailable: The system makes the item unavailable for purchase via the storefront. In Shopify, on
the product management page for each of these items, the Track quantity check box (in the Inventory
section) becomes cleared and the Online Store sales channel below the product status disappears.
• Set as Continue Selling: The system selects the Continue selling when out of stock check box for the item in
the Shopify store.
Integration with Shopify | 303
If you have synchronized the Product Availability entity, when you modify any of the settings described in this
section, the system resets the availability synchronization status for all synchronized items in the Shopify store, and
you need to perform the synchronization of the Product Availability entity again.
By default, the availability and visibility settings defined for the store on the Shopify Stores (BC201010) form are
applied to all stock and non-stock items exported to the Shopify store. However, you can override the default
values for a particular item, as described in the sections below.
Because the tracking of quantities is not applicable to non-stock items, if Default Availability in the store
settings is set to Set as Available (Track Qty.) and Availability of a non-stock item is set to Store Default,
aer the non-stock item is exported to the Shopify store, it is available for purchase but its quantity is not
tracked.
Additionally, for a stock item, if the Set as Available (Track Qty.) option is selected in the Availability box on the
eCommerce tab, you need to specify the action that the system should perform if aer the synchronization of the
Product Availability entity, the item has an available quantity of zero. The available options include all options
of the When Qty. Unavailable box on the Inventory Settings tab of the Shopify Stores form, as well as the Store
Default option, which (if selected) indicates that the setting specified in the box of the same name on the Shopify
Stores form should be applied.
Acumatica ERP Retail-Commerce Edition provides you with the ability to export product images from Acumatica
ERP to the Shopify store.
Learning Objectives
In this chapter, you will learn how to export product images from Acumatica ERP to the Shopify store.
Applicable Scenarios
You export product images from Acumatica ERP to your Shopify store in the following cases:
• You maintain product information in Acumatica ERP, export this information to the Shopify store, and use
Acumatica ERP to store images of exported stock and non-stock items.
• You maintain product information in Acumatica ERP, export this information to the Shopify store, store
images of exported stock and non-stock items in an external storage but keep links to the image files in
Acumatica ERP.
The following activity will walk you through the process of synchronizing product images between Acumatica ERP
and the Shopify store.
Story
Suppose that the SweetLife Fruits & Jams company wants to store some images of the products it sells in the online
store in an external storage. Some of the images, however, are attached to items in the Acumatica ERP instance.
Acting as an implementation consultant helping SweetLife to set up the integration of Acumatica ERP with the
Shopify store, you want to test how images stored in Acumatica ERP are exported to the Shopify store.
Configuration Overview
In the U100 dataset, for the purposes of this activity, on the Stock Items (IN202500) form, the APJAM08 stock item of
the JAM item class been created.
Process Overview
In this activity, you will do the following:
1. On the Stock Items (IN202500) form, add images to the APJAM08 stock item.
2. On the Prepare Data (BC501000) form, prepare the stock item data for synchronization.
3. On the Process Data (BC501500) form, process the stock item data prepared for synchronization.
4. In the admin area of the Shopify store, review the exported stock item.
5. On the Shopify Stores (BC201010) form, activate the Product Image entity.
6. On the Prepare Data form, prepare the product image data for synchronization.
7. On the Process Data form, process the product image data prepared for synchronization.
8. In the admin area of the Shopify store, review the exported images.
System Preparation
Before you complete the instructions in this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The Shopify store has been created and configured, as described in Initial Configuration: To Set Up a
Shopify Store.
• The connection to the Shopify store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Configure the Store Connection.
2. Download the AppleJam1.png and AppleJam2.png files to your device.
3. Launch the Acumatica ERP website with the U100 dataset preloaded, and sign in with the following
credentials:
• Username: gibbs
• Password: 123
4. Sign in to the admin area of the Shopify store as the store administrator in the same browser.
5. Open the Shopify Stores (BC201010) form.
Integration with Shopify | 306
6. In the Store Name box of the Summary area, select SweetStore - SP.
7. On the Entity Settings tab, select the Active check box in the row of the Product Image entity.
8. On the form toolbar, click Save.
URL Type
http://acumatica-builds.s3.amazonaws.com/builds/Universi- Image
ty/CommerceTraining/AppleJam3.png
2. Select the unlabeled check box in the row with the Apple jam 8 oz. item, and on the form toolbar, click
Process.
3. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
Note that images are synchronized only for stock and non-stock items that have been
synchronized with the Shopify store. If an item has not been synchronized, images added to it
will not be exported during the synchronization of the Product Image entity.
3. In the table, select the unlabeled check box in the row of the Product Image entity, and on the form toolbar,
click Prepare.
4. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box and return to the Prepare Data form.
Notice that the Prepared Records column shows the number of synchronization records that have been
prepared and are ready to be processed.
The ERP ID column displays the item type (stock item) and identifier (APJAM08) followed by
the backslash and then the name of the image file. You can click the link in this column to open
the image on the File Maintenance (SM202510) form.
2. On the form toolbar, click Process All to process both synchronization records displayed in the table.
3. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
4. In the first row of the table, click the link in the External ID column to review the item in the Shopify store.
The product management page opens for the Apple jam 8 oz. product.
Notice that the Media section now contains three images. One was added as an external link in the
Media URLs table on the eCommerce tab of the Stock Items (IN202500) form, and exported as part of the
synchronization of the Stock Item entity. The other two were uploaded on the Attributes tab of the Stock
Items form, and exported as part of the synchronization of the Product Image entity. The main product
image (which is the image that appears larger than other thumbnails) is the image that is visible in the
Image area of the Attributes tab.
5. In the upper right, click Preview, and review how the imported images are displayed on the product page
on the storefront.
6. At the top of the page, click Catalog, locate the Apple jam 8 oz. product, and review how the main product
image is displayed on the product listing page.
The display of images may differ depending on the theme applied to the store.
Integration with Shopify | 309
The topics of this chapter explain the availability settings of stock items and non-stock items that are exported to
the Shopify store.
Acumatica ERP Retail-Commerce Edition provides you with the ability to track the availability of stock items that
you sell via the Shopify store and maintain in Acumatica ERP. You have the flexibility to configure which quantities
of a stock item should be included in calculations of the quantity available for sale in the online store.
Learning Objectives
In this chapter, you will learn how to do the following:
• Define how the available quantities of items exported to the Shopify store should be calculated
• Set up quantity tracking for stock items exported to the Shopify store
• Synchronize the available quantities of exported stock items for which quantity tracking is turned on
Applicable Scenarios
You track available quantities of stock items exported to the Shopify store if you want to make these items available
for purchase by shoppers through the storefront only if there is a sufficient quantity in stock.
• To make the item unavailable for purchase via the storefront, select Set as Unavailable in the When Qty.
Unavailable box. In Shopify, on the product management page for each of these items, the Track quantity
check box (in the Inventory section) will become cleared and the Online Store sales channel below the
product status will disappear.
• To make the item unavailable for purchase via the storefront but available for pre-order, select Set as Pre-
Order/Continue Selling in the When Qty. Unavailable box. The system will select the Continue selling when
out of stock check box for the item in the Shopify store.
• To keep the current purchasability settings of the item, select Do Nothing.
For stock items whose quantities are tracked and have been synchronized with the Shopify store, during the
synchronization of the Stock Item entity, the system also checks if the item is in stock (See the Synchronization
of Available Quantities section below). If the item has no available quantity (that is, its calculated quantity is less
than or equal to zero), the system also updates the item's purchasability settings according to the When Qty.
Unavailable setting specified on the eCommerce tab of the Stock Items form.
To avoid discrepancies in sales orders imported into Acumatica ERP, we recommend that before
changing an item's sales UOM you make sure that there are no unsynchronized sales orders that
contain the item. Also, you should synchronize the item's available quantity immediately aer
changing its sales UOM so that new orders for the item are created in the Shopify store with the
updated UOM.
Integration with Shopify | 311
During the configuration of Acumatica ERP Retail-Commerce Edition, you can specify which item quantity in
Acumatica ERP you want to be synchronized with the Shopify store for the items whose quantities are tracked. To
do so, you select one of the following options in the Availability Mode box:
• On Hand: The system synchronizes the on-hand quantity stored at particular warehouses or warehouse
locations.
• Available for Shipping: The system synchronizes the quantity available for shipping, which is calculated as
the quantity on hand minus the quantities shipped, minus the quantities allocated for sales, production,
and service orders, minus the quantities in locations for which the Include in Qty. Available check box is
cleared on the Locations tab of the Warehouses (IN204000) form, minus the quantities on issues that have
not been released yet.
• Available: The system synchronizes the available quantity. You can configure the way the available quantity
is calculated by using an availability calculation rule. For more information, see Configuration of Availability
Calculation Rules: General Information.
You also select whether quantity calculations should include available quantities from all warehouses or from only
the specified warehouses or warehouse locations. To do so, in the Warehouse Mode box on the Inventory Settings
tab of the Shopify Stores (BC201010) form, you select one of the following options:
• All Warehouses: To calculate the available quantity of the item in the Shopify store based on the quantity
of the item in all warehouses. If All Warehouses warehouse mode is selected and multiple locations exist in
the Shopify store, the available quantities of items are synchronized with the first location created in the
Shopify store.
• Specific Warehouses: To calculate the available quantity of the item based on the quantity in the selected
warehouses and warehouse locations.
When you select this option, the Warehouse Mapping for Inventory Export table appears below the
Warehouse Mode box. In this table, you specify a list of warehouses and warehouse locations to be used the
calculation of item availability. If multiple warehouse locations have been created in the Shopify store, you
can specify which Shopify location should be updated with the availability data from a particular warehouse
or warehouse location from Acumatica ERP.
The Warehouse Mapping for Inventory Export table contains the following columns:
• Warehouse (required): A warehouse from Acumatica ERP that holds inventory items whose availability
data should be exported to the Shopify store. You can select a warehouse from the list of all active
warehouses that have been created on the Warehouses (IN204000) form.
• Location ID (optional): A warehouse location from Acumatica ERP that contains inventory items whose
availability data should be exported to the Shopify store. You can select a warehouse location from
the list, which contains the active locations that have been created on the Warehouses form for the
warehouse selected in the Warehouse column of the row. If no location is selected, the system exports
the availability data for items stored in all locations of the selected warehouse.
• Shopify Location (required): The Shopify warehouse location to which the system will export availability
data for inventory items from Acumatica ERP. You select a location from the list, which contains all the
warehouse locations created in the Shopify store.
If Specific Warehouses warehouse mode is selected and no values are specified in the Warehouse Mapping
for Inventory Export table, the system will behave as it would if the All Warehouses mode was selected.
Integration with Shopify | 312
Multiple warehouses and warehouse locations require that the following features be enabled on the
Enable/Disable Features (CS100000) form:
• The Multiple Warehouses feature, which provides the functionality of working with multiple
warehouses (including virtual warehouses)
• The Multiple Warehouse Locations feature, which supports multiple locations for each
warehouse
If you have synchronized the Product Availability entity, when you modify any of the settings described in this
section, the system resets the availability synchronization status for all synchronized items in the Shopify store, and
you need to perform the full synchronization of the Product Availability entity again.
In this activity, you will specify the default availability settings for the Shopify store, specify item-specific
availability settings for particular stock items, export product availability data to the Shopify store, and review the
results of the export.
Story
Suppose that the SweetLife Fruits & Jams company sells several kinds of jams in its online store. By default, items
should be available for purchase in the store only if they are in stock. Some of the jams, however, need to be
available for purchase all the time, regardless of their stock levels. The jams can be ordered in the online store as
follows:
• Banana jams (BANJAM96 and BANJAM08) should be available for purchase only if there is enough stock.
• Plum jams (PLUMJAM96 and PLUMJAM08) should be available for purchase regardless of the available
quantity.
Acting as an implementation consultant helping SweetLife to set up the integration of Acumatica ERP with the
Shopify store, you need to configure the system so that the items' availability will be tracked according to the
business needs..
Configuration Overview
In the U100 dataset, the following tasks have been performed for the purposes of this activity:
• For the purposes of this activity, the following features have been enabled on the Enable/Disable Features
(CS100000) form:
• Multiple Warehouses, which provides the functionality of working with several warehouses (including
virtual warehouses)
• Multiple Warehouse Locations, which supports multiple locations for each warehouse
• On the Warehouses (IN204000) form, the RETAIL warehouse and the JS1 warehouse location have been
configured.
• On the Stock Items (IN202500) form, the stock items have been created in the system and assigned the
availability settings as listed in the following table.
Process Overview
In this activity, you will do the following:
1. On the Shopify Stores form, update the default availability settings for the Shopify store.
2. On the Stock Items (IN202500) form, review and update the availability settings specific to particular stock
items.
3. On the Storage Details by Item Warehouse Location (IN408055) form, review the quantities of stock items
available in the RETAIL warehouse.
4. On the Prepare Data (BC501000) form, prepare the product availability data for synchronization, and on the
Process Data (BC501500) form, process the prepared product availability data.
5. In the Shopify store, review the availability settings and quantities of the exported stock items.
System Preparation
Before you complete the instructions in this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The Shopify store has been created and configured, as described in Initial Configuration: To Set Up a
Shopify Store.
• The connection to the Shopify store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Configure the Store Connection.
2. Launch the Acumatica ERP website with the U100 dataset preloaded, and sign in with the following
credentials:
• Username: gibbs
• Password: 123
3. Sign in to the admin area of the Shopify store as the store administrator in the same browser.
4. Open the Shopify Stores (BC201010) form.
5. In the Store Name box of the Summary area, select SweetStore - SP.
6. On the Entity Settings tab, select the Active check box in the row of the Product Availability entity.
7. On the form toolbar, click Save.
Figure: Quantities available for shipping at the JS1 location of the RETAIL warehouse
• Store: SweetStore - SP
• Prepare Mode: Incremental
3. In the table, select the Selected check box in the rows of the Stock Item entity and the Product Availability
entity.
Before the quantity of a stock item and its availability settings can be exported, the stock item itself must
be synchronized. Quantities of items that have been prepared but not processed will not be updated in the
Shopify store.
4. On the form toolbar, click Prepare.
5. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
6. Open the Process Data (BC501500) form.
7. In the Summary area of the form, specify the following settings:
• Store: SweetStore - SP
• Entity: Stock Item
8. On the form toolbar, click Process All to process the prepared synchronization records of the stock items
you updated in the previous steps.
9. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
10.In the Entity box, select Product Availability.
11.On the form toolbar, click Process All to process the prepared synchronization records of product
availability.
12.In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
selected. In the only line in the Quantity table, notice that the quantity in the Available column is zero,
which means that Plum jam 8 oz. is still available for purchase despite that this item is not in stock.
Synchronizing Orders
In the topics of this chapter, you will read about the main features of order synchronization between Acumatica
ERP and the Shopify store.
You can import sales orders placed in the Shopify store to Acumatica ERP for further processing.
Learning Objectives
In this chapter, you will learn how to do the following:
• Configure the synchronization of orders between Acumatica ERP and the Shopify store
• Configure the synchronization of payments between Acumatica ERP and the Shopify store
• Import sales orders with payments from the Shopify store to Acumatica ERP
• Configure the card payment processing in Acumatica ERP and BigCommerce
Applicable Scenarios
The synchronization of orders is the main scenario for the integration between an ERP system and an external e-
commerce system. You set up the import of orders from the Shopify store to Acumatica ERP so that you can process
the imported orders further, for example, create a shipment, invoice the customer, and process the payment.
You can also indicate that payments that are imported from the Shopify store should be automatically released
as soon as they are imported by selecting the check box in the Release Payments column. If refunds issued in the
store should be imported to Acumatica ERP, you select the Import Refunds check box.
Note that orders that have the Archived status in the Shopify store are filtered during the order
import. That is, for each order with this status, the system creates a synchronization record
and assigns it the Filtered status on the Sync History (BC301000) form.
2. Searches for products (that is, stock and non-stock items) included in the sales order.
Products included in a sales order must be synchronized with or created in Acumatica ERP. During the
import of a sales order, the system searches for an inventory ID of an inventory item in Acumatica ERP that
matches the product's SKU in the Shopify store. If no matching inventory ID has been found, the system
continues to search for a matching alternate ID (that is, an additional identifier of the item, which can be
an identifier used by your company's customer or vendor, that is specified on the Cross-Reference tab of
the Stock Items (IN202500) form for a stock item and of the Non-Stock Items (IN202000) form for a non-stock
item). If the matching alternate ID has been found, the system inserts in the imported order an inventory
item associated with this alternate ID.
3. Searches for a customer that placed the order, and inserts it in the sales order. If the customer has been
updated in the Shopify store, updates the customer record in Acumatica ERP. If the customer has not been
found, creates a new customer on the Customers (AR303000) form, and inserts it in the sales order.
4. Creates a document of the Prepayment type on the Payments and Applications (AR302000) form, if the
payment method used for paying the sales order in the Shopify store has an active mapping with a payment
method defined in Acumatica ERP on the Shopify Stores (BC201010) form, and applies it to the sales order.
If the mapping of the store payment method is inactive or has not been configured, the system creates a
synchronization record for the payment on the Sync History form and assigns it the Filtered status. In this
case, the prepayment document is not created on the Payments and Applications form.
Synchronization of Payments
You can import payments independently of orders by preparing and processing the Payment entity.
During the synchronization of the Payment entity, the system creates a document of the Prepayment type on the
Payments and Applications (AR302000) form and applies it to the sales order if the following conditions are met:
• The store payment method with which the order was paid is mapped to an Acumatica ERP payment method
and the mapping is active on the Shopify Stores (BC201010) form.
• The sales order has the Open status and has an unbilled balance, or the sales order has the Canceled status.
If the mapping of the store payment method is inactive or has not been configured, the system creates a
synchronization record for the payment on the Sync History (BC301000) form and assigns it the Filtered status. In
this case, the prepayment document is not created on the Payments and Applications form.
Integration with Shopify | 320
If the sales order has been fully invoiced, the system cannot apply the prepayment to the sales order. In this case,
the prepayment is applied to the invoice or invoices created for the sales order.
If the sales order has been partially invoiced, the prepayment is applied to the sales order only in the amount equal
to the unbilled amount of the sales order. You need to manually apply the remaining amount to the invoice or
invoices.
The following sections provide details you can use to ensure that the system is configured properly for importing
sales orders, and to understand (and change, if needed) the settings that affect the processing workflow.
Implementation Checklist
We recommend that before you initially import orders from the Shopify store, you make sure the needed features
have been enabled, settings have been specified, and entities have been created, as summarized in the following
checklist.
Shopify Stores (BC201010) The necessary settings have been specified, as demonstrated in the ex-
ample of Initial Configuration: To Configure the Store Connection.
Processing Centers (CA205000) The processing center for processing payments has been created, as
demonstrated in the examples of Order Synchronization: To Configure and
Import Shopify Payments and Order Synchronization: To Configure and Im-
port Authorize.Net Payments.
Shopify Stores (BC201010) • The necessary settings have been specified, as demonstrated in the
example of Initial Configuration: To Configure the Store Connection.
• On the Payment Settings tab, the payment mapping has been de-
fined for store payment methods representing payment gateways, as
demonstrated in the examples of Order Synchronization: To Configure
and Import Shopify Payments and Order Synchronization: To Configure
and Import Authorize.Net Payments.
Integration with Shopify | 321
Validation of Configuration
To make sure that all configuration has been performed correctly, we recommend that in your system, you perform
instructions similar to those described in Order Synchronization: To Configure and Import Shopify Payments and
Order Synchronization: To Configure and Import Authorize.Net Payments.
In Acumatica ERP Retail-Commerce Edition, users can import and, if necessary, process debit and credit card
payments from external e-commerce systems through integration with payment gateways. The ability to use card-
processing features, such as authorization, capture, voiding, and refunding card transactions, is available if the
Integrated Card Processing feature is enabled on the Enable/Disable Features (CS100000) form. This topic explains
how to configure payment providers for processing of payments made in the Shopify store aer they are imported
to Acumatica ERP.
Payments and Applications (AR302000) form based on the payment method from Acumatica ERP that was
mapped to the payment method used for payment in the Shopify store.
For step-by-step instructions on configuring and importing payments based on the Shopify Payments payment
method, see Order Synchronization: To Configure and Import Shopify Payments.
For step-by-step instructions on configuring and importing payments based on the Authorize.Net payment method,
see Order Synchronization: To Configure and Import Authorize.Net Payments.
• Cash Account: A cash account that was specified for the payment method on the Allowed Cash Accounts
tab on the Payment Methods (CA204000) form.
• Proc. Center ID: The identifier of the processing center configured for the payment method on the
Processing Centers tab of the Processing Centers (CA205000) form.
• Release Payments: A check box that you select to indicate that the payment should be immediately
released aer it is imported to Acumatica ERP. If this check box is selected for a card-based payment
method associated with a credit card processing center in Acumatica ERP (that is, for the payment method
for which a processing center is selected in the Proc. Center ID column), only payments that have been
captured in the store will be automatically released on import. Payments that have been authorized but not
captured in the store need to be processed aer import and then released manually or by using the Release
AR Documents (AR501000) form.
• Process Refunds: A check box that indicates (if selected) that refunds made to the payment method should
be imported to Acumatica ERP. This check box is selected and unavailable for card payment methods for
which a processing center is specified, which indicates that all refunds made to such payment methods
must be imported to Acumatica ERP.
When you start the validation process, the system requests the status of the credit card transaction, and updates
the processing status of the transaction and the status of the prepayment, if necessary. If the updated processing
status of the transaction is Captured, the status of the prepayment changes to Balanced. If on the General Settings
tab of the Accounts Receivable Preferences (AR101000) form, the Enable Integrated CC Processing check box is
selected, the system releases the prepayment.
Customizations may support forced validation of all imported credit card transactions. In this case, all credit card
transactions imported from external systems will be displayed on the Deferred Processing Required tab of the
Validate Card Payments form and will need to be validated.
A sales order can be fulfilled only if the credit card payment imported for it from an external e-
commerce system has been validated. To streamline shipping of orders, you can set up an automation
schedule on the Validate Card Payments form to regularly process imported card transactions that
require validation. For information about automation schedules, see Automated Processing: General
Information.
The following activity will walk you through the process of configuring the system so that you can import payments
based on the Shopify Payments payment method from the Shopify store to Acumatica ERP.
Story
Suppose that the SweetLife Fruits & Jams company wants to accept card payments in the Shopify store. The
company sells its products in the United States, where Shopify Payments is supported.
Acting as an implementation consultant helping SweetLife to set up the integration of Acumatica ERP with the
Shopify store, you need to configure Shopify Payments as a card payment provider in the Shopify store, configure
the card payment processing in Acumatica ERP, and then configure the import of card payments from the Shopify
store to Acumatica ERP.
Configuration Overview
In the U100 dataset, the following tasks have been performed for the purposes of this activity:
• On the Enable/Disable Features (CS100000) form, the Integrated Card Processing feature has been enabled.
• On the Cash Accounts (CA202000) form, the 10250ST cash account has been created.
Process Overview
In this activity, you will do the following:
1. On the Accounts Receivable Preferences (AR101000) form, activate integrated card processing.
2. On the Processing Centers (CA205000) form, define a processing center.
3. On the Processing Centers form, connect the processing center to the Shopify store.
4. On the Payment Methods (CA204000) form, define a payment method that will represent payments based on
the Shopify Payments store payment method.
5. In the admin area of the Shopify store, activate the Shopify Stores payment option.
6. On the Shopify Stores (BC201010) form, map the Shopify Payments store payment method with the payment
method defined in Acumatica ERP.
7. On the storefront of the Shopify store, create a test sales order paid by card.
Integration with Shopify | 326
8. In the admin area of the Shopify store, review the created test sales order.
9. On the Prepare Data (BC501000) form, prepare the sales order for synchronization; on the Process Data
(BC501500) form, process the sales order data prepared for synchronization.
10.On the Sales Orders (SO301000) form, review the imported sales order.
System Preparation
Before you complete the instructions in this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The Shopify store has been created and configured, as described in Initial Configuration: To Set Up a
Shopify Store.
• The connection to the Shopify store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Configure the Store Connection.
2. Launch the Acumatica ERP website with the U100 dataset preloaded, and sign in with the following
credentials:
• Username: gibbs
• Password: 123
3. Sign in to the admin area of the Shopify store as the store administrator in the same browser.
Step 5: Creating the Mapping for the Shopify Payments Store Payment Method
To map the Shopify Payments store payment method to the payment method defined for it in Acumatica ERP, do
the following:
1. Open the Shopify Stores (BC201010) form.
2. In the Store Name box of the Summary area, select SweetStore - SP.
3. In the table on the Payment Settings tab, in the row of the SHOPIFY_PAYMENTS store payment method,
specify the following settings:
• Active: Selected
• Store Currency: USD (inserted by default)
• ERP Payment Method: SHOPIFYPAY
• Cash Account: 10250ST
• Proc. Center ID: SHOPIFYPAY
4. On the form toolbar, click Save to save your changes.
6. On the order creation page (Payment step), in the Payment section, specify the following card settings
under Credit card:
• Card number: 4242 4242 4242 4242
• Name on card: Melody Keys
• Expiration date: 12/23
• Security code: 123
7. In the Billing address section, leave the Same as shipping address option button selected.
8. At the bottom of the page, click Pay now to place and pay your order. The order confirmation page opens. At
the top of the page, notice the order number which is represented by the prefix # followed by four digits.
You can change the format of the order number on the General settings page in the Shopify
admin area.
You can view the details of the card transaction by expanding the corresponding link in the
Timeline section at the bottom of the page.
4. In the URL of the order page, aer /admin/orders/, note the order identifier. This is the identifier that will be
shown in Acumatica ERP, in the External ID column on the Process Data (BC501500) form and on the Sync
History (BC301000) form.
In the Shopify store, the status of the order changes from Authorized to Paid, and the capture operation
is automatically reflected in the card transaction details, which you can view in the Timeline of the order
page.
You have finished capturing a payment for the sales order. In a production setting, you would create and
confirm the related shipment, prepare the related invoice, and release the payment, which is beyond the
scope of this activity.
The following activity will walk you through the process of configuring the system so that you can import payments
based on the Authorize.Net payment method from the Shopify store to Acumatica ERP and then further process
them, if necessary.
Story
Suppose that the SweetLife Fruits & Jams company wants to accept card payments in the Shopify store. The
company already has the Authorize.Net account for processing card payments. Acting as an implementation
consultant helping SweetLife to set up the integration of Acumatica ERP with the Shopify store, you need to
configure Authorize.Net as a card payment provider in the Shopify store, configure the card payment processing in
Acumatica ERP, and then configure the import of card payments from the Shopify store to Acumatica ERP.
Configuration Overview
• On the Enable/Disable Features (CS100000) form, the Integrated Card Processing feature has been enabled.
• On the Cash Accounts (CA202000) form, the 10250ST cash account has been created.
Process Overview
In this activity, you will do the following:
1. On the Accounts Receivable Preferences (AR101000) form, activate integrated card processing.
2. On the Processing Centers (CA205000) form, define a processing center.
3. On the Processing Centers form, connect the processing center to the Authorize.Net payment gateway.
4. On the Payment Methods (CA204000) form, define a payment method that will represent all card payments
in the Shopify store.
5. In the admin area of the Shopify store, activate the Authorize.Net payment gateway for accepting card
payments.
6. On the Shopify Stores (BC201010) form, map the Authorize.Net store payment method with the payment
method defined in Acumatica ERP for all card payments.
7. On the storefront of the Shopify store, create a test sales order paid by card.
8. In the admin area of the Shopify store, review the created test sales order.
9. On the Prepare Data (BC501000) form, prepare the sales order for synchronization; on the Process Data
(BC501500) form, process the sales order data prepared for synchronization.
10.On the Sales Orders (SO301000) form, review the imported sales order.
System Preparation
Before you complete the instructions in this activity, do the following:
Integration with Shopify | 332
ID Value
TESTMODE 1
2. To test that the connection settings, on the form toolbar, click Test Credentials.
If the test connection is successful, the system will display the following confirmation message: The
credentials were accepted by the processing center.
5. On the Processing Centers tab, add a row, and specify the following settings in the row:
• Proc. Center ID: AUTHNETCOM
• Active: Selected
• Default: Selected
6. On the form toolbar, click Save to save your changes.
Step 6: Creating the Mapping for the Authorize.Net Store Payment Method
To configure the mapping for the Authorize.Net store payment method, do the following:
1. Open the Shopify Stores (BC201010) form.
2. In the Store Name box of the Summary area, select SweetStore - SP.
3. On the Payment Settings tab, in the Base Currency Payment Methods table of the Payment Method
Mapping section, map the Authorize.Net payment method set up in the Shopify store with the payment
method configured in Acumatica ERP by specifying the following settings:
• Active: Selected
• Store Payment Method: AUTHORIZE_NET
• ERP Payment Method: ALLCARDS
• Cash Account: 10250ST
• Proc. Center ID: AUTHNETCOM
4. Click Save to save your changes.
Integration with Shopify | 335
Notice that the payment status is Authorized and the Capture payment button is displayed. Because you
have configured the Authorize.net payment option to only authorize (but not capture) the payment amount
when the order is placed, the payment funds have not yet been captured.
You can view the details of the card transaction by expanding the corresponding link in the
Timeline section at the bottom of the page.
Next you would proceed to create and confirm the related shipment, prepare the related invoice, and
release the payment. For the purposes of this activity, you do not have to perform any of these operations.
You can import sales orders placed in Acumatica ERP to the Shopify store.
the shipping address or change the customer's email address or phone number. The sales order can then be
resynchronized so that the sales order in the Shopify store reflects the most recent changes.
Sales orders created in Acumatica ERP and exported to Shopify cannot be edited in the Shopify admin area. If
you need to make any changes to such an order (that is, the changes that you would normally make aer clicking
the Edit button at the top of the Shopify order page), you should cancel the order and recreate it with the correct
settings and details.
You can allow adding items to sales orders that have been exported to Shopify. To do so, you select the Allow
Adding Items to Processed Orders check box on the Order Settings tab of the Shopify Stores (BC201010) form.
When this check box is selected for a store, a new column, Excluded from Export, is displayed for sales orders
synchronized with the store on the Details tab of the Sales Orders (SO301000) form. If you add an item to such an
order, theExcluded from Export check box automatically becomes selected, which indicates that this item will not
be reflected in the order in the Shopify store aer the sales order is resynchronized.
Shopify provides the fraud analysis functionality to help merchants identify potentially fraudulent orders. In this
topic, you will read about importing order risk information from Shopify to Acumatica ERP.
Each order can have more than one risk recommendation and score. The Risk Status box
displays the maximum risk in the list of risk recommendations.
0.00–20.00 Low
Integration with Shopify | 339
20.00–60.00 Medium
60.00–100.00 High
Aer you have investigated the order, you can do the following:
• To cancel the order that is too risky to process, you click Actions > Cancel Order on the form toolbar. The
order is assigned the Canceled status and excluded from processing.
• To process the order, you click the Remove Risk Hold button on the form toolbar. The order is assigned the
Open or Pending Approval status, depending on the workflow configuration.
If your company uses Shopify point-of-sale (POS) functionality, you can configure the import of POS orders to
Acumatica ERP. This functionality is available only when the Shopify and Shopify POS Connector feature is enabled
on the Enable/Disable Features (CS10000) form.
Create dedicated order types for Shopify POS orders so that it is easier to tell them from other orders.
In this chapter, you will learn how to configure tax synchronization between Acumatica ERP and the Shopify store.
During the implementation of the integration between Acumatica ERP and the Shopify store, you decide if taxes
should be synchronized during the export or import of sales orders.
Learning Objectives
In this chapter, you will learn how to set up tax synchronization if you collect tax on products you sell in the Shopify
store.
Applicable Scenarios
You set up tax synchronization during the configuration of the connection between Acumatica ERP and the Shopify
store to make sure that taxes collected on online orders are reflected in an imported order and then correctly
recalculated when a shipment and an invoice are created for the order.
If you plan to use only Acumatica ERP (without a dedicated tax calculation provider) for tax calculation and
reporting, you perform the following general steps:
1. Configure manual tax calculation rules in the Shopify store. For information, see General set-up steps and
tax reports in the Shopify documentation.
2. Implement the tax functionality by configuring a tax agency, tax zones, tax categories, and sales taxes.
For detailed information about configuring sales taxes in Acumatica ERP, see the F330 Sales Taxes course
available in Partner University.
The manual tax configuration should match in the Shopify store and in Acumatica ERP, otherwise issues
might occur during the synchronization of entities. Tax categories and taxes in Acumatica ERP should be
configured in the same way as tax rates and exemptions in Shopify. If you use different names for a tax or an
exemption in both systems, you should map tax IDs in the substitution list specified in the Tax List box and
tax categories in the substitution list specified in the Tax Category List box on the Order Settings tab of the
Shopify Stores (BC201010) form. If during the import of a sales order, the system cannot find the tax ID or tax
category specified in the order, it will check to see if there is a mapping defined for the tax ID or tax category
in these substitution lists.
Taxes that have the same name in the Shopify store and Acumatica ERP (or that have been mapped via the
substitution list) should be defined with exactly the same rates. Although an order for which the taxes have
different rates will be imported successfully, when an invoice is prepared for this imported sales order, the
taxes are recalculated based on the tax settings configured in Acumatica ERP. If the tax rates differ, there will
be a discrepancy between the amount of the invoice created in Acumatica ERP and the amount of the order
created in the Shopify store.
3. Specify the tax synchronization settings on the Order Settings tab of the Shopify Stores (BC201010) form as
follows:
• Tax Synchronization: Selected
Integration with Shopify | 341
• Default Tax Zone: The tax zone that the system will assign to the order if no tax zone has been identified
during the order import.
• Use as Primary Tax Zone: Cleared
If you want to use an external tax provider for automatic tax calculation, you need to perform the following general
steps:
Integration with Shopify | 343
1. Configure automatic tax calculation in the Shopify store. For information, see Tax services with Avalara
AvaTax in the Shopify documentation.
2. Configure the integration of Acumatica ERP with the external tax provider by using the same account as
was used in the previous step. For instructions on how to integrate Acumatica ERP with Avalara AvaTax, see
Integrating Acumatica ERP with External Tax Providers.
3. Specify the tax synchronization settings on the Order Settings tab of the Shopify Stores (BC201010) form as
follows:
• Tax Synchronization: Selected
• Default Tax Zone: The tax zone that you have configured for the external tax provider
• Use as Primary Tax Zone: Selected
Because the primary tax zone has the highest priority for tax calculation, if the tax zone configured for the external
tax provider is specified in this box, it will always be used for tax calculation regardless of whether the system has
identified any other tax zone during the order import.
If the Net/Gross Entry Mode feature is enabled on the Enable/Disable Features (CS100000) form, for a sales order
imported from a Shopify store, the Tax Calculation Mode setting on the Financial tab of the Sales Orders
(SO301000) form is determined based on the tax synchronization settings specified on the Shopify Stores
(BC201010) form and the price settings specified in the Shopify store.
If only Acumatica ERP is used for tax calculation, the setting is determined by the price settings specified in the
Shopify store as follows:
• If the prices of items in the store include taxes (that is, if on the Taxes settings page, the All prices include
tax check box is selected), the system inserts Gross in the Tax Calculation Mode box of the Sales Orders
form for the imported sales order.
• If prices are entered for items exclusive of tax (that is, if the All prices include taxes check box is cleared),
the system inserts Net in the Tax Calculation Mode box of the Sales Orders form for the imported sales
order.
If an external tax provider—for example, Avalara AvaTax—is configured, the system inserts Tax Settings in the Tax
Calculation Mode box of the Sales Orders form for the imported sales orders. With this option selected, the sales
order inherits the settings of the customer, or of the customer's location if the Business Account Locations feature
has been enabled on the Enable/Disable Features form.
Integration with Shopify | 344
The following activity will walk you through the process of setting up the synchronization of taxes between the
Shopify store and Acumatica ERP.
Story
Suppose that SweetLife is using Acumatica ERP and Avalara AvaTax for calculating and reporting taxes on the
goods and services it sells. The company currently sells products and needs to collect taxes only in New York State,
As an implementation consultant helping SweetLife to set up a Shopify store, you need to set up the tax calculation
in the store for New York State and then make sure that the taxes calculated for online orders appear correctly in
sales orders imported to Acumatica ERP.
Configuration Overview
For the purposes of this activity, a company profile has been defined for SweetLife in an Avalara AvaTax sandbox
account.
In the U100 dataset, the following tasks have been performed for the purposes of this activity:
• On the Tax Providers (TX102000) form, the AVALARA tax provider has been created, a connection to the
Avalara AvaTax account has been established, and the SweetLife branches have been mapped to a company
profile defined for SweetLife in the AvaTax account.
• On the Tax Zones (TX206000) form, the AVALARA tax zone has been defined.
• On the Tax Categories (TX205500) form, the TAXABLE and EXEMPT tax categories have been defined.
These tax categories have been assigned to item classes on the Item Classes (IN201000) form, and to
individual stock and non-stock items on the Stock Items (IN202500) and Non-Stock Items (IN202000) forms,
respectively.
Process Overview
In this activity, you will do the following:
1. In the admin area of the Shopify store, review the tax regions where you will collect sales tax on products
sold to customers.
2. On the Enable/Disable Features (CS100000) form, enable the External Tax Calculation Integration feature.
3. On the Tax Categories (TX205500) and Tax Zones (TX206000) forms, review some of the tax-related entities
that have been predefined in the U100 dataset.
4. On the Shopify Stores (BC201010) form, specify the tax synchronization settings for your Shopify store.
5. On the Substitution Lists (SM206026) form, review the mapping of tax categories between Acumatica ERP
and the Shopify store.
6. On the Entities (BC202000) form, update the export filtering settings to include stock items of one more item
class.
7. On the Prepare Data (BC501000) form, prepare the stock item data for synchronization; on the Process Data
(BC501500) form, process the prepared data.
8. Review the exported items in the admin area of the Shopify store.
9. To make sure that the tax applied to a sales order in the Shopify store is imported to Acumatica ERP
correctly, create an online order in the admin area of the Shopify store.
10.Import the sales order to Acumatica ERP by using the Prepare Data and Process Data forms.
Integration with Shopify | 345
11.On the Sales Orders (SO301000) form, review the imported sales order.
System Preparation
Do the following:
1. Make sure the connection to the Shopify store is established and the minimum configuration is performed
as described in the prerequisite activity, Initial Configuration: To Configure the Store Connection.
2. Make sure that the customers of the DEFAULT customer class have been exported to the Shopify store, as
described in Customer Synchronization: To Perform Bidirectional Synchronization.
3. Make sure that the integration with the Shopify Payments payment provider has been implemented, as
described in Order Synchronization: To Configure and Import Shopify Payments.
4. Sign in to the admin area of the Shopify store as the store administrator in the same browser.
TAXABLE TRUE
EXEMPT FALSE
With these settings, non-stock and stock items that have the TAXABLE tax category in Acumatica ERP, aer
being exported, have the Charge tax on this product check box selected, and items with the Exempt tax
category have the same check box cleared.
Integration with Shopify | 347
This mapping affects only the export of stock and non-stock items. If the state of the check box
is changed for a product in the Shopify store and then a sales order with this item is placed
and imported to Acumatica ERP, the tax category that appears in the sales order is copied
from the Tax Category box of the General tab of the Stock Items (IN202500) or Non-Stock
Items (IN202000) form (depending on the type of the item). When taxes are recalculated in
Acumatica ERP, there might be discrepancies between the order tax amount in the Shopify
store and the tax amount calculated in Acumatica ERP. To avoid these discrepancies, make
sure that the same changes are made to product tax settings in both systems (that is, that
products are synchronized in a timely manner).
8. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
5. Open the Details tab. In the line with the KIWIJAM96 item, Tax Category is set to TAXABLE. This tax category
has been copied from the Tax Category box of the General tab of the Stock Items (IN202500) form.
In this chapter, you will learn how to set up the import of orders with discounts from the Shopify store to Acumatica
ERP.
You may offer customers of your Shopify store discounts of various types. If the Customer Discounts feature is
enabled on the Enable/Disable Features (CS100000) form, you can select the level at which the discounts will be
displayed in orders imported to Acumatica ERP from the Shopify store.
Learning Objectives
In this chapter, you will learn how to set up the import of sales orders with discounts from the Shopify store to
Acumatica ERP.
Applicable Scenarios
You specify the level at which discounts should be displayed in imported orders if the Customer Discounts feature is
enabled on the Enable/Disable Features (CS100000) form.
applied to an online sales order will be displayed in the order aer it is imported to Acumatica ERP from the
Shopify store. On the Order Settings tab of the Shopify Stores (BC201010) form, you can select in the Show
Discounts As box one of the following options:
• Line Discounts: Discounts applied to the order are distributed between the sales order lines and appear in
the Discount Amount column on the Details tab of the Sales Orders (SO301000) form.
• Document Discounts: Discounts applied to the order are aggregated and displayed on the Discounts tab of
the Sales Orders form.
For an example of configuring discounts in the Shopify store and importing an order with the discounts, see Import
of Orders with Discounts: Process Activity.
The following activity will walk you through the process of importing orders that contain items with discounts.
Story
Suppose that the SweetLife sales manager decided to offer discounts for some of the products that the company
sells in its Shopify store. Starting from today, the company provides the following discounts:
• 10 percent discount on purchase of 96-ounce jar of plum jam
• Five-dollar discount on purchase of 96-ounce jar of banana jam
• Additional discount in the amount of $20 for the orders of $500 or more
As SweetLife's implementation consultant, you need to create an order with discounts of multiple types, import it
to Acumatica ERP, and then explore how the applied discounts are displayed in the imported order.
Configuration Overview
In the U100 dataset, for the purposes of this activity, the PLUMJAM96 and BANJAM96 stock items have been created
on the Stock Items (IN202500) form.
Process Overview
In this activity, you will do the following:
1. On the Enable/Disable Features (CS100000) form, activate the Customer Discounts feature.
2. On the Shopify Stores (BC201010) form, review the discount-related settings.
3. In the admin area, create an order and apply multiple discounts to it.
4. On the Prepare Data (BC501000) form, prepare the sales order data for synchronization; on the Process Data
(BC501500) form, process the sales order data prepared for synchronization.
5. On the Sales Orders (SO301000) form, review the imported sales order and applied discount.
System Preparation
Before you complete the instructions in this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The Shopify store has been created and configured, as described in Initial Configuration: To Set Up a
Shopify Store.
• The connection to the Shopify store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Configure the Store Connection.
Integration with Shopify | 352
• Make sure that the integration with the Shopify Payments payment provider has been implemented, as
described in Order Synchronization: To Configure and Import Shopify Payments.
2. Launch the Acumatica ERP website with the U100 dataset preloaded, and sign in with the following
credentials:
• Username: gibbs
• Password: 123
3. Open the Enable/Disable Features (CS100000) form.
4. On the form toolbar, click Modify, and select the Customer Discounts check box under Advanced
Financials.
5. On the form toolbar, click Enable.
14.In the Payment section, click Add discount to add an order-level discount.
15.In the Add discount dialog box, which opens, in the Discount type box, leave Amount, in the Discount
value box, enter 20, and click Apply.
For the purposes of this activity, assume that the payment was received outside Shopify.
16.In the Payment section, click Collect payment > Mark as paid.
17.In the Mark as paid dialog box, which opens, click Create order.
The system closes the dialog box and creates the order. At the top of the page, notice that the system has
assigned the order an order number, the Paid payment status, and the Unfulfilled fulfillment status.
You have created an order and applied two line-level discounts and one order-level discount to it. In the next step,
you will import this order to Acumatica ERP.
On the Discounts tab, notice that two rows have been added, as shown in the following screenshot. One
discount is the sum of the line-level discounts, and another one is the order-level discount. The External
Document type the Type column reflects the fact that the discounts were imported from an external system.
The values in the Discount Amt. and Discount Percent columns reflect the discounts applied in the Shopify
store.
You have created an order with discounts of various types in the Shopify store, explored how they are applied to an
order in the store, and reviewed how they are displayed in the order aer it has been imported to Acumatica ERP.
In this chapter, you will learn how to configure the Acumatica ERP instance for importing non-card refunds from the
Shopify store. You will also explore how non-card refunds are imported and applied to imported sales orders.
You can import to Acumatica ERP non-card refunds: that is, refunds issued for orders in your Shopify store that
have been paid and refunded with non-card payment methods or with card payment methods that are mapped to
an Acumatica ERP payment method for which integrated card processing is not configured..
Learning Objectives
In this chapter, you will learn how to do the following:
• Configure the import of refunds for non-card payment methods from a Shopify store to Acumatica ERP
• Import refunds for non-card payment methods from a Shopify store to Acumatica ERP
Applicable Scenarios
You import refunds of payments based on a non-card payment method from Shopify to Acumatica ERP so that
you can keep track of refunded payments and restocked items. You may issue refunds in the Shopify store in the
following cases:
• A customer has been overcharged in error and part of the order amount needs to be refunded.
• A customer has not received the purchased item or has received an excessive quantity of the item.
Integration with Shopify | 355
• A customer has received the purchased item but is not satisfied with its quality or performance and wants to
return it.
• The original sales order has not been shipped at all or has been shipped in full. If the sales order has been
shipped partially, the refund will not be imported.
• The payment for the original sales order to which the refund pertains has been imported and released.
For information about the synchronization process, see Data Synchronization: General Information. For information
about the import of various types of refunds, see Importing Non-Card Refunds: Order-Level Refunds and Importing
Non-Card Refunds: Item-Level Refunds.
The following activity will walk you through the configuration of refund import so that you can import to Acumatica
ERP refunds and returns issued to a customer in the Shopify store for orders paid with non-card payment methods.
Story
Suppose that the SweetLife Fruits & Jams company sells several kinds of jams in its Shopify store and wants
Acumatica ERP to keep information about the returns and refunds issued in the Shopify store. Acting as an
implementation consultant, you need to set up the import of refunds from the Shopify store to Acumatica ERP.
Configuration Overview
In the U100 dataset, for the purposes of this activity, the following features have been enabled on the Enable/
Disable Features (CS100000) form:
• Commerce Integration
• Shopify Connector
• Custom Order Types
The following entities, which you will use in this activity, have been predefined in the U100 dataset:
• The ER order type on the Order Types (SO201000) form
• The REFUNDAMT non-stock item on the Non-Stock Items (IN202000) form
• The EREFUND reason code on the Reason Codes (CS211000) form
Process Overview
In this activity, you will do the following:
1. On the Entity Settings tab of the Shopify Stores (BC201010) form, activate the Refund entity.
2. On the Order Settings tab, review the settings related to refund import.
3. On the Payment Settings tab, activate the import of refunds for a non-card payment method (Manual).
System Preparation
To prepare the system for the steps of this activity, do the following:
1. Make sure the connection to the Shopify store has been established and the minimum configuration has
been performed, as described in Initial Configuration: To Configure the Store Connection.
2. Sign in to the Acumatica ERP instance with the U100 dataset preloaded. You should sign in as an
administrator an administrator by using the following credentials:
• Username: gibbs
• Password: 123
Integration with Shopify | 357
1. While you are still viewing the Shopify Stores (BC201010) form, go to the Payment Settings tab.
2. In the table of this tab, select the Process Refunds check box in the row of the MANUAL store payment
method.
The resulting payment method mapping is shown in the following table.
Active Store Store Cur- ERP Pay- Cash Ac- Release Process Re-
Payment rency ment count Payments funds
Method Method
You have now configured the import of refunds from the Shopify store to Acumatica ERP for payments made by
using a non-card payment method (Manual).
Integration with Shopify | 358
The following sections provide details you can use to ensure that the system is configured for importing refunds for
non-card payment methods from the Shopify store to Acumatica ERP, and to understand (and change, if needed)
the settings that affect the processing workflow.
Implementation Checklist
We recommend that before you import refunds issued in the Shopify store for non-card payment methods, you
make sure the needed features have been enabled, settings have been specified, and entities have been created, as
summarized in the following checklist.
Order Types (SO201000) An order type for return orders has been defined.
Non-Stock Items (IN202000) A non-stock item has been created to represent the amounts of re-
funds imported from the Shopify store to Acumatica ERP.
Reason Codes (CS211000) The reason code for imported refunds has been defined.
Shopify Stores (BC201010) • On the Entities tab: The Refund entity has been activated.
• On the Order Settings tab:
• The order type you created for returns has been selected in
the Return Order Types box.
• The reason code you created for refunds has been specified in
the Refund Reason Code box.
• The non-stock item that you created to represent refunded
amounts has been specified in the Refund Amount box.
• On the Payment Settings tab: The Process Refunds check box
has been selected for a non-card payment method or card pay-
ment method that is mapped to an Acumatica ERP payment
method for which integrated card processing is not configured.
Validation of Configuration
To make sure that all configuration has been performed correctly, we recommend that in your system, you import
refunds from your Shopify store by performing instructions similar to those described in Importing Non-Card
Refunds: To Process a Refund for a Not-Yet-Shipped Order and Importing Non-Card Refunds: To Process a Refund for
a Shipped Order.
Integration with Shopify | 359
An order-level refund may be issued, for example, if a customer has been overcharged or is not content with the
quality of the product or service and needs to be partially reimbursed.
During the import of refunds on order amounts, if the original sales order has the Open or On Hold status on the
Sales Orders (SO301000) form, the system does the following:
• On the Payments and Applications (AR302000) form, creates a payment of the Customer Refund type in the
refunded amount and applies it to the original payment.
• In the original sales order, on the Details tab of the Sales Orders form, inserts a line for the non-stock
item that was specified in the Refund Amount Item box on the Order Settings tab of the Shopify Stores
(BC201010) form. In the Unit Price and Ext. Price columns, the system inserts the reversed refund amount
(that is, the amount with the minus sign). In the Reason Code column, the system inserts the reason code
that was specified on the Order Settings tab of the Shopify Stores form.
The following diagram illustrates the processing of an order-level refund for a non-card payment method when the
refund is issued before the sales order has been shipped.
Integration with Shopify | 360
If the original sales order has the Completed status on the Sales Orders form, the following actions are performed:
• On the Sales Orders form, the system creates a return order of the type selected in the Return Order Type
box on the Order Settings tab of the Shopify Stores form. In the External Reference box of the Summary
area, the system inserts the identifier of the refund that is used in the Shopify store.
• In the return order, on the Details tab of the Sales Orders form, the system inserts a line with the non-stock
item that was specified in the Refund Amount Item box on the Order Settings tab of the Shopify Stores
form. In the Unit Price and Ext. Price columns, the system inserts the refund amount (with the plus sign). In
the Reason Code column, the system inserts the reason code that was specified on the Order Settings tab
of the Shopify Stores form.
• On the Payments and Applications (AR302000) form, creates a payment of the Customer Refund type in the
refunded amount and links it to the return order.
The following diagram illustrates the processing of an order-level refund for a non-card payment method when the
refund is issued aer the sales order has been shipped.
If the original sales order has a status other than Open, On Hold or Completed on the Sales Orders form, the system
displays an error message saying that the refund cannot be applied.
An item-level refund may be issued if, for example, a customer wants to amend a not-yet-shipped order to decrease
the quantity of a purchased item or because they want to return the item whose condition or performance is
unsatisfactory.
During the import of item refunds, if the original sales order has the Open or On Hold status of the Sales Orders
(SO301000) form, the following actions occur:
• On the Payments and Applications (AR302000) form, the system creates a payment of the Customer Refund
type in the refunded amount and applies it to the original payment.
• In the original sales order, on the Details tab of the Sales Orders form, the system updates the order line
or lines to decrease the item quantities. If discounts and taxes have been applied, they are recalculated
accordingly.
The following diagram illustrates the processing of an item refund for a non-card payment method when the refund
is issued before the sales order has been shipped.
Integration with Shopify | 361
If the original sales order has the Completed status on the Sales Orders form, the following actions occur:
• On the Sales Orders form, the system creates a return order of the type that was specified in the Return
Order Type box on the Order Settings tab of the Shopify Stores form. In the External Reference box of the
Summary area, the system inserts the identifier of the refund that is used in the Shopify store.
• In the return order, on the Details tab, the system inserts a line with the applicable quantity of the returned
item. In the Reason Code column, the system inserts the reason code that was specified on the Order
Settings tab of the Shopify Stores form.
• On the Payments and Applications (AR302000) form, creates a payment of the Customer Refund type in the
refunded amount and links it to the return order.
The following diagram illustrates the processing of an item return for non-card payment methods when the refund
is issued aer the sales order has been shipped.
Integration with Shopify | 362
If the original sales order has a status other than Open, On Hold, or Completed on the Sales Orders form, the system
displays an error message saying that the refund cannot be applied.
The following activity will walk you through the process of importing a partial refund from the Shopify store to
Acumatica ERP. This is a partial refund of an order that has been paid by a non-card payment method and has not
yet been shipped.
Story
Suppose that a representative of the GoodFood One Restaurant customer placed an order for 10 jars of banana
jam in the SweetLife Fruits & Jams retail store and paid the entire order amount upfront in cash. The jam was to
be delivered from the SweetLife Fruits & Jams warehouse within seven days. Later the same day, before the jam
was shipped, the representative of GoodFood One Restaurant showed up in the retail store. The representative
informed the store manager that an error had occurred and only 3 jars of banana jam should have been purchased,
and asked the manager to refund the cost of the remaining quantity of banana jam. As the store manager, you need
to refund the cost of 3 jars of banana jam and import this refund to Acumatica ERP so that the correct quantities of
jam will be issued from SweetLife Fruits & Jams's warehouse.
Configuration Overview
In the U100 dataset, for the purposes of this activity, the following features have been enabled on the Enable/
Disable Features (CS100000) form:
• Commerce Integration
Integration with Shopify | 363
• Shopify Connector
• Custom Order Types
The following entities, which you will use in this activity, have been predefined in the system:
• The ER order type on the Order Types (SO201000) form
• The REFUNDAMT non-stock item on the Non-Stock Items (IN202000) form
• The EREFUND reason code on the Reason Codes (CS211000) form
Process Overview
In this activity, you will do the following:
1. In the admin area of the Shopify store, place a sales order for a customer.
2. On the Prepare Data (BC501000) form, prepare the sales order data for processing, and on the Process Data
(BC501500) form, process the sales order data.
3. On the Sales Orders (SO301000) form, review the imported sales order.
4. On the Payments and Applications (AR302000) form, release the prepayment related to the imported sales
order.
5. In the admin area of the Shopify store, update the order quantities, and issue a refund to the customer.
6. On the Prepare Data form, prepare the refund data for processing, and on the Process Data form, process
the refund data.
7. On the Sales Orders form, review the updated sales order, and on the Payments and Applications form,
review the updated prepayment.
8. On the Payments and Applications form, review and release the customer refund.
System Preparation
To prepare the system for the steps of this activity, do the following:
1. Make sure that the following prerequisite activities have been performed:
• Initial Configuration: To Configure the Store Connection
• Data Synchronization: To Perform the First Synchronization
• Importing Non-Card Refunds: Implementation Activity
2. Sign in to the admin area of the Shopify store as the store administrator.
Besides the order number, Shopify assigns each order an identifier (a numeric sequence) that you can
see in the URL of the Shopify order page. You can use this identifier to locate the necessary order on
the Process Data (BC501500) form (in the External ID column), for example, if you need to import an
individual order from the Shopify store to Acumatica ERP.
payment method and cash account defined in Acumatica ERP and mapped to the MANUAL store payment
method (ONLINE and 10250ST, respectively). The prepayment has the Balanced status. Before you can
process and import a refund in the Shopify store, you need to release this prepayment.
You have now imported a partial refund for ordered items in an order that has not yet been shipped and processed
this partial refund.
The following activity will walk you through the process of importing a partial refund from the BigCommerce store
to Acumatica ERP. This partial refund is for a shipped order that has already been fully delivered.
Story
Suppose that a representative of the West BBQ Restaurant customer placed an order for 10 jars of plum jam in the
SweetLife Fruits & Jams retail store, and paid the entire order amount upfront in cash. Four days later, aer the
purchased jam has already been delivered, a representative of West BBQ Restaurant returned 2 jars of plum jam. As
the store manager, you need to process the return of 2 jars of plum jam. You also want to reimburse the customer
$10 for the inconvenience of returning part of the purchase in person.
Integration with Shopify | 367
Configuration Overview
In the U100 dataset, for the purposes of this activity, the following features have been enabled on the Enable/
Disable Features (CS100000) form:
• Commerce Integration
• Shopify Connector
• Custom Order Types
The following entities, which you will use in this activity, have been predefined in the U100 dataset:
• The ER order type on the Order Types (SO201000) form
• The REFUNDAMT non-stock item on the Non-Stock Items (IN202000) form
• The EREFUND reason code on the Reason Codes (CS211000) form
Process Overview
In this activity, you will do the following:
1. In the admin area of the Shopify store, place a sales order for a customer.
2. On the Prepare Data (BC501000) form, prepare the sales order data for processing, and on the Process Data
(BC501500) form, process the sales order data.
3. On the Sales Orders (SO301000) form, review the imported sales order.
4. On the Payments and Applications (AR302000) form, release the prepayment related to the imported sales
order.
5. Using the Sales Orders form as a starting point, create a shipment.
6. On the Shipments (SO302000) form, confirm the shipment.
7. On the Sales Orders form, create a shipment.
8. On the Prepare Data form, prepare the shipment data for processing, and on the Process Data form, process
the shipment data.
9. In the admin area of the Shopify store, issue a refund to the customer.
10.On the Prepare Data form, prepare the refund data for processing, and on the Process Data form, process
the refund data.
11.On the Sales Orders form, review the updated sales order, and on the Payments and Applications form,
review the updated prepayment.
12.On the Payments and Applications form, review the customer refunds created for each of the return orders.
System Preparation
To prepare the system for the steps of this activity, do the following:
1. Make sure the following prerequisite activities have been performed:
a. Initial Configuration: To Configure the Store Connection
b. Data Synchronization: To Perform the First Synchronization
c. Importing Non-Card Refunds: Implementation Activity
2. Sign in to the admin area of the Shopify store as the store administrator.
Integration with Shopify | 368
Besides the order number, Shopify assigns each order an identifier (a numeric sequence) that you can
see in the URL of the Shopify order page. You can use this identifier to locate the necessary order on
the Process Data (BC501500) form (in the External ID column), for example, if you need to import an
individual order from the Shopify store to Acumatica ERP.
10.In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
Notice that the shipment has been assigned the Confirmed status. Make a note of the shipment number; you will
use it to identify the shipment to be exported to the Shopify store in the next step.
Because you have confirmed the shipment, on the Sales Orders (SO301000) form, the status of the imported sales
order has changed to Completed.
4. In the table, select the unlabeled check box in the row with the Refund entity.
5. On the form toolbar, click Prepare.
6. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
7. Click the link in the Ready to Process column in the row with the Refund entity.
8. On the Process Data (BC501500) form, which opens with the SweetStore - SP store and the Refund entity
selected in the Summary area, select the unlabeled check box in the row or the refund (which you can
identify by the number of the order it refers to in the External ID column).
9. On the form toolbar, click Process.
10.In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
You have now imported to Acumatica ERP a refund for a returned item and a partial refund of the order amount for
an order that has been fully shipped. For the purposes of this activity, you do not need to process the return order
or customer refund further.
In this chapter, you will learn how to configure the Acumatica ERP instance for importing card refunds from the
BigCommerce store,. You will also explore how card refunds are imported and applied to imported sales orders.
You can import to Acumatica ERP refunds issued for orders paid with card-based payment methods to customers in
your Shopify store.
Learning Objectives
In this chapter, you will learn how to do the following:
• Configure the import of refunds for card-based payment methods (Authorize.Net) from a Shopify store to
Acumatica ERP
• Import refunds for card-based payment methods from a Shopify store to Acumatica ERP
Applicable Scenarios
You import refunds of payments based on a card-based payment method from Shopify to Acumatica ERP to keep
track of refunded payments and restocked items. You may issue refunds in the Shopify store in the following cases:
• A customer has been overcharged in error and part of the order amount needs to be refunded.
• A customer has not received the purchased item or has received an excessive quantity of the item.
• A customer has received the purchased item but is not satisfied with its quality or performance and wants to
return it.
The following activity will walk you through the configuration of refund import so that you can import to Acumatica
ERP refunds issued to a customer in the Shopify store for an order paid by a credit card and processed by using the
Shopify Payments payment gateway.
Story
Suppose that the SweetLife Fruits & Jams company sells several kinds of jams in its Shopify store and wants to
track returns and refunds issued in the Shopify store from within Acumatica ERP. Acting as an implementation
consultant, you need to set up the import of returns and refunds issued in the Shopify store for orders paid by a
card and processed by using the Shopify Payments payment gateway. Further suppose that the Shopify Payments
payment gateway is configured to be used for processing card payments both in the Shopify store and in Acumatica
ERP.
Integration with Shopify | 374
Configuration Overview
For the purposes of this activity, the following features have been enabled on the Enable/Disable Features
(CS100000) form:
• Commerce Integration
• Shopify Connector
• Custom Order Types
The following entities, which you will use in this activity, have been predefined in the system:
• The ER order type on the Order Types (SO201000) form
• The REFUNDAMT non-stock item on the Non-Stock Items (IN202000) form
• The EREFUND reason code on the Reason Codes (CS211000) form
Process Overview
In this activity, you will do the following:
1. On the Entity Settings tab of the Shopify Stores (BC201010) form, activate the Refund entity.
2. On the Order Settings tab, you will review the settings of refund import.
3. On the Payment Settings tab, you will activate the import of refunds for the Shopify Payments payment
method.
System Preparation
Do the following:
1. Make sure the connection to the Shopify store has been established and the minimum configuration has
been performed, as described in Initial Configuration: To Configure the Store Connection.
2. Make sure that the mapping of the Shopify Payments payment method has been set up as described in
Order Synchronization: To Configure and Import Shopify Payments.
3. Launch the Acumatica ERP website, and sign in as an administrator by using the following credentials:
• Username: gibbs
• Password: 123
Step 3: Reviewing the Refund Import Settings for the Payment Method
To import refunds for the SHOPIFYPAY payment method, which you have configured in Order Synchronization: To
Configure and Import Shopify Payments, do the following:
1. While you are still viewing the Shopify Stores (BC201010) form, open the Payment Settings tab.
2. In the table of this tab, make sure that the mappings are defined for the SHOPIFY_PAYMENTS store payment
method as shown in the following table.
Active Store Store Cur- ERP Pay- Cash Ac- Proc. Cen- Release Process
Payment rency ment count ter ID Payments Refunds
Method Method
Notice that the Process Refunds check box is selected for this store payment method and is not available.
3. On the form toolbar, click Save to save your changes.
You have now configured the import of refunds to Acumatica ERP for payments made in the Shopify store with a
card by using the Shopify Payments payment gateway.
The following sections provide details you can use to ensure that the system is configured for importing refunds for
card-based payment methods from the Shopify store to Acumatica ERP, and to understand (and change, if needed)
the settings that affect the processing workflow.
Implementation Checklist
We recommend that before you import refunds issued in the Shopify store for card-based payment methods, you
make sure the needed features have been enabled, settings have been specified, and entities have been created, as
summarized in the following checklist.
Integration with Shopify | 376
Order Types (SO201000) The order type for return orders has been defined.
Non-Stock Items (IN202000) The non-stock item has been created to represent the amounts of re-
funds imported from the Shopify store to Acumatica ERP.
Reason Codes (CS211000) The reason code for imported refunds has been defined.
Shopify Stores (BC201010) • On the Entities tab: The Refund entity has been activated.
• On the Order Settings tab:
• The order type to be used for returns has been selected in the
Return Order Types box.
• The reason code for refunds has been specified in the Refund
Reason Code box.
• The non-stock item that represents refunded amounts has
been specified in the Refund Amount box.
Validation of Configuration
To make sure that all configuration has been performed correctly, we recommend that in your system, you import
refunds from your BigCommerce store by performing instructions similar to those described in Importing Card
Refunds: To Process a Refund for a Not-Yet-Shipped Order and Importing Card Refunds: To Process a Refund for a
Shipped Order.
An order-level refund may be issued, for example, if a customer has been overcharged or is not content with the
quality of the product or service and needs to be partially reimbursed.
During the import of refunds on order amounts, if the original sales order has the Open or On Hold status on the
Sales Orders (SO301000) form, the following actions occur:
• On the Payments and Applications (AR302000) form, the system creates a payment of the Customer Refund
type in the refunded amount and applies it to the original payment. If the sales order is fully refunded or
canceled and the processing status of the original payment is Authorized, the original payment is voided.
• In the original sales order, on the Details tab of the Sales Orders form, the system inserts a line for the non-
stock item that was specified in the Refund Amount Item box on the Order Settings tab of the Shopify
Stores (BC201010) form. In the Unit Price and Ext. Price columns, the system inserts the reversed refund
amount (that is, the amount with the minus sign). In the Reason Code column, the system inserts the
reason code that was specified on the Order Settings tab of the Shopify Stores form.
The following diagram illustrates the processing of an order-level refund for a card-based payment method that is
issued before the sales order has been shipped.
Integration with Shopify | 377
If the original sales order has the Completed status on the Sales Orders form, the following actions are performed:
• On the Sales Orders form, the system creates a return order of the type selected in the Return Order Type
box on the Order Settings tab of the Shopify Stores form. In the External Reference box of the Summary
area, the system inserts the identifier of the refund in the Shopify store.
• In the return order, on the Details tab, the system inserts a line with the non-stock item that was specified
in the Refund Amount Item box on the Order Settings tab of the Shopify Stores form. In the Unit Price and
Ext. Price columns, the system inserts the refund amount. In the Reason Code column, the system inserts
the reason code that was specified on the Order Settings tab of the Shopify Stores form.
• On the Payments and Applications (AR302000) form, creates a payment of the Customer Refund type in the
refunded amount and links it to the return order.
The following diagram illustrates the processing of an order-level refund for a card-based payment method that is
issued aer the sales order has been shipped.
Integration with Shopify | 378
If the original sales order has a status other than Open, On Hold, or Completed on the Sales Orders form, the system
displays an error message saying that the refund cannot be applied.
A refund of an ordered item may be issued if, for example, a customer wants to amend the order to decrease
the quantity of a purchased item or because they want to return the item whose condition or performance is
unsatisfactory.
During the import of item refunds, if the original sales order has the Open or On Hold status on the Sales Orders
(SO301000) form, the following actions occur:
• On the Payments and Applications (AR302000) form, the system creates a payment of the Customer Refund
type in the refunded amount and applies it to the original payment.
• In the original sales order, on the Details tab of the Sales Orders form, the system updates the order line or
lines to decrease the item quantities. Discounts and taxes, if applied, are recalculated accordingly.
• If the sales order is fully refunded or canceled and the processing status of the original payment is
Authorized, then the original payment is voided.
• If the sales order is fully refunded or canceled and the processing status of the original payment is Captured
or Settled, then a new voided payment is created against the original payment.
The following diagram illustrates the processing of an item return for a card-based payment method that is issued
before the sales order has been shipped.
Integration with Shopify | 379
If the original sales order has the Completed status on the Sales Orders form, the following actions occur:
• On the Sales Orders form, the system creates a return order of the type that was specified in the Return
Order Type box on the Order Settings tab of the Shopify Stores (BC201010) form. In the External Reference
box of the Summary area, the system inserts the identifier of the refund in the Shopify store.
• In the return order, on the Details tab of the Sales Orders form, the system inserts a line with the applicable
quantity of the returned item. In the Reason Code column, the system inserts the reason code that was
specified on the Order Settings tab of the Shopify Stores form.
• On the Payments and Applications (AR302000) form, creates a payment of the Customer Refund type in the
refunded amount and links it to the return order.
Integration with Shopify | 380
The following diagram illustrates the processing of an item return for a non-card payment method that is issued
aer the sales order has been shipped.
If the original sales order has a status other than Open, On Hold, or Completed on the Sales Orders form, the system
displays an error message saying that the refund cannot be applied.
The following activity will walk you through the process of importing from the Shopify store to Acumatica ERP a
partial refund of an order that has been paid by a card-based payment method and has not yet been shipped.
Story
Suppose that a customer placed an order for 10 jars of kiwi jam in the online store, and paid for it by card. The
jam was to be delivered later by the SweetLife Fruits & Jams within 7 days of purchase. Later the same day, the
customer called the store to inform the store manager that an error had occurred and only 7 jars of kiwi jam were to
be purchased, and asked the remaining 3 jars of kiwi jam to be refunded. As the store manager, you need to refund
3 jars of kiwi jam and import this refund to Acumatica ERP so that the correct quantities of jam will be issued from
the SweetLife Fruits & Jams warehouse.
Configuration Overview
In the U100 dataset, for the purposes of this activity, the following features have been enabled on the Enable/
Disable Features (CS100000) form:
Integration with Shopify | 381
• Commerce Integration
• Shopify Connector
• Custom Order Types
The following entities, which you will use in this activity, have been predefined in the U100 dataset:
• The ER order type on the Order Types (SO201000) form
• The REFUNDAMT non-stock item on the Non-Stock Items (IN202000) form
• The EREFUND reason code on the Reason Codes (CS211000) form
Process Overview
In this activity, you will do the following:
1. In the Shopify store, place a sales order for a customer through the storefront and pay for it with a credit
card.
2. In the admin area of the Shopify store, review the sales order.
3. On the Prepare Data (BC501000) form, prepare the sales order data for processing, and on the Process Data
(BC501500) form, process the sales order data.
4. On the Sales Orders (SO301000) form, review the imported sales order.
5. On the Payments and Applications (AR302000) form, review the prepayment created for the imported sales
order, capture the funds, and release the prepayment.
6. In the admin area of the Shopify store, issue a refund for an individual item.
7. On the Prepare Data form, prepare the refund data for processing, and on the Process Data form, process
the refund data.
8. On the Sales Orders form, review the updated sales order, and on the Payments and Applications form,
review the updated prepayment.
9. On the Payments and Applications form, review and release the customer refund.
System Preparation
To prepare the system for the steps of this activity, do the following:
1. Make sure that the following prerequisite activities have been performed:
a. Initial Configuration: To Configure the Store Connection
b. Data Synchronization: To Perform the First Synchronization
c. Importing Card Refunds: Implementation Activity
2. Sign in to the admin area of the Shopify store as the store administrator.
Shopify assigns each order an order number, which by default is represented by the prefix # and a
numbering sequence. The order number is displayed at the top of the order page next to the order's
payment status and fulfillment status. If needed, you can change the format of the order number on
the General settings page in the Shopify admin area.
Each order is also assigned a numeric identifier, which you can see in the URL of the Shopify order
page. You can use this identifier to locate the necessary order on the Process Data (BC501500) form
and on the Sync History (BC301000) form (in the External ID column).
You can view the details of the card transaction by expanding the corresponding link in the
Timeline section.
Proc. Status column. The Payment Method and Cash Account columns show the payment method and
cash account defined in Acumatica ERP and mapped to the SHOPIFY_PAYMENTS store payment method
(SHOPIFYPAY and 10250ST, respectively). Because the payment has been authorized but not captured, the
prepayment has the Pending Processing status. Before you can process and import a refund in the Shopify
store, you need to capture and release the prepayment.
Once the processing of the customer refund is finished, its status changes to Closed. In the Application
History tab, the system now shows the original prepayment to which the customer refund was applied.
5. On the Application History tab, in the only row, click the link in the Reference Nbr. column.
On the Payments and Applications form, which opens in a pop-up window with the original prepayment
selected, notice that the available balance of the prepayment has become zero.
You have now imported to Acumatica ERP a partial refund for the ordered items for the order that has not been
shipped. For the purposes of this activity, you do not need to process the sales order further.
The following activity will walk you through the process of importing from the Shopify store to Acumatica ERP a
partial refund of an order paid by card that has been fully delivered.
Story
Suppose that a customer placed an order for 10 jars of pear jam in the SweetLife Fruits & Jams online store, and
paid the entire order by card. Four days later, aer the purchased jam has already been delivered, the customer
returned 2 jars of pear jam to the store. As the store manager, you need to process the return of 2 jars of pear jam.
You also want to reimburse the customer for returning part of the purchase in person.
Configuration Overview
In the U100 dataset, for the purposes of this activity, the following features have been enabled on the Enable/
Disable Features (CS100000) form:
• Commerce Integration
• Shopify Connector
• Custom Order Types
The following entities, which you will use in this activity, have been predefined in the U100 dataset:
• The ER order type on the Order Types (SO201000) form
• The REFUNDAMT non-stock item on the Non-Stock Items (IN202000) form
• The EREFUND reason code on the Reason Codes (CS211000) form
Process Overview
In this activity, you will do the following:
1. On the storefront of the Shopify store, place a sales order for a customer through the storefront and pay for
it with a credit card.
2. In the admin area of the Shopify store, review the sales order.
3. On the Prepare Data (BC501000) form, prepare the sales order data for processing, and on the Process Data
(BC501500) form, process the sales order data.
4. On the Sales Orders (SO301000) form, review the imported sales order.
5. On the Payments and Applications (AR302000) form, review the prepayment created for the imported sales
order, capture the funds, and release the prepayment.
6. On the Sales Orders form, create a shipment.
7. On the Shipments (SO302000) form, confirm the shipment.
Integration with Shopify | 387
8. On the Prepare Data (BC501000) form, prepare the shipment data for processing, and on the Process Data
(BC501500) form, process the shipment data.
9. In the admin area of the Shopify store, issue a refund for an individual item.
10.On the Prepare Data form, prepare the refund data for processing, and on the Process Data form, process
the refund data.
11.On the Sales Orders form, review the return order, and on the Payments and Applications form, review the
updated prepayment.
12.On the Payments and Applications form, review and release the customer refund.
System Preparation
To prepare the system for the steps of this activity, do the following:
1. Make sure that the following prerequisite activities have been performed:
a. Initial Configuration: To Configure the Store Connection
b. Data Synchronization: To Perform the First Synchronization
c. Importing Card Refunds: Implementation Activity
2. Sign in to the admin area of the Shopify store as the store administrator.
• You can view the details of the card transaction by expanding the corresponding link in the
Timeline section.
• Besides the order number, Shopify assigns each order an identifier (a numeric sequence)
that you can see in the URL of the order page in the store admin area. You can use this
identifier to locate the necessary order on the Process Data (BC501500) form (in the
External ID column), for example, if you need to import an individual order from the
Shopify store to Acumatica ERP.
8. On the Process Data (BC501500) form, which opens with the SweetStore - SP store and the Sales Order entity
selected, select the unlabeled check box in the row with the order you created in Step 1 (which you can
identify by its number in the External ID column).
9. On the form toolbar, click Process.
10.In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
Notice that the shipment has been assigned the Confirmed status. Make a note of the shipment number; you will
use it to identify the shipment to be exported to the Shopify store in the next step.
Because you have confirmed the shipment, on the Sales Orders (SO301000) form, the status of the imported sales
order has changed to Completed.
type because this type was selected in the Return Order Type box on the Order Settings tab of the Shopify
Stores (BC201010) form in Importing Card Refunds: Implementation Activity.
3. In the row with the return order for Melody Keys, click the link in the Order Nbr. column.
The Sales Orders (SO301000) form opens with the return order selected.
In the Summary area, notice that the Customer Order Nbr. and Description boxes contain the reference
number of the original order in the Shopify store. In the External Reference box, the system inserted the
identifier of the refund in the Shopify store.
On the Details tab, the system inserted two lines: one with the returned item (PEARJAM96) with the quantity
of 2; the other one with the REFUNDAMT non-stock item, which reflects an order-level refund of $10 that you
specified in the Shopify store.
Notice that in the Reason Code column of both lines, the system inserted EREFUND, which is the reason
code you specified in the Refund Reason Code box on the Order Settings tab of the Shopify Stores
(BC201010) form in Importing Card Refunds: Implementation Activity.
You have now imported to Acumatica ERP a refund for a returned item and a partial refund of the order amount for
an order that has been fully shipped. For the purposes of this activity, you do not need to process the return order
or customer refund further.
In this chapter, you will learn how to configure the gi card functionality to be able to sell gi cards in the Shopify
store and accept the gi cards as payment.
Integration with Shopify | 393
You can sell gi certificates in the Shopify store and then accept them as full or partial payments.
Learning Objectives
In this chapter, you will learn how to do the following:
• Create gi cards so that you can sell them in the Shopify store
• Set up gi cards as a payment method that can be used to pay orders placed in the Shopify store
Applicable Scenarios
You set up gi cards if you want to offer customers the ability to buy a gi card and then accept the sold gi cards
as payments for orders.
When a sales order that has been fully or partially paid by a gi card is imported to Acumatica ERP, a document of
the Prepayment type is created on the Payments and Applications (AR302000) form for the gi card payment. The
Description of the prepayment contains the identifier of the gi card in the Shopify store.
The identifier of the gi card is not the gi card number entered during the order placement. In
Shopify, you can locate the identifier and the last four characters of the number of the gi card used
to pay the order by expanding the subsection with gi card payment details in the Timeline section of
the order page.
For step-by-step instructions for implementing gi cards, see Gift Cards: Process Activity.
Integration with Shopify | 394
In this activity, you will learn how to implement gi cards in the Shopify store and explore how gi cards can be
used to pay, in full or in part, for an online purchase in the Shopify store.
Story
Suppose that SweetLife wants to give its online customers the ability to purchase gi cards and use these cards
when purchasing goods in the SweetLife online store. As an implementation consultant, you need to configure the
gi card functionality—that is, the ability to sell gi cards as items and use the cards as payment methods—and
test it.
Configuration Overview
In the U100 dataset, for the purposes of this activity, on the Non-Stock Items (IN202000) form, the GIFTCERT non-
stock item has been created to represent gi cards sold in the online store. All purchases of gi cards in the online
store will be recorded in Acumatica ERP as purchases of this item.
Process Overview
You will do the following:
1. In the admin area of the Shopify store, enable the gi card functionality and create gi cards in various
amounts to be sold in the online store.
2. On the storefront, purchase a gi card.
3. In the admin area of the Shopify store, send the gi card to the customer.
4. On the Shopify Stores (BC201010) form, review the gi card settings.
5. On the Prepare Data (BC501000) form, prepare the sales order data for synchronization, and on the Process
Data (BC501500) form, process the prepared data.
6. On the Sales Orders (SO301000) form, review the imported sales order.
7. On the storefront, create an order and pay part of it with the purchased gi card.
8. In the admin area of the Shopify store, review the order.
9. On the Prepare Data form, prepare the sales order data for synchronization, and on the Process Data form,
process the prepared data.
10.On the Sales Orders form, review the imported sales order that was partially paid for with the gi card.
System Preparation
Before you start configuring the gi cards, do the following:
1. Make sure the connection to the Shopify store is established and the minimum configuration is performed
as described in Initial Configuration: To Configure the Store Connection.
2. Make sure that the PLUMJAM96 stock item has been exported to the Shopify store during the
synchronization of the Stock Item entity, as described in Initial Configuration: To Configure the Store
Connection.
3. Make sure that the integration with the Shopify Payments payment provider has been implemented, as
described in Order Synchronization: To Configure and Import Shopify Payments.
Integration with Shopify | 395
4. Sign in to the admin area of the Shopify store as the store administrator in the same browser.
Specify a real email address to which you have access. The gi card will be sent to this
email aer the order is completed.
7. On the Process Data (BC501500) form, which opens with the SweetStore - SP store and the Sales Order entity
selected, in the row of the order you created (which you can find by its identifier in the External ID column
and empty ERP ID), select the unlabeled check box.
8. On the form toolbar, click Process.
9. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
For the purposes of this activity, you do not need to process the created sales order further.
Before you perform this step, make sure that you have the code of the gi card ready.
To create an order and pay for part of it with the gi card, in the admin area of the Shopify store, do the following:
1. In the le menu, click Preview right of the Online Store sales channel to open the storefront.
2. On the storefront, start typing plum in the search bar and then select Plum jam 96 oz from the list of search
results.
3. On the page of Plum jam 96 oz, specify a quantity of 3, and click Add to cart. In the pop-up, click Check out.
4. On the order creation page (Information step), specify the needed settings as follows:
a. In the Contact information section, in the Email or mobile phone number box, specify
dheady@example.com.
b. In the Shipping address section, fill in the shipping address boxes as follows:
• Country/region: United States
• First name: Danny
• Last name: Heady
• Address: 2779 Cantebury Drive
• City: New York
• State: New York
• ZIP code: 10005
c. In the Gi card box, enter the code of the gi card that you received, and click Apply.
Notice that the order total has been reduced by the amount of the gi card ($25).
Integration with Shopify | 398
If you have not received the gi card by email, as a workaround, you can issue a new gi
card on the Gi Cards page, which you open by clicking Products > Gi cards in the le
menu of the admin area. To generate a new gi card code, you click Issue gi card, specify
the card balance, specify the optional expiration date, and then click Save. Make sure to
copy the generated gi card code because you will not be able to access it once you close
the page.
Step 9: Importing the Sales Order Paid with the Gi Card
To import the sales order, in Acumatica ERP, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Summary area of the form, specify the following settings:
• Store: SweetStore - SP
• Prepare Mode: Incremental
3. In the table, select the Selected check box in the row of the Sales Order entity.
4. On the form toolbar, click Prepare.
5. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
6. In the row of the Sales Order entity, click the link in the Ready to Process column.
Integration with Shopify | 399
7. On the Process Data (BC501500) form, which opens with the SweetStore - SP and the Sales Order entity
selected, in the row of the order you created (which you can find by its identifier in the External ID column
and empty ERP ID), select the unlabeled check box.
8. On the form toolbar, click Process.
9. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
On the Payments tab, notice that two prepayments have been applied to the order: a credit card payment
(mapped to the SHOPIFYPAY payment method) in the amount of $121.29 and a gi card payment (mapped
to the ONLINE payment method) in the amount of $25.
5. In the row of the gi card payment, which has an applied amount of $25, click the link in the Reference Nbr.
column.
On the Payments and Applications (AR302000) form, which opens in a pop-up window, review the payment
details.
Notice that the Description box contains the order number assigned to the related order in the Shopify
store and the identifier of the gi card used to pay the order.
The prepayment has the Balanced status because the Release Payments check box was cleared in the
mapping of the GIFT_CARD payment method in the table on the Payment Settings tab of the Shopify Stores
(BC201010) form.
You have finished processing a payment for the sales order with a gi certificate. In a production setting, you would
release the prepayment, which is beyond the scope of this activity.
Integration with Shopify | 400
In the topics of this chapter, you will read about how to export matrix items created in Acumatica ERP to a Shopify
store and how to import orders with matrix items from Shopify to Acumatica ERP.
Acumatica ERP Retail-Commerce Edition provides you with the ability to export template items, along with the
matrix items that were generated based on these template items, from Acumatica ERP to the Shopify store.
For details about managing template items in Acumatica ERP, see Managing Matrix Items.
Learning Objectives
In this chapter, you will learn how to do export template items and matrix items from Acumatica ERP to the Shopify
store.
Applicable Scenarios
You export matrix items from Acumatica ERP to the Shopify store in the following cases:
• You are initially configuring the Shopify store and need to transfer template items (and matrix items based
on these template items) that have already been defined in Acumatica ERP.
• You have updated any of the settings of a template item or matrix item in Acumatica ERP aer the template
item was synchronized with the Shopify store, and you need the changes to be reflected in the product
settings in the store.
For details about the information exported to the Shopify store during the synchronization of a template item, see
Template Item Entity.
You can specify the settings for each matrix item to determine if the item's quantity should be tracked and if selling
of the item should be allowed if the item's quantity becomes zero. To do this, on the eCommerce tab of the Stock
Items (IN202500) form, you select the options as follows:
• To track the quantity of the item, you select Set as Available (Track Qty.) in the Availability box. In Shopify,
on the product management page for the matrix item, the system selects the Track quantity check box in
the Inventory section.
• To allow including the item in orders even if its quantity is zero, you select Set as Pre-Order/Continue Selling
in the When Qty. Unavailable box (which is available only if Set as Available (Track Qty.) is selected in the
Availability box. In Shopify, on the product management page for the matrix item, the system selects the
Continue selling when out of stock check box in the Inventory section.
Integration with Shopify | 402
The following activity will walk you through the process of exporting a template item (and the matrix items based
on this template item) defined in Acumatica ERP to the Shopify store.
Story
Suppose that SweetLife Fruits & Jams company is going to sell juices in its Shopify online store. Acting as an
implementation consultant helping SweetLife to set up the integration of Acumatica ERP with the Shopify store,
you need to export the JUICE template item to the Shopify store.
Configuration Overview
In the U100 dataset, the following configuration tasks have been performed to prepare the system for this activity:
• On the Enable/Disable Features (CS100000) form, the Matrix Items feature has been enabled.
• On the Item Classes (IN201000) form, the MJUICE item class has been created.
• On the Attributes (CS205000) form, the attributes and the attribute values listed in the following table have
been defined.
Ingredient APL (Apple), CHR (Cherry), ORG (Orange), PCH (Peach), PNL (Pineapple), SWB
(Strawberry), and TMT (Tomato)
Package BOX (Box), GBT (Glass bottle), JAR (Jar), PBT (Plastic bottle), and TIN (Tin)
Volume 08OZ (08 fl oz), 12OZ (12 fl oz), 16OZ (16 fl oz), 32OZ (32 fl oz), and 96OZ (96 fl oz)
• On the Template Items (IN203000), the JUICE template item has been created based on the MJUICE item class
and the Ingredient, Package, and Volume attributes.
• On the Stock Items (IN202500) form, the matrix items listed in the following table have been generated
based on the JUICE template item.
Inventory ID Description
Inventory ID Description
Process Overview
In this activity, you will do the following:
1. On the Template Items (IN203000) form, review the JUICE template item.
2. On the Entities (BC202000) form, update the filtering conditions to export the template items of the MJUICE
item class.
3. On the Shopify Stores (BC201010) form, activate the Template Item entity.
4. On the Prepare Data (BC501000) form, prepare the template item data for synchronization.
5. On the Process Data (BC501500) form, process the template item data that has been prepared for
synchronization.
6. In the admin area of the Shopify store, review the exported item.
System Preparation
Before you complete the instructions in this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The Shopify store has been created and configured, as described in Initial Configuration: To Set Up a
Shopify Store.
• The connection to the Shopify store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Configure the Store Connection.
2. Launch the Acumatica ERP website with the U100 dataset preloaded, and sign in with the following
credentials:
• Username: gibbs
• Password: 123
4. In the Inventory ID Segment Settings table, notice the settings for the automatic generation of the
identifiers that have been assigned to matrix items. The segments are generated based on the attribute
values (Segment Type is set to Attribute Value for all segments), and the length of each segment is
determined by the value in the Number of Characters column.
5. On the Matrix Items tab, review the list of matrix items that have been generated based on the attributes
configured for the Juice template item.
In the subsequent steps of this activity, you will export these items to the Shopify store.
If you are not signed in to the admin area of the Shopify store in the same browser, you will
need to enter your sign-in credentials.
4. On the product management page, which opens for the Juice product, review the exported settings.
In the Variants table, notice that the variants of the product (which are the matrix items that were
generated in Acumatica ERP) are displayed.
You have now exported the template item and its matrix items to the Shopify store.
Product images and videos can help customers select the most suitable products and choose variants, such as
colors or patterns. In Acumatica ERP, you can save images of template items (such as a particular model of running
shoes), as well as images of the matrix items that were generated based on these template items (such as the colors
of this model of running shoes). You can then export the saved images to the Shopify store.
Integration with Shopify | 406
Learning Objectives
In this chapter, you will learn how to export images for template and matrix items from Acumatica ERP to the
Shopify store.
Applicable Scenarios
You export images for template items and matrix items from Acumatica ERP to the Shopify store in the following
cases:
• You are initially configuring the Shopify store and need to export template items and matrix items (including
images that have been saved for them) from Acumatica ERP to the store.
• You have updated the images of a template item or the images of a matrix item in Acumatica ERP aer the
template item was synchronized with the Shopify store, and you need the changes to be reflected in the
product settings in the store.
During the synchronization of the Product Image entity, images attached to a matrix item are exported to the
Shopify store and added to the product management page of the template item as follows:
• All exported images are added to the Media section.
• One of the exported images is added to the table in the Variants section (the Image column of the row of the
matrix item).
The template item and the matrix item must be synchronized with the Shopify store or created in the Shopify store
before images attached to the matrix item can be exported. Only the files with extensions for which the Image
check box is selected on the File Upload Preferences (SM202550) form can be exported.
If images are added for a matrix item as links in the Media URLs table on the eCommerce tab of the
Stock Items form (if the matrix item is a stock item) or Non-Stock Items form (if the matrix item is a
non-stock item), these images are not exported to Shopify.
Integration with Shopify | 407
The following activity will walk you through the process of exporting the product images added for a template item
and for a matrix item in Acumatica ERP to the Shopify store.
Story
Suppose that the SweetLife Fruits & Jams company wants to export to the Shopify store the images it has added
for the JUICE template and for one of its variants. Some images of the template item are stored in external storage.
The others, however, are attached to items in Acumatica ERP. Acting as an implementation consultant helping
SweetLife to set up the integration of Acumatica ERP with the Shopify store, you need to export to the Shopify store
an image of the JUICE template item and a matrix item generated from this template item.
Configuration Overview
In the U100 dataset, for the purposes of this activity, the following steps have been performed:
• On the Enable/Disable Features (CS100000) form, the Matrix Items feature has been enabled.
• On the Template Items (IN203000) form, the JUICE template item has been created.
• On the Stock Items (IN202500) form, the PCH-32OZ-GBT matrix item has been generated from the JUICE
template item.
Process Overview
In this activity, you will do the following:
1. On the Template Items (IN203000) form, add an image for the template item.
2. On the Stock Items (IN202500) form, add an image for the stock item (which is a matrix item generated from
the JUICE template).
3. On the Prepare Data (BC501000) form, prepare the template item data for synchronization; on the Process
Data (BC501500) form, process the template item data.
4. In the admin area of the Shopify store, review the exported images.
5. On the Shopify Stores (BC201010) form, activate the Product Image entity.
6. On the Prepare Data (BC501000) form, prepare the product image data for synchronization; on the Process
Data (BC501500) form, process the product image data.
7. In the admin area of the Shopify store, review the exported images.
System Preparation
Before you complete the instructions in this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The Shopify store has been created and configured, as described in Initial Configuration: To Set Up a
Shopify Store.
• The connection to the Shopify store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Configure the Store Connection.
Integration with Shopify | 408
URL Type
http://acumatica-builds.s3.amazonaws.com/builds/Universi- Image
ty/CommerceTraining/Juice3.png
Incremental indicates that only the records that have been modified since the last successful data
synchronization will be prepared.
3. In the table, select the Selected check box in the row of the Template Item entity.
4. On the form toolbar, click Prepare.
5. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
6. In the row of the Template Item entity, click the link in the Ready to Process column.
7. On the Process Data (BC501500) form, which opens with the SweetStore - SP store and the Template Item
entity selected, select the unlabeled check box in the row of the JUICE template item (for which the ERP ID
column shows Juice).
8. On the form toolbar, click Process.
9. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
5. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
6. In the row of the Product Image entity, click the link in the Ready to Process column.
7. On the toolbar of the Process Data (BC501500) form, which opens with the SweetStore - SP store and the
Product Image entity selected, click Process All.
8. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
The display of images may differ depending on the theme applied to the store.
Acumatica ERP Retail-Commerce Edition provides you with the ability to track the availability of template items
(and matrix items based on them) that you sell in the Shopify store and maintain in Acumatica ERP. You have the
flexibility to configure which quantities of items should be included in calculations of the quantities available for
sale in the online store.
Learning Objectives
In this chapter, you will learn how to do the following:
• Determine how the available quantities of template and matrix items exported to the Shopify store should
be calculated
• Set up quantity tracking for matrix items exported to the Shopify store
• Synchronize the available quantities of exported matrix items for which quantity tracking is turned on
Integration with Shopify | 411
Applicable Scenarios
You track available quantities of matrix items exported to the Shopify store if you want to make these items
available for purchase by shoppers through the storefront only if there is a sufficient quantity in stock.
To avoid discrepancies in sales orders imported into Acumatica ERP, we recommend that before
changing an item's sales UOM you make sure that there are no unsynchronized sales orders that
contain the item. Also, you should synchronize the item's available quantity immediately aer
changing its sales UOM so that new orders for the item are created in the Shopify store with the
updated UOM.
In this activity, you will specify the default availability settings for the Shopify store, as well as the availability
settings for a particular template item and the matrix items generated based on this template item. You will then
export the product availability data to the Shopify store and review the results of the export.
Integration with Shopify | 412
Story
Suppose that the SweetLife Fruits & Jams company wants to sell several variants of juices in its online store.
The company needs to track the quantity of juice available for shipping from a particular location of its retail
warehouse.
Acting as an implementation consultant helping SweetLife to set up the integration of Acumatica ERP with the
Shopify store, you need to export to the Shopify store the availability settings of the JUICE template item and the
matrix items based on this template item. You also need to export the quantities of matrix items available for
shipping from the JS3 warehouse location of the RETAIL warehouse.
To explore how various availability settings specified for the store, template item, and matrix items in Acumatica
ERP affect the availability settings of the exported template item and matrix items in Shopify, you will gain
familiarity with various availability settings for items.
Configuration Overview
For the purposes of this activity, the following tasks have been performed in the U100 dataset:
• On the Enable/Disable Features (CS100000) form, the Multiple Warehouses and Multiple Warehouse Locations
features have been enabled.
• On the Warehouses (IN204000) form, the RETAIL warehouse and the JS3 warehouse location have been
configured.
• On the Template Items (IN203000) form, the JUICE template item has been defined.
• On the Stock Items (IN202500) form, the matrix items based on the JUICE template item have been defined.
Process Overview
In this activity, you will do the following:
1. On the Shopify Stores (BC201010) form, activate the needed entity.
2. On the Shopify Stores form, review the default availability settings.
3. On the Template Items (IN203000) form, update the availability settings of the JUICE template item.
4. On the Stock Items (IN202500) form, update the availability settings of the matrix items that have been
generated based on the JUICE template item.
5. On the Storage Details by Item Warehouse Location (IN408055) form, review the quantities of the matrix
items available in the JS3 location of the RETAIL warehouse.
6. On the Prepare Data (BC501000) form, prepare the template item data for synchronization; on the Process
Data (BC501500) form, process the prepared data.
7. On the Prepare Data form, prepare the product availability data for synchronization; on the Process Data
form, process the prepared data.
8. In the admin area of the Shopify store, review the items' settings and exported quantities.
System Preparation
Before you complete the instructions in this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The Shopify store has been created and configured, as described in Initial Configuration: To Set Up a
Shopify Store.
Integration with Shopify | 413
• The connection to the Shopify store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Configure the Store Connection.
2. Launch the Acumatica ERP website with the U100 dataset preloaded, and sign in with the following
credentials:
• Username: gibbs
• Password: 123
The Store Default option is specified in the Availability box for all other matrix items based on the JUICE template
item; you will not change this option for these items.
3. In the table, select the Selected check box in the rows of the Template Item entity.
4. On the form toolbar, click Prepare.
5. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
6. In the row of the Template Item entity, click the link in the Ready to Process column.
7. On the Process Data (BC501500) form, which opens with the SweetStore - SP store and the Template Item
entity selected, select the check box in the row of the Juice template item.
8. On the form toolbar, click Process.
9. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
8. On the product management page of Pineapple / Glass bottle / 16 fl oz, notice that the Track quantity check
box is cleared.
9. In the Variants section, click Orange / Glass bottle / 16 fl oz.
10.On the product management page of Orange / Glass bottle / 16 fl oz, notice that the Track quantity check
box is selected, the Continue selling when out of stock check box is cleared, and in the Available box of
the Quantity subsection, the available quantity of the item is displayed.
For all other items, the Track quantity check box is cleared because the Availability setting for each of
them was set to Store Default on the eCommerce tab of the Stock Items (IN202500) form and the default
availability setting specified for the SweetStore - SP store on the Shopify Stores (BC201010) form was Set as
Available (Don't Track Qty.).
Acumatica ERP Retail-Commerce Edition provides you with the ability to sell matrix items created in Acumatica ERP
in a Shopify store.
Learning Objectives
In this chapter, you will learn how sales orders containing matrix items (also referred to as product variants in
Shopify) are imported to Acumatica ERP from a Shopify store and how these items appear in imported sales orders.
Applicable Scenarios
You import a sales order with matrix items if you offer products with variants in your Shopify store and a customer
places an order that contains at least one variant.
The following activity will walk you through the processes of purchasing products with variants (matrix items) in
the Shopify store and importing the sales order with these products into Acumatica ERP.
Story
Suppose that SweetLife Fruits & Jams sells juices (which are defined in Acumatica ERP as matrix items based on
the JUICE template item) in its Shopify store. Acting as an implementation consultant helping SweetLife to set up
the integration between Acumatica ERP and the Shopify store, you want to explore how online orders containing
matrix items (product variants) are imported to Acumatica ERP and review the results of the import.
Integration with Shopify | 417
Process Overview
In this activity, you will do the following:
1. On the storefront of the Shopify store, place an order with two variants of the Juice product.
2. On the Prepare Data (BC501000) form, prepare the sales order data for synchronization; on the Process Data
(BC501500) form, process the prepared data.
3. On the Sales Orders (SO301000) form, review the imported sales order.
System Preparation
Before you complete the instructions in this activity, do the following:
1. Make sure that the following prerequisites have been met:
• The Shopify store has been created and configured, as described in Initial Configuration: To Set Up a
Shopify Store.
• The connection to the Shopify store has been established and the initial configuration has been
performed, as described in Initial Configuration: To Configure the Store Connection.
• The JUICE template item has been exported to the Shopify store, as described in Sale of Matrix Items: To
Export Matrix Items.
• The SHOPIFYPAY payment method has been defined and mapped to the store payment method
configured for the Shopify Payments payment provider, as described in Order Synchronization: To
Configure and Import Shopify Payments.
2. Sign in to the admin area of the Shopify store as the store administrator.
For the purposes of this activity, you do not need to process the sales order.
Retail-Commerce Edition Form Reference | 420
BigCommerce Stores
• This form is available only if the Commerce Integration and BigCommerce Connector features
are enabled on the Enable/Disable Features (CS100000) form.
• The number of BigCommerce stores to which you can establish a connection on this form is
limited by your license.
Form Toolbar
The form toolbar includes standard and form-specific buttons and commands. For the list of standard buttons, see
Form Toolbar. The form-specific commands are listed in the following table.
Button Description
Test Connection By using the information specified on the Connection Settings tab, tests the
ability to connect to the BigCommerce store via the API and to connect to the
BigCommerce file storage via WebDAV.
Summary Area
In this area, you specify the basic settings of a particular BigCommerce store, or select a store to view and edit its
settings.
Element Description
Connector A read-only box with the name of the e-commerce connector (BigCommerce)
of a store configured on this form.
Store Name The name of the BigCommerce store to which the connection is being con-
figured. The store name is specified when the connection is first configured;
you cannot change it later.
Retail-Commerce Edition Form Reference | 421
Element Description
Active A check box that indicates (if selected) that the store configuration is active
and the entities activated and configured for this store are synchronized be-
tween Acumatica ERP and the store.
For inactive stores, you can modify the store settings on the current form,
but entities are not synchronized; you can see the history of the synchroniza-
tion of entities on the Sync History (BC301000) form.
Default A check box that you select to indicate that this store is the default store in
Acumatica ERP.
If multiple stores have been configured on this form and on the Shopify
Stores (BC201010) form, if applicable, when you open other commerce-relat-
ed forms, the store you have defined as the default is automatically inserted
in the Store box.
The system requires a store to be defined as the default store. When you are
defining the first store in the system—on this form or on the Shopify Stores
form—this check box is selected automatically. When you define another
store, this check box is cleared by default; if you select this check box for the
store being defined, the system clears this check box for the store that was
previously defined as the default store.
Element Description
Store Admin Path The administrator URL of the BigCommerce store—that is, the store's perma-
nent URL followed by /manage.
Acumatica ERP uses this path when a user navigates to BigCommerce pages
from the Sync History (BC301000) and Process Data (BC501500) forms.
Element Description
Client ID An ID that is provided by BigCommerce when a new store is set up on the Big-
Commerce platform.
Access Token An access token provided by BigCommerce when a new store is set up on the
BigCommerce platform.
The access token should have the necessary access permissions in BigCom-
merce for synchronization to work properly.
Retail-Commerce Edition Form Reference | 422
Element Description
WebDAV Path The URL of the store used for file management. This path facilitates the ex-
change of data between Acumatica ERP and the BigCommerce store. Specif-
ically, this path is the store's permanent URL followed by DAV. This URL is
used by Acumatica ERP to upload files and images to the BigCommerce
store.
WebDAV Username The email address of the registered owner of the BigCommerce store, which
is used to connect to the BigCommerce store.
WebDAV Password The password that is used to connect to the BigCommerce file storage.
The WebDAV password is a string of random letters and numbers. You can
find this password on the File Access page of the BigCommerce control pan-
el.
Element Description
Element Description
Default Currency The currency specified as the default in the BigCommerce store.
Element Description
Administrator The administrator of the BigCommerce store, which is the user who re-
ceives notifications about aborted synchronization that are triggered by
predefined business events. For more information about predefined busi-
ness events for aborted synchronization records, see Automated Synchro-
nization: Business Events for Aborted Records.
Retail-Commerce Edition Form Reference | 423
Element Description
Max. Number of Stores The maximum number of BigCommerce stores that can be connected to the
Acumatica ERP instance.
Column Description
Active A check box that indicates (if selected) that the entity is synchronized be-
tween Acumatica ERP and the BigCommerce store.
Entity The entity that can be synchronized between Acumatica ERP and the Big-
Commerce store, which is one of the following:
• Customer Price Class
• Customer
For information about the data that is synchronized as part of this entity
and standard mapping of fields, see Customer Entity.
• Customer Location
For information about the data that is synchronized as part of this entity
and standard mapping of fields, see Customer Location Entity.
• Sales Category
For information about the data that is synchronized as part of this entity
and standard mapping of fields, see Sales Category Entity.
• Stock Item
For information about the data that is synchronized as part of this entity
and standard mapping of fields, see Stock Item Entity.
• Non-Stock Item
For information about the data that is synchronized as part of this entity
and standard mapping of fields, see Non-Stock Item Entity.
• Template Item
For information about the data that is synchronized as part of this entity
and standard mapping of fields, see Template Item Entity.
• Base Sales Price
• Price List
Retail-Commerce Edition Form Reference | 424
Column Description
• Product Image
• Product Availability
For information about the data that is synchronized as part of this entity
and standard mapping of fields, see Product Availability Entity.
• Sales Order
For information about the data that is synchronized as part of this entity
and standard mapping of fields, see Sales Order Entity.
• Payment
For information about the data that is synchronized as part of this entity
and standard mapping of fields, see Payment Entity.
• Shipment
For information about the data that is synchronized as part of this entity
and standard mapping of fields, see Shipment Entity.
• Refund
You can click the link with each entity name to open the Entities (BC202000)
form in a pop-up window and specify the mapping and filtering settings for
the entity.
Sync Direction The direction in which the entity should be synchronized. The direction can
be one of the following:
• Export: Data is exported from Acumatica ERP to the BigCommerce store.
• Import: Data is imported to Acumatica ERP from the BigCommerce store.
• Bidirectional: Data is synchronized between Acumatica ERP and the Big-
Commerce store in both directions.
The direction of the synchronization is predefined by the system and cannot
be changed for the following entities:
• Stock Item (predefined as Export)
• Non-Stock Item (predefined as Export)
• Template Item (predefined as Export)
• Base Sales Price (predefined as Export)
• Price List (predefined as Export)
• Product Image (predefined as Export)
• Product Availability (predefined as Export)
• Payment (predefined as Import)
• Shipment (predefined as Import)
Retail-Commerce Edition Form Reference | 425
Column Description
Primary System The system that is used as the source of data during the synchronization of
entities. If bidirectional synchronization is selected for the entity, the data
of the primary system takes precedence if any conflicts arise during the syn-
chronization.
The primary system can be either of the following:
• ERP (that is, Acumatica ERP)
• External System (that is, the BigCommerce store)
The primary system is determined based on the Sync Direction setting as
follows:
• For Export, ERP is set to be the primary system and cannot be changed.
• For Import, External System is set to be the primary system and cannot
be changed.
• For Bidirectional, you can select which system should be used as the pri-
mary system based on your processes.
Real-Time Import The status of the real-time import for the entity. The status can be one of
the following options:
• Stopped: Real-time synchronization has not been started for the Import
direction.
• Running: Real-time synchronization has been started for the Import di-
rection.
• Not Supported: Real-time synchronization cannot be started for the Im-
port direction.
Real-Time Export The status of the real-time export for the entity. The status can be one of the
following:
• Stopped: Real-time synchronization has not been started for the Export
direction.
• Running: Real-time synchronization has been started for the Export di-
rection.
• Not Supported: Real-time synchronization cannot be started for the Ex-
port direction.
Real-Time Mode The mode of the processing of the synchronization records, which can be ei-
ther of the following:
• Prepare: As soon as a push notification about a change to data is re-
ceived, the corresponding synchronization record is placed in the pro-
cessing queue.
• Prepare & Process: As soon as a push notification about a change to da-
ta is received, the corresponding synchronization record is placed in the
processing queue, and the data synchronization process is immediately
started for the synchronization record.
Retail-Commerce Edition Form Reference | 426
Column Description
Max. Number of Failed At- The maximum number of errors allowed during the import or export of data
tempts before the synchronization record is skipped (that is, excluded from further
synchronization).
By default, the column contains 5: That is, the system allows 5 failed at-
tempts before excluding the synchronization record from further process-
ing.
Element Description
Customer Class The customer class that is assigned to new customers imported to Acumatica
ERP from the BigCommerce store and thus used to provide their default set-
tings.
Customer Numbering Tem- The template that is used to provide the identifiers of new customers import-
plate ed to Acumatica ERP from the BigCommerce store. This character string, such
as ____-____-######, initially shows the number and length of segments in
the CUSTOMER segmented key, which is configured on the Segmented Keys
(CS202000) form and defines the structure of the identifiers used for customers
in Acumatica ERP. The groups of underscores represent the constant segments,
and the number signs represent the auto-numbered segment.
You replace the underscores with the values of the constant segments to be
used in the identifiers of the customers imported from the BigCommerce store,
as shown in the following example: ECUS-RET1-######. With this setting, the
identifiers of all customers imported from BigCommerce to Acumatica ERP
would start with ECUS-RET1, for easy identification, and the system would au-
tomatically assign the numerical part of the identifier according to the number-
ing sequence selected in the Customer Auto-Numbering box. These settings do
not affect the assignment of identifiers to other customers in the system (those
that already exist or those that are created directly in Acumatica ERP).
This box is available for editing only if the CUSTOMER segmented key has more
than one segment.
If you will be importing customers from an online store, one of the segments of
the CUSTOMER segmented key must be automatically numbered.
Retail-Commerce Edition Form Reference | 427
Element Description
Customer Auto-Numbering The numbering sequence that the system uses to automatically generate identi-
fiers for customers imported from the BigCommerce store.
If the CUSTOMER segmented key consists of more than one segment, the num-
bering sequence that you select in this box applies to the automatically num-
bered segment (a group of number signs in the Customer Numbering Tem-
plate box). The length of the numbering sequence must match the length of the
auto-numbered segment.
Selecting a numbering sequence in this box does not change the Numbering ID
setting of the CUSTOMER segmented key on the Segmented Keys form. The se-
lected numbering sequence applies only to customers that are imported from
the BigCommerce store and does not affect the assignment of identifiers to oth-
er customers in the system (those that already exist or those that are created di-
rectly in Acumatica ERP).
Location Numbering Tem- The template that is used to provide the identifiers of new customer locations
plate imported to Acumatica ERP from the BigCommerce store. This character string,
such as ____-____-######, initially shows the number and length of segments
in the LOCATION segmented key, which is configured on the Segmented Keys
form and defines the structure of the identifiers used for customer locations
in Acumatica ERP. The underscores represent the constant segments, and the
number signs represent the automatically numbered segment.
You replace the underscores with values of the constant segments to be used in
the identifiers of the customer locations imported from the BigCommerce store,
as shown in the following example: ECUS-RET1-######. With this setting, the
identifiers of all customer locations imported from BigCommerce to Acumatica
ERP would start with ECUS-RET1, for easy identification, and the system would
automatically assign the numerical part of the identifier according to the num-
bering sequence selected in the Location Auto-Numbering box. These settings
do not affect the assignment of identifiers to other customer locations in the
system (those that already exist or those that are created directly in Acumatica
ERP).
This box is available for editing only if the LOCATION segmented key has more
than one segment.
If you will be importing customer locations from an online store, one of the seg-
ments of the LOCATION segmented key must be automatically numbered.
Location Auto-Numbering The numbering sequence that the system uses to automatically generate identi-
fiers for customer locations imported from the BigCommerce store.
If the LOCATION segmented key consists of more than one segment, the num-
bering sequence that you select in this box applies to the automatically num-
bered segment (a group of number signs in the Location Numbering Template
box). The length of the numbering sequence must match the length of the au-
to-numbered segment.
Selecting a numbering sequence in this box does not change the Numbering ID
setting of the LOCATION segmented key on the Segmented Keys form. The se-
lected numbering sequence applies only to customer locations that are import-
ed from the BigCommerce store and does not affect the assignment of identi-
fiers to other customer locations in the system (those that already exist or those
that are created directly in Acumatica ERP).
Retail-Commerce Edition Form Reference | 428
Element Description
Generic Guest Customer The generic customer account that appears on imported sales orders that were
placed in the BigCommerce store as guest orders. This customer account is not
exported to the BigCommerce store during the synchronization of customers.
Use Multiple Guest Ac- A check box that indicates (if selected) that multiple guest customer accounts
counts should be created to record imported guest sales orders.
When this check box is selected, this system limits the number of sales orders
that can be created in Acumatica ERP for the customer account selected in the
Generic Guest Customer box. When the maximum allowed number of sales or-
ders is exceeded, the system creates a new customer and inserts its identifier
in the Generic Guest Customer box. The settings of the new customer account
are copied from the previous generic guest customer account, and its identifier
is generated based on the numbering sequence specified in the Customer Au-
to-Numbering box.
By default, the allowed number of sales orders per guest customer account is
limited to 10,000. You can override this number by changing the value of the
MaxOrdersPerGuestAccount parameter in the web.config file.
Element Description
Default Stock Categories The item sales categories that are assigned by default to exported stock items
that do not have item sales categories assigned in Acumatica ERP.
In the multiselect drop-down list, you select the check box of each item sales
category to be assigned to these items, and the system displays the selected
categories in the box, separated by commas. The categories available for selec-
tion are those that have been defined on the Item Sales Categories (IN204060)
form.
Sales categories are synchronized during the synchronization of the Sales Cate-
gory entity.
During the synchronization of stock items, sales categories are assigned to ex-
ported stock items only if the Sales Category entity is activated on the Entity
Settings tab of the BigCommerce Stores (BC201000) form.
Retail-Commerce Edition Form Reference | 429
Element Description
Default Non-Stock Cate- The item sales categories that are assigned by default to exported non-stock
gories items that do not have item sales categories assigned in Acumatica ERP.
In the multiselect drop-down list, you select the check box of each item sales
category to be assigned to these items, and the system displays the selected
categories in the box, separated by commas. The categories available for selec-
tion are those that have been defined on the Item Sales Categories form.
Sales categories are synchronized during the synchronization of the Sales Cate-
gory entity.
During the synchronization of non-stock items, sales categories are assigned to
exported non-stock items only if the Sales Category entity is activated on the
Entity Settings tab of the BigCommerce Stores (BC201000) form.
Related Items The types of related item information that can be exported to the BigCommerce
store. In the multiselect drop-down list, you select the check box of each type
of related items to be exported, and the system displays the selected related
item types in the box, separated by commas. You can select any of the following
types:
• Cross-Sell
• Up-Sell
• Substitute
• Other
If an item is specified as a related item of any of the selected types, for any of
the following items, information about this item is exported to the BigCom-
merce store during the synchronization of the respective entity as follows:
• For a stock item on the Related Items tab of the Stock Items (IN202500): The
Stock Item entity
• For a non-stock item on the Related Items tab of the Non-Stock Items
(IN202000) form: The Non-Stock Item entity
• For a template item on the Related Items tab of the Template Items
(IN203000) form: The Template Item entity
Default Visibility The default visibility that is assigned to stock and non-stock items exported to
the BigCommerce store. You can select one of the following options:
• Visible: The items are visible on the storefront immediately after synchro-
nization with the store.
• Featured: The items are visible on the storefront and are listed among fea-
tured products displayed on the front page of the store.
• Invisible: The items are exported to the product list of the external e-com-
merce system but do not appear on the storefront.
Retail-Commerce Edition Form Reference | 430
Element Description
Default Availability The default availability that is assigned to stock and non-stock items exported
to the BigCommerce store. You can select one of the following options:
• Set as Available (Track Qty.): The exported items are available in the BigCom-
merce store, and their quantities are tracked.
• Set as Available (Don't Track Qty.): The exported items are available in the
BigCommerce store, and their quantities are not tracked.
• Set as Pre-Order: The exported items are available for pre-order.
• Do Not Update: The availability status and the available quantities of items
are not updated in the store.
• Set as Unavailable: The exported items are marked as unavailable for pur-
chasing.
The default availability can be overridden for each particular item on the eCom-
merce tab of Stock Items (IN202500), Non-Stock Items (IN202000), or Template
Items (IN203000) form.
When Qty. Unavailable The action that the system must perform on an item when there is no stock le.
You can select one of the following options:
• Do Nothing: No action should be performed.
• Set as Disabled: The item should be made unavailable for purchasing.
• Set as Pre-Order: The item should be made available for pre-order.
This box is available only if the Default Availability is set to Set as Available
(Track Qty.).
The setting is applied to products in BigCommerce during the synchronization
of the Product Availability entity.
Availability Mode The type of item quantity that is exported to the BigCommerce store during the
synchronization of the Product Availability entity. You can select one of the fol-
lowing options:
• Available: The item's available quantity in BigCommerce is based on the en-
tire available quantity of the item in Acumatica ERP.
• Available for Shipping: The item's available quantity in BigCommerce is
based on the quantity available for shipping in Acumatica ERP.
• On Hand: The item's available quantity in BigCommerce is based on the on-
hand quantity in all warehouses or only specific warehouses (or warehouse
locations), depending on the Warehouse Mode setting.
For information about availability calculation in Acumatica ERP, see Configura-
tion of Availability Calculation Rules: General Information.
Retail-Commerce Edition Form Reference | 431
Element Description
Warehouse Mode An option that determines whether all warehouses or specific warehouses and
locations are used for determining the available quantity of the item in the Big-
Commerce store.
You can select one of the following options:
• All Warehouses: The available quantity of the item is calculated based on the
on-hand quantity of the item in all warehouses.
• Specific Warehouses: The available quantity of the item is calculated based
on the on-hand quantity in the selected warehouses and warehouse loca-
tions. If this option is selected, a list of warehouses and warehouse locations
to be used should be specified.
Table: Table
In this table, you select the specific warehouses and locations whose item quantities should be used to calculate
the item's available quantity in the BigCommerce store. This table is displayed if the Warehouse Mode is set to
Specific Warehouses.
The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.
Column Description
Warehouse The identifier of the warehouse in Acumatica ERP whose item quantity should
be used for calculating the item's available quantity in the BigCommerce
store.
You can select a warehouse from the list, which contains all active warehous-
es that have been created on the Warehouses (IN204000) form.
Location ID The identifier of the warehouse location from Acumatica ERP that contains
inventory items whose availability data should be exported to the BigCom-
merce store.
If you specify a location, only this specific location of the selected warehouse
is used. If no location is selected, the system exports the availability data for
items stored in all locations of the selected warehouse.
You can select a warehouse location from the list of locations that have been
created on the Warehouses form for the warehouse selected in the Ware-
house column. The list displays only the locations that are active and sales
from which are allowed—that is, the locations for which the Active and Sales
Allowed check boxes are selected on the Location tab of the Warehouses
form.
Element Description
Branch The branch that is inserted in the sales orders and payments imported to
Acumatica ERP from the BigCommerce store.
The base currency of the branch must match the default currency of the Big-
Commerce store, which is displayed in the Default Currency box of the Store
Properties section on the Connection Settings tab.
Element Description
Order Type for Import The order type in Acumatica ERP that is assigned to imported sales orders to
indicate that the orders have originated in the BigCommerce store.
Order Types for Export The types of orders in Acumatica ERP to be exported to the BigCommerce
store.
Orders of these types are exported to the BigCommerce store only if the syn-
chronization direction of the Sales Order entity is set to Export or Bidirectional
for that store on this form or on the Entities (BC202000) form.
This box is available only if the Custom Order Types feature is enabled on the
Enable/Disable Features (CS100000) form.
Return Order Type The order type that the system will use as a source of default settings for cre-
ating a return order when a refund is issued in the BigCommerce store. You
can select only an order type with the following settings on the Template tab
of the Order Types (SO201000) form:
• Automation Behavior: RMA Order
• Default Operation: Receipt
• AR Document Type: Credit Memo
Refund Amount Item The non-stock item that is used to represent a refund amount in an imported
sales order. The non-stock item selected in this box is excluded from synchro-
nization and is not exported when the Non-Stock Item entity is synchronized.
The non-stock item representing refund amounts should be exempt from
taxes (that is, on the General tab of the Non-Stock Items (IN202000) form, in
the Tax Category box, a category corresponding to tax-exempt items should
be assigned). Also on this tab, the Require Receipt and Require Shipment
check boxes must be cleared for the item.
Refund Reason Code The reason code that the system will insert in each return order line for a re-
fund or return imported from the Shopify store. The reason code must have
the Issue usage type specified on the Reason Codes (CS211000) form.
Order Time Zone The time zone the system will use for each sales order imported from the Big-
Commerce store when it is created in Acumatica ERP. The order time zone is
needed to determine the correct date and time of the order if Acumatica ERP
and the BigCommerce store are located in different time zones.
Retail-Commerce Edition Form Reference | 433
Element Description
Show Discounts As The level on which discounts appear in each sales order imported from Big-
Commerce. You can select either of the following options:
• Line Discounts: Discounts applied to the order are distributed between the
sales order lines and appear in the Discount Amount column on the De-
tails tab of the Sales Orders (SO301000) form.
• Document Discounts: Discounts applied to the order are aggregated and
displayed on the Discounts tab of the Sales Orders form.
You can select this option only if the Customer Discounts fea-
ture is enabled on the Enable/Disable Features (CS100000)
form.
Gi Certificate Item The non-stock item in Acumatica ERP that is used to record the sale of gi
certificates in the BigCommerce store. This item is excluded from synchro-
nization (that is, it is not exported to the BigCommerce store during the syn-
chronization of the Non-Stock Item entity).
Gi Wrapping Item The non-stock item in Acumatica ERP that is used to represent gi wrapping
in sales orders, shipments, and invoices. This item is excluded from synchro-
nization (that is, it is not exported to the BigCommerce store during the syn-
chronization of the Non-Stock Item entity).
On the Non-Stock Items (IN202000) form, this non-stock item has the Non-
Stock Item or Service type (the Type box in the Item Defaults section of the
General tab of the ) and the Active, No Purchases, or No Request status (Item
Status box in the Summary area).
Tag Ext. Order with ERP Order A check box that indicates (if selected) that after a sales order has been
Nbr. imported from the BigCommerce store and assigned an order number in
Acumatica ERP, the assigned order number should be exported to the Big-
Commerce store and saved as a metafield of the sales order.
Earliest Order Date The earliest order creation date included in synchronization. Orders created
in the BigCommerce store earlier than this date are not imported to Acumati-
ca ERP even if synchronization is performed in Full preparation mode.
Element Description
Tax Synchronization A check box that indicates (if selected) that taxes should be synchronized be-
tween Acumatica ERP and the BigCommerce store during the export or im-
port of sales orders.
Default Tax Zone The identifier of the tax zone that is assigned by default to each sales order
imported to Acumatica ERP from the BigCommerce store if no other tax zone
has been identified during the import of the order.
The box is available if the Tax Synchronization check box is selected.
Retail-Commerce Edition Form Reference | 434
Element Description
Use as Primary Tax Zone A check box that you select to indicate that the tax zone selected in Default
Tax Zone should be assigned to each sales order imported to Acumatica ERP
from the BigCommerce store, regardless of whether any other tax zone has
been identified during the import of the order.
This box is available if the Default Tax Zone is specified.
Element Description
Tax List The substitution list to be used for mapping tax IDs between Acumatica ERP
and the BigCommerce store.
During the import of each sales order, if the system cannot find the tax ID
specified in the order, it checks if there is a mapped tax ID in the substitution
list specified in this box.
Substitution lists are defined on the Substitution Lists (SM206026) form.
Tax Category List The substitution list to be used for mapping tax categories Acumatica ERP
with tax classes in the BigCommerce store.
During the import of a sales order, if the system cannot find the tax category
specified in the order, it checks if there is a mapped tax category in the sub-
stitution list specified in this box.
Substitution lists are defined on the Substitution Lists form.
Column Description
Active A check box that indicates (if selected) that the system should use the
mapped ship via, shipping zone, and shipping terms when importing orders
from the BigCommerce store.
Retail-Commerce Edition Form Reference | 435
Column Description
Store Shipping Zone The shipping zone that has been set up in the BigCommerce store.
Store Shipping Method The shipping method for the specified shipping zone that has been set up in
the BigCommerce store.
For each store shipping zone, one of the values in this column is always None
even though this shipping method does not exist in the BigCommerce store.
Ship Via The ship via code in Acumatica ERP that is mapped to the combination of the
store shipping zone and the store shipping method.
The value selected in this column is assigned to orders imported into
Acumatica ERP and is displayed on the Shipping tab of the Sales Orders
(SO301000) form for these orders.
Shipping Zone The identifier of the shipping zone in Acumatica ERP, which is defined on the
Shipping Zones (CS207510) form, that is mapped to the combination of the
store shipping zone and the store shipping method. The value selected in this
column is assigned to each sales order imported to Acumatica ERP with the
store shipping zone and store shipping method specified in this row. This val-
ue is also inserted on the Shipping tab of the Sales Orders form for the sales
order.
This value is optional. If you leave it empty, the Shipping Zone box on the
Shipping tab of the Sales Orders form will not be populated when a sales or-
der with the store shipping zone and store shipping method specified in the
row is imported.
Shipping Terms The identifier of the shipping terms in Acumatica ERP, which is defined on
the Shipping Terms (CS208000) form, that is mapped to the combination of
the store shipping zone and store shipping method. The value selected in
this column is assigned to each sales order imported to Acumatica ERP with
the store shipping zone and store shipping method specified in this row. This
value is also inserted in the Shipping Terms box on the Shipping tab of the
Sales Orders form for the sales order.
This value is optional. If you leave it empty, the Shipping Terms box on the
Shipping tab of the Sales Orders form will not be populated when a sales or-
der with the store shipping zone and store shipping method specified in the
row is imported.
Column Description
Active A check box that indicates (if selected) that payment processing is enabled
for the payment method.
If this check box is cleared for a payment method, when an order is placed in
the BigCommerce store and this payment method is selected at checkout,
the corresponding payment is not imported from the BigCommerce store to
Acumatica ERP.
This check box is cleared by default.
Store Payment Method The payment method defined in the BigCommerce store. This column is
populated automatically. However, you can manually add additional map-
pings of payment options, if necessary.
The system populates the table with the following store payment methods
even if these store payment methods have not been configured in the Big-
Commerce store:
• AMAZON
• GIFTCERTIFICATE (GIFT_CERTIFICATE)
• PAYPAL
• STORECREDIT (STORE_CREDIT)
• TEST PAYMENT GATEWAY
Store Currency The currency for which the store payment method has been defined in the
BigCommerce store.
You can select a currency from the list of active currencies defined on the
Currencies (CM202000) form. This column is filled in automatically for store
payment methods added to the table automatically by the API.
ERP Payment Method The identifier of the payment method in Acumatica ERP. This payment
method is used to create payment documents in Acumatica ERP for import-
ed payments based on the store payment method.
Cash Account The cash account associated with the payment method in Acumatica ERP.
You can select only cash accounts in the store currency.
Proc. Center ID The processing center configured in Acumatica ERP for the card-based pay-
ment method selected in the ERP Payment Method column and the cash
account selected in the Cash Account column.
This column is displayed if the Integrated Card Processing feature is enabled
on the Enable/Disable Features (CS100000) form.
Release Payments A check box that you select to indicate that payments should be automati-
cally released as soon as they are imported to Acumatica ERP.
If this check box is selected for a card-based payment method associated
with a credit card processing center in Acumatica ERP (that is, for the pay-
ment method for which a processing center is selected in the Proc. Center
ID column), only payments that have been captured in the store will be auto-
matically released on import.
Retail-Commerce Edition Form Reference | 437
Column Description
Process Refunds A check box that you select to indicate that refunds issued in the store for the
store payment method should be imported to Acumatica ERP.
This check box is selected and unavailable for a card-based store payment
method (Authorize.Net) that is mapped to a payment method in Acumati-
ca ERP for which a processing center has been configured on the Processing
Centers (CA205000) form and specified in the Proc. Center ID column of this
table.
Create Payment from Order A check box that indicates (if selected) that if a payment is imported from
the BigCommerce store without payment details, the system should create
a payment in Acumatica ERP based on the information from the imported
sales order.
This check box is selected by default for the following store payment meth-
ods:
• AMAZON
• PAYPAL
• TEST PAYMENT GATEWAY
For card-based payment methods with integrated card processing (that is,
for card-based payment methods for which a processing center has been
configured and selected in the table), this check box is cleared and unavail-
able.
This column is hidden by default.
Store Order Payment Method The payment method that is specified in the store order.
This column is hidden by default.
Shopify Stores
• This form is available only if the Commerce Integration and Shopify Connector features are
enabled on the Enable/Disable Features (CS100000) form.
• The number of Shopify stores to which you can establish a connection on this form is limited
by your license.
Retail-Commerce Edition Form Reference | 438
Form Toolbar
The form toolbar includes standard and form-specific buttons and commands. For the list of standard buttons, see
Form Toolbar. The form-specific commands are listed in the following table.
Button Description
Test Connection By using the information specified on the Connection Settings tab, tests
the ability to connect to the Shopify store via the API.
Summary Area
In this area, you specify the basic settings of a particular Shopify store, or select a store to view and edit its settings.
Element Description
Connector A read-only box with the name of the e-commerce connector (Shopify) of a
store configured on this form.
Store Name The name of the Shopify store to which the connection is being configured.
The store name is specified when the connection is first configured; you
cannot change it later.
Active A check box that indicates (if selected) that the store configuration is active
and the entities activated and configured for this store are synchronized be-
tween Acumatica ERP and the store.
For inactive stores, you can modify the store settings on the current form,
but entities are not synchronized; you can see the history of the synchro-
nization of entities on the Sync History (BC301000) form.
Default A check box that you select to indicate that this store is the default store in
Acumatica ERP.
If multiple stores have been configured on this form or on the BigCommerce
Stores (BC201000) form, if applicable, when you open other commerce-re-
lated forms, the store you have defined as the default is automatically in-
serted in the Store box.
The system requires a store to be defined as the default store. When you are
defining the first store in the system—on this form or on the BigCommerce
Stores form—this check box is selected automatically. When you define an-
other store, this check box is cleared by default; if you select this check box
for the store being defined, the system clears this check box for the store
that was previously defined as the default store.
Element Description
Store Admin URL The administrator URL of the Shopify store—that is, the store's permanent
URL followed by /admin.
API Key The API key of the custom or public app created in the Shopify store to inte-
grate it with Acumatica ERP.
API Access Token The API access token that was generated for the custom app added to the
Shopify store to integrate it with Acumatica ERP.
API Secret Key The API secret key that was generated for the custom app created in the
Shopify store to integrate it with Acumatica ERP.
Element Description
Locale The locale of Acumatica ERP to be synchronized with the Shopify store.
If multiple locales have been configured in Acumatica ERP and data is main-
tained in multiple languages, in this box, you select the locale that will be
synchronized with the Shopify store.
Element Description
Default Currency The currency specified as the default in the Shopify store.
Supported Currencies The list of currencies that are supported by the Shopify store.
API Version The version of the Shopify API used in the Acumatica ERP instance.
Element Description
Administrator The administrator of the Shopify store, which is the user who receives no-
tifications about aborted synchronization that are triggered by predefined
business events. For more information about predefined business events for
aborted synchronization records, see Automated Synchronization: Business
Events for Aborted Records.
Retail-Commerce Edition Form Reference | 440
Element Description
Max. Number of Stores The maximum number of Shopify stores that can be connected to the
Acumatica ERP instance.
Column Description
Active A check box that indicates (if selected) that the entity is synchronized be-
tween Acumatica ERP and the Shopify store.
Entity The entity that can be synchronized between Acumatica ERP and the
Shopify store, which is one of the following:
• Customer
• Customer Location
• Stock Item
• Non-Stock Item
• Template Item
• Product Image
• Product Availability
• Sales Order
• Payment
• Shipment
• Refund
You can click the link with each entity name to open the Entities
(BC202000) form in a pop-up window and specify the mapping and filter-
ing settings for the entity.
Sync Direction The direction in which the entity should be synchronized. The direction
can be one of the following:
• Export: Data is exported from Acumatica ERP to the Shopify store.
• Import: Data is imported to Acumatica ERP from the Shopify store.
• Bidirectional: Data is synchronized between Acumatica ERP and the
Shopify store in both directions.
Retail-Commerce Edition Form Reference | 441
Column Description
The direction of the synchronization is predefined by the system and can-
not be changed for the following entities:
• Stock Item (predefined as Export)
• Non-Stock Item (predefined as Export)
• Template Item (predefined as Export)
• Product Image (predefined as Export)
• Product Availability (predefined as Export)
• Sales Order (predefined as Import)
• Payment (predefined as Import)
• Shipment (predefined as Export)
• Refund (predefined as Import)
Primary System The system that is used as the source of data during the synchronization
of entities. If bidirectional synchronization is selected for the entity, the
data of the primary system takes precedence if any conflicts arise during
the synchronization.
The primary system can be either of the following:
• ERP (that is, Acumatica ERP)
• External System (that is, the Shopify store)
The primary system is determined based on the Sync Direction setting as
follows:
• For Export, ERP is set to be the primary system and cannot be changed.
• For Import, External System is set to be the primary system and cannot
be changed.
• For Bidirectional, you can select which system should be used as the
primary system based on your processes.
Real-Time Import The status of the real-time import for the entity. The status can be one of
the following options:
• Stopped: Real-time synchronization has not been started for the Im-
port direction.
• Running: Real-time synchronization has been started for the Import di-
rection.
• Not Supported: Real-time synchronization cannot be started for the
Import direction.
You can start or stop real-time synchronization on the Entities form.
Retail-Commerce Edition Form Reference | 442
Column Description
Real-Time Export The status of the real-time export for the entity. The status can be one of
the following:
• Stopped: Real-time synchronization has not been started for the Export
direction.
• Running: Real-time synchronization has been started for the Export di-
rection.
• Not Supported: Real-time synchronization cannot be started for the Ex-
port direction.
You can start or stop real-time synchronization on the Entities form.
Real-Time Mode The mode of the processing of the synchronization records, which can be
either of the following:
• Prepare: As soon as a push notification about a change to data is re-
ceived, the corresponding synchronization record is placed in the pro-
cessing queue.
• Prepare & Process: As soon as a push notification about a change to da-
ta is received, the corresponding synchronization record is placed in
the processing queue, and the data synchronization process is imme-
diately started for the synchronization record.
Max. Number of Failed Attempts The maximum number of errors allowed during the import or export of
data before the synchronization record is skipped (that is, excluded from
further synchronization).
By default, the column contains 5: That is, the system allows 5 failed at-
tempts before excluding the synchronization record from further process-
ing.
Element Description
Customer Class The customer class that is assigned to new customers imported to
Acumatica ERP from the Shopify store and thus used to provide their de-
fault settings.
Retail-Commerce Edition Form Reference | 443
Element Description
Customer Numbering Template The template that is used to provide the identifiers of new customers im-
ported to Acumatica ERP from the Shopify store. This character string,
such as ____-____-######, initially shows the number and length of seg-
ments in the CUSTOMER segmented key, which is configured on the Seg-
mented Keys (CS202000) form and defines the structure of the identifiers
used for customers in Acumatica ERP. The groups of underscores rep-
resent the constant segments, and the number signs represent the au-
to-numbered segment.
You replace the underscores with the values of the constant segments
to be used in the identifiers of the customers imported from the Shopi-
fy store, as shown in the following example: ECUS-RET1-######. With this
setting, the identifiers of all customers imported from Shopify to Acumat-
ica ERP would start with ECUS-RET1, for easy identification, and the sys-
tem would automatically assign the numerical part of the identifier ac-
cording to the numbering sequence selected in the Customer Auto-Num-
bering box. These settings do not affect the assignment of identifiers to
other customers in the system (those that already exist or those that are
created directly in Acumatica ERP).
This box is available for editing only if the CUSTOMER segmented key has
more than one segment.
If you will be importing customers from an online store, one of the seg-
ments of the CUSTOMER segmented key must be automatically num-
bered.
Customer Auto-Numbering The numbering sequence that the system uses to automatically generate
identifiers for customers imported from the Shopify store.
If the CUSTOMER segmented key consists of more than one segment,
the numbering sequence that you select in this box applies to the auto-
matically numbered segment (a group of number signs in the Customer
Numbering Template box). The length of the numbering sequence must
match the length of the auto-numbered segment.
Selecting a numbering sequence in this box does not change the Num-
bering ID setting of the CUSTOMER segmented key on the Segmented
Keys form. The selected numbering sequence applies only to customers
that are imported from the Shopify store and does not affect the assign-
ment of identifiers to other customers in the system (those that already
exist or those that are created directly in Acumatica ERP).
Retail-Commerce Edition Form Reference | 444
Element Description
Location Numbering Template The template that is used to provide the identifiers of new customer loca-
tions imported to Acumatica ERP from the Shopify store. This character
string, such as ____-____-######, initially shows the number and length
of segments in the LOCATION segmented key, which is configured on the
Segmented Keys form and defines the structure of the identifiers used
for customer locations in Acumatica ERP. The underscores represent the
constant segments, and the number signs represent the automatically
numbered segment.
You replace the underscores with values of the constant segments to be
used in the identifiers of the customer locations imported from the Shopi-
fy store, as shown in the following example: ECOM-RET1-######. With this
setting, the identifiers of all customer locations imported from Shopify to
Acumatica ERP would start with ECOM-RET1, for easy identification, and
the system would automatically assign the numerical part of the identi-
fier according to the numbering sequence selected in the Location Au-
to-Numbering box. These settings do not affect the assignment of identi-
fiers to other customer locations in the system (those that already exist or
those that are created directly in Acumatica ERP).
This box is available for editing only if the LOCATION segmented key has
more than one segment.
If you will be importing customer locations from an online store, one of
the segments of the LOCATION segmented key must be automatically
numbered.
Location Auto-Numbering The numbering sequence that the system uses to automatically generate
identifiers for customer locations imported from the Shopify store.
If the LOCATION segmented key consists of more than one segment, the
numbering sequence that you select in this box applies to the automati-
cally numbered segment (a group of number signs in the Location Num-
bering Template box). The length of the numbering sequence must
match the length of the auto-numbered segment.
Selecting a numbering sequence in this box does not change the Num-
bering ID setting of the LOCATION segmented key on the Segmented Keys
form. The selected numbering sequence applies only to customer loca-
tions that are imported from the Shopify store and does not affect the as-
signment of identifiers to other customer locations in the system (those
that already exist or those that are created directly in Acumatica ERP).
Generic Guest Customer The generic customer account that appears on imported sales orders that
were placed in the Shopify store as guest orders. This customer account
is not exported to the Shopify store during the synchronization of cus-
tomers.
Retail-Commerce Edition Form Reference | 445
Element Description
Use Multiple Guest Accounts A check box that indicates (if selected) that multiple guest customer ac-
counts should be created to record imported guest sales orders.
When this check box is selected, this system limits the number of sales or-
ders that can be created in Acumatica ERP for the customer account se-
lected in the Generic Guest Customer box. When the maximum allowed
number of sales orders is exceeded, the system creates a new customer
and inserts its identifier in the Generic Guest Customer box. The settings
of the new customer account are copied from the previous generic guest
customer account, and its identifier is generated based on the numbering
sequence specified in the Customer Auto-Numbering box.
By default, the allowed number of sales orders per guest customer ac-
count is limited to 10,000. You can override this number by changing the
value of the MaxOrdersPerGuestAccount parameter in the we-
b.config file.
Element Description
Sales Category Export The way in which sales category export is handled. You can select either of
the following options:
• Do Not Export: Item sales categories assigned to an item in Acumatica
ERP are not synchronized with the Shopify store.
• Export as Product Tags: Item sales categories are synchronized with
product tags in the Shopify store. During the synchronization of stock
items, non-stock items, or template items, these items will be added to
the Shopify store's collections based on product tags (if any collections
have been created based on product tags) according to the sales cate-
gories assigned to these items in Acumatica ERP.
Default Visibility The default visibility that is assigned to stock and non-stock items exported
to the Shopify store. You can select one of the following options:
• Visible: The items are visible on the storefront immediately after syn-
chronization with the store.
• Invisible: The items are exported to the product list of the external e-
commerce system but do not appear on the storefront.
Retail-Commerce Edition Form Reference | 446
Element Description
Default Availability The default availability that is assigned to stock items exported to the
Shopify store. You can select one of the following options:
• Set as Available (Track Qty.): The exported items are available in the
Shopify store, and their quantities are tracked.
• Set as Available (Don't Track Qty.): The exported items are available in
the Shopify store, and their quantities are not tracked.
• Do Not Update: The availability status and the available quantities of
items are not updated in the store.
• Set as Unavailable: The exported items are marked as unavailable for
purchasing.
The default availability can be overridden for each particular item on the
eCommerce tab of the Stock Items (IN202500) form.
When Qty. Unavailable The action that the system must perform on an item when there is no stock
le. You can select one of the following options:
• Do Nothing: No action should be performed.
• Set as Unavailable: The item should be made unavailable for purchas-
ing.
This box is available only if the Default Availability is set to Set as Available
(Track Qty.).
The setting is applied to products in Shopify during the synchronization of
the Stock Item, Template Item or Product Availability entity.
Availability Mode The type of item quantity that is exported to the Shopify store during the
synchronization of the Product Availability entity. You can select one of the
following options:
• Available: The item's available quantity in Shopify is based on the entire
available quantity of the item in Acumatica ERP.
• Available for Shipping: The item's available quantity in Shopify is based
on the quantity available for shipping in Acumatica ERP.
• On Hand: The item's available quantity in Shopify is based on the on-
hand quantity in all warehouses or only specific warehouses or ware-
house locations, depending on the Warehouse Mode setting.
For information about availability calculation in Acumatica ERP, see Config-
uration of Availability Calculation Rules: General Information.
Warehouse Mode An option that determines whether all warehouses or specific warehouses
and locations are used for determining the available quantity of the item in
the Shopify store.
You can select one of the following options:
• All Warehouses: The available quantity of the item is calculated based
on the quantity of the item in all warehouses.
• Specific Warehouses: The available quantity of the item is calculated
based on the quantity in the selected warehouses and warehouse loca-
tions. If this option is selected, a list of warehouses and warehouse loca-
tions to be used must be specified.
Retail-Commerce Edition Form Reference | 447
Column Description
Warehouse The identifier of the warehouse in Acumatica ERP whose item quantity
should be used for calculating the item's available quantity in the Shopify
location.
You can select a warehouse from the list, which contains all active ware-
houses that have been created on the Warehouses (IN204000) form.
Location ID The identifier of the warehouse location from Acumatica ERP that con-
tains inventory items whose availability data should be exported to the
Shopify store.
If you specify a location, only this specific location of the selected ware-
house is used. If no location is selected, the system exports the availability
data for items stored in all locations of the selected warehouse.
You can select a warehouse location from the list of locations that have
been created on the Warehouses form for the warehouse selected in the
Warehouse column. The list displays only the locations that are active
and sales from which are allowed—that is, the locations for which the Ac-
tive and Sales Allowed check boxes are selected on the Location tab of
the Warehouses form.
Shopify Location The Shopify warehouse location to which the system will export availabili-
ty data for inventory items from Acumatica ERP.
You select a location from the list, which contains all the warehouse loca-
tions created in the Shopify store.
Element Description
Branch The branch that is inserted as the default in the sales orders and pay-
ments imported to Acumatica ERP from the Shopify store.
The base currency of the branch must match the default currency of
the Shopify store, which is displayed in the Default Currency box of the
Store Properties section on the Connection Settings tab.
Retail-Commerce Edition Form Reference | 448
Element Description
Order Type for Import The order type in Acumatica ERP that is assigned to imported sales or-
ders to indicate that the orders have originated in the Shopify store.
Order Types for Export The types of orders in Acumatica ERP to be exported to the Shopify
store.
Orders of these types are exported to the Shopify store only if the syn-
chronization direction of the Sales Order entity is set to Export or Bidirec-
tional for that store on this form or on the Entities (BC202000) form.
Return Order Type The order type that the system will use as a source of default settings for
creating a return order when a refund is issued in the Shopify store. You
can select only an order type with the following settings on the Tem-
plate tab of the Order Types (SO201000) form:
• Automation Behavior: RMA Order
• Default Operation: Receipt
• AR Document Type: Credit Memo
Refund Amount Item The non-stock item that is used to represent a refund amount in an im-
ported sales order. The non-stock item selected in this box is excluded
from synchronization and is not exported when the Non-Stock Item en-
tity is synchronized. The non-stock item representing refund amounts
should be exempt from taxes (that is, on the General tab of the Non-
Stock Items (IN202000) form, in the Tax Category box, a category corre-
sponding to tax-exempt items should be assigned). Also on this tab, the
Require Receipt and Require Shipment check boxes must be cleared
for the item.
Refund Reason Code The reason code that the system will insert in each return order line for a
refund or return imported from the Shopify store. The reason code must
have the Issue usage type specified on the Reason Codes (CS211000)
form.
Order Time Zone The time zone the system will use for each sales order imported from the
Shopify store when it is created in Acumatica ERP. The order time zone is
needed to determine the correct date and time of the order if Acumatica
ERP and the Shopify store are located in different time zones.
Show Discounts As The level on which discounts appear in each sales order imported from
Shopify. You can select either of the following options:
• Line Discounts: Discounts applied to the order are distributed be-
tween the sales order lines and appear in the Discount Amount col-
umn on the Details tab of the Sales Orders (SO301000) form.
• Document Discounts: Discounts applied to the order are aggregated
and displayed on the Discounts tab of the Sales Orders form.
Element Description
Import Order Risks A check box that indicates (if selected) that the risk analysis information
for a sales order should be imported from the Shopify store when the
sales order is synchronized.
This check box is selected by default.
Hold on Risk Status The risk status or statuses of the sales order for which the system as-
signs the order the Risk Hold status. You can select either of the following
options:
• High Risk (default): Only imported sales orders with the High risk sta-
tus are assigned the Risk Hold status.
• Medium or High Risk: Imported sales orders with the High and Medium
risk statuses are assigned the Risk Hold status.
Gi Certificate Item The non-stock item in Acumatica ERP that is used to record the sale of
gi cards in the Shopify store. This item is excluded from synchroniza-
tion (that is, it is not exported to the Shopify store during the synchro-
nization of the Non-Stock Item entity).
Earliest Order Date The earliest order creation date included in synchronization. Orders
created in the Shopify store earlier than this date are not imported to
Acumatica ERP even if synchronization is performed in Full preparation
mode.
Tag Ext. Order with ERP Order Nbr. A check box that indicates (if selected) that after a sales order has
been imported from the Shopify store and assigned an order number
in Acumatica ERP, the system should add two tags to the order in the
Shopify store—ERP and a tag with the order number from Acumatica
ERP.
Allow Adding Items to Processed A check box that indicates (if selected) that after a sales order has been
Orders synchronized between Acumatica ERP and the Shopify store, users can
add items to it on the Details tab of the Sales Orders form.
Element Description
Tax Synchronization A check box that indicates (if selected) that taxes should be synchro-
nized between Acumatica ERP and the Shopify store during the export
or import of sales orders.
Default Tax Zone The identifier of the tax zone that is assigned by default to each sales
order imported to Acumatica ERP from the Shopify store if no other tax
zone has been identified during the import of the order.
The box is available if the Tax Synchronization check box is selected.
Retail-Commerce Edition Form Reference | 450
Element Description
Use as Primary Tax Zone A check box that you select to indicate that the tax zone selected in
Default Tax Zone should be assigned to each sales order imported to
Acumatica ERP from the Shopify store, regardless of whether any other
tax zone has been identified during the import of the order.
This check box is available if the Default Tax Zone is specified.
Element Description
Tax List The substitution list to be used for mapping tax IDs between Acumatica
ERP and the Shopify store.
During the import of each sales order, if the system cannot find the tax
ID specified in the order, it checks if there is a mapped tax ID in the sub-
stitution list specified in this box.
Substitution lists are defined on the Substitution Lists (SM206026) form.
Tax Category List The substitution list to be used for mapping tax categories Acumatica
ERP with tax classes in the Shopify store.
During the import of each sales order, if the system cannot find the tax
category specified in the order, it checks if there is a mapped tax catego-
ry in the substitution list specified in this box.
Substitution lists are defined on the Substitution Lists form.
Element Description
Import POS Orders A check box that indicates (if selected) that POS orders should be im-
ported from the Shopify store to Acumatica ERP.
POS Direct Order Type The order type that is used by the system for the orders that do not in-
volve shipping and have already been fulfilled from the brick-and-mor-
tar store. In this box, the order types with the Invoice order type tem-
plate are displayed.
POS Shipping Order Type The order type that is used for orders with shipping. In this box, the or-
der types with the Sales Order order type template are displayed.
Orders of this type are included in the shipment export process.
Column Description
Shopify Location The Shopify warehouse location from which the order is fulfilled. You
can select a location from the list, which includes all active locations
configured in the Shopify store.
Warehouse A warehouse from Acumatica ERP that should appear in the order line
of the imported order that was fulfilled from the specified Shopify lo-
cation. You can select a warehouse from the list, which contains the ac-
tive warehouses that have been created on the Warehouses (IN204000)
form.
Location ID A warehouse location from Acumatica ERP that should appear in the
order line of the imported order that was fulfilled from the specified
Shopify location. You can select a warehouse location from the list,
which contains the active locations that have been created on the
Warehouses form for the warehouse selected in the Warehouse col-
umn of the row.
Column Description
Active A check box that indicates (if selected) that payment processing is enabled
for the payment method.
If this check box is cleared for a payment method, when an order is placed
in the Shopify store and this payment method is selected at checkout, the
corresponding payment is not imported from the Shopify store to Acumatica
ERP.
This check box is cleared by default.
Store Payment Method The payment method defined in the Shopify store. This column is populated
automatically. However, you can manually add additional mappings of pay-
ment options.
Store Currency The currency for which the store payment method has been defined in the
Shopify store.
You can select a currency from the list of active currencies defined on the
Currencies (CM202000) form. This column is filled in automatically for store
payment methods added to the table automatically by the API.
Retail-Commerce Edition Form Reference | 452
Column Description
ERP Payment Method The identifier of the payment method in Acumatica ERP. This payment
method is used to create payment documents in Acumatica ERP for import-
ed payments based on the store payment method.
Cash Account The cash account associated with the payment method in Acumatica ERP.
You can select only cash accounts in the store currency.
Proc. Center ID The processing center configured in Acumatica ERP for the card-based pay-
ment method selected in the ERP Payment Method column and the cash
account selected in the Cash Account column.
This column is displayed if the Integrated Card Processing feature is enabled
on the Enable/Disable Features (CS100000) form.
Release Payments A check box that you select to indicate that payments should be automati-
cally released as soon as they are imported to Acumatica ERP.
If this check box is selected for a card-based payment method associated
with a credit card processing center in Acumatica ERP (that is, for the pay-
ment method for which a processing center is selected in the Proc. Center
ID column), only payments that have been captured in the store will be auto-
matically released on import.
Process Refunds A check box that you select to indicate that refunds issued in the store for the
store payment method should be imported to Acumatica ERP.
This check box is selected and unavailable for a card-based store payment
method (Authorize.Net or Shopify Payments) that is mapped to a payment
method in Acumatica ERP for which a processing center has been configured
on the Processing Centers (CA205000) form and specified in the Proc. Center
ID column of this table.
The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.
Retail-Commerce Edition Form Reference | 453
Column Description
Active A check box that indicates (if selected) that the system should use the
mapped ship via, shipping zone, and shipping terms when importing or-
ders from the Shopify store.
Store Shipping Zone The shipping zone that has been set up in the Shopify store.
Store Shipping Method The shipping method for the specified shipping zone that has been set up
in the Shopify store.
Ship Via The ship via code in Acumatica ERP that is mapped to the combination of
the store shipping zone and the store shipping method.
The value selected in this column is assigned to orders imported into
Acumatica ERP and is displayed on the Shipping tab of the Sales Orders
(SO301000) form for these orders.
Shipping Zone The identifier of the shipping zone in Acumatica ERP, which is defined on
the Shipping Zones (CS207510) form, that is mapped to the combination
of the store shipping zone and the store shipping method. The value se-
lected in this column is assigned to each sales order imported to Acumat-
ica ERP with the store shipping zone and store shipping method specified
in this row. This value is also inserted on the Shipping tab of the Sales
Orders form for the sales order.
This value is optional. If you leave it empty, the Shipping Zone box on
the Shipping tab of the Sales Orders form will not be populated when a
sales order with the store shipping zone and store shipping method spec-
ified in the row is imported.
Shipping Terms The identifier of the shipping terms in Acumatica ERP, which is defined
on the Shipping Terms (CS208000) form, that is mapped to the combina-
tion of the store shipping zone and store shipping method. The value se-
lected in this column is assigned to each sales order imported to Acumat-
ica ERP with the store shipping zone and store shipping method specified
in this row. This value is also inserted in the Shipping Terms box on the
Shipping tab of the Sales Orders form for the sales order.
This value is optional. If you leave it empty, the Shipping Terms box on
the Shipping tab of the Sales Orders form will not be populated when a
sales order with the store shipping zone and store shipping method spec-
ified in the row is imported.
Entities
This form is available only if the Commerce Integration feature is enabled on the Enable/Disable
Features (CS100000) form.
Form Toolbar
The form toolbar includes standard buttons and form-specific buttons and commands. For the list of standard
buttons, see Form Toolbar. The form-specific commands can be shown as buttons on the form toolbar, as
commands on the More menu, or in both places. These commands are listed in the following table in alphabetical
order.
Command Description
Clear Sync Data Opens the Clear Sync Data dialog box, which you can use to delete all syn-
chronization information for the selected entity.
Start Real-Time Sync For the Export synchronization direction: Starts the real-time synchroniza-
tion process and sets the Real-Time Export status to Running for the se-
lected entity.
For the Import and Bidirectional synchronization direction: Opens the Start
Real-Time Sync dialog box.
Stop Real-Time Sync Disables the real-time synchronization process and sets the Real-Time Ex-
port or Real-Time Import status, depending on the selected direction of
the synchronization, to Stopped for the selected entity.
Element Description
Real-Time Webhook URL The URL that will be used to receive push notifications from the exter-
nal system. By default, the URL of your instance is displayed, but you can
change it if necessary.
Continue Starts the real-time synchronization process, sets the Real-Time Import
status to Running for the selected entity, and closes the dialog box.
Element Description
Entity Name The name of the entity for which synchronization data needs to be deleted.
This name should be the same as the entity selected in the Summary area.
Continue Deletes all synchronization information for the entity specified in the Enti-
ty Name box, and closes the dialog box.
This operation cannot be undone.
Retail-Commerce Edition Form Reference | 455
Element Description
Summary Area
In this area, you can select a particular entity for which you want to configure field mapping and filtering rules that
are applied when data is imported to Acumatica ERP or exported to the external e-commerce system. The elements
also display the general settings for the selected entity.
Element
Connector The name of the e-commerce connector, which corresponds to the plat-
form on which the online store has been deployed.
Entity The name of the entity supported by the connector. The available options
are the following, based on the entities for which the connector supports
synchronization:
• For BigCommerce: Customer Price Class, Customer, Customer, Sales
Category, Stock Item, Non-Stock Item, Template Item, Base Sales Price,
Price List, Product Image, Product Availability, Sales Order, Payment,
Shipment, Refund
• For Shopify: Customer, Customer Location, Stock Item, Non-Stock Item,
Template Item, Product Image, Product Availability, Sales Order, Pay-
ment, Shipment, Refund
Active A read-only check box that indicates (if selected) that the entity has been
activated (that is, selected for synchronization) on the BigCommerce
Stores (BC201000) form or on the Shopify Stores (BC201010) form.
Sync Direction The direction in which the entity should be synchronized, which can be one
of the following:
• Export: Data is exported from Acumatica ERP to the external e-com-
merce system.
• Import: Data is imported to Acumatica ERP from the external e-com-
merce system.
• Bidirectional: Data is synchronized between Acumatica ERP and the ex-
ternal e-commerce system in both directions.
For the BigCommerce stores, the direction of the synchronization is insert-
ed by the system and cannot be changed for the following entities:
• Stock Item (predefined as Export)
• Non-Stock Item (predefined as Export)
• Template Item (predefined as Export)
• Base Sales Price (predefined as Export)
• Price List (predefined as Export)
Retail-Commerce Edition Form Reference | 456
Element
Primary System The system that is used as the source of data during the synchronization
of entities. If bidirectional synchronization is selected for the entity, the
data of the primary system takes precedence if any conflicts arise during
the synchronization.
The primary system can be either of the following:
• ERP (that is, Acumatica ERP)
• External System (that is, the external e-commerce system)
The primary system is determined based on the direction of the synchro-
nization as follows:
• For Export, ERP is set to be the primary system and cannot be changed.
• For Import, External System is set to be the primary system and cannot
be changed.
• For Bidirectional, you can select which system should be used as the
primary system, based on your synchronization processes.
Max. Number of Failed Attempts The maximum number of errors that are allowed during the import or ex-
port of data before the synchronization record is skipped (that is, exclud-
ed from further synchronization).
By default, the box contains 5, indicating that the system allows five failed
attempts before excluding the synchronization record from further pro-
cessing.
Retail-Commerce Edition Form Reference | 457
Element
Real-Time Import The status of real-time import for the entity. The system inserts the status,
which is one of the following:
• Stopped: Real-time synchronization is not started for the Import direc-
tion.
• Running: Real-time synchronization is started for the Import direction.
• Not Supported: Real-time synchronization is not supported for the Im-
port direction.
Real-Time Export The status of real-time export for the entity. The system inserts the status,
which is one of the following:
• Stopped: Real-time synchronization is not started for the Export direc-
tion.
• Running: Real-time synchronization is started for the Export direction.
• Not Supported: Real-time synchronization is not supported for the Ex-
port direction.
Real-Time Mode The mode of the processing of the synchronization records, which can be
either of the following:
• Prepare: As soon as a push notification about a change to data is re-
ceived, the corresponding synchronization record is placed in the pro-
cessing queue.
• Prepare & Process: As soon as a push notification about a change to da-
ta is received, the corresponding synchronization record is placed in
the processing queue, and the data processing is immediately started
for the synchronization record.
Column Description
Active A check box that indicates (if selected) that the import
mapping rule is active.
Column Description
Source Field / Value The field or a particular field value of the object in the
external e-commerce system that is mapped to the
field of the object in Acumatica ERP.
The list of available options depends on the selected
entity, the e-commerce connector, and the source ob-
ject.
Column Description
Active A check box that indicates (if selected) that the condi-
tion is active and is used for filtering.
Field Name The name of the field in the external e-commerce sys-
tem to which the filter will be applied.
The list of available options depends on the selected
entity.
Column Description
Column Description
Active A check box that indicates (if selected) that the export
mapping rule is active.
Target Field The field of the selected target object in the external
e-commerce system that is mapped to the field of the
object in Acumatica ERP.
The list of available options depends on the selected
entity, the e-commerce connector, and the target ob-
ject.
Column Description
Source Field / Value The field of the selected source object in Acumatica
ERP that is mapped to the field of the object in the ex-
ternal e-commerce system.
The list of available options depends on the selected
entity.
Column Description
Active A check box that indicates (if selected) that the condi-
tion is active and is used for filtering.
Field Name The name of the field in Acumatica ERP to which the
filter will be applied.
The list of available options depends on the selected
entity.
Prepare Data
This form is available only if the Commerce Integration feature is enabled on the Enable/Disable
Features (CS100000) form.
Form Toolbar
The form toolbar includes standard and form-specific buttons and commands. For the list of standard buttons, see
Form Toolbar. The form-specific commands are listed in the following table.
Button Description
Prepare Starts the data preparation process for the entities you
have selected in the table.
Selection Area
By using the elements in this area, you can configure the data fetch process to be started for the entities in the
table.
Element Description
Element Description
Start Date The start date of the date range. Records that have
been modified in this date range are prepared for syn-
chronization.
This box is available for editing only if Incremental by
Date or Full is selected in the Prepare Mode box.
End Date The end date of the date range. Records that have
been modified in this date range are prepared for syn-
chronization.
This box is available for editing only if Incremental by
Date or Full is selected in the Prepare Mode box.
Table
In this table, you can select the entities that should be prepared for synchronization and view the information
about the previous data preparation processes, including the date and time of the previous full and incremental
fetch, and the errors that occurred during the last data preparation attempt, if any.
The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.
Column Description
Selected A check box that you select to include the row in pro-
cessing.
Retail-Commerce Edition Form Reference | 463
Column Description
Primary System The system that is used as a source of data during the
synchronization of entities. If bidirectional synchro-
nization is selected, the data of the primary system
takes precedence if any conflicts arise during the syn-
chronization.
The primary system can be either of the following:
• ERP (that is, Acumatica ERP)
• External System (that is, the external e-commerce
system)
Last Error The last error that occurred during the data fetch
process (if any).
Column Description
Latest Incremental Import The date and time of the last incremental data fetch
for the Import direction.
Latest Incremental Export The date and time of the last incremental data fetch
for the Export direction.
Last Reconciliation Export A read-only column that shows the date and time of
the last data preparation in the Incremental by Date
mode for the Export direction.
This column is hidden by default.
Last Reconciliation Import A read-only column that shows the date and time of
the last data preparation in the Incremental by Date
mode for the Import direction.
This column is hidden by default.
Column Description
Real-Time Mode A read-only column that shows the mode of the pro-
cessing of the synchronization records, which can be
either of the following:
• Prepare: As soon as a push notification about a
change to data is received, the corresponding syn-
chronization record is placed in the processing
queue.
• Prepare & Process: As soon as a push notification
about a change to data is received, the correspond-
ing synchronization record is placed in the pro-
cessing queue, and data processing is immediately
started for the synchronization record.
This column is hidden by default.
Process Data
This form is available only if the Commerce Integration feature is enabled on the Enable/Disable
Features (CS100000) form.
Form Toolbar
The form toolbar includes standard buttons and form-specific buttons and commands. For the list of standard
buttons, see Form Toolbar. The form-specific commands can be shown as buttons on the form toolbar, as
commands on the More menu, or in both places. These commands are listed in the following table in alphabetical
order.
Retail-Commerce Edition Form Reference | 466
Command Description
Process All Starts the data synchronization process for all syn-
chronization records in the table.
Set All as Processed Sets the status of all synchronization records in the ta-
ble to Processed, updates the date and time of the last
synchronization with the current date and time, and
removes the synchronization records from the table.
A synchronization record can be set as processed on-
ly if both the ERP ID and the External ID exist for this
record.
Synchronization records set as synchronized are listed
on the Processed filter tab of the Sync History form.
Skip All Sets the status of all synchronization records in the ta-
ble to Skipped, which excludes the selected synchro-
nization records from further synchronization and re-
moves them from the table.
Skipped records are listed on the Skipped filter tab of
the Sync History form.
Selection Area
By using the elements in this area, you can filter the synchronization records to be shown in the table.
Retail-Commerce Edition Form Reference | 467
Element Description
Store The name of the e-commerce store for which you need
to display data in the table.
By default, the system inserts the store for which the
Default check box is selected on the BigCommerce
Stores(BC201000) or Shopify Stores (BC201010) form.
Table
By using this table, you can select the synchronization records to be processed during the data synchronization
process.
Column Description
Column Description
Last Error The error, if any, that occurred during the last attempt
to run the process.
Last Operation The operation that was last performed on the record,
which is one of the following options:
• Inserted in ERP: The synchronization record was syn-
chronized; during the synchronization, a new docu-
ment or entity record was created in Acumatica ERP.
• Updated in ERP: The synchronization record was
synchronized; during the synchronization, the ex-
isting document or entity record was updated in
Acumatica ERP.
• Deleted in ERP: The synchronization record was syn-
chronized; during the synchronization, the existing
document or entity record was deleted in Acumatica
ERP.
• Modified in ERP: The document or entity record was
changed in Acumatica ERP but not synchronized.
• Failed to Save in ERP: An error occurred while the
document or entity record was being saved in
Acumatica ERP.
• Conflict Resolved by Override in ERP: The synchro-
nization record was synchronized; during the syn-
chronization, a conflict occurred that the system re-
solved by updating the document or entity record in
Acumatica ERP with the changes from the external
e-commerce system.
• Inserted Externally: The synchronization record was
synchronized; during the synchronization, a new
document or entity record was created in the exter-
nal e-commerce system.
• Updated Externally: The synchronization record was
synchronized; during the synchronization, the exist-
ing document or entity record was updated in the
external e-commerce system.
• Deleted Externally: The synchronization record was
synchronized; during the synchronization, the exist-
ing document or entity record was deleted in the ex-
ternal e-commerce system.
• Modified Externally: The document or entity record
was changed in the external e-commerce system but
not synchronized.
• Failed to Save Externally: An error occurred while the
document or entity record was saved in the external
e-commerce system.
Retail-Commerce Edition Form Reference | 469
Column Description
• Conflict Resolved by Override Externally: The syn-
chronization record was synchronized; during the
synchronization, a conflict occurred that the system
resolved by updating the document or entity record
in the external e-commerce system with the changes
from Acumatica ERP.
• Sync Failed: An error occurred during the synchro-
nization.
• Manually Synchronized: The synchronization record
was manually synchronized by the user; timestamps
were updated in the synchronization record.
• Forced to Resync: The synchronization record was
force-synchronized.
• Not Found: During the synchronization, the docu-
ment or entity record was not found in Acumatica
ERP or in the external e-commerce system. The syn-
chronization record is marked as deleted.
• Sync Settings Reconfigured: The synchronization set-
tings for the entity were updated.
• Skipped from Sync: The record was skipped during
the synchronization.
• Filtering Applied: Filtering conditions defined in the
code or on the Entities (BC202000) form have been
applied.
Last Attempt The date and time when the last attempt to run the da-
ta synchronization process occurred.
Last Externally Modified The date and time when the document or entity record
was last modified in the external e-commerce system.
This column is hidden by default.
Last Locally Modified The date and time when the document or entity record
was last modified in Acumatica ERP.
This column is hidden by default.
Retail-Commerce Edition Form Reference | 470
Column Description
Primary System The system that is used as a source of data during the
synchronization of entities. If bidirectional synchro-
nization is selected, the data of the primary system
takes precedence if any conflicts arise during the syn-
chronization.
The primary system can be either of the following:
• ERP (that is, Acumatica ERP)
• External System (that is, the external e-commerce
system)
This column is hidden by default.
Sync History
This form is available only if the Commerce Integration feature is enabled on the Enable/Disable
Features (CS100000) form.
Form Toolbar
The form toolbar includes standard buttons and form-specific buttons and commands. For the list of standard
buttons, see Form Toolbar. The form-specific commands can be shown as buttons on the form toolbar, as
commands on the More menu, or in both places. These commands are listed in the following table in alphabetical
order.
Retail-Commerce Edition Form Reference | 471
Command Description
Add New Opens the Add or Edit Sync Status dialog box for adding a new synchroniza-
tion record.
Delete Deletes the selected synchronization record or records from the table on the
tab. You select a synchronization record by selecting the Included check box
for it or by clicking its row before invoking this command.
Edit Opens the Add or Edit Sync Status dialog box for editing the selected syn-
chronization record. You select a synchronization record by selecting the In-
cluded check box for it or by clicking its row before invoking this command.
Set as Processed Sets the status of the selected synchronization record or records (that is, all
records for which you have selected the Included check box) to Processed,
updates the date and time of the last synchronization with the current date
and time for these records, and sets the Last Operation value to Manually
Synchronized for these records.
Synchronization records set as processed are listed on the Processed filter
tab of this form.
Skip Sets the status of the selected synchronization record or records to Skipped,
which excludes the synchronization record from further synchronization and
removes it from the table. You select a synchronization record by selecting
the Included check box for it.
Skipped synchronization records are listed on the Skipped filter tab of this
form.
Sync Starts the data synchronization process for the selected synchronization
record or records. You select a synchronization record by selecting the In-
cluded check box for it or by clicking its row before invoking this command.
This button launches forced synchronization. That is, even if the synchro-
nization record already has a status of Processed, the system synchronizes it
again, with the data in the primary system (the system used as the source of
data) taking precedence.
View Details Opens the Sync Record Details dialog box for the selected synchronization
record. You select a synchronization record by selecting the Included check
box for it or by clicking its row before invoking this command.
Element Description
Connector The e-commerce connector used for the synchronization of data between
Acumatica ERP and the external e-commerce system.
Store Required. The name of the e-commerce store with which data is synchro-
nized.
Only stores configured for the selected connector are displayed in the drop-
down list.
Retail-Commerce Edition Form Reference | 472
Element Description
External ID The identifier in the external e-commerce system of the record being syn-
chronized.
Need to Sync A check box that you select to indicate that the new record must be syn-
chronized.
OK Creates or updates the synchronization record with the specified values and
closes the dialog box.
Column Description
Entity Type The type of entity that was synchronized during the processing of the syn-
chronization record.
ERP ID The identifier of the entity record in Acumatica ERP that was synchronized
during the processing of the synchronization record.
If you click the link in this column, the system opens the corresponding
Acumatica ERP form in a pop-up window with the document or record se-
lected.
External ID The identifier of the entity record in the external system that was synchro-
nized during the processing of the synchronization record.
If you click the link in this column, the system opens the corresponding
page of the e-commerce system in a new window and displays the details
of the document or record.
Selection Area
In this area, you select the criteria of the synchronization records to be displayed on the tabs of the form.
Element Description
Store The name of the e-commerce store for which you want to display synchro-
nization records on the tabs.
By default, the system inserts the store for which the Default check box
is selected on the BigCommerce Stores(BC201000) or Shopify Stores
(BC201010) form.
Retail-Commerce Edition Form Reference | 473
Element Description
Entity The entity for which you want to display synchronization records on the
tabs.
The drop-down list contains only the entities that have been activated for
the selected store.
If no option is selected in this box, the synchronization records of all entities
are listed on the tabs.
Filter Tabs
Below the Selection area is a series of filter tabs, each of which has a table that displays particular synchronization
records:
• All Records: This tab displays all synchronization records for the selected store and entity.
• Ready to Process: This tab displays active synchronization records that have the Prepared status or
the Failed status. The system attempts to synchronize records with either of these statuses when data
processing is started for the corresponding entity.
• Failed: This tab displays active synchronization records that have the Failed status, which the system
assigns if the system could not process a synchronization record but the number of synchronization
attempts is below the allowed maximum specified for the entity to which the synchronization record
belongs. The system attempts to process synchronization records with this status when data processing is
started for the corresponding entity.
• Processed: This tab displays active synchronization records that have the Processed status—that is, active
synchronization records that have been successfully processed by the system.
• Skipped: This tab displays the active synchronization records that have the Skipped status—that is, the
active synchronization records that have been manually excluded from the synchronization by users.
• Aborted: This tab displays active synchronization records with the Aborted status—that is, active
synchronization records that have been excluded from the synchronization by the system. The system
assigns the Aborted status to a synchronization record if it fails to process it for more than the maximum
number of failed attempts allowed for the synchronization of the entity to which the synchronization record
belongs.
• Deleted: This tab displays active synchronization records that have the Deleted status, which is assigned
to a synchronization record if the record data it contains has been prepared (that is, pulled from Acumatica
ERP and the external e-commerce system) and then deleted in the primary system of the entity.
• Filtered: This tab displays active synchronization records that have the Filtered status. The system
assigns this status to a synchronization record if it has been prepared and then filtered out during the
synchronization because filtering conditions defined for the entity on the Entities (BC202000) form have
been applied.
• Invalid: This tab displays active synchronization records that the system has assigned the Invalid status—
that is, synchronization records generated for document or entity records that cannot be synchronized, for
example, if they have been used in the store settings. For instance, a customer record that has been selected
as the Generic Guest Customer is not synchronized during the synchronization of the Customer entity.
• Inactive: This tab displays synchronization records for entities that have been deactivated (that is, the
Active check box is cleared) on the Entity Settings tab of the BigCommerce Stores (BC201000) and Shopify
Stores (BC201010) forms. Inactive synchronization records have the Active check box cleared in the table.
Retail-Commerce Edition Form Reference | 474
Column Description
Included An unlabeled check box that you select to indicate that this synchroniza-
tion record should be processed when you click an available button on
the form toolbar or click an available command on the More menu. The
possible commands that can be clicked for are Sync, Delete, Skip, Set as
Processed Edit, and View Details.
This check box is available for selection only if the entity and the store
the synchronization record was generated for are activated in the store
settings—that is, if the Active check box is selected for the store in the
Summary area of the BigCommerce Stores (BC201000) or Shopify Stores
(BC201010) form and the Active check box is selected for the entity on the
Entity Settings tab of these forms.
Entity The entity for which the synchronization record was generated.
External ID The ID of the document or entity record in the external e-commerce sys-
tem.
If you click the link in this column, the system opens the corresponding
page of the e-commerce system in a new window and displays the details
of the document or record.
The value in this column may be simple or combined. A combined exter-
nal ID includes two identifiers separated by a comma. For example, if the
record represents a sales order that has been paid, this column would con-
tain the order number and the payment number, separated by a comma.
External Description The description of the document or entity record in the external e-com-
merce system. The value in this column depends on the entity type of the
synchronization record.
Retail-Commerce Edition Form Reference | 475
Column Description
Last Error The error, if any, that occurred during the last attempt to process the syn-
chronization record.
Last Operation The operation that was last performed on the document or entity record,
which is one of the following options:
• Inserted in ERP: The synchronization record was successfully processed;
during the synchronization, a new document or entity record was creat-
ed in Acumatica ERP.
• Updated in ERP: The synchronization record was successfully processed;
during the synchronization, the existing document or entity record was
updated in Acumatica ERP.
• Deleted in ERP: The synchronization record was successfully processed;
during the synchronization, the existing document or entity record was
deleted in Acumatica ERP.
• Modified in ERP: The document or entity record associated with this syn-
chronization record was changed in Acumatica ERP but not synchro-
nized.
• Failed to Save in ERP: An error occurred while the document or entity
record was being saved in Acumatica ERP.
• Conflict Resolved by Override in ERP: The synchronization record was
successfully processed; during the synchronization, a conflict occurred
that the system resolved by updating the document or entity record in
Acumatica ERP with the changes from the external system.
Retail-Commerce Edition Form Reference | 476
Column Description
• Inserted Externally: The synchronization record was successfully
processed; during the synchronization, a new document or entity record
was created in the external system.
• Updated Externally: The synchronization record was successfully
processed; during the synchronization, the existing document or entity
record was updated in the e-commerce system.
• Deleted Externally: The synchronization record was successfully
processed; during the synchronization, the existing document or entity
record was deleted in the external e-commerce system.
• Modified Externally: The document or entity record was changed in the
external e-commerce system but not synchronized.
• Failed to Save Externally: An error occurred while the document or entity
record was saved in the external e-commerce system.
• Conflict Resolved by Override Externally: The synchronization record was
successfully processed; during the synchronization, a conflict occurred
that was resolved by updating the document or entity record in the ex-
ternal e-commerce system with the changes from Acumatica ERP.
• Sync Failed: An error occurred during the synchronization.
• Manually Synchronized: The synchronization record was manually syn-
chronized by the user.
• Forced to Resync: The synchronization record was force-synchronized.
• Not Found: During the synchronization, the document or entity record
was not found in Acumatica ERP or in the external system.
• Sync Settings Reconfigured: The synchronization settings for the entity
were updated.
• Skipped from Sync: The document or entity record was skipped during
the synchronization.
• Filtering Applied: Filtering conditions defined in the code or on the Enti-
ties (BC202000) form have been applied.
Last Attempt The date and time when the last attempt to run the data synchronization
process occurred.
Attempt Count The total number of attempts to process the synchronization record if the
attempt resulted in an error; otherwise, the column contains 0.
Active A read-only check box that indicates (if selected) that the entity to which
the synchronization record belongs is activated in the store settings on
the Entity Settings tab of the BigCommerce Stores (BC201000) or Shopify
Stores (BC201010) form.
External Hash The security value generated during the export or import operation if the
document or entity record does not have a timestamp.
Ready to Process A read-only check box that indicates (if selected) that the synchronization
record needs to be processed.
Column Description
Last Externally Modified The date and time when the document or entity record was last modified
in the external e-commerce system.
This column is hidden by default.
Last Locally Modified The date and time when the document or entity record was last modified
in Acumatica ERP.
This column is hidden by default.
Primary System The system that is used as the source of data during the synchronization of
entities.
The primary system can be either of the following:
• ERP (that is, Acumatica ERP)
• External System (that is, the external e-commerce system)
If an entity is synchronized in both directions (Bidirectional is specified in
the Sync Direction column), the data of the primary system takes prece-
dence if any conflicts arise during the synchronization.
This column is hidden by default.
Sync Direction The direction of the synchronization. One of the following options may be
displayed:
• Export: Data is exported from Acumatica ERP to the external e-com-
merce system.
• Import: Data is imported to Acumatica ERP from the external e-com-
merce system.
• Bidirectional: Data is synchronized between Acumatica ERP and the ex-
ternal e-commerce system in both directions.
This column is hidden by default.
In this chapter, you will find reference topics that show the field mapping used during the synchronization
of entities between Acumatica ERP and BigCommerce. The mapping settings described in these topics are
preconfigured and available in Acumatica ERP Retail-Commerce Edition out of the box. You can override the
standard mapping or map additional fields on the Entities (BC202000) form, as described in Preparing Entities for
Synchronization.
The topics also contain information about any standard filters that may be applied during the synchronization
process, as well as information about the merging of duplicate records.
Customer Entity
This topic provides reference information about the standard filtering and field mapping used for the Customer
entity during the synchronization between Acumatica ERP and BigCommerce. The topic also contains information
about the merging of duplicate records during the synchronization.
Customer Filtering
During the export of the Customer entity from Acumatica ERP, the guest customer account—which is the account
selected in the Generic Guest Customer box on the Customer Settings tab of the BigCommerce Stores (BC201000)
form—is excluded from synchronization.
Merging of Duplicates
During the synchronization of the Customer entity (for both the Export direction and the Import direction), a
customer record in the source system is merged with an existing customer record in the target system if both
records have the same email address.
Name (part before General tab > Pri- First Name Edit Customer page >
the first space) mary Contact sec- Customer Details sec-
tion tion
Name (part after General tab > Pri- Last Name Edit Customer page >
the first space) mary Contact sec- Customer Details sec-
tion tion
Account Name General tab > Ac- Company Name Edit Customer page >
count Info section Customer Details sec-
tion
Email General tab > Pri- Email Address Edit Customer page >
mary Contact sec- Customer Details sec-
tion tion
Phone 2 General tab > Addi- Phone Number Edit Customer page > If Phone 2 is
tional Account Info Customer Details sec- empty, Phone
section tion 1 is used.
Price Class Shipping tab > Oth- Customer Group Edit Customer page > Customer
er Settings section Customer Details sec- price classes
tion are mapped
to customer
groups only if
the Customer
Price Class en-
tity is activated
on the BigCom-
merce Stores
form.
Retail-Commerce Edition Entity Reference | 480
Address Line 1 General tab > Ac- Address Line 1 Edit Customer page These map-
count Address sec- > Customer Address pings apply if
tion Book section the Customer
Location enti-
Address Line 2 General tab > Ac- Address Line 2 Edit Customer page ty is activated
count Address sec- > Customer Address on the Entity
tion Book section Settings tab
of the BigCom-
Account Name General tab > Ac- Company Name Edit Customer page merce Stores
count Info section > Customer Address (BC201000)
Book section form and the
corresponding
Account Name General tab > Ac- First Name Edit Customer page boxes are emp-
(part before the first count Info section > Customer Address ty on the Cus-
space) Book section tomer Locations
(AR303020)
Account Name General tab > Ac- Last Name Edit Customer page form.
(part after the first count Info section > Customer Address
space) Book section
Country General tab > Ac- Country Edit Customer page The ISO coun-
count Address sec- > Customer Address try code is
tion Book section transformed
to the coun-
try name. This
mapping ap-
plies if the Cus-
tomer Loca-
tion entity is
activated on
the Entity Set-
tings tab of
the BigCom-
merce Stores
(BC201000)
form and the
correspond-
ing box is emp-
ty on the Cus-
tomer Locations
(AR303020)
form.
Retail-Commerce Edition Entity Reference | 481
State General tab > Ac- State/Province Edit Customer Address The state code
count Address sec- page > Customer Ad- is transformed
tion dress Details section to the state
name. This
mapping ap-
plies if the Cus-
tomer Loca-
tion entity is
activated on
the Entity Set-
tings tab of
the BigCom-
merce Stores
(BC201000)
form and the
correspond-
ing box is emp-
ty on the Cus-
tomer Locations
(AR303020)
form.
Postal Code General tab > Ac- Zip/Postcode Edit Customer page Zip/Postcode
count Address sec- > Customer Address is a required
tion Book section field in Big-
Commerce.
This mapping
applies if the
Customer Lo-
cation entity
is activated
on the Entity
Settings tab
of the BigCom-
merce Stores
(BC201000)
form and the
correspond-
ing box is emp-
ty on the Cus-
tomer Locations
(AR303020)
form.
Retail-Commerce Edition Entity Reference | 482
Phone 1 General tab > Addi- Phone Number Edit Customer page This mapping
tional Account Info > Customer Address applies if the
section Book section Customer Lo-
cation entity
is activated
on the Entity
Settings tab
of the BigCom-
merce Stores
(BC201000)
form and the
correspond-
ing box is emp-
ty on the Cus-
tomer Locations
(AR303020)
form.
Company Name Edit Customer Account Name General tab > Ac-
page > Customer count Info section
Details section
Phone Number Edit Customer Phone 1 General tab > Addi- The phone number
page > Customer tional Account Info is copied from the
Address Book sec- section first address in the
tion customer address
book.
Email Address Edit Customer Account Email General tab > Addi-
page > Customer tional Account Info
Details section section
Customer ID Edit Customer Ext. Ref. Nbr. General tab > Addi- The value in the
page > URL tional Account Info Ext. Ref. Nbr. box
section consists of the cus-
tomer ID from the
customer's page
URL in BigCom-
merce, a hyphen,
and the name of the
BigCommerce store.
Address Line 1 Edit Customer Ad- Address Line 1 General tab > Ac-
dress page > Cus- count Address sec-
tomer Address De- tion
tails section
Address Line 2 Edit Customer Ad- Address Line 2 General tab > Ac-
dress page > Cus- count Address sec-
tomer Address De- tion
tails section
Retail-Commerce Edition Entity Reference | 484
State/Province Edit Customer Ad- State General tab > Ac- The state name is
dress page > Cus- count Address sec- transformed to the
tomer Address De- tion state code.
tails section
Zip/Postcode Edit Customer Ad- Postal Code General tab > Ac-
dress page > Cus- count Address sec-
tomer Address De- tion
tails section
Country Edit Customer Ad- Country General tab > Ac- The country name is
dress page > Cus- count Address sec- transformed to the
tomer Address De- tion ISO country code.
tails section
This topic provides reference information about the standard filtering and field mapping used for the Customer
Location entity during the synchronization between Acumatica ERP and BigCommerce.
Attention (part be- General tab > Addi- First Name Edit Customer Ad- • If Attention is
fore the first space) tional Location In- dress page > Cus- empty, Location
fo section tomer Address De- Name is used.
tails section • If Attention
consists of one
word, it is used
for both First
Name and Last
Name.
Attention (part af- General tab > Addi- Last Name Edit Customer Ad- • If Attention is
ter the first space) tional Location In- dress page > Cus- empty, Location
fo section tomer Address De- Name is used.
tails section • If Attention
consists of one
word, it is used
for both First
Name and Last
Name.
Account Name General tab > Addi- Company Name Edit Customer Ad- If Account Name
tional Location In- dress page > Cus- is empty, Location
fo section tomer Address De- Name is used.
tails section
Phone 1 General tab > Addi- Phone Number Edit Customer If Phone 1 is empty,
tional Location In- page >Customer Phone 2 is used.
fo section Details section
Address Line 1 General tab > Lo- Address Line 1 Edit Customer Ad-
cation Address sec- dress page > Cus-
tion tomer Address De-
tails section
Address Line 2 General tab > Lo- Address Line 2 Edit Customer Ad-
cation Address sec- dress page > Cus-
tion tomer Address De-
tails section
Country General tab > Loca- Country Edit Customer Ad- The ISO country
tion Address sec- dress page > Cus- code is transformed
tion tomer Address De- to the company
tails section name.
Retail-Commerce Edition Entity Reference | 486
State General tab > Loca- State/Province Edit Customer Ad- The state code is
tion Address sec- dress page > Cus- transformed to the
tion tomer Address De- state name.
tails section
Postal Code General tab > Lo- Zip/Postcode Edit Customer Ad- Zip/Postcode is a
cation Address sec- dress page > Cus- required field in Big-
tion tomer Address De- Commerce.
tails section
Company Name Edit Customer Ad- Location Name Summary area If Company Name
dress page > Cus- is empty, First
tomer Address De- Name and Last
tails section Name are used.
Company Name Edit Customer Ad- Account Name General tab > Addi- If Company Name
dress page > Cus- tional Location In- is empty, First
tomer Address De- fo section Name and Last
tails section Name are used.
First Name and Edit Customer Ad- Attention General tab > Addi-
Last Name dress page > Cus- tional Location In-
tomer Address De- fo section
tails section
Email Address Edit Customer page Email General tab > Addi-
> Customer Details tional Location In-
section fo section
Phone Number Edit Customer Ad- Phone 1 General tab > Addi- The phone num-
dress page > Cus- tional Location In- ber from the first
tomer Address De- fo section address in the cus-
tails section tomer address book
is used.
Phone Number Edit Customer page Phone 2 General Info tab >
>Customer Details Additional Loca-
section tion Info section
Address Line 1 Edit Customer Ad- Address Line 1 General tab > Loca-
dress page > Cus- tion Address sec-
tomer Address De- tion
tails section
Retail-Commerce Edition Entity Reference | 488
Address Line 2 Edit Customer Ad- Address Line 2 General tab > Loca-
dress page > Cus- tion Address sec-
tomer Address De- tion
tails section
Country Edit Customer Ad- Country General tab > Loca- The country name is
dress page > Cus- tion Address sec- transformed to the
tomer Address De- tion ISO country code.
tails section
State/Province Edit Customer Ad- State General tab > Loca- The state name is
dress page > Cus- tion Address sec- transformed to the
tomer Address De- tion state code.
tails section
Zip/Postcode Edit Customer Ad- Postal Code General tab > Loca-
dress page > Cus- tion Address sec-
tomer Address De- tion
tails section
This topic provides reference information about the standard filtering and field mapping used for the Sales
Category entity during the synchronization between Acumatica ERP and BigCommerce. The topic also contains
information about the merging of duplicate records during the synchronization.
Merging of Duplicates
During the synchronization of the Sales Category entity, a sales category in the source system is merged with an
existing sales category in the destination system if the Name of the product category in BigCommerce matches the
Description of the item sales category in Acumatica ERP.
Name Edit Category page > Category Description Item Sales Categories
Details section (IN204060)
Parent Category Edit Category page > Category Parent Category Item Sales Categories
Details section
When the Sales Category entity is synchronized, the order in which item sales categories are displayed on the Item
Sales Categories form in Acumatica ERP and on the Product Category page in BigCommerce (and ultimately on the
storefront) is also synchronized.
This topic provides reference information about the standard filtering and field mapping used for the Stock Item
entity during the synchronization between Acumatica ERP and BigCommerce. The topic also contains information
about the merging of duplicate records during the synchronization.
Merging of Duplicates
During the export of stock items from Acumatica ERP, a stock item is merged with an existing product in
BigCommerce if at least one of the following conditions is met:
• The stock item's description in Acumatica ERP—that is, the value in the Description box on the Stock Items
(IN202500) form—matches the Product Name of the product in BigCommerce.
• The stock item's ID in Acumatica ERP—that is, the value in the Inventory ID box on the Stock Items form—
matches the SKU of the product in BigCommerce.
Default Price Price/Cost tab > Default Price Product manage- If the Multiple Base
Price Management ment page > Pricing Currencies feature
section section is enabled on the
Enable/Disable Fea-
tures (CS100000)
form, the system
exports the default
price defined in
the currency of the
branch selected on
the Order Settings
tab of the BigCom-
merce Stores form.
Retail-Commerce Edition Entity Reference | 491
MSRP Price/Cost tab > MSRP Product manage- If the Multiple Base
Price Management ment page > Pricing Currencies feature
section section is enabled on the
Enable/Disable Fea-
tures (CS100000)
form, the system ex-
ports the MSRP de-
fined in the curren-
cy of the branch se-
lected on the Or-
der Settings tab of
the BigCommerce
Stores form.
General tab
Default Issue From General tab > Bin Picking Num- Product manage-
Warehouse De- ber (BPN) ment page > Prod-
faults section uct Identifiers sec-
tion
eCommerce tab
Visibility: Visible eCommerce tab Visible on Store- Product manage- The Visible on
front ment page > Basic Storefront check
Information sec- box is selected.
tion
Visibility: Featured eCommerce tab Set as a Featured Product manage- The Visible on
Product on my ment page > Store- Storefront check
Storefront front Details sec- box is selected,
tion and the Set as a
Featured Product
on my Storefront
check box is select-
ed.
Visibility: Invisible eCommerce tab Visible on Store- Product manage- The Visible on
front ment page > Basic Storefront check
Information sec- box is cleared.
tion
Retail-Commerce Edition Entity Reference | 492
Availability: Set eCommerce tab Track inventory Product manage- The This product
as Available (Track ment page > Inven- can be purchased
Qty.) tory section in my online store
option button is
selected, and the
Track inventory
check box is select-
ed.
Availability: Set eCommerce tab Track inventory Product manage- The This prod-
as Available (Don't ment page > Inven- uct can be pur-
Track Qty.) tory section chased in my on-
line store option
button is selected,
and the Track in-
ventory check box
is cleared.
Availability: Set as eCommerce tab This product is Product manage- The This product
Pre-Order coming soon but I ment page > Pur- can be purchased
want to take pre- chasability section in my online store
orders option button is se-
lected.
Availability: Set as eCommerce tab This product can- Product manage- The This product
Unavailable not be purchased ment page > Pur- cannot be pur-
in my online store chasability section chased in my on-
line store option
button is selected.
Cross-Reference tab
Alternate Type: Cross-Reference Manufacturer Part Product manage- The first row for
Vendor Part Number tab Number (MPN) ment page > Prod- Vendor Part Num-
uct Identifiers sec- ber with the default
tion vendor is used.
Alternate Type: Cross-Reference Product UPC/EAN Product manage- The first row for Bar-
Barcode tab ment page > Prod- code with the base
uct Identifiers sec- UOM is used.
tion
This topic provides reference information about the standard filtering and field mapping used for the Non-Stock
Item entity during the synchronization between Acumatica ERP and BigCommerce. The topic also contains
information about the merging of duplicate records during the synchronization.
Merging of Duplicates
During the export of non-stock items from Acumatica ERP, a non-stock item is merged with an existing product in
BigCommerce if at least one of the following conditions is met:
• The non-stock item's description in Acumatica ERP—that is, the value in the Description box on the Non-
Stock Items (IN202000) form—matches the Product Name of the product in BigCommerce.
• The non-stock item's ID in Acumatica ERP—that is, the value in the Inventory ID box on the Non-Stock Items
form—matches the SKU of the product in BigCommerce.
Retail-Commerce Edition Entity Reference | 494
Require Shipment: General tab Product Type Product manage- Default: Digital
Cleared ment page > Basic
Information sec-
tion
Require Shipment: General tab Product Type Product manage- Default: Physical
Selected ment page > Basic
Information sec-
tion
Default Price Price/Cost tab > Default Price Product manage- If the Multiple Base
Price Management ment page > Pricing Currencies feature
section section is enabled on the
Enable/Disable Fea-
tures (CS100000)
form, the system
exports the default
price defined in
the currency of the
branch selected on
the Order Settings
tab of the BigCom-
merce Stores form.
Retail-Commerce Edition Entity Reference | 495
MSRP Price/Cost tab > MSRP Product manage- If the Multiple Base
Price Management ment page > Pricing Currencies feature
section section is enabled on the
Enable/Disable Fea-
tures (CS100000)
form, the system ex-
ports the MSRP de-
fined in the curren-
cy of the branch se-
lected on the Or-
der Settings tab of
the BigCommerce
Stores form.
General tab
eCommerce tab
Visibility: Visible eCommerce tab Visible on Store- Product manage- The Visible on
front ment page > Basic Storefront check
Information sec- box is selected.
tion
Visibility: Featured eCommerce tab Set as a Featured Product manage- The Visible on
Product on my ment page > Store- Storefront check
Storefront front Details sec- box is selected and
tion the Set as a Fea-
tured Product on
my Storefront
check box is select-
ed.
Visibility: Invisible eCommerce tab Visible on Store- Product manage- The Visible on
front ment page > Basic Storefront check
Information sec- box is cleared.
tion
Availability: Set eCommerce tab Track inventory Product manage- The This prod-
as Available (Don't ment page > Inven- uct can be pur-
Track Qty.) tory section chased in my on-
line store option
button is selected,
and the Track in-
ventory check box
is cleared.
Availability: Set as eCommerce tab This product is Product manage- The This product
Pre-Order coming soon but I ment page > Pur- can be purchased
want to take pre- chasability section in my online store
orders option button is se-
lected.
Availability: Set as eCommerce tab This product can- Product manage- The This product
Unavailable not be purchased ment page > Pur- cannot be pur-
in my online store chasability section chased in my on-
line store option
button is selected.
Cross-Reference tab
Alternate Type: Cross-Reference Manufacturer Part Product manage- The first row for
Vendor Part Number tab Number (MPN) ment page > Prod- Vendor Part Num-
uct Identifiers sec- ber with the default
tion vendor is used.
Retail-Commerce Edition Entity Reference | 497
Alternate Type: Cross-Reference Product UPC/EAN Product manage- The first row for
Barcode tab ment page > Prod- Barcode with the
uct Identifiers sec- base UOM is used.
tion
This topic provides reference information about the standard filtering and field mapping used for the Template Item
entity during the synchronization between Acumatica ERP and BigCommerce. The topic also contains information
about the merging of duplicate records during the synchronization.
Merging of Duplicates
During the export of template items from Acumatica ERP, a template item is merged with an existing product in
BigCommerce if at least of the following conditions is met:
• The template item's description in Acumatica ERP—that is, the value in the Description box on the Template
Items (IN203000) form—matches the Product Name of the product in BigCommerce.
• The template item's ID in Acumatica ERP—that is, the value in the Inventory ID box on the Template Items
form—matches the SKU of the product in BigCommerce.
Stock Item: Select- Summary area Product Type Product manage- Product Type is set
ed ment page > Basic to Physical
Information sec-
tion
Retail-Commerce Edition Entity Reference | 498
Stock Item: Summary area Product Type Product manage- Product Type is set
Cleared;Require ment page > Basic to Physical
Shipment: Selected Information sec-
tion
Stock Item: Summary area Product Type Product manage- Product Type is set
Cleared;Require ment page > Basic to Digital
Shipment: Cleared Information sec-
tion
Default Price Price/Cost tab > Default Price Product manage- If the Multiple Base
Price Management ment page > Pric- Currencies feature
section ing section is enabled on the
Enable/Disable Fea-
tures (CS100000)
form, the system
exports the default
price defined in
the currency of the
branch selected on
the Order Settings
tab of the BigCom-
merce Stores form.
MSRP Price/Cost tab > MSRP Product manage- If the Multiple Base
Price Management ment page > Pric- Currencies feature
section ing section is enabled on the
Enable/Disable Fea-
tures (CS100000)
form, the system ex-
ports the MSRP de-
fined in the curren-
cy of the branch se-
lected on the Or-
der Settings tab of
the BigCommerce
Stores form.
General tab
Retail-Commerce Edition Entity Reference | 499
Default Issue From General tab > Bin Picking Num- Product manage-
Warehouse De- ber (BPN) ment page > Prod-
faults section uct Identifiers sec-
tion
eCommerce tab
Visibility: Visible eCommerce tab Visible on Store- Product manage- The Visible on
front ment page > Basic Storefront check
Information sec- box is selected.
tion
Visibility: Featured eCommerce tab Set as a Featured Product manage- The Visible on
Product on my ment page > Store- Storefront check
Storefront front Details sec- box is selected, and
tion the Set as a Fea-
tured Product on
my Storefront is
selected.
Visibility: Invisible eCommerce tab Visible on Store- Product manage- The Visible on
front ment page > Basic Storefront check
Information sec- box is cleared.
tion
Availability: Set eCommerce tab Track inventory Product manage- The Set as Avail-
as Available (Track ment page > Inven- able (Track Qty.) op-
Qty.) tory section tion is available on-
ly if the Stock Item
check box is select-
ed in the Summary
area of the Template
Items form.
Availability: Set eCommerce tab Track inventory Product manage- The This prod-
as Available (Don't ment page > Inven- uct can be pur-
Track Qty.) tory section chased in my on-
line store option
button is selected
and the Track in-
ventory check box
is cleared.
Availability: Set as eCommerce tab This product is Product manage- The This product
Pre-Order coming soon but I ment page > Pur- can be purchased
want to take pre- chasability section in my online store
orders option button is se-
lected.
Availability: Set as eCommerce tab This product can- Product manage- The This product
Unavailable not be purchased ment page > Pur- cannot be pur-
in my online store chasability section chased in my on-
line store option
button is selected.
The following table includes the mapping of Acumatica ERP fields to BigCommerce fields that is used during the
export of matrix items to BigCommerce as part of the synchronization of the Template Item entity.
Default Price Price/Cost tab > Default Price Product manage- If the Multiple Base
Price Management ment page > Varia- Currencies feature
section tions section > Vari- is enabled on the
ants table Enable/Disable Fea-
tures (CS100000)
form, the system
exports the default
price defined in
the currency of the
branch selected on
the Order Settings
tab of the BigCom-
merce Stores form.
Retail-Commerce Edition Entity Reference | 502
MSRP Price/Cost tab > MSRP Product manage- If the Multiple Base
Price Management ment page > Varia- Currencies feature
section tions section > Vari- is enabled on the
ants table Enable/Disable Fea-
tures (CS100000)
form, the system ex-
ports the MSRP de-
fined in the curren-
cy of the branch se-
lected on the Or-
der Settings tab of
the BigCommerce
Stores form.
Cross-Reference tab
Alternate Type: Cross-Reference Manufacturer Part Product manage- The first row for
Vendor Part Number tab Number (MPN) ment page > Prod- Vendor Part Num-
uct Identifiers sec- ber with the default
tion vendor is used.
Alternate Type: Cross-Reference Product UPC/EAN Product manage- The first row for
Barcode tab ment page > Prod- Barcode with the
uct Identifiers sec- base UOM is used.
tion
This topic provides reference information about the standard field mapping used for the Product Availability entity
during the synchronization between Acumatica ERP and BigCommerce.
To avoid discrepancies in sales orders imported into Acumatica ERP, we recommend that before
changing an item's sales UOM you make sure that there are no unsynchronized sales orders that
contain the item. Also, you should synchronize the item's available quantity immediately aer
changing its sales UOM so that new orders for the item are created in the BigCommerce store with the
updated UOM.
Availability Mode: Inventory Settings Stock Product manage- Stock is set to the
Available tab ment page > Inven- available quantity
tory section of the item.
Availability Mode: Inventory Settings Stock Product manage- Stock is set to the
Available for Ship- tab ment page > Inven- quantity available
ping tory section for shipping.
Availability Mode: Inventory Settings Stock Product manage- Stock is set to the
On Hand tab ment page > Inven- on-hand quantity of
tory section the item.
When Qty. Unavail- eCommerce tab This product can- Product manage- If Stock becomes
able: Do Nothing not be purchased ment page > Pur- zero, the This prod-
in my online store chasability section uct can be pur-
chased in my on-
line store option is
selected.
When Qty. Unavail- eCommerce tab This product can- Product manage- If Stock becomes
able: Set as Unavail- not be purchased ment page > Pur- zero, the This prod-
able in my online store chasability section uct cannot be pur-
chased in my on-
line store option is
selected.
When Qty. Unavail- eCommerce tab This product is Product manage- If Stock becomes
able: Set as Pre-Or- coming soon but I ment page > Pur- zero, the This prod-
der/Continue Selling want to take pre- chasability section uct is coming soon
orders but I want to take
pre-orders option
is selected.
When Qty. Unavail- eCommerce tab See the following rows of the table.
able: Store Default
Retail-Commerce Edition Entity Reference | 504
When Qty. Unavail- Inventory Settings This product can Product manage- If Stock becomes
able: Do Nothing tab be purchased in ment page > Pur- zero, the This prod-
my online store chasability section uct can be pur-
chased in my on-
line store option is
selected.
This setting applies
only if the When
Qty Unavailable
box on the eCom-
merce tab is set to
Store Default.
When Qty. Unavail- Inventory Settings This product can- Product manage- If Stock becomes
able: Set as Unavail- tab not be purchased ment page > Pur- zero, the This prod-
able in my online store chasability section uct cannot be pur-
chased in my on-
line store option is
selected.
This setting applies
only if the When
Qty Unavailable
box on the eCom-
merce tab is set to
Store Default.
When Qty. Unavail- Inventory Settings This product is Product manage- If Stock becomes
able: Set as Pre-Or- tab coming soon but I ment page > Pur- zero, the This prod-
der want to take pre- chasability section uct is coming soon
orders but I want to take
pre-orders option
remains selected.
This setting applies
only if the When
Qty Unavailable
box on the eCom-
merce tab is set to
Store Default.
This topic provides reference information about the standard filtering and field mapping used for the Sales Order
entity during the synchronization between Acumatica ERP and BigCommerce. The topic also contains information
about the merging of duplicate records during the synchronization.
Retail-Commerce Edition Entity Reference | 505
Merging of Duplicates
A sales order imported from the BigCommerce store is merged with an existing sales order in Acumatica ERP if the
ID of the BigCommerce order (found on the View orders page) matches the External Reference of the order, which
is located on the Sales Orders (SO301000) form, in Acumatica ERP.
Currency Summary area Currency View Orders page > This box is shown
Transactional Cur- only if the Multic-
rency section urrency Account-
ing feature is en-
abled on the En-
able/Disable Fea-
tures (CS100000)
form.
Retail-Commerce Edition Entity Reference | 506
Status Summary area Status View Orders page The statuses are
mapped as follows:
• Back Order ->
Partially shipped
• Canceled -> Can-
celled
• Completed ->
Shipped
• Credit Hold ->
Verification re-
quired
• On Hold -> Pend-
ing
• Open -> Awaiting
fulfillment
• Balanced -> Man-
ual verification
required
• Shipping ->
Awaiting ship-
ment
• Invoiced ->
Awaiting fulfill-
ment
Freight Price Totals tab > Freight Shipping View Orders page
Info section
Attention (part be- Addresses tab > First Name Edit an Order page If there is no space
fore the first space) Bill-To Contact sec- > Billing Informa- in Attention, the
tion tion section whole value is
copied to First
Name.
Attention (part af- Addresses tab > Last Name Edit an Order page If there is no space
ter the space) Bill-To Contact sec- > Billing Informa- in Attention, the
tion tion section whole value is
copied to Last
Name.
Account Name Addresses tab > Company Name Edit an Order page
Bill-To Contact sec- > Billing Informa-
tion tion section
Address Line 1 Addresses tab > Address Line 1 Edit an Order page
Bill-To Contact sec- > Billing Informa-
tion tion section
Retail-Commerce Edition Entity Reference | 507
Address Line 2 Addresses tab > Address Line 2 Edit an Order page
Bill-To Contact sec- > Billing Informa-
tion tion section
Country Addresses tab > Country Edit an Order page The ISO country
Bill-To Contact sec- > Billing Informa- code is transformed
tion tion section to the country
name.
State Addresses tab > State/Province Edit an Order page The state code is
Bill-To Contact sec- > Billing Informa- transformed to the
tion tion section state name.
Attention (part be- Addresses tab > First Name Edit an Order page
fore the first space) Ship-To Contact > Shipping section
section
Attention (part af- Addresses tab > Last Name Edit an Order page
ter the first space) Ship-To Contact > Shipping section
section
Account Name Addresses tab > Company Name Edit an Order page
Ship-To Contact > Shipping section
section
Address Line 1 Addresses tab > Address Line 1 Edit an Order page
Ship-To Address > Shipping section
section
Address Line 2 Addresses tab > Address Line 2 Edit an Order page
Ship-To Address > Shipping section
section
Country Addresses tab > Country Edit an Order page The ISO country
Ship-To Address > Shipping section code is transformed
section to the country
name.
State Addresses tab > State/Province Edit an Order page The state code is
Ship-To Address > Shipping section transformed to the
section state name.
Discount Amount Details tab Manual Discount Edit an Order page All discounts are
> Summary section summed and the
total amount is
added.
Address View Orders page > Location Summary area If the shipping ad-
Shipping section dress of the or-
der is saved to the
customer address
book in BigCom-
merce and if syn-
chronization of lo-
cations/address-
es is turned on, the
saved address is im-
ported to Acumat-
ica ERP as a cus-
tomer location and
this customer loca-
tion is used for the
order. Otherwise,
the primary loca-
tion is used.
Staff Notes Edit an Order page Notes Form title bar Default: Staff Notes:
> Comments and <text> (combined
Notes section with Customer
Notes)
Comments Edit an Order page Notes Form title bar Default: Customer
> Comments and Notes: <text> (com-
Notes section bined with Staff
Notes)
Shipping View Orders page Freight Price Totals tab > Freight This mapping is
Info section used if the shipping
terms allow freight
calculation on or-
der.
Billing Information
Retail-Commerce Edition Entity Reference | 511
First Name and Edit an Order page Attention Addresses tab > The First Name is
Last Name > Billing Informa- Bill-To Contact sec- concatenated with
tion section tion the Last Name.
Company Name Edit an Order page Account Name Addresses tab >
> Billing Informa- Bill-To Contact sec-
tion section tion
Address Line 1 Edit an Order page Address Line 1 Addresses tab >
> Billing Informa- Bill-To Address sec-
tion section tion
Address Line 2 Edit an Order page Address Line 2 Addresses tab >
> Billing Informa- Bill-To Address sec-
tion section tion
Country Edit an Order page Country Addresses tab > The country name
> Billing Informa- Bill-To Address sec- is transformed to
tion section tion the ISO country
code.
State Edit an Order page State Addresses tab > The state name is
> Billing Informa- Bill-To Address sec- transformed to the
tion section tion state code.
Shipping Info
Retail-Commerce Edition Entity Reference | 512
BigCommerce sup-
ports multiple ship-
ping addresses,
whereas Acumati-
ca ERP supports on-
ly one shipping ad-
dress. Only the first
shipping address is
imported with the
sales order.
First Name and Edit an Order page Attention Addresses tab >
Last Name > Shipping section Ship-To Contact
section
Company Name Edit an Order page Account Name Addresses tab >
> Shipping section Ship To Contact
section
Address Line 1 Edit an Order page Address Line 1 Addresses tab >
> Shipping section Ship To Address
section
Address Line 2 Edit an Order page Address Line 2 Addresses tab >
> Shipping section Ship To Address
section
Country Edit an Order page Country Addresses tab > The country name
> Shipping section Ship To Address is transformed to
section the ISO country
code.
State Edit an Order page State Addresses tab > The state name is
> Shipping section Ship To Address transformed to the
section state code.
Order Lines
Product Discount Edit an Order page Discount Amount Details tab Used if discounts
> Summary section are configured to
appear on the line
level on the Or-
der Settings tab of
the BigCommerce
Stores form.
Order Discounts
Manual Discount Edit an Order page Discount Amt. Discounts tab A separate row is
> Summary section added for the man-
ual discount on the
Discounts tab.
Retail-Commerce Edition Entity Reference | 515
Product Discount Edit an Order page Discount Amt. Discounts tab If discounts are
> Summary section configured to ap-
pear on the docu-
ment level on the
Order Settings
tab of the BigCom-
merce Stores form,
all product line
discounts are dis-
played on the Dis-
counts tab grouped
by discount code
(one row per dis-
count code).
Shipment Entity
This topic provides reference information about the standard filtering and field mapping used for the Shipment
entity during the synchronization between Acumatica ERP and BigCommerce.
Shipment Filtering
When shipments are exported to Shopify, a shipment is skipped if any of the following conditions are met:
• The status of the shipment is Confirmed, Invoiced, or Completed.
• The sales order related to the shipment has not been synchronized.
Ship Via Shipping tab > Shipping Method View Shipments If a shipment is a
Shipping Informa- page drop-shipment,
tion section the ship via code
is copied from the
purchase order.
Payment Entity
This topic provides reference information about the standard filtering and field mapping used for the Payment
entity during the synchronization between Acumatica ERP and BigCommerce.
Payment Filtering
Filters are applied during the import of payments to Acumatica ERP. A payment is skipped if any of the following is
true:
• Its status is Error—for example, if the credit card payment transaction was not successful.
• The manual payment method used for purchase is not supported.
• The sales order related to the payment has not been synchronized.
If the mapping of the store payment method has not been configured or is inactive on the Payment Settings tab
of the BigCommerce Stores (BC201000) form, the system creates a synchronization record for the payment on the
Sync History (BC301000) form and assigns it the Filtered status.
Retail-Commerce Edition Entity Reference | 517
Currency Edit an Order page Currency Summary area This box is shown
> Transactional only if the Multic-
Currency section urrency Account-
ing feature is en-
abled on the En-
able/Disable Fea-
tures (CS100000)
form.
Date Payment transac- Application Date Summary area The payment trans-
tion action date is used.
Amount Payment transac- Payment Amount Summary area The payment trans-
tion action amount is
used.
Payment Method Payment transac- Payment Method Summary area The payment
tion method that is
mapped to the
store's payment
method on the Pay-
ment Settings tab
of the BigCommerce
Stores form.
Retail-Commerce Edition Entity Reference | 518
In this chapter, you will find reference topics that show the field mapping used during the synchronization of
entities between Acumatica ERP and Shopify. The mapping settings described in these topics are preconfigured
and available in Acumatica ERP Retail-Commerce Edition out of the box. You can override the standard mapping or
map additional fields on the Entities (BC202000) form, as described in Preparing Entities for Synchronization.
The topics also contain information about any standard filters that may be applied during the synchronization
process, as well as information about the merging of duplicate records.
Customer Entity
This topic provides reference information about the standard filtering and field mapping used for the Customer
entity during the synchronization between Acumatica ERP and Shopify. The topic also contains information about
the merging of duplicate records during the synchronization.
Customer Filtering
During the export of the Customer entity from Acumatica ERP, the guest customer account—which is the account
selected in the Generic Guest Customer box on the Customer Settings tab of the Shopify Stores (BC201010) form
—is excluded from synchronization.
Merging of Duplicates
During the synchronization of the Customer entity (for both the Export direction and the Import direction), a
customer record in the source system is merged with an existing customer record in the target system if both
records have the same email address or the same phone number (if there is no email address).
Name (part before General tab > Pri- First name New customer If Primary Contact
the first space) mary Contact sec- page > Customer is empty, Account
tion overview section Name in the Ac-
count Info section
is used.
Retail-Commerce Edition Entity Reference | 520
Name (part after General tab > Pri- Last name New customer If Primary Contact
the first space) mary Contact sec- page > Customer is empty, Account
tion overview section Name in the Ac-
count Info section
is used.
Phone 1 General tab > Addi- Phone number New customer If Phone 1 is empty,
tional Account Info page > Customer Phone 2 is used.
section overview section
Address Line 2 General tab > Ac- Apartment, suite, New customer
count Address sec- etc. page >Address sec-
tion tion
Account Name General tab > Ac- First name New customer
(part before the first count Info section page > Address sec-
space) tion
Account Name General tab > Ac- Last name New customer
(part after the first count Info section page > Address sec-
space) tion
Postal Code General tab > Ac- ZIP code New customer
count Address sec- page > Address sec-
tion tion
Retail-Commerce Edition Entity Reference | 521
Tax Exemption Customer Locations Collect tax New customer If the Tax Exemp-
Number (AR303020) form > page > Tax exemp- tion Number box
Shipping tab, Tax tions section is empty, the Col-
Settings section lect tax check box
is selected. Other-
wise, the Collect
tax check box is
cleared.
Company Customer page > Account Name General tab > Ac-
Default Address count Info section
section
First Name Customer page > Name (part before General tab > Pri-
Customer section the first space) mary Contact sec-
tion
Last Name Customer page > Name (part after General tab > Pri-
Customer section the first space) mary Contact sec-
tion
Email Customer page > Account Email General tab > Addi-
Customer section tional Account Info
section
Phone number Customer page > Phone 1 General tab > Addi-
Customer section tional Account Info
section
Customer ID Visible in the Ext. Ref. Nbr. General tab > Addi- The value in the
page URL (<store tional Account Info Ext. Ref. Nbr. box
URL>/admin/cus- section consists of the cus-
tomers/<Customer tomer ID from the
ID>) customer's page
URL in Shopify, a
hyphen, and the
name of the Shopify
store.
Address Customer page > Address Line 1 General tab > Addi-
Default address tional Account Info
section section
Apartment, suite, Customer page > Address Line 2 General tab > Addi-
etc. Default address tional Account Info
section section
Country/region Customer page > Country General tab > Addi- The country name is
Default address tional Account Info transformed to the
section section ISO country code.
State/Province Customer page > State General tab > Addi- The state name is
Default address tional Account Info transformed to the
section section state code.
ZIP code Customer page > Postal Code General tab > Addi-
Default address tional Account Info
section section
This topic provides reference information about the standard filtering and field mapping used for the Customer
Location entity during the synchronization between Acumatica ERP and Shopify.
Attention (part be- General tab > Addi- First name New customer If Attention is emp-
fore the first space) tional Location In- page > Address sec- ty, Account Name is
fo section tion used.
Attention (part af- General tab > Addi- Last name New customer If Attention is emp-
ter the first space) tional Location In- page > Address sec- ty, Account Name is
fo section tion used.
Retail-Commerce Edition Entity Reference | 524
Account Name General Info tab > Company New customer If Account Name is
Additional Loca- page > Address sec- empty, Customer
tion Info section tion Name of the related
customer is used.
Address Line 2 General tab > Loca- Apartment, suite, New customer
tion Address sec- etc. page > Address sec-
tion tion
State General tab > Loca- State/Province New customer The state code is
tion Address sec- page > Address sec- transformed to the
tion tion state name.
Postal Code General tab > Loca- Postal code New customer
tion Address sec- page > Address sec-
tion tion
Country General tab > Loca- Country/Region New customer The ISO country
tion Address sec- page > Address sec- code is transformed
tion tion to the country
name.
Phone 1 General tab > Addi- Phone New customer If Phone 1 is empty,
tional Location In- page > Address sec- Phone 2 is used.
fo section tion
Company Customer page > Location Name Summary area If Company is emp-
Default address ty, First Name and
section Last Name are used.
Company Customer page > Account Name General tab > Addi-
Default address tional Location In-
section fo section
First name Customer page > Attention General tab > Addi-
Default address tional Location In-
section fo section
Last name Customer page > Attention General tab > Addi-
Default address tional Location In-
section fo section
Phone number Customer page > Phone 2 General tab > Addi-
Customer section tional Location In-
fo section
Address Customer page > Address Line 1 General tab > Lo-
Default address cation Address
section section
Apartment, suite, Customer page > Address Line 2 General tab > Lo-
etc. Default address cation Address
section section
Country/Region Customer page > Country General tab > Lo- The country name is
Default address cation Address converted to the ISO
section section country code.
State/Province Customer page > State General tab > Lo- The state name is
Default address cation Address converted to state
section section code.
Postal code Customer page > Postal Code General tab > Lo-
Default address cation Address
section section
This topic provides reference information about the standard filtering and field mapping used for the Stock Item
entity during the synchronization between Acumatica ERP and Shopify. The topic also contains information about
the merging of duplicate records during the synchronization.
Merging of Duplicates
During the export of stock items from Acumatica ERP, a stock item is merged with an existing product in
BigCommerce if its ID in Acumatica ERP—that is, the value in the Inventory ID box on the Stock Items form—
matches the SKU of the product in Shopify.
Retail-Commerce Edition Entity Reference | 527
Item Class General tab > Item Product Type Product page >
Defaults section Product organiza-
tion section
Vendor ID Vendors tab Vendor Product page > The vendor for
Product organiza- which the Default
tion section check box is select-
ed on the Vendors
tab is exported.
Category ID Attributes tab > Tags Product page > Sales categories are
Sales Categories Product organiza- exported to tags on-
table tion section ly if on the Shopify
Stores (BC201010)
form, the Sales Cat-
egory Export box
is set to Export as
Product Tags.
Visibility: Visible eCommerce tab Product page > The status is set
Product status sec- to Active and the
tion Online Store sales
channel is selected.
Retail-Commerce Edition Entity Reference | 528
Visibility: Featured eCommerce tab Product page > The status is set
Product status sec- to Active and the
tion Online Store sales
channel is selected.
Visibility: Invisible eCommerce tab Product page > The status is set to
Product status sec- Dra.
tion
Availability: Set eCommerce tab Track quantity Product page > In- The Track quantity
as Available (Track ventory section check box is select-
Qty.) ed.
Availability: Set eCommerce tab Track quantity Product page > In- The Track quan-
as Available (Don't ventory section titycheck box is
Track Qty.) cleared.
Availability: Set as eCommerce tab Track quantity Product page > In- The Track quan-
Pre-Order ventory section titycheck box is
cleared.
Availability: Set as eCommerce tab Track quantity Product page > In- The Track quan-
Unavailable ventory section titycheck box is
cleared. In the
Product status sec-
tion, no sales chan-
nel is selected.
When Qty. Unavail- eCommerce tab Continue selling Product page > In- The setting applies
able: Do Nothing when out of stock ventory section only to synchro-
nized items whose
quantities have
been synchronized.
The state of the
Continue selling
when out of stock
check box remains
unchanged.
When Qty. Unavail- eCommerce tab Continue selling Product page > In- The setting applies
able: Set as Unavail- when out of stock ventory section only to synchro-
able nized items whose
quantities have
been synchronized.
If Available in the
Quantity subsec-
tion becomes zero,
the Continue sell-
ing when out of
stock check box is
cleared.
Retail-Commerce Edition Entity Reference | 529
When Qty. Unavail- eCommerce tab Continue selling Product page > In- The setting applies
able: Set as Pre-Or- when out of stock ventory section only to synchro-
der/Continue Selling nized items whose
quantities have
been synchronized.
If Available in the
Quantity subsec-
tion becomes zero,
the Continue sell-
ing when out of
stock
check box is select-
ed.
Inventory ID Summary area SKU (Stock Keep- Product page > In-
ing Unit) ventory section
Weight UOM Packaging tab > Di- Weight Product page >
mensions section Shipping section >
Weight subsection
Default Price Price/Cost tab > Price Product page > If the Multiple Base
Price Management Pricing section Currencies feature
section is enabled on the
Enable/Disable Fea-
tures (CS100000)
form, the system
exports the default
price defined in
the currency of the
branch selected on
the Order Settings
tab of the Shopify
Stores form.
Tax Category General tab > Item Charge tax on this Product page > The check box is se-
Defaults section product Pricing section lected if Tax Cate-
gory is set to Tax-
able; the check box
is cleared if Tax Cat-
egory is set to Ex-
empt.
Retail-Commerce Edition Entity Reference | 530
MSRP Price/Cost tab > Compare at price Product page > If the Multiple Base
Price Management Pricing section Currencies feature
section is enabled on the
Enable/Disable Fea-
tures (CS100000)
form, the system ex-
ports the MSRP de-
fined in the curren-
cy of the branch se-
lected on the Order
Settings tab of the
Shopify Stores form.
Stock Item General tab > Gen- This is a physical Product page > The This is a phys-
eral Settings set- product Shipping section ical product check
tings box is selected for
a stock item—that
is, for an item with
an item class for
which the Stock
Item check box is
selected on the Item
Classes form.
Stock Item General tab > Gen- This is a physical Product page > The This is a phys-
eral Settings sec- product Shipping section ical product check
tion box is selected for
a stock item—that
is, for an item with
an item class for
which the Stock
Item check box is
selected on the Item
Classes form.
Retail-Commerce Edition Entity Reference | 531
This topic provides reference information about the standard filtering and field mapping used for the Non-Stock
Item entity during the synchronization between Acumatica ERP and Shopify. The topic also contains information
about the merging of duplicate records during the synchronization.
Merging of Duplicates
During the export of non-stock items from Acumatica ERP, a non-stock item is merged with an existing product in
Shopify if its ID in Acumatica ERP—that is, the value in the Inventory ID box on the Non-Stock Items form—matches
the SKU of the product in Shopify.
Item Class General tab > Item Product Type Product page >
Defaults section Product organiza-
tion section
Vendor ID Vendors tab Vendor Product page > The vendor for
Product organiza- which the Default
tion section check box is select-
ed on the Vendors
tab is exported.
Retail-Commerce Edition Entity Reference | 532
Category ID Attributes tab > Tags Product page > Sales categories are
Sales Categories Product organiza- exported to tags on-
table tion section ly if on the Shopify
Stores (BC201010)
form, the Sales Cat-
egory Export box
is set to Export as
Product Tags.
Visibility: Visible eCommerce tab Product page > The status is set
Product status sec- to Active and the
tion Online Store sales
channel is selected.
Visibility: Featured eCommerce tab Product page > The status is set
Product status sec- to Active and the
tion Online Store sales
channel is selected.
Visibility: Invisible eCommerce tab Product page > The status is set to
Product status sec- Dra.
tion
Availability: Set eCommerce tab Track quantity Product page > In- The Track quan-
as Available (Don't ventory section titycheck box is
Track Qty.) cleared.
Availability: Set as eCommerce tab Track quantity Product page > In- The Track quan-
Pre-Order ventory section titycheck box is
cleared.
Availability: Set as eCommerce tab Track quantity Product page > In- The Track quan-
Unavailable ventory section titycheck box is
cleared. In the
Product availabili-
ty section, no sales
channel is selected.
Inventory ID Summary area SKU (Stock Keep- Product page > In-
ing Unit) ventory section
Retail-Commerce Edition Entity Reference | 533
Default Price Price/Cost tab > Price Product page > If the Multiple Base
Price Management Pricing section Currencies feature
section is enabled on the
Enable/Disable Fea-
tures (CS100000)
form, the system
exports the default
price defined in
the currency of the
branch selected on
the Order Settings
tab of the Shopify
Stores form.
Tax Category General tab > Item Charge tax on this Product page > The check box is se-
Defaults section product Pricing section lected if Tax Cate-
gory is set to Tax-
able; the check box
is cleared if Tax Cat-
egory is set to Ex-
empt.
MSRP Price/Cost tab > Compare at price Product page > If the Multiple Base
Price Management Pricing section Currencies feature
section is enabled on the
Enable/Disable Fea-
tures (CS100000)
form, the system ex-
ports the MSRP de-
fined in the curren-
cy of the branch se-
lected on the Order
Settings tab of the
Shopify Stores form.
Stock Item General tab > Gen- This is a physical Product page > The This is a phys-
eral Settings sec- product Shipping section ical product check
tion box is cleared for a
non-stock item—
that is, for an item
with an item class
for which the Stock
Item check box is
cleared on the Item
Classes form.
This topic provides reference information about the standard filtering and field mapping used for the Template Item
entity during the synchronization between Acumatica ERP and Shopify. The topic also contains information about
the merging of duplicate records during the synchronization.
Merging of Duplicates
During the export of template items from Acumatica ERP, a template item is merged with an existing product in
Shopify if its ID in Acumatica ERP—that is, the value in the Inventory ID box on the Template Items form—matches
the SKU of the product in Shopify.
Item Class General tab > Item Product Type Product page >
Defaults section Product organiza-
tion section
Retail-Commerce Edition Entity Reference | 535
Vendor ID Vendors tab Vendor Product page > The vendor for
Product organiza- which the Default
tion section check box is select-
ed on the Vendors
tab is exported.
Category ID Fulfillment tab > Tags Products page > Sales categories are
Sales Categories Product organiza- exported to tags on-
table tion section ly if on the Shopify
Stores (BC201010)
form, the Sales Cat-
egory Export box
is set to Export as
Product Tags.
Visibility: Visible eCommerce tab Product page > The status is set
Product status sec- to Active and the
tion Online Store sales
channel is selected.
Visibility: Featured eCommerce tab Product page > The status is set
Product status sec- to Active and the
tion Online Store sales
channel is selected.
Visibility: Invisible eCommerce tab Product page > The status is set to
Product status sec- Dra.
tion
The following table includes the mapping of Acumatica ERP fields to Shopify fields that is used during the export of
matrix items to Shopify as part of the synchronization of the Template Item entity.
Retail-Commerce Edition Entity Reference | 536
Default Price Price/Cost tab > Price Product variant If the Multiple Base
Price Management page > > Pricing Currencies feature
section section is enabled on the
Enable/Disable Fea-
tures (CS100000)
form, the system
exports the default
price defined in
the currency of the
branch selected on
the Order Settings
tab of the Shopify
Stores form.
Tax Category General tab > Item Charge tax on this Product variant The check box is se-
Defaults section variant page > > Pricing lected if Tax Cate-
section gory is set to Tax-
able; the check box
is cleared if Tax Cat-
egory is set to Ex-
empt.
Retail-Commerce Edition Entity Reference | 537
MSRP Price/Cost tab > Compare at price Product variant If the Multiple Base
Price Management page > > Pricing Currencies feature
section section is enabled on the
Enable/Disable Fea-
tures (CS100000)
form, the system ex-
ports the MSRP de-
fined in the curren-
cy of the branch se-
lected on the Order
Settings tab of the
Shopify Stores form.
Availability: Set eCommerce tab Track quantity Product variant The Track quantity
as Available (Track page > Inventory check box is select-
Qty.) section ed.
Availability: Set eCommerce tab Track quantity Product variant The Track quan-
as Available (Don't page > Inventory titycheck box is
Track Qty.) section cleared.
Availability: Set as eCommerce tab Track quantity Product variant The Track quan-
Pre-Order page > Inventory titycheck box is
section cleared.
Availability: Set as eCommerce tab Track quantity Product variant The Track quan-
Unavailable page > Inventory titycheck box is
section cleared. In the
Product availabili-
ty section, no sales
channel is selected.
Retail-Commerce Edition Entity Reference | 538
When Qty. Unavail- eCommerce tab Continue selling Product variant The setting applies
able: Do Nothing when out of stock page > Inventory only to synchro-
section nized items whose
quantities have
been synchronized.
If Available in the
Quantity subsec-
tion becomes zero,
the Continue sell-
ing when out of
stock check box is
selected.
When Qty. Unavail- eCommerce tab Continue selling Product variant The setting applies
able: Set as Unavail- when out of stock page > Inventory only to synchro-
able section nized items whose
quantities have
been synchronized.
If Available in the
Quantity subsec-
tion becomes zero,
the Continue sell-
ing when out of
stock check box is
cleared.
When Qty. Unavail- eCommerce tab Continue selling Product variant The setting applies
able: Set as Pre-Or- when out of stock page > Inventory only to synchro-
der/Continue Selling section nized items whose
quantities have
been synchronized.
If Available in the
Quantity subsec-
tion becomes zero,
the Continue sell-
ing when out of
stock
check box is select-
ed.
Weight Packaging tab > Di- Weight Product variant Only for matrix
mensions section page >Shipping items that are stock
section > Weight items.
subsection
Weight UOM Packaging tab > Di- Weight Product variant Only for matrix
mensions section page > Shipping items that are stock
section > Weight items.
subsection
Stock Item Item Classes This is a physical Product variant The This is a phys-
(IN201000) form > product page > Shipping ical product check
General tab > Gen- section box is selected for
eral Settings set- a stock item (that
tings is, for an item with
an item class for
which the Stock
Item check box is
selected on the Item
Classes form) and
cleared for a non-
stock item (that is,
for an item with
an item class for
which the Stock
Item check box is
cleared on the Item
Classes form).
This topic provides reference information about the standard field mapping used for the Product Availability entity
during the synchronization between Acumatica ERP and Shopify.
To avoid discrepancies in sales orders imported into Acumatica ERP, we recommend that before
changing an item's sales UOM you make sure that there are no unsynchronized sales orders that
contain the item. Also, you should synchronize the item's available quantity immediately aer
changing its sales UOM so that new orders for the item are created in the Shopify store with the
updated UOM.
Retail-Commerce Edition Entity Reference | 540
Availability Mode: Inventory Settings Available Product page > In- Available is set to
Available tab > Inventory ventory section the available quan-
Settings section tity of the item.
Availability Mode: Inventory Settings Available Product page > In- Available is set to
Available for Ship- tab > Inventory ventory section the quantity avail-
ping Settings section able for shipping.
Availability Mode: Inventory Settings Available Product page > In- Available is set to
On Hand tab > Inventory ventory section the on-hand quanti-
Settings section ty of the item.
Warehouse Mode: Inventory Settings Available Product page > In- Available is cal-
All Warehouses tab > Inventory ventory section culated based on
Settings section quantities in all
warehouses.
Warehouse Mode: Inventory Settings Available Product page > In- Available is cal-
Specific Warehouses tab > Inventory ventory section culated based on
Settings section quantities in on-
ly particular ware-
houses and ware-
house locations.
When Qty. Unavail- eCommerce tab Continue selling Product page > In- If Available in the
able: Do Nothing when out of stock ventory section Quantity subsec-
tion becomes zero,
the Continue sell-
ing when out of
stock check box is
selected.
When Qty. Unavail- eCommerce tab Continue selling Product page > In- If Available in the
able: Set as Unavail- when out of stock ventory section Quantity subsec-
able tion becomes zero,
the Continue sell-
ing when out of
stock check box is
cleared.
Retail-Commerce Edition Entity Reference | 541
When Qty. Unavail- eCommerce tab Continue selling Product page > In- If Available in the
able: Set as Pre-Or- when out of stock ventory section Quantity subsec-
der/Continue Selling tion becomes zero,
the Continue sell-
ing when out of
stock check box is
selected.
When Qty. Unavail- Inventory Settings Continue selling Product page > In- If Available in the
able: Do Nothing tab > Inventory when out of stock ventory section Quantity subsec-
Settings section tion becomes zero,
the Continue sell-
ing when out of
stock check box is
selected.
This setting applies
only if the When
Qty. Unavailable
box on the eCom-
merce tab is set to
Store Default.
When Qty. Unavail- Inventory Settings Continue selling Product page > In- If Available in the
able: Set as Unavail- tab > Inventory when out of stock ventory section Quantity subsec-
able Settings section tion becomes zero,
the Continue sell-
ing when out of
stock check box is
cleared.
This setting applies
only if the When
Qty. Unavailable
box on the eCom-
merce tab is set to
Store Default.
Retail-Commerce Edition Entity Reference | 542
When Qty. Unavail- Inventory Settings Continue selling Product page > In- If Available in the
able: Set as Pre-Or- tab > Inventory when out of stock ventory section Quantity subsec-
der Settings section tion becomes zero,
the Continue sell-
ing when out of
stock check box is
cleared.
This setting applies
only if the When
Qty. Unavailable
box on the eCom-
merce tab is set to
Store Default.
This topic provides reference information about the standard filtering and field mapping used for the Sales Order
entity during the synchronization between Acumatica ERP and Shopify. The topic also contains information about
the merging of duplicate records during the synchronization.
Merging of Duplicates
A sales order imported from the e-commerce store is merged with an existing sales order in Acumatica ERP if the
ID of the Shopify order (found in the URL of the order page) matches the External Reference of the order, which is
located on the Sales Orders (SO301000) form, in Acumatica ERP.
created_at Order page > order Requested On Summary area This date is the
summary same as the date
shown in the Date
box in the Summary
area.
total_discounts Order page > to- Discount Total Summary area Applies if on the
tal of discount Order Settings
amounts tab (Order sec-
tion) of the Shopify
Stores (BC201010)
form, the Show Dis-
counts As box is
set to Document Dis-
counts.
Retail-Commerce Edition Entity Reference | 544
order_number Order page > order External Reference Summary area The External Ref-
summary erence contains the
order number and
the store name.
Discounts
Taxes
Billing Address
company Order page > Billing Account Name Addresses tab >
Address section Bill-To Contact sec-
tion
address1 Order page > Billing Address Line 1 Addresses tab >
Address section Bill-To Address sec-
tion
address2 Order page > Billing Address Line 2 Addresses tab >
Address section Bill-To Address sec-
tion
zip Order page > Billing Postal Code Addresses tab >
Address section Bill-To Address sec-
tion
country_code Order page > Billing Country Addresses tab > The country code is
Address section Bill-To Address sec- transformed to the
tion country name.
Shipping Address
company Order page > Ship- Account Name Addresses tab >
ping Address sec- Ship-To Contact
tion section
address1 Order page > Ship- Address Line 1 Addresses tab >
ping Address sec- Ship-To Address
tion section
address2 Order page > Ship- Address Line 2 Addresses tab >
ping Address sec- Ship-To Address
tion section
zip Order page > Ship- Postal Code Addresses tab >
ping Address sec- Ship-To Address
tion section
country_code Order page > Ship- Country Addresses tab > The country code is
ping Address sec- Ship-To Contact transformed to the
tion section country name.
Retail-Commerce Edition Entity Reference | 546
Customer Details
total_discount Order page > line Discount Amount Details tab Applies if on the
items Order Settings
tab (Order sec-
tion) of the Shopify
Stores (BC201010)
form, the Show Dis-
counts As box is set
to Line Discounts.
total_discount Order page > line Discount Amt. Discounts tab Applies if on the Or-
items der Settings tab of
the Shopify Stores
form, the Show Dis-
counts As box is set
to Document Dis-
counts.
External Reference Summary area id Order page > order The order identifi-
summary er is displayed in
the URL of the order
page.
Line Description Details tab title / variant_title Order page > line
items
Disc. Unit Price Details tab price Order page > line
items
Shipping Address
Retail-Commerce Edition Entity Reference | 548
Account Name Addresses tab > company Order page > Ship-
Ship-To Contact ping Address sec-
section tion
Address Line 1 Addresses tab > address1 Order page > Ship-
Ship-To Address ping Address sec-
section tion
Address Line 2 Addresses tab > address2 Order page > Ship-
Ship-To Address ping Address sec-
section tion
Postal Code Addresses tab > zip Order page > Ship-
Ship-To Address ping Address sec-
section tion
Billing Address
Account Name Addresses tab > company Order page > Billing
Bill-To Contact sec- Address section
tion
Address Line 1 Addresses tab > address1 Order page > Billing
Bill-To Address sec- Address section
tion
Address Line 2 Addresses tab > address2 Order page > Billing
Bill-To Address sec- Address section
tion
Postal Code Addresses tab > zip Order page > Billing
Bill-To Address sec- Address section
tion
Customer Details
Account Name Addresses tab > first_name, Order page > Cus-
Ship-To Contact last_name tomer section
section
Order Totals
Freight Price / Pre- Totals tab price, code, title The title and code
mium Freight Price are the shipping
method mapped to
the ship via code of
the order
Payment
Status Payments tab financial_status Order page > order The exported order
summary is assigned the Paid
status in Shopify.
Shipment Entity
This topic provides reference information about the standard filtering and field mapping used for the Shipment
entity during the synchronization between Acumatica ERP and Shopify.
Shipment Filtering
When shipments are exported to Shopify, a shipment is skipped if any of the following conditions are met:
• The status of the shipment is Confirmed, Invoiced, or Completed.
• The sales order related to the shipment has not been synchronized.
Fulfillments
Line Items
Payment Entity
This topic provides reference information about the standard filtering and field mapping used for payment data
during the synchronization of the Payment entity between Acumatica ERP and Shopify.
Payment Filtering
Filters are applied during the import of payments to Acumatica ERP. A payment is skipped if any of the following is
true:
• Its status is Error—for example, if the credit card payment transaction was not successful.
• The manual payment method used for purchase is not supported.
• The sales order related to the payment has not been synchronized.
If the mapping of the store payment method has not been configured or is inactive on the Payment Settings tab
of the Shopify Stores (BC201010) form, the system creates a synchronization record for the payment on the Sync
History (BC301000) form and assigns it the Filtered status.
created_at (for the order) Application Date Summary area The payment transaction
date is used.
kind Tran. Type Card Processing tab The type of the last suc-
cessful operation with the
credit card transaction.
amount Tran. Amount Card Processing tab The amount of the trans-
action.
authorization Proc. Center Tran. Nbr. Card Processing tab The number of the cred-
it card transaction in the
processing center (also
displayed in the Payment
Ref. box in the Summary
area).
transaction_id Proc. Center Tran. Nbr. Card Processing tab The number of the cred-
it card transaction in the
processing center (also
displayed in the Payment
Ref. box in the Summary
area). The transaction_id
field is used only if the au-
thorization field is empty
Retail-Commerce Edition Entity Reference | 554
created_at (for the order) Tran. Time Card Processing tab The time when the trans-
action operation was per-
formed.
Appendix | 555
Appendix
The appendix provides some reference information relevant for this document. The additional information in this
section is a useful source for readers who need some reference material that is related to system forms and tables,
as well as running reports.
In this section:
• Reports
• Form Toolbar
• Table Toolbar
• Glossary
Reports
In addition to offering a comprehensive collection of reports, Acumatica ERP gives you a high degree of control over
each report.
On a typical report form, described in Report Form, you can adjust the report settings to meet your specific
informational needs. You can specify sorting and filtering options and select the data by using report-specific
settings—such as financial period, ledger, and account—and configure additional processing settings for each
report. The settings can be saved as a report template for later use. For details, see To Run a Report and To Create a
Report Template.
Aer you run a report, the prepared report appears on your screen. You can print the report, export the report to a
file, or send the report by email.
This chapter describes a typical report form and the main tasks related to using reports.
In This Chapter
• Report Form
• To Run a Report
• To Modify a Filter on a Report Form
• To Create a Report Template
Report Form
Before you run a report, you set a variety of parameters on the report form. You can select a template or manually
make selections that affect the information collected. Also, you can specify appropriate settings to print or email
the finished report.
The following screenshot shows a typical report form.
Appendix | 556
Button Description
Cancel Clears any changes you have made and restores default settings.
Run Report Initiates data collection for the report and displays the generated report.
Save Template Gives you the ability to save the currently selected report as a template with all the select-
ed settings.
Schedule Tem- Opens the Select Schedule Name Dialog Box dialog box, which you can use to schedule re-
plate port processing.
This button is available only when you select a template.
Element Description
Schedule The schedule for report processing. Select an existing schedule, or leave the box blank
and click OK to open the Automation Schedules (SM205020) form to create a new sched-
ule for running the report. For more information on scheduling, see Automated Process-
ing: General Information in the Acumatica ERP System Administration Guide.
Appendix | 557
Element Description
Merge Reports A check box that indicates (if selected) that this report will be merged with the other re-
ports selected for merging into one net report when processed.
You can check the reports that will be merged when processed on the Send
Reports (SM205060) form.
Report Toolbar
The following table lists the buttons of the toolbar aer you run the configured report.
Parameters Navigates back to the report form to let you change the report parameters.
Refresh Refreshes the information displayed in the report (if any data changes were made).
Groups Adds to the report a le pane where the report structure is shown. Click a report node
to highlight the pertinent data in the right pane.
View PDF / Displays the report as a PDF, or displays the report in HTML format. The available but-
View HTML ton depends on the current report view; if you're viewing a PDF, for instance, you will
see the View HTML button.
/
Print Opens the browser dialog box so you can print the report.
Appendix | 558
Send Opens the Email Activity dialog box, which you use to send the report file (in the cho-
sen format) to the specified email address.
Export Enables you to export the data in the chosen format (Excel or PDF).
Template Area
Use the elements in this area to select an existing template and then use the template, share it with other users, or
use it as your default report settings.
The Template area elements, which are available for all reports, are described in the following table.
Element Description
Template The template to be used for the report. If any templates were created and saved, you can
select a template to use its settings for the report.
Default A check box that indicates (if selected) that the selected template is marked as the default
one for you. A default template cannot be shared.
Shared A check box that indicates (if selected) that the selected template is shared with other
users. A shared template cannot be marked as the default.
Locale A locale that you select to indicate to the system that the report should be prepared with
the data translated to the language associated with this locale. This box is displayed if
there are multiple active locales in the system. For details, see Locales and Languages.
Element Description
Deleted Records Selects the visibility of the data deleted from the database.
Compress PDF file Indicates that the system will generate a compressed PDF.
Embed fonts in PDF file Indicates that the system will generate the PDF with fonts embedded.
If you plan to send the report as an email, in the Email Settings area, specify the format in which the report will be
sent, as well as the email subject, the recipients of copies of the report, and the email account of the recipient.
Field Description
Format The format (HTML, PDF, or Excel) in which the report will be emailed.
Merge function for reports in Excel format is not supported. If you want to
merge a report with other reports and send an aggregated report by email,
you should select either the HTML or PDF format for the report.
BCC The email address of a person to receive a blind carbon copy (BCC) of the email; an address
entered in this box will be hidden from other recipients.
Button Description
Button Description
Related Links
• To Run a Report
• To Create a Report Template
• Types of Filters
• Automation Schedule Statuses
Report
Once you click Run Report, the prepared report appears on your screen. You can print the report, export the report
to a file, or send the report by email.
The prepared report is displayed in the report view of the report form. For more information about setting up the
report parameters and the parameters view of the report form, see Report Form.
Report Toolbar
The following table lists report toolbar buttons.
Parameters Navigates back to the report form to let you change the report parameters.
Refresh Refreshes the information displayed in the report (if any data changes were made).
Groups Adds to the report a le pane where the report structure is shown. Click a report node
to highlight the pertinent data in the right pane.
View PDF / Displays the report as a PDF, or displays the report in HTML format. The available but-
View HTML ton depends on the current report view; if you're viewing a PDF, for instance, you will
see the View HTML button.
/
Print Opens the browser dialog box so you can print the report.
Send Opens the Email Activity dialog box, which you use to send the report file (in the cho-
sen format) to the specified email address.
Export Enables you to export the data in the chosen format (Excel or PDF).
Related Links
• Filters
• Report
Form Toolbar
The form toolbar, available on most forms, is located near the top of the form, under the form title (and subtitle, if
the form has one), as shown in the following screenshot.
The form toolbar includes the following:
• Standard buttons (see Item 1 in the following screenshot), with the particular set of buttons depending on
the specific form
• On some forms, form-specific buttons (Item 2)
• On some form, the More button (Item 3); clicking this button opens the More menu (Item 4), which contains
additional form-specific commands
You use the standard buttons on the form toolbar to navigate through entities that were created by using the
current form, insert or delete an entity, use the clipboard, save the data you have entered, or cancel your work on
the form.
A form toolbar on a particular form may include form-specific buttons in addition to standard buttons; it may also
(or instead) include commands on the More menu. These form-specific buttons and commands provide navigation
to related forms, invoke specific actions, and perform modifications or processing related to the functionality of the
form.
Discard Changes Discards any unsaved changes made to the entity, and navigates to the list of
and Close records that is related to the current form.
Save & Close Saves the changes made to the entity, and navigates to the list of records that
is related to the current form.
Add New Record Clears any values you've specified on the form, restores any default values,
and initiates the creation of a new entity.
Delete Deletes the currently selected entity, clears any values you have specified on
the form, and populates elements with the default values that the system in-
serts when a new entity is created.
You can delete an entity only if it is not linked with another enti-
ty.
Appendix | 563
Go to First Record Displays the first entity (in the list of entities of the specific type) and its de-
tails.
Go to Last Record Displays the last entity (in the list of entities of the specific type) and its de-
tails.
View Schedule Gives you the ability to schedule the processing. For more information, see
Automated Processing: General Information.
Cancel Clears all changes (including selection criteria that has been specified, if the
generic inquiry form has this criteria) and restores the default settings.
Appendix | 564
Edit Opens the applicable data entry form with the selected record.
Fit to Screen Expands the form to fit on the screen and adjusts the column widths propor-
tionally.
Export to Excel Exports the data to an Excel file. For more information, see Integration with Ex-
cel in the Acumatica ERP Getting Started Guide.
Filter Settings Opens the Filter Settings dialog box, which you can use to define a new filter.
After the filter has been created and saved, the corresponding tab appears on
the table. For more information about filtering, see Filters.
4. The More menu with most form-specific menu commands and descriptive categories on it
5. The star icon, which is used to mark the individual user's favorite commands on the form
6. An unavailable command
Favorite Commands
Based on your role in the company and your job duties, you may use some commands more oen than others.
On the form toolbar, you can specify these commands as favorites. This will cause the system to duplicate the
commands as form toolbar buttons, easing access to them.
To add a command to the form toolbar as a button, you open the More menu, hover over the needed command,
and click the star icon when it appears. The yellow color of the star indicates that the command has been added
to your favorites, and a button for the command appears on the form toolbar immediately. The following example
shows two commands that have been added to the user's favorites on the Invoices and Memos (AR301000) form
and thus added as buttons on the form toolbar.
Figure: Favorite commands on the More menu and the corresponding toolbar buttons
Favorites are individual to each user account, specific to a particular form, and preserved across user sessions.
Related Links
• Integration with Excel
• To Copy a Document Contents to a New Document
• To Create a Document with a Template
Table Toolbar
Each table on an Acumatica ERP form, tab, dialog box, or page has a table toolbar, which contains the buttons
you can use to work with the details or objects of the table. A toolbar, shown in the following screenshot, includes
buttons that are specific to the table, standard buttons that most table toolbars have, and the search box (for some
tables; for others, the search box is displayed in the filtering area).
Switch Between Controls how the elements are displayed: in a table (grid) with rows and columns;
Grid and Form or as separately arranged elements for one table row, with navigation tools you use
to move between row data.
Add Row Appends a new row to the table so you can define a new detail or object. The new
row may contain some default values.
Move Row Down Moves the selected row one position down.
Fit to Screen Adjusts the table to the screen width and makes the column width proportional.
Export to Excel Exports the data in the table to an Excel file. For more information, see Integration
with Excel in the Acumatica ERP Getting Started Guide.
Filter Settings Opens the Filter Settings dialog box, which you can use to define a new advanced
filter. After you create and save the filter, the corresponding tab appears on the ta-
ble.
For more information about filtering, see Filters. For details on the Filter Settings
dialog box, see Filter Settings Dialog Box.
Load Records Opens the File Upload dialog box, described in detail below, so you can locate and
from File upload a local file for import. You can use this option to import data from an Excel
spreadsheet (.xlsx) or .csv file. For the detailed procedure, see To Import Data
from a Local File to a Table.
Search A box in which you can type a word, part of a word, or multiple words. As you type,
the system filters the contents of the table to display only rows that contain the
string you have typed in any column.
Element Description
Upload Closes the dialog box and opens the Common Settings dialog box, where you specify the
import settings.
Appendix | 570
Element Description
Separator Chars The character that is used as the separator in the imported file.
By default, the comma is used as the separator. You specify the separator character if the
imported file uses any other separator.
This box appears only if you import data from a .csv file.
Null Value Optional. The value that is used to mark an empty column in the imported file. You speci-
fy the null value if the value in the imported file differs from the empty string.
Culture The regional format that has been used to display the time, currency, and other measure-
ments in the imported file.
Mode The mode defining which rows of the uploaded file will be imported into the table. The
following options are available:
• Update Existing: The rows already present in the table will be updated, and the rows
not present in the table will be added.
• Bypass Existing: Only the new rows that are not present in the table will be imported.
The rows that are already present in the table will not be updated.
• Insert All Records: All the rows from the file will be imported into the table.
If you select this option, you may get duplicated rows because the sys-
tem won't check for duplicates when importing rows from the file.
OK Closes the dialog box and opens the Columns dialog box.
Cancel Closes the dialog box without importing the data from the file.
Element Description
Property Name The name of the corresponding column in the table in Acumatica ERP.
Appendix | 571
Element Description
Cancel Closes the dialog box without importing the data from the file.
Related Links
• Tables
• Integration with Excel
• To Import Data from a Local File to a Table