You are on page 1of 571

End-User Guide

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

Synchronizing Customers: To Synchronize Customers with Multiple Locations................................ 81


Synchronizing Products...................................................................................................................................87
Product Synchronization: General Information....................................................................................87
Product Synchronization: Default Store Settings................................................................................. 88
Product Synchronization: Settings of Individual Items........................................................................89
Product Synchronization: Sales Categories.......................................................................................... 90
Product Synchronization: To Synchronize Items with Attributes........................................................ 91
Product Synchronization: Product Images........................................................................................... 97
Product Synchronization: To Synchronize Product Images.................................................................98
Product Synchronization: Related Items............................................................................................ 102
Synchronizing Sales Prices............................................................................................................................103
Price Synchronization: General Information.......................................................................................103
Price Synchronization: To Export Base Prices.....................................................................................105
Price Synchronization: To Export Prices for Customer Groups.......................................................... 109
Synchronizing Product Availability...............................................................................................................113
Product Availability: General Information.......................................................................................... 113
Product Availability: Calculation of Available Quantities...................................................................115
Product Availability: To Export Product Availability Data.................................................................. 115
Synchronizing Orders.................................................................................................................................... 120
Order Synchronization: General Information..................................................................................... 120
Order Synchronization: Implementation Checklist............................................................................ 125
Order Synchronization: Card Payments.............................................................................................. 126
Order Synchronization: To Configure and Import Authorize.Net Payments..................................... 130
Order Synchronization: Orders with Gi Wrapping............................................................................ 136
Importing Orders with Taxes.........................................................................................................................137
Import of Taxes: General Information................................................................................................. 137
Import of Taxes: Process Activity.........................................................................................................140
Importing Orders with Discounts..................................................................................................................147
Import of Orders with Discounts: General Information......................................................................147
Import of Orders with Discounts: Process Activity............................................................................. 147
Importing Orders with Freight Charges........................................................................................................152
Importing an Order with Freight Charges: General Information........................................................152
Importing an Order with Freight Charges: Activity.............................................................................153
Importing Non-Card Refunds........................................................................................................................157
Importing Non-Card Refunds: General Information...........................................................................157
Importing Non-Card Refunds: Implementation Activity.................................................................... 159
Contents | 4

Importing Non-Card Refunds: Implementation Checklist..................................................................161


Importing Non-Card Refunds: Order-Level Refunds...........................................................................162
Importing Non-Card Refunds: Item-Level Refunds............................................................................ 164
Importing Non-Card Refunds: To Process a Refund for a Not-Yet-Shipped Order............................ 166
Importing Non-Card Refunds: To Process a Refund for a Shipped Order..........................................171
Importing Card Refunds................................................................................................................................ 178
Importing Card Refunds: General Information................................................................................... 178
Importing Card Refunds: Implementation Activity.............................................................................179
Importing Card Refunds: Implementation Checklist..........................................................................182
Importing Card Refunds: Order-Level Refunds...................................................................................182
Importing Card Refunds: Item-Level Refunds.....................................................................................185
Importing Card Refunds: To Process a Refund for a Not-Yet-Shipped Order.................................... 187
Importing Card Refunds: To Import a Refund for a Shipped Order................................................... 192
Selling and Accepting Gi Certificates......................................................................................................... 199
Gi Certificates: General Information................................................................................................. 200
Gi Certificates: Process Activity......................................................................................................... 200
Selling Matrix Items in a BigCommerce Store..............................................................................................206
Selling Matrix Items: General Information.......................................................................................... 206
Selling Matrix Items: To Export Matrix Items...................................................................................... 209
Selling Matrix Items: Export of Product Images..................................................................................213
Selling Matrix Items: To Export Product Images................................................................................. 214
Selling Matrix Items: Export of Product Availability Data...................................................................217
Selling Matrix Items: To Export Product Availability Data.................................................................. 219
Selling Matrix Items: Export of Item Prices......................................................................................... 223
Selling Matrix Items: To Export Base Prices........................................................................................ 224
Selling Matrix Items: Import of Orders with Matrix Items.................................................................. 227
Selling Matrix Items: To Import an Order with Matrix Items.............................................................. 227
Integration with Shopify..................................................................................................................... 231
Initial Configuration of a Shopify Store........................................................................................................231
Initial Configuration: General Information..........................................................................................231
Initial Configuration: Implementation Checklist................................................................................ 234
Initial Configuration: Setting Up a Shopify Store............................................................................... 237
Initial Configuration: To Set Up a Shopify Store................................................................................. 238
Initial Configuration: To Establish the Store Connection with a Custom App................................... 240
Initial Configuration: To Establish the Store Connection with a Public App..................................... 242
Initial Configuration: To Prepare the Acumatica ERP Instance.......................................................... 244
Contents | 5

Initial Configuration: To Configure the Store Connection..................................................................246


Overview of Data Synchronization............................................................................................................... 249
Data Synchronization: General Information....................................................................................... 249
Data Synchronization: Synchronization Statuses...............................................................................254
Data Synchronization: Manual Synchronization.................................................................................254
Data Synchronization: To Perform the First Synchronization............................................................255
Preparing Entities for Synchronization........................................................................................................ 263
Preparing Entities for Synchronization: General Information............................................................263
Preparing Entities for Synchronization: Updating Product Details................................................... 265
Preparing Entities for Synchronization: Filtering............................................................................... 266
Preparing Entities for Synchronization: Field Mapping......................................................................268
Preparing Entities for Synchronization: Shopify Metafields...............................................................270
Automating Synchronization........................................................................................................................ 271
Automated Synchronization: General Information............................................................................ 271
Automated Synchronization: Scheduled Synchronization................................................................ 272
Automated Synchronization: Real-Time Synchronization................................................................. 274
Automated Synchronization: Recommended Setup.......................................................................... 276
Automated Synchronization: To Activate a Predefined Automation Schedule.................................277
Automated Synchronization: To Configure a New Automation Schedule.........................................279
Automated Synchronization: To Turn On Real-Time Synchronization.............................................. 281
Automated Synchronization: Business Events for Aborted Records................................................. 282
Automated Synchronization: To Activate a Predefined Business Event............................................ 283
Synchronizing Customers..............................................................................................................................285
Customer Synchronization: General Information...............................................................................285
Customer Synchronization: To Perform Bidirectional Synchronization............................................291
Customer Synchronization: To Synchronize Customers with Multiple Locations.............................295
Synchronizing Products.................................................................................................................................301
Product Synchronization: General Information..................................................................................301
Product Synchronization: Default Store Settings............................................................................... 302
Product Synchronization: Settings of Individual Items......................................................................303
Product Synchronization: Product Images......................................................................................... 304
Product Synchronization: To Sync Product Images........................................................................... 305
Synchronizing Product Availability...............................................................................................................309
Product Availability: General Information.......................................................................................... 309
Product Availability: Calculation of Available Quantities...................................................................311
Product Availability: To Export Product Availability Data.................................................................. 312
Contents | 6

Synchronizing Orders.................................................................................................................................... 316


Order Synchronization: General Information..................................................................................... 316
Order Synchronization: Implementation Checklist............................................................................ 320
Order Synchronization: Card Payments.............................................................................................. 321
Order Synchronization: To Configure and Import Shopify Payments............................................... 325
Order Synchronization: To Configure and Import Authorize.Net Payments..................................... 331
Order Synchronization: Export of Orders to the Shopify Store..........................................................337
Order Synchronization: Import of Order Risk Information................................................................ 338
Order Synchronization: Import of POS Orders................................................................................... 339
Importing Orders with Taxes.........................................................................................................................340
Import of Taxes: General Information................................................................................................. 340
Import of Taxes: Manual Tax Setup..................................................................................................... 340
Import of Taxes: External Tax Provider................................................................................................342
Import of Taxes: Tax Calculation Mode............................................................................................... 343
Import of Taxes: To Set Up Tax Synchronization................................................................................ 344
Importing Orders with Discounts..................................................................................................................350
Import of Orders with Discounts: General Information......................................................................350
Import of Orders with Discounts: Process Activity............................................................................. 351
Importing Non-Card Refunds........................................................................................................................354
Importing Non-Card Refunds: General Information...........................................................................354
Importing Non-Card Refunds: Implementation Activity.................................................................... 356
Importing Non-Card Refunds: Implementation Checklist..................................................................358
Importing Non-Card Refunds: Order-Level Refunds...........................................................................359
Importing Non-Card Refunds: Item-Level Refunds............................................................................ 360
Importing Non-Card Refunds: To Process a Refund for a Not-Yet-Shipped Order............................ 362
Importing Non-Card Refunds: To Process a Refund for a Shipped Order..........................................366
Importing Card Refunds................................................................................................................................ 372
Importing Card Refunds: General Information................................................................................... 372
Importing Card Refunds: Implementation Activity.............................................................................373
Importing Card Refunds: Implementation Checklist..........................................................................375
Importing Card Refunds: Order-Level Refunds...................................................................................376
Importing Card Refunds: Item-Level Refunds.....................................................................................378
Importing Card Refunds: To Process a Refund for a Not-Yet-Shipped Order.................................... 380
Importing Card Refunds: To Process a Refund for a Shipped Order..................................................386
Selling and Accepting Gi Cards...................................................................................................................392
Gi Cards: General Information...........................................................................................................393
Contents | 7

Gi Cards: Process Activity.................................................................................................................. 394


Selling Matrix Items in a Shopify Store........................................................................................................ 400
Sale of Matrix Items: General Information.......................................................................................... 400
Sale of Matrix Items: To Export Matrix Items...................................................................................... 402
Sale of Matrix Items: Export of Product Images..................................................................................405
Sale of Matrix Items: To Export Product Images.................................................................................407
Sale of Matrix Items: Export of Product Availability Data...................................................................410
Sale of Matrix Items: To Export Product Availability Data.................................................................. 411
Sale of Matrix Items: Import of Orders with Matrix Items.................................................................. 416
Sale of Matrix Items: To Import an Order with Matrix Items.............................................................. 416
Retail-Commerce Edition Form Reference............................................................................................. 420
BigCommerce Stores..................................................................................................................................... 420
Shopify Stores................................................................................................................................................ 437
Entities............................................................................................................................................................453
Prepare Data.................................................................................................................................................. 461
Process Data...................................................................................................................................................465
Sync History................................................................................................................................................... 470
Retail-Commerce Edition Entity Reference............................................................................................478
BigCommerce Mapping Reference................................................................................................................478
Customer Entity.................................................................................................................................... 478
Customer Location Entity.................................................................................................................... 484
Sales Category Entity........................................................................................................................... 488
Stock Item Entity.................................................................................................................................. 489
Non-Stock Item Entity.......................................................................................................................... 493
Template Item Entity............................................................................................................................497
Product Availability Entity................................................................................................................... 502
Sales Order Entity.................................................................................................................................504
Shipment Entity....................................................................................................................................515
Payment Entity..................................................................................................................................... 516
Shopify Mapping Reference.......................................................................................................................... 519
Customer Entity.................................................................................................................................... 519
Customer Location Entity.................................................................................................................... 523
Stock Item Entity.................................................................................................................................. 526
Non-Stock Item Entity.......................................................................................................................... 531
Template Item Entity............................................................................................................................534
Product Availability Entity................................................................................................................... 539
Contents | 8

Sales Order Entity.................................................................................................................................542


Shipment Entity....................................................................................................................................550
Payment Entity..................................................................................................................................... 551
Appendix............................................................................................................................................ 555
Reports........................................................................................................................................................... 555
Report Form.......................................................................................................................................... 555
Report....................................................................................................................................................560
Form Toolbar..................................................................................................................................................561
Table Toolbar................................................................................................................................................. 568
Copyright | 9

Copyright

© 2022 Acumatica, Inc.

ALL RIGHTS RESERVED.

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 Soware clause at DFARS 252.227-7013 or subparagraphs (c)(1) and
(c)(2) of the Commercial Computer Soware-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.

Soware Version: 2022 R2


Last Updated: 01/29/2023
Integration with BigCommerce | 10

Integration with BigCommerce


This part of the guide describes the minimum configuration of the BigCommerce integration, as well as the
implementation of the e-commerce functionality in Acumatica ERP.

Initial Configuration of a BigCommerce Store

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.

Initial Configuration: General Information

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.

Each of these steps is described in greater detail below.

Setup of a BigCommerce Store


Before you can connect Acumatica ERP to a BigCommerce store, you need to set up the store. For a test
implementation, we recommend that you sign up for a BigCommerce trial site. For more information, see Initial
Configuration: To Set Up a BigCommerce Store.

Obtaining of the BigCommerce API Keys and WebDAV Information


When you create a BigCommerce store in Acumatica ERP, you need to specify the following details:
• Store admin path, which is the URL of the BigCommerce store followed by /manage
• API credentials (API path, client ID, and access token)
Integration with BigCommerce | 11

• WebDAV settings (WebDAV path, username, and password)


For details on obtaining API and WebDAV information, see Initial Configuration: To Establish and Configure the Store
Connection.

Preparation of the Acumatica ERP Instance


During the configuration of the connection to the BigCommerce store, you need to specify certain values coming
from the Acumatica ERP instance, such as the numbering sequence to be used for generating the identifiers of
customers imported from the BigCommerce store, and the payment methods that will be mapped to the payment
methods configured in the BigCommerce store. Some of these values can be defined at the time of the initial
configuration. However, we recommend that the Acumatica ERP instance be prepared in advance.
For more information, see Initial Configuration: To Prepare the Acumatica ERP Instance.

Establishing of the Connection to the BigCommerce Store


Once you have captured the API account details for your BigCommerce store, you proceed to set up the connection
on the Connection Settings tab of the BigCommerce Stores (BC201000) form. You specify the store name, the
admin path to the store, the API account details, and the WebDAV credentials to use for file transfer (that is, for
uploading product images). Once you have specified these settings, you click Test Connection on the form toolbar
to ensure that the data has been specified correctly.

Initial Configuration of the Store Connection


Aer you have successfully established a connection to the BigCommerce store, you perform the basic required
configuration. This step involves the following substeps:
1. On the Entity Settings tab of the BigCommerce Stores (BC201000) form, you activate the needed entities
—that is, you select the Active check box in the row of each entity whose records you want to synchronize
between Acumatica ERP and the BigCommerce store.
The synchronization of a particular entity may require that some other entities also be synchronized as a
prerequisite. When you select the Active check box for such an entity, the system automatically selects it for
all other entities required as a prerequisite. Similarly, when you clear the Active check box for an entity that
is a required entity for other entities, the check box becomes cleared for all dependent entities.
In this substep, you also review the following default synchronization settings for each entity for which the
Active check box is selected, and make sure the default settings are appropriate for your configuration
needs:
• Sync Direction: The direction of the synchronization, which can be Import (data is imported to
Acumatica ERP), Export (data is exported to the BigCommerce store), and Bidirectional (data is both
exported to the BigCommerce store and imported to Acumatica ERP).
• Primary System: The system, ERP (Acumatica ERP) or External System (the BigCommerce store), whose
data takes precedence if conflicts occur during the synchronization.
• Real-Time Import: The status of the real-time import process. At the time of the initial configuration,
this status is either Stopped (that is, real-time synchronization is currently not running in the Import
direction) or Not Supported (that is, real-time synchronization cannot be started in the Import direction).
• Real-Time Export: The status of the real-time export process. At the time of the initial configuration, this
status is either Stopped (that is, real-time synchronization is currently not running in the Export direction)
or Not Supported (that is, real-time synchronization cannot be started in the Export 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 received, the corresponding
synchronization record is placed in the processing queue.
Integration with BigCommerce | 12

• 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 aer 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.

If Multiple Warehouse Locations feature is enabled on the Enable/Disable Features


(CS101000) form, you can specify warehouse locations whose item quantities should be
used for calculating the items' available quantities in the BigCommerce store.

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

Configuration of the Entities Enabled for Synchronization


For each entity that you want to synchronize between Acumatica ERP and the BigCommerce store and that you
have activated on the Entity Settings tab of the BigCommerce Stores form, you can also set up the mapping of
custom fields for synchronization and synchronization filtering settings on the Entities (BC202000) form.
For more information about defining filtering and mapping settings for the needed entities, see Preparing Entities
for Synchronization: Filtering and Preparing Entities for Synchronization: Field Mapping.

Synchronization of Data
Aer 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.

Initial Configuration: Implementation Checklist

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.

API Credentials and WebDAV Information to Capture in the BigCommerce Store


The table below lists the API and WebDAV information that is necessary for configuring a store connection and
should be captured beforehand. For more information, see Initial Configuration: To Capture Store Connection
Information.

Required Information Description

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

API Path The URL of the BigCommerce API.

Client ID An ID that is provided by BigCommerce when a new store is set up on the


BigCommerce platform.

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

Required Information Description

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.

Settings in the BigCommerce Store


In the table below, you will find the information about the settings that you should specify in the BigCommerce
store before you start setting up the integration with Acumatica ERP. For more information, see Initial Configuration:
To Set Up a BigCommerce Store.

Required Settings Description

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.

Taxes The tax settings that apply to your online store.

Settings in Acumatica ERP


The table below contains the features that need to be enabled, the entities that need to be created, and the
settings that need to be specified in Acumatica ERP before you can specify the appropriate settings on the
BigCommerce Stores (BC201000) form.

Form Things to Check Notes

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

Form Things to Check Notes


• Custom Order Types
• Inventory
• Scheduled Processing
• Volume Pricing
The Inventory Subitems feature is disabled.

If this feature is enabled, the import


of sales orders will not work.

The following recommended features are en-


abled:
• Drop Shipments
• External Tax Calculation Integration
• Customer Discounts
• Multiсurrency Accounting
• Multiple Warehouses
• Multiple Warehouse Locations
• Shipping Carrier Integrations

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.

A sales category under which non-stock and


stock items will be placed if they are not as-
signed any category in Acumatica ERP has been
configured.

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

Form Things to Check Notes

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.

Initial Configuration: Setting Up a BigCommerce Store

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.

Setting Up a BigCommerce Store


You use the control panel in BigCommerce to initially set up and configure your store, as well as to perform ongoing
management of products, customers, and orders. By using the control panel, you set up the BigCommerce store by
performing the following general steps:
1. Signing up for a BigCommerce account
2. Completing the store profile
3. Setting up the currencies in which goods will be available for purchase and the payment methods that you
will accept
4. Setting up taxes
5. Configuring the shipping zones and shipping rules

Signing Up for a BigCommerce Trial Account


Before you implement the integration with Acumatica ERP on the production BigCommerce store, we recommend
that you test your desired configuration in a test environment. To do that, you need a free BigCommerce trial
account, which you can sign up for on the BigCommerce Essentials Trial page. The registration requires that you
provide a valid email address, the name of your store (which you can change at any time), your name and contact
details, and your admin password.
Integration with BigCommerce | 18

For information about the detailed steps that you need to complete to create a trial account, see the BigCommerce
documentation.

Completing the Store Profile


Aer you have created a new BigCommerce store, you need to set it up so that you can accept and process orders.
The first thing you should do is complete the store's profile on the Store profile page. To access the page, you click
Settings in the le pane, and on the Settings page, in the Setup section, you click Store profile. Here you can
specify such settings as the store name, store address, store country, contact email address, and contact phone. It
is important to specify the store country early in the setup process because this setting determines which payment
gateways or shipping providers are available for use in your store.
For more information about setting up the store profile, see Store Profile Settings in the BigCommerce
documentation.

Setting Up Currencies and Payment Methods


You set up the currencies that your store’s customers will see and can be charged in on the Currencies page. To
access the page, you click Settings in the le pane, and on the Settings page, in the Setup section, you click
Currencies.
You can configure multiple currencies to be used as display currencies and transaction currencies in your store. The
default currency is determined based on the store's general settings; however, it can be changed. For each currency
that you want to use as a transactional currency in your store, at least one acceptable payment method must be
configured.
You should check and, if necessary, update the display settings of the default currency, and then configure at least
one payment method for this currency on the Payment Methods page. To access the page, you click Settings in
the le pane, and on the Settings page, in the Setup section, you click Payments.
For more information about working with currencies in BigCommerce, see Managing Currencies in the
BigCommerce documentation. For details on payment methods, see Online Payment Methods and Offline Payment
Methods.

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.

Turning Off Notifications About Changes to Customer Accounts


If you are planning to export customer records from Acumatica ERP to the BigCommerce store, we recommend that
you turn off sending email notifications about changes to customer accounts in the BigCommerce store. If such
notifications are turned on and customers are configured to be exported or to be synchronized in both directions
(that is, to be exported and imported), a customer will be sent an email every time the e-commerce connector
synchronizes the customer data, which may look to the customer as if their store account has been hacked.
You manage sending notifications to customers on the Transactional emails page, which you open by clicking
Marketing > Transactional Emails in the le pane of the control panel. To disable notifications about changes
in the customer account, you click the button in the rightmost column in the row of the Account Settings Edited
template, and in the menu that opens, you click Disable.

Initial Configuration: To Set Up a BigCommerce Store

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

Step 1: Signing Up for a BigCommerce Trial Account


Create a BigCommerce trial account by following the instructions in the BigCommerce documentation. Make a note
of the login and password that you have created, because you will use them to sign in to the control panel of your
store as the store administrator.

Step 2: Completing the Store Profile


To complete the profile of the BigCommerce store, do the following:
1. Sign in to the BigCommerce store as the store owner by using the username and password you have created
in the previous step.
You are now viewing the BigCommerce control panel, which you will use for setup and management of the
store.
2. In the le pane, click Settings.
3. On the Settings page, in the Setup section, click Store profile.
4. On the Store profile page, in the Contact information section, specify the following details:
• Store display name: SweetStore - BC
• Address: 3950 Hoffman Avenue, Elmont, New York
• Address type: Commercial Office
5. In the Locale section, specify the following details:
• Default country: United States
• Default language: English (en)

Make sure that you have selected the correct country because it affects the range of payment,
shipping, and tax options available for your store.

6. In the lower right, click Save to save your changes.

Step 3: Specifying the Default Currency


To specify the default currency in which prices will be displayed to customers and in which transactions will be
made, do the following:
1. While you are still signed in to the control panel of your BigCommerce store, in the le pane, click Settings.
2. On the Settings page, in the Setup section, click Currencies.
Integration with BigCommerce | 21

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.

Step 4: Configuring the Shipping Rules


To configure the shipping rules for your online store, do the following:
1. While you are signed in to the BigCommerce store, in the le pane of the control panel, click Settings,
2. On the Settings page, in the Setup section, click Shipping.
3. On the Shipping Manager page, which opens, in the Shipping Origin section, review the location from
which products are going to be shipped. If the address is not displayed, add it as follows:
a. In the Shipping Origin section, click Add shipping address.
b. In the Configure Shipping Address dialog box, which opens, specify the following details:
• Address Line 1: 3950 Hoffman Avenue
• City: New York
• Postcode: 11003
• Country: United States (default)
• State: New York
c. In the lower right, click Submit.
4. In the Checkout Shipping Options section, under Default shipping rules, make sure United States is the
default shipping rule. If it is anything other than United States, do the following:
a. In the Checkout Shipping Options section, click Add shipping zone > Add a custom zone.
b. In the Add custom zone dialog box, which opens, on the Zone tab, specify the following settings:
• Name: New York State
• Type: Selection of states or provinces
• Country: United States
• State: New York
c. Click Submit to save the changes and close the dialog box.
In the Default shipping rules subsection, notice that the New York State rule is now active (the toggle is
switched on for it).
Integration with BigCommerce | 22

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.

Step 5: Turning Off Notifications About Changes to Customer Accounts


To turn off sending email notifications to customers every time their details are changed, do the following:
1. While you are signed in to the control panel of the BigCommerce store, in the le pane, click Marketing >
Transactional Emails.
2. On the page that opens, in the row of the Account Settings Edited template, click the button in the rightmost
column, and on the menu that opens, click Disable.

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.

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

Step 1: Enabling the Needed Features


To make sure the needed features for e-commerce functionality have been enabled, do the following:
1. Open the Enable/Disable Features (CS100000) form.
2. Make sure that the following features are enabled:
• Business Account Locations (under the Standard Financials group of features)
• Inventory (under the Inventory and Order Management group of features)
• Commerce Integration (under the Third Party Integrations group of features)
• BigCommerce Connector

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.

Step 4: Reviewing the Customer Record to Be Used for Guest Orders


SweetLife's online store is going to accept guest orders (that is, orders from customers who are not registered in the
store). During the configuration of the store connection, you will need to select the customer record in Acumatica
ERP that will appear in orders that are placed as guest orders in the BigCommerce store. In the instance with the
U100 data preloaded, the generic online customer account has already been created.
To review the customer account that will be used for guest orders, do the following:
1. Open the Customers (AR303000) form.
2. In the Summary area, in the Customer ID box, select ECOMGUEST.
In a subsequent activity, you will specify this customer in the store settings to make it appear on all orders
imported from the BigCommerce store that were placed in the store by non-registered customers.

Step 5: Reviewing the Item Sales Categories


To review the inventory-related settings that you will need to specify during the configuration of the store
connection, do the following:
1. Open the Item Sales Categories (IN204060) form.
2. In the Categories tree, click Other.
Integration with BigCommerce | 25

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 aer they are imported to the BigCommerce store.

Step 6: Reviewing the Order Settings


In order to review the order type created for the sales orders coming from the BigCommerce store, do the following:
1. Open the Order Types (SO201000) form.
2. In the Order Type box, select EO - eCommerce Order.
In the Order Template box of the Summary area, 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 BigCommerce store.

Step 7: Reviewing the Shipping Settings


To review the Acumatica ERP shipping settings that you will need to specify during the configuration of the store
connection, do the following:
1. Open the Ship via Codes (CS207500) form.
2. In the Ship Via box, select SWEETSHIP.
Because SweetLife is going to deliver the products sold in the online store by using only its own fleet of
vehicles, you will specify this shipping option when you configure the store connection.

Step 8: Reviewing the Cash Account and Payment Method Settings


To review the payment method in Acumatica ERP that will be mapped to the BigCommerce payment methods
configured in the online store, do the following:
1. Open the Payment Methods (CA204000) form.
2. In the Payment Method ID box, select ONLINE.
For simplicity, you will later map this payment method to all payment methods configured in the
BigCommerce store. On the Allowed Cash Accounts tab, notice that the table contains only one cash
account, 10250ST - Company Merchant Account.
3. In the Cash Account column, click the link with the cash account identifier.
4. On the Cash Accounts (CA202000) form, which opens in a pop-up window, review the cash account settings.
In the Summary area, notice that the 10250ST cash account has been configured for the RETAIL branch and
the USD currency.

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.

Initial Configuration: To Capture Store Connection Information

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

• The WebDAV settings (WebDAV path, username, and password)


In this activity, you will learn where to find the listed information.

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.

Step 1: Obtaining the BigCommerce Store API Credentials


Before you can establish a connection between your instance of Acumatica ERP and the online store, you need to
generate an API account. Do the following:
1. In the le pane of the control panel, click Settings.
2. On the Settings page, in the API section, click API accounts.
3. On the API accounts page, click Create API account.
4. On the Create account page, specify the following settings:
• Token type: V2/V3 API token
• Name: Acumatica ERP Integration
5. For each scope under OAuth scopes, set the permission to the highest (rightmost) level.
6. In the lower right, click Save to save your changes.
7. In the BigCommerce API credentials dialog box, which appears, the following details of the created API
account are displayed:
• Client ID
• Client secret
• Access token
If you are using Chrome, Firefox, or Edge, a text file with this information, as well as the API Path, will be
automatically downloaded to your computer.
8. Save the API account information to a file.

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.

9. Click Done to close the dialog box.

On the API accounts page, the information about the Acumatica ERP Integration account is now displayed.

Step 2: Obtaining the BigCommerce Store WebDAV Information


To find the information that is required to set up file transfer between Acumatica ERP and the online store over
WebDAV, do the following:
Integration with BigCommerce | 27

1. In the le pane of the control panel, select Settings.


2. On the Settings page, in the Advanced section, click File access (WebDAV).
On the File Access page, which opens, notice the following WebDAV information:
• WebDAV Path
• WebDAV Username
• WebDAV Password
3. Save this information to a file. You will need it to set up file access in the next activity.

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.

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. Aer 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.

Step 2: Specifying the Entity Settings


To specify the entity settings, while you are still viewing the BigCommerce Stores (BC201000) form, do the
following:
1. Go to the Entity Settings tab.
The table displays all entities that are supported by the BigCommerce connector and their default settings
(such as, the synchronization direction and primary system).
Integration with BigCommerce | 29

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.

Step 3: Specifying the Customer Settings


To specify the settings that will be used by default for importing customers from the BigCommerce store to
Acumatica ERP, while you are still viewing the BigCommerce Stores (BC201000) form, do the following:
1. Go to the Customer Settings tab.
2. In the Customer section, select the following values:
• Customer Class: ECCUSTOMER
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 BigCommerce store.
• Generic Guest Customer: ECOMGUEST
This customer account, which has been created in Acumatica ERP, will appear on orders imported from
the BigCommerce stores and placed by non-registered users. This account will be used only if placing
guest orders is allowed in the BigCommerce store.

Step 4: Specifying the Order Settings


To specify the order-related settings, while you are still viewing the BigCommerce Stores (BC201000) form, do the
following:
1. Go to the Order Settings tab.
2. In the Branch box (in the General section), select RETAIL.
This branch will be inserted in sales orders imported from the SweetStore - BC store.
3. In the Order section, select the following values:
• Order Type for Import: EO - eCommerce Order
This order type has been configured specifically for sales orders imported from BigCommerce stores.
• Refund Amount Item: REFUNDAMT
This non-stock item will be used as a dummy product to reflect refunded amounts in sales orders and
return orders for returns initiated in the BigCommerce store.
Although the Refund Amount Item box is required and you need to specify its value during the initial
setup, it is only be used during the configuration and processing of refunds, which is out of the scope of
this course.
Although the Refund Amount Item box is required and you need to specify its value during the initial
setup, it will only be used during the configuration and processing of refunds, which is described in
Importing Card Refunds: General Information.
4. In the Taxes section, leave the Tax Synchronization check box cleared.
Integration with BigCommerce | 30

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

Step 5: Configuring the Payment Method Mapping


To import payments based on a particular payment method configured in the BigCommerce store to Acumatica
ERP, you need to map the payment method to a corresponding payment method configured in Acumatica ERP.
To configure the payment method mapping, while you are still viewing the BigCommerce Stores (BC201000) form,
do the following:
1. Go to the Payment Settings tab.
2. In the table of this tab, in the row of the CUSTOM (CUSTOM) payment method, specify the following settings:
• Active: Selected
• Store Currency: USD (inserted automatically)
• ERP Payment Method: ONLINE
• Cash Account: 10250ST
The CUSTOM (CUSTOM) value in the table corresponds to the Manual Payment payment method in the
BigCommerce store. With these settings, the payments made with the Manual Payment payment method
will be imported to Acumatica ERP. In the imported payments and related sales orders, the mapped
payment method, ONLINE, will be displayed.
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.

Overview of Data Synchronization

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.

Data Synchronization: General Information

Aer 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

Stages of the Synchronization Process


The process of the synchronization of data between Acumatica ERP and the e-commerce store consists of the
following stages:
• Preparing out-of-sync data for synchronization. For details, see the Preparation of Out-of-Sync Data for
Synchronization section below.
• Processing out-of-sync data, as described in the Processing of Out-of-Sync Data section below.

Preparation of Out-of-Sync Data for Synchronization


During the preparation of data for synchronization, the system receives the data that needs to be synchronized
between Acumatica ERP and the e-commerce system and puts it in the processing queue. The following
mechanisms can be used for obtaining data:
• Data preparation process: The data preparation process pulls the data to be synchronized from Acumatica
ERP and the e-commerce system through API calls and puts it in the processing queue. It can be performed
in the following modes:
• Full mode: In this mode, all records of the entity that have been created or modified during the specified
date range are pulled from Acumatica ERP and the e-commerce system and put in the processing queue,
regardless of whether they have been processed previously or not.
• Incremental mode: In this mode, only the records that have been modified since the date of the last
successful data preparation are pulled.
• Incremental by Date mode: In this mode, only records that have been modified during the specified date
range and that have not yet been processed are pulled.
The pulled data is then filtered according to the filtering criteria defined on the Entities (BC202000) form
and saved in the processing queue as synchronization records with the Prepared status, which indicates
that these synchronization records have not yet been processed. The synchronization records are then
processed as described in the Processing of Out-of-Sync Data section below.
The data preparation process can be started in the following ways:
• Manually, on the Prepare Data (BC501000) form. For information on manual synchronization, see Data
Synchronization: Manual Synchronization.
• By an automation schedule. For details about scheduling synchronization, see Automated
Synchronization: General Information.
• Push notifications: If real-time synchronization is enabled for an entity on the Entities (BC202000) form,
whenever a record is changed in the source system, the e-commerce connector is immediately notified
about the change, and the corresponding synchronization record is created or updated in the processing
queue.
This synchronization record is saved with the Prepared status and remains in the processing queue until it is
processed.
The following diagram shows the process of preparing data for synchronization.
Integration with BigCommerce | 32

Figure: Preparing data for synchronization

Processing of Out-of-Sync Data


During the data processing stage, the system processes the synchronization records in the processing queue
according to the synchronization settings defined for the corresponding entity on the Entities (BC202000) form
or on the Entity Settings tab of the BigCommerce Stores (BC201000) form, and the synchronized data is saved in
Acumatica ERP, in the BigCommerce store, or in both systems.
Integration with BigCommerce | 33

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.

The processing of out-of-sync data can be started as follows:


• You can start data processing manually, as described in Data Synchronization: Manual Synchronization.
• You can configure an automation schedule that will start data processing at regular intervals, as described
in Automated Synchronization: Scheduled Synchronization.
• You can configure the system to immediately start data processing for each synchronization record created
or updated as a result of the real-time synchronization process. To do this, on the Entities form, you set Real-
Time Mode for an entity to Prepare & Process. For more information about real-time synchronization, see
Automated Synchronization: Real-Time Synchronization.
In the following diagram, you can see the flow of the processing of data prepared for synchronization.
Integration with BigCommerce | 34

Figure: Processing prepared data

Preparation of Deleted Records


If a previously processed entity record is deleted in Acumatica ERP, in the external system, or in both systems,
its synchronization record is assigned the Deleted status on the Sync History (BC301000) form. When the entity is
prepared, the synchronization record is assigned the Prepared status in the following cases:
• If the entity record was deleted in the primary system or in both systems and then was restored in the
primary system
• If the entity record was deleted only in the secondary system and then was modified in the primary system
During the entity preparation, synchronization records that were never processed and were manually assigned the
Deleted status on the Sync History form, are assigned the Prepared status regardless of the changes to the entity
records in either of the systems.
Integration with BigCommerce | 35

Data Synchronization: Synchronization Statuses

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.

Skipped The synchronization record was manually excluded from synchronization by a


user.

Deleted The record in the synchronization record has been deleted in Acumatica ERP, in
the external system, or in both systems.

Invalid The synchronization record cannot be processed because its synchronization is


not possible.

Filtered The entity has been filtered as a result of applying a filter defined in the code or
on the Entities form.

Data Synchronization: Manual Synchronization

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.

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.

Step 1: Finding and Reviewing the Stock Items to Be Sold Online


To find and review the stock items that will be sold online, do the following:
1. Open the Stock Items (IN2025PL) form.
2. Filter the stock items to display only the items of the Jam item class as follows:
a. In the Item Class column, click the column header.
b. In the menu that opens, select the Equals filter condition.
c. In the box at the bottom of the menu, type Jam.
d. Click OK to apply the filter.
Integration with BigCommerce | 38

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.

Step 2: Configuring the Export of a Subset of Stock Items


To configure a filtering condition for the Stock Item entity to export only stock items of the Jam item class to the
BigCommerce store, do the following:
1. Open the Entities (BC2020PL) form.
2. In the Store Name box of the Selection area, make sure SweetStore - BC is selected.
3. In the Entity column, click the Stock Item link.
The system opens the Entities (BC202000) form with the SweetStore - BC store and the Stock Item entity
selected in the Summary area. Notice that this entity can only be exported to the BigCommerce store and
cannot be imported to Acumatica ERP (that is, its Sync Direction is set to Export and cannot be changed).
4. To create a filtering condition for stock items, on the Export Filtering tab, click Add Row on the table
toolbar, and specify the following settings in the row:
• Active: Selected
• Field Name: Item Class
• Condition: Equals
• Value: Jam
5. On the form toolbar, click Save to save your changes.
Now when you prepare and process the Stock Item entity, only the stock items of the Jam item class will be
exported 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.

Step 3: Preparing the Product Data for Synchronization


To prepare the stock item data that needs to be synchronized to the BigCommerce store, 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
This setting controls which data will be loaded. Incremental indicates that the system will load only the
data that has been modified since the previous data synchronization. Because you are starting the data
preparation process for the Stock Item for the first time, all stock item data will be prepared.
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.
In the table on the form, notice that the Ready to Process column shows the number of synchronization
records that have been prepared and are ready to be processed. The Processed Records column shows the
number of records that have been processed (that is, records that have been successfully synchronized and
assigned the Processed status.
Integration with BigCommerce | 39

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.

Step 4: Reviewing the Results of Data Preparation


To review the results of the preparation of data for synchronization, do the following:
1. While you are still viewing the Prepare Data (BC501000) form, click the link in the Total Records in the row of
the Stock Item entity. The Sync History (BC301000) form opens in a new browser tab with the SweetStore - BC
store and the Stock Item entity selected in the Summary area.
On the Filtered filter tab, notice that all synchronization records on this tab have the Filtered status. These
are the stock items that were excluded from synchronization based on the filtering conditions that you
configured in Step 2.
2. Go to the Ready to Process filter tab.
Notice that the table is displaying the list of stock item synchronization records with the Prepared status,
as shown in the screenshot below. This status means that the data for these items has been prepared and
the items are now ready to be processed. The Ready to Process filter tab shows only the items with the JAM
item class.
For each of these items, the ERP ID column displays a link with the item description that you can click to
open the item on the Stock Items (IN202500) form. Notice that the External ID column currently does not
display any values because the stock items have not yet been exported to the BigCommerce store.

Figure: Stock item synchronization records prepared for processing

Step 5: Processing the Prepared Product Data


To process the Stock Item entity, do the following:
1. Open the Process Data (BC501500) form.
Integration with BigCommerce | 40

2. In the Summary area, select the following settings:


• Store: SweetStore - BC
• Entity: Stock Item
The table displays only the list of stock items that have been prepared for synchronization.
3. On the form toolbar, click Process All to process all synchronization records displayed on the form.
4. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.

Step 6: Reviewing the Synchronization Status of the Product Data


To again review the synchronization status of the product data, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area of the form, specify the following settings:
• Store: SweetStore - BC
• Entity: Stock Item
3. Go to the Processed filter tab.
The tab shows the list of items that have been synchronized with the BigCommerce store. For each item,
there is now a product identifier in the External ID column. In the table, the Last Operation value has
changed to Inserted Externally and the time stamp in the Last Attempt column has changed to the date and
time when you ran data processing on the Process Data (BC501500) form.

Step 7: Viewing an Exported Product in the BigCommerce Store


To view the KIWIJAM96 stock item (which has the description Kiwi jam 96 oz) in the BigCommerce store, do the
following:
1. While you are still viewing the Sync History (BC301000) form, click the link in the External ID column in the
row of the synchronization record for the Kiwi jam 96 oz item.
The product management page for the Kiwi jam 96 oz item in the BigCommerce store opens in a new
browser tab.
2. Scan the product details that have been exported to the BigCommerce store (the product name, SKU,
image, description, default price, and weight).

Step 8: Placing an Order from the Control Panel


To purchase a 96-ounce jar of kiwi jam by using the storefront, do the following:
1. In the le pane of the control panel, click Orders > Add. The Add an Order page opens.
2. On the Add an Order > Customer Info page, create the order as follows:
a. In the Customer Information section, select the New Customer option button right of Order for.
b. In the Account details subsection, specify the following settings:
• Email Address: larry@example.com
• Password: !Q123456
• Confirm Password: !Q123456
c. In the Billing Information section, specify the following details:
• First Name: Larry
• Last Name: Coleman
Integration with BigCommerce | 41

• Address Line 1: 1970 Duncan Avenue


• Suburb/City: New York
• Country: United States
• State/Province: New York
• Zip/Postcode: 10016
• Save to customer's address book: Selected
3. In the lower right, click Next.
4. On the Add an Order > Items page, under Add Products, do the following:
a. In the Search box, start typing kiwi, and in the list of search results, select KIWIJAM96.
b. In the row of the Kiwi jam 96 oz product, change the quantity to 5.
c. In the lower right, click Next.
5. On the Add an Order > Fulfillment page, in the Shipping Method section, click the Fetch Shipping Quotes
link.
6. In the box with the list of shipping options that appears, click Free Shipping ($0.00). The Free Shipping option
is available for the order because its total amount is greater than $100.
7. In the lower right, click Next.
8. On the Add an Order > Finalize page, 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.
Because you have not defined any payment methods during the initial configuration of the
BigCommerce store, Manual Payment is the only payment method available for selection. This payment
method is used to record payments accepted outside of the BigCommerce store.
9. Click Save & Process Payment.
10.On the View Orders page, which opens, make a note of the reference number of the created order in the
Order ID column. You will review and process this order in Acumatica ERP further in this activity. Notice that
the order status is Awaiting Fulfillment.

Step 9: Importing the Sales Order Data to Acumatica ERP


To import sales orders from the BigCommerce store to 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.
Notice that the Ready to Process column now shows 1 in the row of the Sales Order entity because you have
created only one order in the BigCommerce store.
5. In the row of the Sales Order entity, click the link in the Ready to Process column.
The system opens the Process Data (BC501500) form with the SweetStore - BC store and the Sales Order
entity selected in the Summary area. Notice that the External ID column of the table displays the order
identifier assigned to the order in the BigCommerce store.
6. Select the unlabeled check box in the only row, and on the form toolbar, click Process.
Integration with BigCommerce | 42

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.

Step 11: Reviewing the Imported Sales Order


To review the details of the imported sales order, do the following:
1. While you are still viewing the synchronization results on the Sync History (BC301000) form, click the link in
the ERP ID column for the sales order you imported.
2. On the Sales Orders (SO301000) form, which opens in a pop-up window, review the details of the order, as
shown in the following screenshot.

Figure: Sales order imported from the store

In the Summary area, notice the following:


Integration with BigCommerce | 43

• 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.

Step 12: Creating and Confirming a Shipment


To process a shipment for the imported order, do the following:
1. While you are still viewing the sales order on the Sales Orders (SO301000) form, on the form toolbar, click
Create Shipment.
2. In the Specify Shipment Parameters dialog box, which opens, make sure the current date and the RETAIL
warehouse are selected, and click OK. The system creates a shipment and opens it on the Shipments
(SO302000) form.
3. On the form toolbar, click Confirm Shipment.

The shipment is assigned the Confirmed status. The sales order is assigned the Completed status.

Step 13: Synchronizing the Shipment with the BigCommerce Store


To synchronize with the SweetStore - BC store the shipment that you created and confirmed in the previous steps,
do the following:
1. In the Summary area on the Prepare Data (BC501000) form, select the following settings:
• Store: SweetStore - BC
• Prepare Mode: Incremental
2. In the table, select the Selected 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 to close the
dialog box.
5. Click the link in the Ready to Process (which shows 1 because only one shipment has been created) in the
row of the Shipment entity.
The Process Data (BC501500) form opens with the SweetStore - BC store and the Shipment entity selected.
6. Select the unlabeled check box for the only row of the table, and click Process on the form toolbar.
7. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
Integration with BigCommerce | 44

Step 14: Reviewing the Updated Order and Shipment in BigCommerce


To check whether the shipment and the updated order have been imported to the BigCommerce store correctly, do
the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area of the form, specify the following settings:
• Store: SweetStore - BC
• Entity: Shipment
3. On the Processed tab, notice that the synchronization record of the shipment is now displayed in the only
row of the table. The External ID column displays the identifier of the shipment in BigCommerce, which
consists of two parts—the identifier of the order and the identifier of the shipment.
4. Click the link in the External ID column.
5. On the order page of the BigCommerce store, which opens in a new browser tab, notice that the status of
the order has been changed to Shipped.
In the rightmost column, notice that the information about the shipment is displayed. You can click the link
with the shipment number to view the shipment details.

You have now performed the first manual synchronization of products, sales orders, and shipments.

Preparing Entities for Synchronization

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.

Preparing Entities for Synchronization: General Information

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.

Configuration of Synchronization Preferences


During the initial configuration of the connection between Acumatica ERP and the BigCommerce store, you
determine which of the entities supported by the BigCommerce connector need to be synchronized between the
two systems. To do this, you select the Active check box for each required entity on the Entity Settings tab of the
BigCommerce Stores (BC201000) form. On this tab, you can also configure the following:

• 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 aer 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.

Filtering and Field Mapping for Export and Import


For some of the entities supported by the e-commerce connector, on the Entities (BC202000) form, you
can configure the additional synchronization settings—for example, define a filter to be applied during the
synchronization of entity data, or define a new mapping between the fields in Acumatica ERP and the fields in
BigCommerce. You define filters and mappings for the import and export processes on the following tabs:
• Filtering for import: Import Filtering tab
• Filtering for export: Export Filtering tab
• Mapping for import: Import Mapping tab
• Mapping for export: Export Mapping tab

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.

Table: Availability of Filtering and Mapping Options for Entities

Entity in Import Mapping Import Filtering Export Mapping Export Filtering

Customer Yes Yes Yes Yes


Integration with BigCommerce | 46

Entity in Import Mapping Import Filtering Export Mapping Export Filtering

Customer Price Class Yes Yes Yes Yes

Customer Location No Yes No Yes

Sales Category Yes Yes Yes Yes

Stock Item No No Yes Yes

Non-Stock Item No No Yes Yes

Template Item No No Yes Yes

Base Sales Price No No No No

Price List No No No No

Product Image No No No No

Product Availability No No No No

Sales Order Yes Yes Yes Yes

Payment Yes Yes No No

Shipment No No Yes Yes

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.

Preparing Entities for Synchronization: Updating Product Details

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 aer 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. Aer 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. Aer 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.

Preparing Entities for Synchronization: Filtering

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.

Active Brackets Field Name Condition Value Value 2 Brackets Operator

Selected - Customer Does Not INTL Empty - And


Class Equal

The particular fields that you can select in the Field Name column depend on the selected entity.

If you change the export filter settings aer 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.

Export Filtering by Custom Fields


Export filtering by custom fields, which are fields added to a form as a result of publishing a customization project,
is available for the Customer, Stock Item, Non-Stock Item, Template Item, and Sales Order entities.
To use a custom field in a filtering condition, on the Export Filtering tab of the Entities (BC202000) form, you should
type the name of the field in the Field Name column of the table. The system validates the field name against the
API field list and displays an error if the field name cannot be found.

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

Export Filtering by Attributes


Export filtering by attributes is available for the Customer, Stock Item, and Non-Stock Item, and Template Item
entities.
When an attribute is created and added to a customer class or item class, it becomes available for selection on the
Entities (BC202000) form. To use an attribute in a filtering condition, you should select it in the Field Name column
of the table on the Export Filtering tab. An attribute can be distinguished from other fields by the Attributes prefix
before its name.

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.

Active Brackets Field Name Condition Value Value 2 Brackets Operator

Selected - Customer Does Not Morning Empty - And


Equal Cafe

The particular fields that you can select in the Field Name column depend on the selected entity.

If you change the import filter settings aer 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

Preparing Entities for Synchronization: Field Mapping

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.

Mapping of Fields for Export


Acumatica ERP Retail-Commerce Edition provides you with the ability to map fields, which are related to
synchronized entities, in Acumatica ERP with fields in BigCommerce. You can define additional mappings of
standard or custom fields as well as override the standard mappings provided with the BigCommerce integration.
You define the mappings of fields that should be processed during the export of data from Acumatica ERP into
BigCommerce on the Export Mapping tab of the Entities (BC202000) form. During the export 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 export process, you specify values in the following columns:
• Target 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.
• 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 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.
• 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 do not want inventory IDs of stock items maintained in Acumatica ERP to be publicly displayed
as SKU names on the storefront of your BigCommerce store. Instead, you want to show alternate IDs. To map the
alternate IDs of stock items in Acumatica ERP to stock keeping units (SKU) in BigCommerce, you do the following:
1. In Acumatica ERP, you make sure that an alternate ID is specified for each stock item on the Cross-
Reference tab of the Stock Items (IN202500) form.
2. On the Export Mapping tab of the Entities form, you select the store and the Stock Item entity, and in the
table row, you specify the following mapping settings.

Active Target Object Target Field Source Object Source Field / Val-
ue

Selected Product Stock Keeping Unit Stock Items → Cross Alternate ID


References

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.

Mapping of Fields for Import


Acumatica ERP Retail-Commerce Edition provides you with the ability to map fields, which are related to
synchronized entities, in Acumatica ERP with fields in BigCommerce. You can define additional mappings of
standard or custom fields, as well as override the standard mappings provided with the BigCommerce integration.
Integration with BigCommerce | 51

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

Selected Customer → Attrib- Message to Admin Customer → Form Message to Admin


utes Fields

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 the field is found, maps it to the source field


• If the field is not found, creates a new text field in the e-commerce system with the same name as that of the
source field

If <<Auto_Mapping>> is entered in the target field, you cannot use a formula in the source field.

Removing Standard Mapping for a Field


You can remove the mapping for fields that you do not want to be synchronized between Acumatica ERP and the
external system. You perform the unmapping for import and export directions separately as follows:
1. On the Entities (BC202000) form, you select the store and the entity for which you want to modify field
mapping.
2. Depending on the synchronization direction, you do one of the following:
• To remove the mapping from an Acumatica ERP field so that it is not used during the import, on the
Import Mapping tab, you select the needed values in the Target Object and Target Field columns, and
then in the Source Object column, you select <<Unmap>>.
• To remove the mapping from a field in the external e-commerce system so that it is not used during the
export, on the Export Mapping tab, you select the needed values in the Target Object and Target Field
columns, and then in the Source Object column, you select <<Unmap>>.
During the synchronization, the system will not pull data from the unmapped fields or record data to these
fields.

Using of Formulas in Field Mapping


When you define mappings between fields in Acumatica ERP and in the external system on the Entities (BC202000)
form, you can use formulas to calculate the values to be displayed in the target fields. Formulas give you the ability
to use advanced calculations and data transformation functions if some values are calculated or depend on the
data from other sources.
You can enter the formula directly in the Source Field / Value column (Import Mapping tab) or Target Field / Value
column (Export Mapping) or in the Formula Editor Dialog Box, which you invoke by clicking the Edit button in these
columns.
Operators and functions that you can use in formulas on the Entities form are the same as the operators and
functions that are used on the Import Scenarios (SM206025) and Export Scenarios (SM207025) forms. For more
information about formulas, functions, and operators, see Formulas in Mapping, Operators, and Functions.

Mappable Fields and Mapping Limitations


You can define additional mapping or override default mapping for the following types of Acumatica ERP fields:
• Standard fields: These fields are available in Acumatica ERP out of the box.
• Custom fields: These fields are not present in the out-of-the-box version of Acumatica ERP and are created
when a customization project is published.

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. Aer 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.

For more information about user-defined fields, see User-Defined Fields.


The table below lists the entities for which the mapping of nonstandard fields is supported, as well as the types of
fields that are supported for each entity. The last column also displays the objects in BigCommerce to which the
nonstandard Acumatica ERP fields can be mapped.

Table: Supported field types for entities in Acumatica ERP

Acumatica ERP Object BigCommerce Ob-


ject
Entity Custom Fields Attribute Fields User-Defined Fields

Stock Item Yes Yes No Product

Non-Stock Item Yes Yes No Product

Customer Yes Yes Yes • Customer


• Customer → Cus-
tomer Address
• Customer → Cus-
tomer Form
Fields

Customer Location Yes Yes Yes • Customer Ad-


dress Data
• Customer Ad-
dress Data →
Form Fields

Import Mapping of Sales Order Details


You can map the fields with information about the products included in an order in BigCommerce with the fields
used in sales order detail lines in Acumatica ERP.
When you define the field mapping to be used for importing sales orders from an external system, you can use both
predefined and custom Acumatica ERP fields of sales order detail lines—that is, fields that are used in sales order
lines, which are displayed on the Details tab of the Sales Orders (SO301000) form. During order synchronization,
details of the products in an order placed in BigCommerce is sent to the mapped fields in Acumatica ERP.
To use a sales order detail field in import mapping, on the Import Mapping tab of the Entities (BC202000) form, you
do the following:
1. In the Target Object column, select the Sales Order → Details or Sales Order → Details → Advanced option.
2. In the Target Value column, select a field from the list of fields that hold information about sales order
details. Custom fields have the prefix Usr.
3. In the Source Object column, select the Order Data → Order Products option.
Integration with BigCommerce | 54

4. In the Source Field / Value column, select a field from the list of fields holding information about products
in BigCommerce orders.

Import Mapping of BigCommerce Product Modifiers


You can map the fields used to modify a product in BigCommerce (which are called product modifiers or
customizations in BigCommerce) to the fields shown in sales order lines in Acumatica ERP. Product modifiers are
used to customize existing products without creating new product variants. For more information about product
modifiers, see the BigCommerce documentation.
To use a product modifier in an import mapping, on the Import Filtering tab of the Entities (BC202000) for, you
select Order Data → Order Products → Order Product Options in the Source Object column and type the name of the
product modifier as it appears on the user interface in BigCommerce. To define a more advanced mapping—for
example, to display data from multiple product modifier fields to a single sales order line field in Acumatica ERP—
you can specify a formula in this column.

Preparing Entities for Synchronization: Implementation Activity

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 1: Reviewing the Stock Items to Be Sold Online


To find the stock items that will be sold online, do the following:
1. Open the Stock Items (IN2025PL) form.
2. Filter the stock items to display only the items of the Jam item class as follows:
a. In the Item Class column, click the column header.
b. In the menu that opens, select the Equals filter condition.
c. In the box at the bottom of the menu, type Jam.
d. Click OK to apply the filter.
Now all stock items of the Jam item class are displayed. These are the stock items that will need to be
exported to the BigCommerce store.

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 4: Reviewing the Organization Size Attribute in Acumatica ERP


To see how the ORGSIZE attribute has been set up in the Acumatica ERP instance, do the following:
1. On the Attributes (CS205000) form, in the Attribute ID box, select ORGSIZE.
Take note of the description of the attribute and the descriptions of the attribute values. You will use them
for creating the corresponding custom field in BigCommerce.
2. On the Customer Classes (AR201000) form, in the Class ID box, select ECCUSTOMER.
3. On the Attributes tab, click Add Row on the table toolbar.
4. In the Attribute ID column, select the ORGSIZE attribute.
5. Click Save & Close on the form toolbar to save your changes.

Step 5: Adding a Custom Field to the Customer Registration Form in BigCommerce


To add a new field to the customer registration form in the BigCommerce store, do the following:
1. Sign in to the BigCommerce store by using the administrator credentials.
2. In the le pane, click Advanced Settings > Account Signup Form.
3. On the Account Signup Fields tab of the Form Fields page, which opens, click Create a New Field > Pick
List.
4. In the Create a Radio Buttons dialog box, specify the following settings:
• Field Name: Organization size
This field name corresponds to the description of the ORGSIZE attribute in Acumatica ERP.
• Instructional Text: Tell us how large your company is
• List of Values:
• 1-100 employees
• 100-500 employees
• Over 500 employees
These values correspond to the descriptions of values of the ORGSIZE attribute in Acumatica ERP.
5. Click Save to save the new field.
Integration with BigCommerce | 57

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, aer 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.

Automated Synchronization: General Information

Aer 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 aer 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 and Real-Time Synchronization


You can automate the synchronization of data of a particular entity between Acumatica ERP and the BigCommerce
store in the following ways:
• You configure automation schedules for data preparation or for data processing on the Automation
Schedules (SM205020) form. Data preparation or processing is started for the entity when the automation
schedule is executed. For information about scheduled synchronization, see Automated Synchronization:
Scheduled Synchronization.
• You turn on real-time synchronization for a particular entity on the Entities (BC202000) form. When real-
time synchronization is on, Acumatica ERP attempts to prepare or prepare and process data as soon as a
change is made to the entity in Acumatica ERP or in the e-commerce system. For information about real-
time synchronization, see Automated Synchronization: Real-Time Synchronization.
Scheduled synchronization and real-time synchronization do not interfere with each other or with manual
synchronization and can be used together. For recommendations on synchronization frequency, see Automated
Synchronization: Recommended Setup.

Automated Synchronization: Scheduled Synchronization

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.

Predefined Automation Schedules for Data Preparation and Processing


Acumatica ERP provides a number of predefined automation schedules—some for data preparation and others for
data processing—that you can use as starting points for setting up your own automation schedules. The following
table lists these schedules by the Description settings on the Automation Schedules (SM205020) form, along with
each schedule's predefined frequency of execution.

Table: Predefined Schedules for Data Preparation

Schedule Description Execution Frequency

Prepare Stock, Non-Stock, and Template Items Daily, once a day

Prepare Product Availability Daily, every hour

Prepare Sales Orders Daily, every 10 min

Prepare Shipments Daily, every 30 min

Prepare Refunds Daily, every 20 min

Process Non-Stock Items Daily, every hour


Integration with BigCommerce | 59

Schedule Description Execution Frequency

Process Stock Items Daily, every hour

Process Template Items Daily, every hour

Process Product Availability Daily, every hour

Process Sales Orders Daily, every 10 min

Process Shipments Daily, every 10 min

Process Refunds Daily, every 10 min

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.

2. You modify the schedule's settings as follows:


• On the Filters tab, add a filter condition to include the store for which the schedule should be executed.
• On the Schedule tab, adjust the schedule execution frequency, if necessary.

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

3. On the table toolbar, you click Schedule > Add.


The system opens the Automation Schedules form in a pop-up window. The settings that you have specified
appear on the Conditions and Filter Values tabs of the form.
4. You specify a name and description for the schedule, as well as its frequency, expiration information,
execution dates and times, and other settings.
5. You activate and save the schedule.

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.

To select all entities, clear the value in the Entity box.

2. On the table toolbar, you click Schedule > Add.


The Automation Schedules form opens in a pop-up window. The settings that you have specified appear on
the Filter Values tab of the form.
3. You specify a name and description for the schedule, as well as its frequency, expiration information,
execution dates and times, and other settings.
4. You activate and save the schedule.

For step-by-step instructions on creating a schedule for preparing and processing data, see Automated
Synchronization: To Configure a New Automation Schedule.

Automated Synchronization: Real-Time Synchronization

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

Turning On Real-Time Synchronization


To turn on real-time synchronization for an entity, on the Entities (BC202000) form, you select the store and the
entity and then click Start Real-Time Sync on the form toolbar. Real-time synchronization is turned on for the
direction specified in the Sync Direction box of the Summary area as follows:
• If the Sync Direction is Export, only real-time export is turned on for the entity.
• If the Sync Direction is Import, only real-time import is turned on for the entity.
• If the Sync Direction is Bidirectional, both real-time export and real-time import are turned on for the entity.
The status of the real-time import and export processes for an entity are displayed in the Real-Time Import and
Real-Time Export boxes in the Summary area and can be either of the following:
• Running: Real-time synchronization has been turned on.
• Stopped: Real-time synchronization is off but can be turned on.
• Not Supported: Real-time synchronization cannot be turned on.
To turn off real-time synchronization for an entity, you select the store and the entity in the Summary area, and
then click Stop Real-Time Sync on the form toolbar.
For detailed instructions on how to enable real-time synchronization, see Automated Synchronization: To Turn On
Real-Time Synchronization .

Webhook URL for Real-Time Import


If the synchronization direction is set to Import or Bidirectional, when you open a particular entity on the Entities
(BC202000) form and click Start Real-Time Sync on the More menu, the system opens the Start Real-Time Sync
dialog box. In the Real-Time Webhook URL box of this dialog box, you can update the URL which Acumatica ERP
will use for webhook notifications from the e-commerce system, if necessary. The webhook URL must be publicly
accessible and have SSL/TLS encryption. If a webhook cannot be delivered to the webhook URL, real-time import
will not work. When real-time synchronization is running, the URL that is currently used to receive webhooks for the
entity is displayed in the Real-Time Webhook URL box of the Summary area.

Limitations of Real-Time Synchronization


The use of real-time synchronization has the following limitations:
• Real-time synchronization in the Import direction is not reliable. Webhooks may be lost, disabled, or
deleted, in which case notifications about the changes will not be received and the synchronization will not
happen. We recommend that for each entity for which you have configured real-time synchronization, you
set up an automation schedule to run data preparation in Incremental mode at least once a night.
• The background process makes only one attempt to process each synchronization record placed in the
processing queue by the real-time synchronization process. If the attempt fails, processing continues for
other records in the queue. We recommend that you set up an automation schedule to regularly run data
processing to ensure that failed synchronization records are synchronized.
• In some cases, Acumatica ERP or an e-commerce system may generate multiple notifications for the same
record. For example, when a shipment is processed, Acumatica ERP generates multiple notifications about
updates to the sales order. For optimal performance, incoming notifications are processed with a delay of 15
to 20 seconds to ensure that all related notifications are processed simultaneously.
Integration with BigCommerce | 62

Automated Synchronization: Recommended Setup

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.

Table: Recommended Synchronization Setup for Lower Volumes

Entity Real-Time Synchronization Data Preparation Data Processing

Sales Order Started Daily, once a night Daily, once a night


Real-time mode: Prepare &
Process

Refund Started Daily, once a night Daily, once a night


Real-time mode: Prepare &
Process

Shipment Started Daily, once a night Daily, once a night


Real-time mode: Prepare &
Process

Stock Item, Non-Stock Started Daily, once a night Daily, once a night
Item, Template Item
Real-time mode: Prepare &
Process

Product Availability Stopped Daily, every 60 minutes Daily, every 60 minutes

Other entities Stopped Daily, once a night Daily, once a night

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 aer
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.

Table: Recommended Synchronization Setup for Higher Volumes

Entity Real-Time Synchronization Data Preparation Data Processing

Sales Order Stopped Daily, every 10 minutes Daily, every 10 minutes

Refund Stopped Daily, every 20 minutes Daily, every 10 minutes

Shipment Stopped Daily, every 30 minutes Daily, every 10 minutes

Stock Item, Non-Stock Stopped Daily, once a night Daily, every 60 minutes
Item, Template Item
Integration with BigCommerce | 63

Entity Real-Time Synchronization Data Preparation Data Processing

Product Availability Stopped Daily, every 60 minutes Daily, every 60 minutes

Other entities Stopped Daily, once a night Daily, once a night

Automated Synchronization: To Configure a New Automation Schedule

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.

The following activity is based on the U100 dataset.

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

Step 1: Scheduling of the Automatic Data Preparation for Customers


To configure an automation schedule that will start the data preparation process for the Customer entity once every
night, 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
With this option selected, only data that has been modified since the previous data synchronization will
be placed in the processing queue.
3. In the table, select the Selected check box in the row of the Customer entity.
4. On the form toolbar, click Schedules > Add to open the Automation Schedules (SM205020) form.
5. In the Description box, type Prepare Customers.
In the Summary area, the system has inserted Prepare Data in the Screen ID box and Prepare All in the
Action Name box.
On the Conditions tab, the system has added the settings summarized in the following table, which
correspond to the selections you have made on the Prepare Data earlier in this step.

Active Field Name Condition Value

Selected Connector Equals BigCommerce

Selected Store Equals SweetStore - BC

Selected Entity Equals Customer

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.

Active Field Name Value

Selected Store SweetStore - BC

Selected Prepare Mode Incremental

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

Step 2: Scheduling of the Automatic Data Processing for Customers


To configure an automation schedule that will start data processing for the Customer entity once a day, do the
following:
1. Open the Process Data (BC501500) form.
2. In the Summary area of the form, specify the following settings:
• Store: SweetStore - BC
• Entity: Customer
3. On the form toolbar, click Schedules > Add to open the Automation Schedules (SM205020) form.
4. In the Description box, enter Process Customers.
In the Summary area, the system has inserted Process Data in the Screen ID box and Process All in the
Action Name box.
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.

Active Field Name Value

Selected Store SweetStore - BC

Selected Entity Customer

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).

Automated Synchronization: To Turn On Real-Time Synchronization

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

Step: Enabling Real-Time Synchronization for Shipments


Perform the following instructions to enable real-time synchronization for shipments:
1. Open the Entities (BC2020PL) form.
2. In the Store Name box of the Selection area, select SweetStore - BC.
3. In the Entity column of the table, click the Shipment link.
The system opens the Entities (BC202000) form with the SweetStore - BC store and the Shipment entity
selected in the Summary area. Notice that this entity can only be exported to the BigCommerce store (that
is, Sync Direction is set to Export).
4. In the Real-Time Mode box, select Prepare & Process.
With this option selected, when the system creates or updates a synchronization record for a shipment as
part of real-time synchronization, it will also start processing this synchronization record so that out-of-sync
shipment data is saved in the BigCommerce store.
5. On the form toolbar, click Start Real-Time Sync.
Starting real-time synchronization can take a few seconds. Aer the real-time synchronization is turned on,
Real-Time Export is changed from Stopped to Running.

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.

Automated Synchronization: Business Events for Aborted Records

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.

Table: Predefined Business Events for Aborted Synchronization Records

Business Event ID Description Generic Inquiry Notification Tem-


plate

BCAbortedOrder Triggers notifications for aborted BC-DB-AbortedOrders Aborted Order Noti-


synchronization records of the Sales fication
Order entity

BCAbortedPayment Triggers notifications for aborted BC-DB-AbortedPayments Aborted Payment


synchronization records of the Pay- Notification
ment entity

BCAbortedRefund Triggers notifications for aborted BC-DB-AbortedRefunds Aborted Refund No-


synchronization records of the Re- tification
fund entity

BCAbortedShipment Triggers notifications for aborted BC-DB-AbortedShipments Aborted Shipment


synchronization records of the Ship- Notification
ment entity

For information about email notifications that are triggered by business events, see Business Events: Email
Notifications.

Automated Synchronization: To Activate a Predefined Business Event

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.

The following activity is based on the U100 dataset.


Integration with BigCommerce | 68

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

Step 1: Specifying the Store Administrator


To specify the administrator of the SweetStore - BC store, do the following:
1. Open the BigCommerce Stores (BC201000) form.
2. In the Store Name box of the Summary area, select SweetStore - BC.
Integration with BigCommerce | 69

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.

Step 2: Activating the Business Event


To activate the business event that will trigger the sending of email notifications to the store administrator, do the
following:
1. Open the Business Events (SM302050) form.
2. In the Event ID box of the Summary area, select BCAbortedOrder.
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 an email notification to Jerald Stevens every time a
synchronization record of the Sales Order entity is assigned the Aborted status.

Step 3: Reviewing the Notification Template


To review the template for notifications about aborted sales order synchronization records sent to the
administrator of SweetStore - BC, do the following:
1. While you are still viewing the BCAbortedOrder business event on the Business Events (SM302050) form, on
the Subscribers tab, click the Aborted Order Notification link in the Subscriber ID column.
2. On the Email Templates (SM204003) form, which opens, review the details of the template.
In the To box, notice that instead of a specific user name or email address, a variable is used. So emails are
sent to whoever is specified as the administrator of the store to which the aborted synchronization record
belongs.
On the Message tab, review the details of the aborted synchronization record. The information includes the
store name, the entity type, the local and external identifiers of the record, the last operation, and the last
error. The email body also contains the link to the Sync History (BC301000) form, on which you can review
the status of all synchronization records and resynchronize them aer the issues are resolved.

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.

Synchronizing Customers: General Information

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.

Synchronization of Customers Without Customer Locations


Before you can start synchronizing customer records between Acumatica ERP and the BigCommerce store, you
need to activate the Customer 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 entity. Then on
the Customer Settings tab, you need to also fill in the following boxes:
• 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 settings. For information about creating a
customer class, see Accounts Receivable: Customer Classes and Customers: Customer Class Settings.
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 Numbering Template (available for editing only if the CUSTOMER segmented key has more than
one segment): The template that is used to provide the identifiers of new customers imported 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.
Integration with BigCommerce | 71

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.

Synchronization of Customers with Customer Locations


To save shoppers time on entering address details with each purchase, BigCommerce provides the ability to store
each customer's shipping addresses in the customer's address book. In Acumatica ERP, you can save more than
one location for a customer account if the Business Account Locations feature is enabled on the Enable/Disable
Features (CS100000) form.

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.

Creation of a Customer Without an Address


With the Customer and Customer Location entities activated on the BigCommerce Stores (BC201000) form, when a
new customer is created in the BigCommerce store without an address, aer the Customer entity is synchronized, a
customer record is created in Acumatica ERP with the MAIN location. In the MAIN location, the system populates the
Country and Ship Via values based on the customer class specified in the Customer Class box on the Customer
Settings tab of the BigCommerce Stores (BC201000) form. However, the address lines are le blank.
In Acumatica ERP, whenever a new customer is created, the default MAIN location is created and specified for the
customer. When the Customer entity is exported, in the BigCommerce store, this customer is created without an
address record in the customer address book.
The following diagram illustrates the synchronization of customers created without an address.

Figure: Synchronization of customers created without an address


Integration with BigCommerce | 73

Creation of a Customer Address


If the Customer and Customer Location entities are activated on the BigCommerce Stores (BC201000) form and a
new address was created for a customer in the BigCommerce store, during the import of the Customer entity, the e-
commerce connector does one of the following:
• If the default MAIN location has empty address lines, the new address is used to populate the elements of
the MAIN location.
• If the default location has been deleted in Acumatica ERP, and there is a corresponding synchronization
record with the Deleted status on the Sync History (BC301000) form, the e-commerce connector creates a
new location and makes it the default.
• If the default location exists and the address lines in it are filled in, the connector creates a new location.
If a new location was created for a customer in Acumatica ERP, when the Customer entity is exported, the
corresponding new address is created for the customer in the BigCommerce store with the data of the new
location.
The following diagram illustrates the synchronization of a new customer address.

Figure: Synchronization of a new customer address

Editing of a Customer Address


With the Customer and Customer Location entities activated on the BigCommerce Stores (BC201000) form, if an
existing customer address synchronized with Acumatica ERP is edited in the BigCommerce store, during the import
of the Customer entity, the corresponding customer location in Acumatica ERP is updated with the changes made
to the customer address in the BigCommerce store.
If an existing customer location is edited in Acumatica ERP, during the export of the Customer entity, the e-
commerce connector does one of the following:
Integration with BigCommerce | 74

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.

Figure: Synchronization of an updated customer address

Deletion of a Customer Address


With the Customer and Customer Location entities activated on the BigCommerce Stores (BC201000) form, if a
customer address is deleted in the BigCommerce store, the import of the Customer entity proceeds as follows:
• If the corresponding customer location in Acumatica ERP is not the default customer location, the system
makes it inactive and its synchronization status changes to Deleted.
• If the corresponding customer location in Acumatica ERP is the default customer location, the connector
does one of the following:
• If the customer location is the only active location of a customer, the connector assigns the Deleted
status to the location's synchronization record.
• If other active locations exist for the customer, the connector makes this default location inactive,
assigns the Deleted status to its synchronization record, and makes one of the other active locations the
default one.
If an existing customer location is made inactive in Acumatica ERP, when the Customer entity is exported, the
inactive customer location is not synchronized with the BigCommerce store.
The following diagram illustrates the synchronization of a deleted customer address.
Integration with BigCommerce | 75

Figure: Synchronization of a deleted customer address

Synchronizing Customers: Implementation Checklist

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.

Form Criteria to Check

Enable/Disable Features (CS100000) The following features have been enabled:


• Commerce Integration
• BigCommerce Connector
• Business Account Locations (for synchronization of customer ad-
dresses)
Integration with BigCommerce | 76

Form Criteria to Check

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

Synchronizing Customers: To Perform Bidirectional Synchronization

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.

Step 1: Reviewing the Synchronization Settings of the Customer Entity


To review the synchronization settings of the Customer entity, 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 that the following settings have
been specified:
• Active Selected
• Sync Direction: Bidirectional
• Primary System: External System
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
will be defined based on the customer class selected in this box.
• Customer Auto-Numbering: ECCUSTOMER
Each new customer imported from the BigCommerce store will be assigned an identifier based on the
numbering sequence selected in this box.
5. If you have changed any of the settings, click Save on the form toolbar to save your changes.
Integration with BigCommerce | 79

Step 2: Step 1: Configuring the Filtering Condition


To configure the export of only customer records that are assigned to the COMMERCEBB customer class, do the
following:
1. Open the Entities (BC2020PL) form.
2. In the Store Name box of the Selection area, select SweetStore - BC.
3. In the Entity column of the table, click the Customer link.
The system opens the Entities (BC202000) form with the SweetStore - BC store and the Customer entity
selected in the Summary area.
4. To create a first filtering condition, on the Export Filtering tab, click Add Row on the table toolbar, and
specify the following settings in the row:
• Active: Selected
• Field Name: Customer Class
• Condition: Equals
• Value: COMMERCEBB
5. To create a second filtering condition, and another row and specify the following settings in the row:
• Active: Selected
• Field Name: Email
• Condition: Is Not Empty
6. 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 - BC store.

Step 3Step 2: Preparing the Customer Data for Synchronization


To prepare the customer data for synchronization, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Prepare Mode: Incremental
3. In the table, select the Selected check box in the row of the Customer 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.

Step 4Step 3: Processing the Prepared Customer Data


To process the customer data you have prepared for synchronization, do the following:
1. While you are still viewing the Prepare Data (BC501000) form, click the link in the Ready to Process column
of the row with the Customer entity.
Integration with BigCommerce | 80

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.

Step 5: Step 4: Reviewing the Synchronization Status


To review the synchronization status of the synchronization records that you processed in the previous step, do the
following:
1. Open the Sync History (BC301000) form.
2. In the Summary area of the form, specify the following settings:
• Store: SweetStore - BC
• Entity: Customer
3. Go to the Processed tab.
The tab shows the items that have been synchronized with the SweetStore - BC store (see the following
screenshot). For each customer of the COMMERCEBB customer class that you processed, the system
displays an identifier in the External ID column. In the table, the Last Operation column is set to Inserted
Externally and the time stamp in the Last Attempt column now shows the date and time when you ran data
processing on the Process Data (BC501500) form.

Figure: Synchronization records for processed customer entities

Step 6: Step 5: Viewing Exported Customer Records


To view the FRUITICO and JAMIFIQUE customers (which have been synchronized in the previous steps of this
activity) in the BigCommerce store, do the following:
1. While you are still viewing the Sync History (BC301000) form, locate the row with JAMIFIQUE, Jamifique
factory in the ERP ID column, and click the link in the External ID column of that row.
The Edit Customer page of the control panel of the BigCommerce store opens for Colleen Plunkett, who is
the primary contact of the JAMIFIQUE customer.

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

2. Open the Customer Address Book tab.


Notice that no addresses have been added for the customer. Because the Customer Location entity was not
activated on the Entity Settings tab of the BigCommerce Stores (BC201000) form, the location information
has not been imported to the BigCommerce store for this customer and other customers synchronized in
the previous steps of this activity.
3. In the le pane, click Customers > View.
4. On the View Customers page, which opens, review the list of customers that have been exported.
Because you have configured the filtering condition so that the system exports from Acumatica ERP only the
customers of the COMBUSFEF customer class, only the customers of that customer class are displayed on
the View Customers page.

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.

5. Click the row of Fruitico Coffee and Cakes.


The Edit Customer page opens. Because on the Customers (AR303000) form the Name box of the Primary
Contact section was empty for this customer, the First Name and Last Name boxes have been filled in with
the information from the Account Name box of the Account Info section on the Customers form.

Synchronizing Customers: To Synchronize Customers with Multiple Locations

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.

Step 2: Creating a Customer in the BigCommerce Store


To create a customer with two addresses, in the control panel of the BigCommerce store, do the following:
1. Open the control panel of the BigCommerce store.
2. In the le pane, click Customers > Add to open the Add Customer page.
3. In the Customer Details section of the Customer Details tab, specify the following details:
• First Name: Isabelle
• Last Name: Bober
• Company Name: Hoppy Place Coffee and Cakes
• Email Address: hoppy_info@example.com
4. In the Customer Password section, specify the following settings:
• Password: !Q123456
• Confirm Password: !Q123456
5. In the lower right, click Save & Exit to save the new customer record.

Step 3: Adding Two Addresses for the Customer


To add the first address for the customer record that you created in the previous step, do the following in the
BigCommerce store:
1. While you are still signed in to the control panel of the BigCommerce store, on the View Customers page,
click the row of Isabelle Bober (which you can locate in the Name column).
Integration with BigCommerce | 84

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.

Step 4: Preparing the Customer and Customer Location Data


To prepare the customer and customer location data for synchronization, in the Acumatica ERP instance, 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
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 automatically 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.
Integration with BigCommerce | 85

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.

Step 5: Processing the Prepared Customer and Customer Location Data


To process the customer and customer location data you have prepared for synchronization, do the following:
1. While you are still viewing the Prepare Data (BC501000) form, click the link in the Ready to Process column
of the row with the Customer entity.
The Process Data (BC501500) form opens with the SweetStore - BC store and the Customer entity selected in
the Summary area.
2. In the table, select the unlabeled check box in the only row, which has a number in the External ID column
but does not have any value in the ERP ID column.

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.

Step 6: Reviewing the Imported Customers and Customer Locations


Perform the following instructions to review the customers and customer locations that have been imported to
Acumatica ERP:
1. Open the Customers (AR3030PL) form.
2. In the list of customers, in the Customer Name column, locate the Hoppy Place Coffee and Cakes customer,
which you created in the BigCommerce store, and click the link for this customer in the Customer ID
column.
3. On the Customers (AR303000) form, which opens for Hoppy Place Coffee and Cakes, on the Locations tab,
review the locations the system created when the customer record was synchronized.
Notice that the table displays the following locations (shown in the screenshot below):
• The location with the MAIN identifier, which was created for the customer first in the BigCommerce store.
This location is also marked as the default (that is, the Default check box is selected for this location).
• The location with the identifier that the system assigned to it based on the numbering sequence selected
for locations in the store settings on the BigCommerce Stores (BC201000) form.
Integration with BigCommerce | 86

Figure: Customer locations imported from the store

4. Click the MAIN link in the Location ID column.


5. On the Customer Locations (AR303020) form, which the system has opened in a pop-up window, on the
General tab, review the location details that have been imported from the BigCommerce store.
Notice that the Company Name value from the address in BigCommerce 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 BigCommerce have been imported to the Attention box of the
Additional Location Info section.

Step 7: Updating the Customer Location


Suppose that you need to update the contact and address details of the MAIN customer location of the Hoppy Place
Coffee and Cakes customer. Do the following:
1. While you are still viewing the MAIN customer location on the Customer Locations (AR303020) form, on the
General tab, in the Additional Location Info section, type Gail Anderson in the Attention box.
2. In the Location Address section, change Address Line 1 to 3650 Taylor Street.
3. On the form toolbar, click Save & Close to save your changes.

Step 8: Synchronizing the Updated Location with the BigCommerce Store


To synchronize the updated customer location with the BigCommerce store in order to update the address in the
store, do the following:
1. On the Sync History (BC301000) form, in the Selection area, specify the following settings:
• Store: SweetStore - BC
• Entity: Customer Location
2. On the Processed tab, select the unlabeled check box in the row of the MAIN, Hoppy Place Coffee and Cakes
location, and on the form toolbar, click Sync.
Integration with BigCommerce | 87

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.

Step 9: Reviewing the Updated Customer Address in the BigCommerce Store


To review the updated customer address in the BigCommerce store, do the following:
1. While you are still viewing the Sync History (BC301000) form, in the row of the MAIN, Hoppy Place Coffee and
Cakes, click the link in the External ID column.
The Edit Customer Address page of the control panel of the BigCommerce store opens for the
corresponding address of the Hoppy Place Coffee and Cakes customer.

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.

Product Synchronization: General Information

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 aer 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

Configuration of Product Synchronization


Before exporting stock and non-stock items defined in Acumatica ERP to the BigCommerce store, you need to
perform the following general steps:
1. Activate the Stock Item and Non-Stock Item entity. 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 Stock Item and
Non-Stock Item entity.
2. Configure the default visibility and purchasability settings for items exported to the BigCommerce store. For
details, see Product Synchronization: Default Store Settings.
3. Determine which items should be exported and define the visibility and purchasability settings for
individual items. For details, see Product Synchronization: Settings of Individual Items.

Synchronization of Stock and Non-Stock Items


Depending on the item type, the settings of an item in the BigCommerce store are updated as part of the
synchronization of the Stock Item or Non-Stock Item entity.
During the export, the system updates the availability and visibility settings of each item exported to BigCommerce
based on the settings specified for the item on the eCommerce tab of the Non-Stock Items form or Stock Items form
and for the store on the Inventory Settings tab of the BigCommerce Stores (BC201000) form.
For details about the information exported to the BigCommerce store during the synchronization of a stock item or
a non-stock item, see Stock Item Entity and Non-Stock Item Entity.

Product Synchronization: Default Store Settings

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.

Default Product Availability Settings


On the Inventory Settings tab of the BigCommerce Stores (BC201000) form, you define the default availability
status that is assigned to items exported from Acumatica ERP. This status determines whether the exported
item can be purchased in the BigCommerce store. To define the default availability status, you select one of the
following options in the Default Availability box:
• Set as Available (Track Qty.): The stock items exported to the BigCommerce store are available for purchase
via the storefront, and their quantities are tracked, meaning that the items can be purchased only if their
quantities are greater than zero. In BigCommerce, on the product management page for each of these
items, the This product can be purchased in my online store option button (in the Purchasability section)
and the Track inventory check box (in the Inventory section) are selected.
For stock items, the available quantities are tracked on the product level (that is, the On the product level
option button is selected under the Track Inventory check box).
The non-stock items exported to the BigCommerce store are available for purchase via the storefront, and
their quantities are not tracked (that is, the Track inventory check box is cleared).
• Set as Available (Don't Track Qty.): The non-stock and stock items exported to the BigCommerce store are
available for purchase via the storefront, and their quantities are not tracked. In BigCommerce, on the
product management page for each of these items, the This product can be purchased in my online
store option button (in the Purchasability section) is selected and the Track inventory check box (in the
Inventory section) is cleared.
Integration with BigCommerce | 89

• 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.

Default Visibility Settings


You can specify visibility settings that will be applied by default to each item exported to the BigCommerce store on
the Inventory Settings tab of the BigCommerce Stores (BC201000) form. To instruct the system to make all items
by default immediately available on the storefront aer they are exported to the BigCommerce store, you select
Visible in the Default Visibility box. To make items by default available for management in the store's control panel
but hidden from the storefront, you select Invisible in this box. To make items visible on the storefront and included
in the group of featured products (which are displayed in specific places across the storefront, depending on the
theme set up for the store), you select Featured in this box.

Product Synchronization: Settings of Individual Items

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.

Excluding Items from Synchronization


You can exclude an individual stock or non-stock items from synchronization with the BigCommerce store (or any
other e-commerce system) by clearing the Export to External System check box on the eCommerce tab of the
Stock Items (IN202500) or Non-Stock Items (IN202000) form.

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—aer 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.

Visibility of an Exported Item


You can specify the visibility settings for an individual item on the eCommerce tab of the Stock Items (IN202500) or
Non-Stock Items (IN202000) form. To make the item visible on the storefront immediately aer it is exported, you
select Visible in the Visibility box. To make the item available in the control panel of BigCommerce store but hidden
from the storefront, you select Invisible. To make the item visible on the storefront and included in the group of
featured products (which are displayed in specific places across the storefront, depending on the theme set up for
the store), you select Featured in this box.
The option selected in the Visibility box for a particular item takes precedence over the default visibility setting
specified for the store in the Default Visibility box on the Inventory Settings tab of the BigCommerce Stores
(BC201000) form. If Store Default is selected, the store's default visibility settings applies.

Availability of an Exported Item


When a stock or non-stock item is exported to or created in a BigCommerce store, it is assigned an availability
(purchasability) status in the Purchasability section of the product management page in the store's control panel.
In Acumatica ERP, you can determine which status is to be assigned to an item exported to BigCommerce by
selecting a corresponding option in the Availability box on the eCommerce tab of the Stock Items (IN202500) or
Non-Stock Items (IN202000) form:

• 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.

Product Synchronization: Sales Categories

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.

Product Synchronization: To Synchronize Items with Attributes

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.

Step 1: Creating an Attribute


To create an attribute for the release date of a product that is a non-stock item, do the following:
1. On the Attributes (CS205000) form, add a new record.
2. In the Summary area, specify the following settings:
• Attribute ID: RELDATE
• Description: Pre-Order Release Date
• Control Type: Datetime
3. On the form toolbar, click Save.

Step 2: Adding the Attribute to the Needed Item Class


To add the Pre-Order Release Date attribute to the TRAINING item class, do the following:
1. Open the Item Classes (IN201000) form.
2. In the Item Class Tree pane, select the TRAINING item class.
3. In the right pane, on the Attributes tab, click Add Row on the table toolbar of the upper table.
4. In the added row, in the Attribute ID column, select RELDATE.
5. On the form toolbar, click Save.

Step 3: Assigning a Value to the Added Attribute


To assign a specific value to the created attribute for the ONLCOURSE non-stock item, do the following:
1. Open the Non-Stock Items (IN202000) form.
2. In the Summary area, in the Inventory ID box, select ONLCOURSE.
Integration with BigCommerce | 93

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.

Step 4: Mapping the Attribute to a Field in the BigCommerce Store


To map the release date attribute with the BigCommerce field, do the following:
1. Open the Entities (BC2020PL) form.
2. In the Store Name box of the Selection area, select SweetStore - BC.
3. In the Entity column of the table, click the Non-Stock Item link.
The system opens the Entities (BC202000) form with the SweetStore - BC store and the Non-Stock Item entity
selected in the Summary area. Notice that the Sync Direction is set to Export, which means that this entity
is only exported to the BigCommerce store.
4. On the Export Mapping tab, click Add Row.
5. In the row you have added to the table, specify the following settings:
• Active: Selected
• Target Object: Product
• Target Field: Pre-Order Release Date
• Source Object: Non-Stock Item → Attributes
• Source Field / Value: =Year(CDate([NonStockItem -> Attributes.Pre-Order Release
Date]))+'-'+Month(CDate([NonStockItem -> Attributes.Pre-Order Release
Date]))+'-'+Day(CDate([NonStockItem -> Attributes.Pre-Order Release
Date]))+'T00:00:00+00:00'
6. On the form toolbar, click Save.

Step 5: Configuring the Export of a Subset of Non-Stock Items


To configure the Non-Stock Item entity to export to the BigCommerce store only stock items of the TRAINING item
class, do the following:
1. While you are still viewing the Entities (BC202000) form for the SweetStore - BC store and the Non-Stock Item
entity, on the Export Filtering tab, add a row and specify the following settings:
• Active: Selected
• Field Name: Item Class
• Condition: Equals
• Value: Training
2. On the form toolbar, click Save.

Step 6: Creating an Attribute


To create an attribute that will indicate the sugar level of products, do the following:
1. On the Attributes (CS205000) form, add a new record.
2. In the Summary area, specify the following settings:
• Attribute ID: SUGARLEVEL
• Description: Sugar Level
Integration with BigCommerce | 94

• Control Type: Text


3. On the form toolbar, click Save.

Step 7: Adding the Attribute to the Needed Item Class


To add the Sugar Level attribute to the JAM item class, do the following:
1. Open the Item Classes (IN201000) form.
2. In the Item Class Tree pane, select the JAM item class.
3. In the upper table on the Attributes tab, click Add Row on the table toolbar.
4. In the added row, in the Attribute ID column, select SUGARLEVEL.
5. On the form toolbar, click Save.

Step 8: Assigning a Value to the Added Attribute


To assign a specific value to the created attribute for the CHERJAM96 stock item, do the following:
1. Open the Stock Items (IN202500) form.
2. In the Summary area, in the Inventory ID box, select CHERJAM96.
3. In the Attributes table on the Attributes tab, in the row with the Sugar Level attribute, enter Sugar-free
as the Value.
4. On the form toolbar, click Save.

Step 9: Mapping the Attribute to a Field in the BigCommerce Store


To map the Sugar Level attribute with the BigCommerce field, do the following:
1. Open the Entities (BC2020PL) form.
2. In the Store Name box of the Selection area, select SweetStore - BC.
3. In the Entity column of the table, click the Stock Item link.
4. On the Entities (BC202000) form, which opens with the SweetStore - BC store and the Stock Item entity
selected in the Summary area, on the Export Mapping tab, click Add Row.
5. In the row you have added, specify the following settings:
• Active: Selected
• Target Object: Product → Custom Fields
• Target Field: <<Auto_Mapping>>
• Source Object: Stock Item → Attributes
• Source Field / Value: Sugar Level
6. On the form toolbar, click Save.

Step 10: Preparing Product Data for Synchronization


To prepare the product data for synchronization, 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
Integration with BigCommerce | 95

• Prepare Mode: Incremental


This setting controls which data will be loaded. Incremental indicates that the system will load only the data
that has been modified since the previous data synchronization.
3. In the table, select the Selected check box in the rows of the Stock Item and Non-Stock Item entities, 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.
Notice that the Ready to Process column shows the number of synchronization records that have been
prepared and are ready to be processed. The Processed Records column shows the number of records that
have been processed (that is, records that have been successfully synchronized).

Step 11: Processing the Prepared Product Data


To process the product data that has been prepared for synchronization, do the following:
1. While you are still viewing the Prepare Data (BC501000) form, click the link in the Ready to Process column
in the row of the Non-Stock Item entity.
The Process Data (BC501500) form opens with the SweetStore - BC store and the Non-Stock Item entity
selected in the Summary area. The table displays all synchronization records of the Non-Stock Item entity
that the system prepared in the previous step.
2. In the row of the Home canning courses online (website session) non-stock item, select the unlabeled check
box, 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.
4. In the Entity box, select Stock Item.
5. In the row of the Cherry jam 96 oz stock item, select the unlabeled check box, and on the form toolbar, click
Process.
6. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.

Step 12: Viewing the Exported Products


To view the exported product data in the BigCommerce store, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area of the form, specify the following settings:
• Store: SweetStore - BC
• Entity: Non-Stock Item
On the Processed tab, notice that the synchronization record of the non-stock item is displayed in the only
row of the table. The External ID column displays the identifier of the non-stock item in BigCommerce.
3. Click the link in the External ID column to open the product in the BigCommerce control panel.

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

Figure: Custom attribute shown in the storefront

Product Synchronization: Product Images

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

Export of Product Images


In Acumatica ERP, you can save images for stock and non-stock items in two ways:
• As attachments to an item: On the Attributes tab of the Stock Items (IN202500) and Non-Stock Items
(IN202000) forms
• As links to an external storage: In the Media URLs table on the eCommerce tab of the Stock Items and Non-
Stock Items forms
Images that have been attached to an item on the Stock Items or Non-Stock Items form are exported to the
BigCommerce store during the synchronization of the Product Image entity. The item they belong to must be
exported to the BigCommerce store or created in the BigCommerce store before images attached to it are exported.
Of all files attached to the item, the system exports only the files with extensions for which the Image check box is
selected on the File Upload Preferences (SM202550) form.
Images specified as links in the Media URLs table on the eCommerce tab are exported together with the item
(that is, during the synchronization of the Stock Item and Non-Stock Item entities). When the item is exported to the
BigCommerce store, the images are added to the product management page of the exported item in the control
panel of the BigCommerce store. For successful synchronization, images must be publicly accessible (that is, access
to them should not require authentication or authorization).
In the Media URLs table, you can also specify links to YouTube videos for an item. These videos are added to the
product page in the BigCommerce store during the synchronization of the item (that is, during the synchronization
of the Stock Item and Non-Stock Item entities). You can specify the full URL or the Share URL (that is, a short URL
generated when you click the Share button under the video) of a publicly accessible video.

Product Synchronization: To Synchronize Product Images

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.

Step 1: Adding an Image to the Stock Item


To add an image to the APJAM08 stock item, do the following:
1. Open the Stock Items (IN202500) form.
2. In the Summary area, in the Inventory ID box, select APJAM08.
3. On the Attributes tab, drag the files you downloaded to the Image area.
The files are attached to the form. You can browse them in the Image area or access them by clicking Files in
the form title bar.
4. On the eCommerce tab, add a row in the Media URLs table, and specify the following settings in the added
row:
• URL: http://acumatica-builds.s3.amazonaws.com/builds/University/
CommerceTraining/AppleJam3.png
• Type: Image
5. On the form toolbar, click Save.

Step 2: Preparing the Stock Item Data for Synchronization


Before you can synchronize images for a stock item, you need to synchronize the stock item itself. To prepare the
stock item data for synchronization, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Summary area of the form, specify the following settings:
Integration with BigCommerce | 100

• 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 aer 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.

Step 3: Processing the Prepared Stock Item Data


To process the stock item data prepared for synchronization, do the following:
1. While you are still viewing the Prepare Data (BC501000) form, click the link in the Ready to Process column
in the row of the Stock Item entity.
The Process Data (BC501500) form opens with the SweetStore - BC store and the Stock Item entity selected in
the Summary area.
2. Select the unlabeled check box in the row with the Apple jam 8 oz. description, 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.

Step 4: Reviewing the Synchronized Stock Item


To review the Apple jam 8 oz. stock item, which has been synchronized, in the BigCommerce store, do the following:
1. In the le pane of the control panel, click Products > View.
2. On the View Products page, which opens, click the Apple jam 8 oz. link in the Product Name column.
3. On the product management page for the Apple jam 8 oz. product, which opens, review the Images &
Videos section.
Notice that the Images subsection contains only one image, which you added as an external link to the
Media URLs table on the eCommerce tab of the Stock Items (IN202500) form. Images and videos added to
this table are synchronized as part of the synchronization of the Stock Item entity.
In the next steps, you will synchronize the images that you uploaded on the Attributes tab of the Stock
Items form.

Step 5: Preparing the Image Data for Synchronization


To prepare the image data for synchronization, 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
Because you have not processed the Product Image entity before, the system will prepare all images
attached to the synchronized items as it would if Full mode were selected.
Integration with BigCommerce | 101

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.

Step 6: Processing the Prepared Image Data


To process the image data prepared for synchronization, do the following:
1. While you are still viewing the Prepare Data (BC501000) form, click the link in the Ready to Process column
in the row of the Product Image entity.
The Process Data (BC501500) form opens with the SweetStore - BC store and the Product Image entity
selected in the Summary area. The table displays two synchronization records of the Product Image entity.

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.

Step 7: Reviewing the Synchronized Images


To review the images that have been exported for the Apple jam 8 oz. product, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area of the form, specify the following settings:
• Store: SweetStore - BC
• Entity: Product Image
3. Open the Processed tab.
The table displays two synchronization records of the Product Image entity, as shown in the following
screenshot. In the External ID column, notice that the identifier of each image in the BigCommerce store
consists of two parts—the identifier of the product and the identifier of the image.

Figure: Synchronization records for the product images


Integration with BigCommerce | 102

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.

Product Synchronization: Related Items

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

Aer 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).

Synchronizing Sales Prices

In this chapter, you will learn how sales prices are synchronized between Acumatica ERP and the BigCommerce
store.

Price Synchronization: General Information

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.

Types of Sales Prices Synchronized with BigCommerce


The following basic types of prices that you maintain in Acumatica ERP can be synchronized with the BigCommerce
store:
• Default prices: The default price of a particular stock item is specified on the Stock Items (IN202500) form
and is exported to the BigCommerce store during the synchronization of the stock item. Similarly, the
default price of a non-stock item is maintained on the Non-Stock Items (IN202000) form and is exported to
the BigCommerce store when the non-stock item is synchronized.
In the BigCommerce store, the default prices of stock and non-stock items are displayed in the Default
Price box in the Pricing subsection of the Product Information section on the View Products page for a
particular stock or non-stock item.
• Base prices: Base prices—that is, the prices that 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.
Sales prices of the Base type imported from Acumatica ERP are saved in BigCommerce in the Sale Price box
in the Pricing subsection of the Product Information section on the View Products page for a particular
stock or non-stock item.
In BigCommerce, the sales price has a higher priority than the default price. Therefore, when the Sale Price
box is populated for an item, the price specified in this box is the effective price of the item.
Integration with BigCommerce | 104

• 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.

Synchronization of Volume-Based Prices


In Acumatica ERP, if the Volume Pricing feature is enabled on the Enable/Disable Features (CS100000) form, you can
define prices that are dependent on the quantity of the products being purchased by a customer. These prices can
be defined for all customers (that is, they have the Base type) or for particular customer classes (that is, they have
the Customer Price Class type). For more information on how volume-based pricing works in Acumatica ERP, see
Automatic Price Selection: To Explore Volume-Based Prices.

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).

Limitations of Sales Price Synchronization


The following price types maintained in Acumatica ERP cannot be exported to a BigCommerce store:
• Customer-specific prices: Prices defined in Acumatica ERP for a particular customer—that is, prices that
have the Customer type—cannot be exported to the BigCommerce store. If you want to provide a particular
customer with the ability to purchase products at individual prices, create a separate customer price class
for this customer. This way, the prices that you define for this customer price class will be available for only
the customer that you add to this customer price class.
Integration with BigCommerce | 105

• 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.

Price Synchronization: To Export Base 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.

Inventory ID Price Type Price Code UOM Break Qty Price

PEARJAM96 Base Empty PIECE 0 45.00

BANJAM96 Base Empty PIECE 0 45.00


Integration with BigCommerce | 106

Inventory ID Price Type Price Code UOM Break Qty Price

BANJAM96 Base Empty PIECE 5 43.00

BANJAM96 Base Empty PIECE 10 40.00

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.

Step 2: Synchronizing the Prices of Stock Items


To synchronize the base sales prices, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Prepare Mode: Incremental
3. In the table, select the Selected check box for the Base Sales Price 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 Base Sales Price entity, click the link in the Ready to Process column.
6. On the Process Data (BC501500) form, which opens with the SweetStore - BC store and the Base Sales Price
entity selected in the Summary area, on the form toolbar, click Process All.
7. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.

Step 3: Reviewing the Exported Base Prices


To view the exported prices of the PEARJAM96 item, in the control panel of the BigCommerce store, do the
following:
1. In the le pane, click Products > View.
2. On the View Products page, which opens, locate the PEARJAM96 item in the list of products, and in the row
of this item, click the link in the Product Name column.
3. On the product management page, which opens, in the Pricing subsection of the Product Information
section, click the Show Advanced Pricing link.
Notice that for this product two prices are specified (as shown in the following screenshot):
• The default price shown in the Default Price box. This is the price, which was defined for the item on the
Price/Cost tab of the Stock Items (IN202500) form was exported during the synchronization of the Stock
Item entity.
• The sales price shown in the Sale Price box. This is the base sales price, which was exported during the
synchronization of the Base Sales Price entity.
Integration with BigCommerce | 108

Figure: Base prices and default price specified for the item

4. At the top of the page, click View on Storefront.


On the product page, which opens with the Pear jam 96 oz. product, notice the price that is displayed for
shoppers ($45.00).

Step 4: Reviewing the Exported Volume-Based Prices


To view the sales prices of the BANJAM96 item that depend on the quantity being purchased, do the following:
1. Return to the control panel of the BigCommerce store.
2. In the le pane, click Products > View.
3. On the View Products page, in the list of products, locate the BANJAM96 item, and in the row of this item,
click the link in the Product Name column.
4. On the product management page, which opens, in the Pricing subsection of the Product Information
section, click the Show Advanced Pricing link.
Notice the price in the Sale Price box, $45.00, which corresponds to the price with a break quantity of 0
defined on the Sales Prices (AR202000) form of Acumatica ERP. In the Bulk Pricing section, review the two
rows of bulk pricing options, which correspond to the two sales prices with break quantities of 5 and 10
defined for the item on the Sales Prices form.
5. At the top of the page, click View on Storefront.
6. On the product page, which opens, notice that $45.00 is displayed as the item's price.
7. Click Buy in bulk and save under Bulk Pricing.
8. In the Bulk Discount Rates dialog box, which opens, review the description and the following bulk discount
options:
• Buy 5 - 9 and pay only $43.00 each
• Buy 10 or above and pay only $40.00 each
9. Leave the quantity of 1 and click Add to Cart.
10.On the confirmation page, click View or edit your cart.
In the row of Banana jam 96 oz, notice that the price for 1 jar of jam is $45.
11.Change the quantity to 6.
You might need to click elsewhere on the page to refresh the price and the total. Notice that the price has
changed to $43, and the total is now $301.
Integration with BigCommerce | 109

12.Change the quantity to 10.


Notice that the price has changed to $40, and the total is now $400,

You have exported base sales prices, including volume-based sales prices, to the BigCommerce store.

Price Synchronization: To Export Prices for Customer Groups

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.

• The following activity is based on the U100 dataset.


• 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.

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.

Inventory ID Price Type Price Code UOM Price

PEARJAM96 Base Empty PIECE 45.00

PEARJAM96 Customer Price Class LOCAL PIECE 43.70

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.

Step 1: Preparing the Data


To synchronize the customer price classes and prices of the stock items that are specific to customer price classes,
do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Prepare Mode: Full
• Start Date: Empty
3. In the table, select the Selected check box for each of the following entities:
• Customer Price Class
• Customer
• Price List
The Customer entity is included in this synchronization process to make sure the customers assigned to the
LOCAL customer price class are exported to the BigCommerce store and are added to the customer group
corresponding to their price class. You will use a customer of this customer price class (FourStar Coffee &
Sweets Shop) later in this activity.
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.
Integration with BigCommerce | 111

Step 2: Processing the Prepared Data


To process the customer price class, customer, and price list data, do the following:
1. Open the Process Data (BC501500) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Entity: Customer Price Class
3. On the form toolbar, click Process All.
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 Entity box, select Customer.
6. On the form toolbar, click Process All.
7. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
8. In the Entity box, select Price List.
9. On the form toolbar, click Process All.
10.In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.

Step 3: Reviewing the Customer Groups


To review the customer groups, in the control panel of the BigCommerce store, do the following:
1. In the le pane, click Customers > Customer Groups.
On the Customer Groups page, which opens, notice that two customer groups have been created (INTERN
and LOCAL).
Customer price classes defined in Acumatica ERP are mapped to customer groups in the BigCommerce
store. In the Customers in Group column, notice the number of customers that have been assigned to each
of the customer groups.
2. In the row of the LOCAL customer group, click the View link in the Customers in Group column.
On the View Customers page, which opens, the system displays the list of customers assigned to the
customer group. Notice that the FourStar Coffee & Sweets Shop customer has been assigned to this customer
group.

Step 4: Reviewing the Exported Sales Prices of the Item


To review the sales prices of the PEARJAM96 stock item in the BigCommerce store, do the following:
1. In the le pane, click Products > View.
2. On the View Products page, in the list of products, locate the PEARJAM96 stock item, and in the row of this
item, click the link in the Product Name column.
3. On the product management page, which opens for Pear jam 96 oz, in the Pricing subsection of the Product
Information section, click the Show Advanced Pricing link.
Notice that two prices are displayed in this section: the default price of $45.15, which is the default price of
the stock item maintained on the Stock Items (IN202500) form; and the sales price of $45.00, which is the
sales price of the Base type defined for the stock item on the Sales Prices (AR202000) form.
Integration with BigCommerce | 112

4. At the top of the page, click View on Storefront.


On the product detail page, which opens for Pear jam 96 oz, notice that the sales price of $45.00 is displayed
as the item's price, and the default price is displayed as the previous price.

Step 5: Reviewing the Exported Price List


To review the LOCAL price list, which is specific to customers belonging to the LOCAL customer group, do the
following:
1. Return to the control panel of the BigCommerce store.
2. In the le pane, click Products > Price Lists.
3. On the Price Lists page, which opens, in the Price List Name column, click LOCAL.
On the View Price Lists / LOCAL (USD) page, which opens, review the prices on the Prices tab.
Notice that for the PEARJAM96 item, the New Sale Price column shows a value of $43.70, which is the price
of the item defined for the LOCAL customer price class on the Sales Prices form.

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.

Step 6: Creating a Password for the Customer


To create a password for the FourStar Coffee & Sweets Shop customer, do the following:
1. In the le pane, click Customers > View.
2. While you are still viewing the View Customers page, click the FourStar Coffee & Sweets Shop link in the
Name column.
3. On the Edit Customer page, which opens, in the Customer Password section, specify the customer
password of !Q123456 in both the Password box and the Confirm Password box.
4. In the lower right, click Save & Exit to save your changes.

Step 7: Viewing the Product Page as a Signed-In Customer


To view customer price, do the following:
1. In the le pane, click View Store.
2. On the storefront, click Sign In in the upper right of the main page.
3. On the Sign-In page, enter the following credentials:
• Email Address: salesperson.fourstars@example.com
• Password: !Q123456
4. Click Sign in to sign in to the account of the FourStar Coffee & Sweets Shop customer.
5. In the upper right, click Search, and start typing pearjam in the search box.
6. In the list of search results, click the tile of Pear jam 96 oz.
On the product detail page, which opens for Pear jam 96 oz, review the product price. Pear jam 96 oz is
available for purchase at $43.70, which is the price specific to the LOCAL customer price class (or customer
group) to which the FourStar Coffee & Sweets Shop is assigned.
7. In the upper right, click Sign Out to sign out of the FourStar Coffee & Sweets Shop account.
Integration with BigCommerce | 113

Synchronizing Product Availability

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.

Product Availability: General Information

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.

Configuration of Product Availability Synchronization


Before you start exporting available quantities of stock items between Acumatica ERP and a BigCommerce, you
need to perform the following general steps:
1. Activate the Product Availability entity. 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 Product Availability entity.
2. Specify the quantity calculation settings for the store on the Inventory Settings tab of the BigCommerce
Stores form. For details, see Product Availability: Calculation of Available Quantities.
3. Determine the stock items for which available quantities should be exported. For more information, see the
Tracking Available Quantities of Exported Stock Items section below.

Tracking Available Quantities of Exported Stock Items


You can track available quantities of stock items exported to a BigCommerce store and make them available for
purchase via the storefront only when they are in stock. You can also determine how the system should handle
items that go out of stock.
To make an exported stock item available for purchase via the storefront and enable quantity tracking for it, on the
eCommerce tab of the Stock Items (IN202500) form, you select Set as Available (Track Qty.) in the Availability box.
When the item is synchronized, in BigCommerce, on the product management page for the item, the system
applies the following settings:
Integration with BigCommerce | 114

• 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.

Synchronization of Availability Settings


The availability (purchasability) settings of a stock item in the BigCommerce store are updated as part of the
synchronization of the Stock Item entity. During the synchronization, the system updates the purchasability
settings of each item exported to BigCommerce based on the option selected in the Availability box on the
eCommerce tab of the Stock Items (IN202500) form.
For stock items whose quantities are tracked and have been synchronized with the BigCommerce 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.

Synchronization of Available Quantities


Available quantities of stock items are exported to the BigCommerce store during the synchronization of the
Product Availability entity.
The synchronization of the Product Availability entity affects only the stock items that have Availability set to Set as
Available (Track Qty.) on the eCommerce tab of the Stock Items (IN202500) form.
During the synchronization, the system updates the item's quantity in BigCommerce based on the Warehouse
Mode and Availability Mode settings specified on the Inventory Settings tab of the BigCommerce Stores
(BC201000) form. For details, see Product Availability: Calculation of Available Quantities.
If the item has no available quantity (that us 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.

Units of Measure of Available Item Quantities


An item's available quantity is exported to the BigCommerce store in the item's sales unit of measure, which is
defined on the General tab of the Stock Items (IN202500) form. If an item's base UOM is different from its sales
UOM, during the synchronization of the Product Availability entity, the item's available quantity is converted to the
sales UOM before being exported to the BigCommerce store.
Integration with BigCommerce | 115

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 aer
changing its sales UOM so that new orders for the item are created in the BigCommerce store with the
updated UOM.

Product Availability: Calculation of Available Quantities

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.

Product Availability: To Export Product Availability Data

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.

Stock Item Availability When Qty. Unavailable

BANJAM96 Store Default Store Default

BANJAM08 Store Default Store Default

PEARJAM96 Set as Available (Track Qty.) Set as Unavailable

PEARJAM08 Set as Available (Track Qty.) Set as Unavailable

PLUMJAM96 Set as Available (Track Qty.) Do Nothing

PLUMJAM08 Set as Available (Track Qty.) Do Nothing

CHERJAM96 Set as Pre-Order Store Default

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.

Step 1: Updating the Default Availability Settings


Now you need to specify the availability settings that the system will apply by default to stock items and non-stock
items exported from Acumatica ERP to the BigCommerce store. While you are viewing the BigCommerce Stores
(BC201000) form for the SweetStore - BC store, do the following:
1. On the Inventory Settings tab, specify the following settings:
• Default Availability: Set as Available (Track Qty.)
With this setting, by default, a stock item exported to the BigCommerce store will be available for
purchase through the storefront, and its quantity will be tracked.
• When Qty. Unavailable: Set as Pre-Order
With this setting, aer the synchronization of the Product Availability entity, if the stock item's quantity
becomes zero, the stock item will no longer be available for purchase in the BigCommerce store, but
customers will be able to place pre-orders.
• Availability Mode: Available for Shipping
• Warehouse Mode: Specific Warehouses
2. In the Warehouse Settings table, add a new row and specify the following settings:
• Warehouse: RETAIL
• Location ID: JS1
For each item, only its quantity available for shipping at the JS1 location in the RETAIL warehouse is
synchronized with the BigCommerce store.
Integration with BigCommerce | 118

3. On the form toolbar, click Save to save the settings.

Step 2: Reviewing the Available Quantities of Items


To review the availability quantity of the stock items, do the following:
1. Open the Storage Details by Item Warehouse Location (IN408055) form.
2. In the Selection area, in the Warehouse box, select RETAIL.
The system displays the quantities of all items stored in the RETAIL warehouse.
3. Click the header of the Location ID column, and in the dialog box that opens, select Equals, type JS1 in the
box below, and click OK.
The system now displays only the items that are stored in the JS1 warehouse location. Because you have set
the Availability Mode setting to Available for Shipping, the quantities of the items displayed in the Location
Available for Shipping column (which is shown in the following screenshot) will be synchronized with
the BigCommerce store. Notice that the BANJAM96, CHERJAM96, PEARJAM96, and PLUMJAM96 stock items
are available at the JS1 location (a nonzero quantity is displayed for each of these items in the Location
Available for Shipping column), whereas the BANJAM08, PEARJAM08, and PLUMJAM08 stock items have
zero quantities.

Figure: Quantities of stock items available for shipping

Step 3: Synchronizing the Product Availability Data


To synchronize the availability settings and the quantities of the stock items, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Summary area, make sure the following settings are specified:
• Store: SweetStore - BC
• 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
BigCommerce 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.
Integration with BigCommerce | 119

6. Open the Process Data (BC501500) form.


7. In the Summary area of the form, specify the following settings:
• Store: SweetStore - BC
• 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.

Step 4: Reviewing the Synchronized Data


To review the synchronized availability data in the BigCommerce store, do the following:
1. In the le pane of the control panel, click Products > View.
2. On the View Products page, which opens, review the BANJAM96 and BANJAM08 stock items.
In the Stock Level column, notice that for the BANJAM96 stock item, the green bar is displayed, which
indicates that the quantity of this item is tracked and the item is in stock. For BANJAM08, the bar in the
Stock Level column is gray, meaning that the item's quantity is tracked and the item is currently out of
stock. The system also shows Pre-Order right of the product name.
3. Click the Banana jam 96 oz. link in the Product Name column.
4. On the product management page for the BANJAM96 stock item, notice the following:
• In the Inventory section, the Track Inventory check box is selected, the On the product level option
button is selected, and 40 is displayed in the Stock box.
• In the Purchasability section, the This product can be purchased in my online store option button is
selected.
5. In the le pane of the control panel, click Products > View.
6. On the View Products page, click the Banana jam 8 oz. link in the Product Name column.
7. On the product management page for the BANJAM08 stock item, notice the following:
• In the Inventory section, the Track Inventory check box is selected, the On the product level option
button is selected, and 0 is displayed in the Stock box.
• In the Purchasability section, the This product is coming soon but I want to take pre-orders option
button is selected.
8. Repeat Instructions 6 and 7 to review the PEARJAM96, PEARJAM08, PLUMJAM96, PLUMJAM08, and
CHERJAM08 stock items.
The following table summarizes the settings and available quantities that have been set for the exported
stock items.

Item Name Inventory Stock Purchasability

PEARJAM96 Track inventory check box 35 This product can be pur-


selected chased in my online store
option button selected
Integration with BigCommerce | 120

Item Name Inventory Stock Purchasability

PEARJAM08 Track inventory check box 0 This product cannot be pur-


selected chased in my online store
option button selected

PLUMJAM96 Track inventory check box 42 This product can be pur-


selected chased in my online store
option button selected

PLUMJAM08 Track inventory check box 0 This product can be pur-


selected chased in my online store
option button selected

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.

Order Synchronization: General Information

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.

Minimal Configuration of Order Synchronization


To start importing sales orders from the BigCommerce store, you need to activate the required entities and specify
the minimal settings for the activated entities on the BigCommerce Stores (BC201000) form. On the Entity Settings
Integration with BigCommerce | 121

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.

The Order Time Zone


While you are performing the initial configuration of the BigCommerce store, on the Order Settings tab of the
BigCommerce Stores (BC201000) form, you should specify the Order Time Zone that the system will use for each
sales order imported from the BigCommerce 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.

Limiting the Date Range for Order Import


If you have had the BigCommerce store for a while before implementing Acumatica ERP, you might want to prevent
old orders from being imported to Acumatica ERP when you start synchronizing orders. On the Order Settings tab
of the BigCommerce Stores (BC201000) form, you specify the Earliest Order Date. Orders created before this date
in the BigCommerce store are excluded from synchronization between Acumatica ERP and the BigCommerce store.
Payments and shipments created for such orders are excluded from synchronization too.

Tracking Imported Sales Orders in the BigCommerce Store


You might want to have information about the orders that have already been imported to Acumatica ERP available
in the BigCommerce store. On the Order Settings tab of the BigCommerce Stores (BC201000) form, you select
the Tag Ext. Order with ERP Order Nbr. check box. When a sales order is imported from the BigCommerce store
and assigned an order number in Acumatica ERP, the Acumatica ERP order number is exported and saved as a
metafield of the sales order in BigCommerce.

Mapping of Shipping Options


You define the mapping of each shipping option (which is a combination of a shipping zone and shipping method)
defined in BigCommerce to the ship via code, and optionally, shipping zone and shipping terms defined in
Acumatica ERP in the Shipping Option Mapping table on the Order Settings tab of the BigCommerce Stores
(BC201000) form. The Store Shipping Zone and Store Shipping Method columns of the table are populated with
the settings from BigCommerce automatically for shipping options defined in the BigCommerce store.

Configuration of Payment Synchronization


If payments for at least one payment method set up in the BigCommerce store should be imported to Acumatica
ERP, you need to activate the Payment entity on the Entity Settings tab of the BigCommerce Stores (BC201000)
form.
Integration with BigCommerce | 122

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.

Synchronization of Sales Orders and Payments


Orders are imported from a BigCommerce store during the synchronization of the Sales Order entity. During the
data processing stage of the order import, the system does the following in Acumatica ERP:
1. Creates a sales order on the Sales Orders (SO301000) form. For information about the details and settings
that the system inserts in the created sales order, see Sales Order Entity.

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

Workflow of Importing a Sales Order with a Manual Payment


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 manual payment method or a card payment method without integrated
card processing.
Integration with BigCommerce | 124

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.

Order Synchronization: Implementation Checklist

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.

Table: Checklist for Order Import if Payments Do Not Require Processing

Form Criteria to Check

Enable/Disable Features (CS100000) The following features have been enabled:


• Commerce Integration
• BigCommerce Connector

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.

Table: Checklist for Order Import if Payments Require Processing

Form Criteria to Check

Enable/Disable Features (CS100000) The following features have been enabled:


• Commerce Integration
• BigCommerce Connector

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

Form Criteria to Check

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.

Other Settings That Affect the Workflow


You can affect the workflow of the import of orders and payments by specifying additional settings. To
automatically release payments related to the imported order, select the Release Payments check box for the
store payment method on the Payment Settings tab of the BigCommerce Stores (BC201000) form.

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

Order Synchronization: Card 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
aer they are imported to Acumatica ERP.

Configuration of Authorize.Net Payment Method for Integrated Card Processing


Authorize.Net is a processing center that accepts transactions through an application programming interface and
processes payments online. Before credit card payments can be imported from a BigCommerce store, you need to
configure payment processing via Authorize.Net as follows:
1. Sign up for an Authorize.Net account.
For testing purposes, you can create a sandbox account. You will use the API login, transaction, and
optionally signature key generated during the account creation to connect the processing center to the
Authorize.Net server.
2. Activate integrated card processing.
You enable integrated card processing (that is, the ability to use additional card processing steps for AR
payments) by selecting the Enable Integrated CC Processing check box on the Accounts Receivable
Preferences (AR101000) form.
3. Configure an Authorize.Net processing center.
You set up the processing center on the Processing Centers (CA205000) form. Before you proceed with the
configuration, you need to obtain the API login, signature key, and transaction key that you will use to
connect to the Authorize.Net server. For instructions on setting up a processing center in Acumatica ERP, see
Integration with Authorize.Net Through the API Plug-in and To Configure the Authorize.Net Processing Center
with the API Plug-in.
Integration with BigCommerce | 127

4. Configure a card-based payment method in Acumatica ERP.


Aer you have configured the processing center, on the Payment Methods (CA204000) form, you need to
create a payment method that will be associated with the processing center. For information about setting
up payment methods in Acumatica ERP, see Cash Management: Payment Methods.
5. Configure the Authorize.Net payment gateway in the BigCommerce store.
You set up the Authorize.Net payment provider in the BigCommerce store using the same API login,
signature key, and transaction key that you have used to configure the processing center in Acumatica ERP.
For information about configuring payment providers in the external system, refer to the BigCommerce
documentation.
6. Map the card-based payment method with the payment methods defined in the BigCommerce store.
You map payment methods between Acumatica ERP and the BigCommerce store on the BigCommerce
Stores (BC201000) form. When a payment is imported from the BigCommerce store to Acumatica ERP, a
prepayment is created on the 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 BigCommerce store.

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.

Mapping of Card-Based Payment Methods


During the configuration of a connection to the BigCommerce store, one of the steps you perform is the mapping of
payment methods configured in Acumatica ERP with payment methods configured in the BigCommerce store. You
define payment method mapping in the table on the Payment Settings tab of the BigCommerce Stores (BC201000)
form.
For the Authorize.Net store payment method, you specify the following:
• ERP Payment Method: The identifier of the payment method in Acumatica ERP that was configured to use
the same processing center as was used for setting up the payment provider in the online store.
• 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.
• Active: A check box that you select for a payment method to indicate that payments made in the e-
commerce system that are based on should be imported to Acumatica ERP.
• Release Payments: A check box that you select to indicate that the payment should be immediately
released aer 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 aer 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.

Import of Payments Based on Credit Cards


A customer who has signed in to the BigCommerce store can save credit card details during checkout. When this
customer selects the Authorize.Net payment method, enters the details of a new card, selects the Save this card for
future transactions check box, and then places an order, the details of the credit card are saved in the processing
center configured in the BigCommerce store.
Integration with BigCommerce | 128

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

Deferred Processing of Imported Credit Card Payments


Credit card transactions created in Acumatica ERP during the import of payments based on credit card payment
methods require validation in the following cases:
• If the customer used a previously saved credit card
Integration with BigCommerce | 130

• 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.

Order Synchronization: To Configure and Import Authorize.Net Payments

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.

The following activity is based on the U100 dataset.

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.
Aer 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.

Step 1: Activating Integrated Card Processing


To activate integrated card processing, do the following:
1. Open the Accounts Receivable Preferences (AR101000) form.
2. In the Data Processing Settings section on the General tab, select the Enable Integrated CC Processing
check box.
3. On the form toolbar, click Save.
Integration with BigCommerce | 132

Step 2: Creating the Processing Center


To create the processing center that will be connected to the Authorize.Net payment gateway, do the following:
1. Open the Processing Centers (CA205000) form.
2. On the form toolbar, click Add New Record, and in the Summary area, specify the following settings:
• Proc. Center ID: AUTHNETCOM
This processing center represents the connection to the Authorize.Net payment gateway for the credit
card processing transactions from the online store.
• Name: Authorize.Net Commerce
• Cash Account: 10250ST - Company Merchant Account
This cash account specifies the currency in which the system will make the authorization and capture
credit card transactions.
• Active: Selected
• Payment Plug-In (Type): PX.CCProcessing.V2.AuthnetProcessingPlugin
The selected payment plug-in is a card processing plug-in supplied with Acumatica ERP that interacts
with the payment gateway in PCI DSS-compliant mode. The sensitive information of the card is neither
stored in Acumatica ERP nor transferred between the system and the payment gateway.
• Allow Saving Payment Profiles: Selected (default state)
• Synchronize Deletion: Selected (default state)
• Accept Payments from New Cards: Selected (default state)
3. On the form toolbar, click Save.

Step 3: Specifying the Connection Settings for the Processing Center


To configure the connection to the payment gateway (so that you can use the payment gateway in test mode), do
the following:
1. While you are still viewing the Processing Centers (CA205000) form, on the Plug-In Parameters tab, specify
the values as listed in the following table.

ID Value

MERCNAME The API Login ID of your sandbox account

SIGNKEY Leave as is

TESTMODE 1

TRANKEY The Transaction Key of your sandbox account

VALIDATION Test Mode

2. Save your changes.


3. 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 message: The credentials were
accepted by the processing center.
Integration with BigCommerce | 133

Step 4: Configuring a Payment Method That Represents Payments by Card


You can create one payment method for all credit cards, which is the approach you will take in this step.
(Alternatively, to categorize payments in Acumatica ERP by card payment systems, you could create a payment
method for each payment system supported by the gateway and specify the same merchant account for all
payment methods.)
To create the payment method to be used for processing for all payments by credit card, do the following:
1. On the Payment Methods (CA204000) form, add a new record.
2. In the Summary area, specify the following settings:
• Payment Method ID: ALLCARDS
• Active: Selected
• Means of Payment: Credit Card
When you set Means of Payment to Credit Card, on the Settings for Use in AR tab, the Integrated
Processing check box becomes selected, and the Processing Centers tab appears.
• Description: All card payments
• Use in AP: Cleared
• Use in AR: Selected
• Require Remittance Information for Cash Account: Cleared
3. On the Allowed Cash Accounts tab, do the following:
a. On the table toolbar, click Add Row.
b. In the new row, select the 10250ST cash account in the Cash Account column.
c. Make sure the Use in AR check box is selected for the cash account.
4. On the Processing Centers tab, add a row, and specify the following settings in the row:
• Proc. Center ID: AUTHNETCOM
• Active: Selected
• Default: Selected
5. On the form toolbar, click Save to save your changes.

Step 5: Defining the Authorize.Net Payment Gateway in the BigCommerce Store


To define the Authorize.Net payment method that the store will accept for the United States Dollar (USD) currency,
in the BigCommerce control panel, do the following:
1. In the le pane, click Settings.
2. On the Settings page, in the Setup section, click Payments.
3.
4. On the Payment Methods page, which opens, in the Show payment methods for box, make sure USD (US
Dollar) is selected.
The system displays the Checkout Payment Settings tab and a tab for each payment method activated for
the selected currency.
5. On the Checkout Payment Settings tab, under Additional providers, expand the Online Payment
Methods group.
6. In the row of Authorize.Net, click Set up.
7. On the Authorize.Net Settings tab, which appears, specify the following settings:
• API Login ID: The API Login ID of your Authorize.Net sandbox account
Integration with BigCommerce | 134

• Transaction Key: The Transaction Key of your Authorize.Net sandbox account


You should use API Login ID and Transaction Key that you used when you configured the connection to
Authorize.Net payment gateway.
• Transaction Type: Authorize Only
• Test Mode: Yes
8. In the lower right, 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 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.

Step 7: Creating an Order Through the Storefront


To purchase a jar of jam, so that you can later import the order and review the credit card payment, in the
BigCommerce control panel, do the following:
1. In the le pane, click View Store to open the storefront.
2. On the storefront, in the search box, start typing plum.
3. In the search results, click the tile of the Plum jam 96 oz product.
4. On the page for the Plum jam 96 oz product, which opens, select a quantity of 3, and click Add to Cart.
5. In the pop-up window that opens, click Proceed to checkout.
6. On the checkout page, specify the needed settings as follows:
a. In the Customer section, in the Email Address box, specify melody@example.com, and click Continue.
b. In the Shipping 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
• My billing address is the same as my shipping address: Selected
c. In the Shipping Method section, make sure that the Free Shipping option is selected, and click Continue.
7. In the Payment section, make sure the Authorize.Net option button is selected, and specify the following
card settings:
Integration with BigCommerce | 135

• Credit Card Number: 4111 1111 1111 1111


• Expiration: 12/23
• Name on Card: Melody Keys
8. Click Place Order to place your order.
Your order has been created, and on the confirmation page, the order number is displayed. You will process
the order with this order number further in this activity.

Step 8: Reviewing the Sales Order in the Control Panel


To review the sales order that you placed in the previous step, in the BigCommerce control panel, do the following:
1. In the le pane, click Orders > View.
2. On the View Orders page, which opens, expand the order of Melody Keys, 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 you have configured the Authorize.Net payment option to only authorize the
payment amount when the order is placed, the payment funds have not yet been captured.

Step 9: Importing the Sales Order


To prepare the sales order data for synchronization and then process it, 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. The Process Data (BC501500) form opens with the SweetStore - BC store and
the Sales Order entity selected.
6. In the table on the Process Data form, select the unlabeled check box for the only row, and click Process on
the form toolbar.
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 Imported Sales Order


To review the settings of the imported sales order, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Entity: Sales 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.
Integration with BigCommerce | 136

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.

Figure: Prepayment applied to order

6. On the table toolbar, click Capture.


Aer the capture operation is successfully completed, Proc. Status is changed to Captured, and the status of
the prepayment document is changed from Pending Processing to Open, which means that the prepayment
document has been released.

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.

Order Synchronization: Orders with Gi Wrapping

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.

Configuration of Gi Wrapping Import


To configure the import of gi-wrapped items to Acumatica ERP, you perform the following general steps:
1. On the Non-Stock Items (IN202000) form, define a non-stock item to represent gi wrapping in sales orders,
shipments, and invoices. This non-stock item should have the following settings:
• Item Status (in the Summary area): Active, No Purchases, or No Request
• Type (the General tab): Non-Stock Item or Service
• Require Receipt: Selected
• Require Shipment: Selected
Integration with BigCommerce | 137

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.

Import of Gi Messages


You can set up an import mapping to display a gi message, if a customer le one while adding gi wrapping for an
item in the BigCommerce store, in the Gi Message column of the line of the gi wrapping of the imported order.
To do this, on the Import Mapping tab of the Entities (BC202000) form, you select the BigCommerce store and the
Sales Order entity and specify the mapping settings as shown in the following table.

Active Target Object Target Field Source Object Source Field / Val-
ue

Selected Sales Order → Details Gi Message Order Data → Order Products Wrapping Mes-
sage

Gi Wrapping Details in the Sales Order Synchronization Record Information


You can view the information about the gi-wrapping item on the Sync History (BC301000) form. To do this, you
select a row of a sales order synchronization record in the table and click View Details on the More menu. In
the Sync Record Details dialog box, which is opened, information about the sales order line containing the gi-
wrapping item is displayed along with information about the sales order line of the item for which gi wrapping
was added in the BigCommerce store. The gi wrapping order line contains Sales Order Line (Gi Wrapping) in the
Entity Type column. The sales order line for gi wrapping has the same value in the External ID column as the
sales order line of the item to be gi wrapped.

Importing Orders with Taxes

In this chapter, you will learn how to configure tax synchronization between Acumatica ERP and the BigCommerce
store.

Import of Taxes: General Information

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.

Configuration of Tax Synchronization for Manual Tax Setup


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 BigCommerce store. For information, see Manual Tax Setup in
the BigCommerce 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 BigCommerce 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 classes and tax rates in BigCommerce. If you use different names for a
tax or a tax category 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 BigCommerce Stores (BC201000) 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 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.
3. Specify the tax synchronization settings on the Order Settings tab of the BigCommerce Stores (BC201000)
form as follows:
• Tax Synchronization: Selected
• 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
During the import of an order, the system searches for the tax zone that should be used for tax calculation as
follows, stopping the search when it finds a qualifying tax zone:
1. The system searches for the primary tax zone.
2. The system searches for the tax zone of the customer location.
3. The system tries to determine the tax zone based on the zip code of the shipping address.
4. The system searches for the default tax zone.

This process is illustrated in the following diagram.


Integration with BigCommerce | 139

Figure: Determining the tax zone for tax calculation

Configuration of Tax Synchronization for the External Tax Service


If you want to use an external tax provider for automatic tax calculation, you need to perform the following general
steps:
1. Configure automatic tax calculation in the BigCommerce store. For information, see Automatic Tax Setup in
the BigCommerce documentation.
Integration with BigCommerce | 140

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.

Handling of Long Tax Names


If an external tax provider is used for tax calculation, sometimes tax names returned by the external tax provider
can exceed the maximum allowed length of tax IDs supported by Acumatica ERP, (which is currently 60 characters).
Long tax IDs are processed as follows:
• If there is no hyphen in the tax ID, any characters that exceed the maximum length are truncated.
• If there is a hyphen in the tax ID, the tax ID is processed as follows:
• If the tax ID contains the word SPECIAL, the part of the ID to the right of the hyphen is used. Any
characters that still exceed the maximum length are truncated.
• If the tax ID does not contain the word SPECIAL, the part of the ID to the le of the hyphen is used. Any
characters that still exceed the maximum length are truncated.

Tax Calculation Mode in Imported Sales Orders


In BigCommerce, you can indicate whether the prices of products are entered in the control panel of the store
inclusive or exclusive of tax. However, information about this setting is not passed during the import of sales orders
from BigCommerce to Acumatica ERP. If the Net/Gross Entry Mode feature is enabled on the Enable/Disable Features
(CS100000) form, for sales orders imported from the BigCommerce store, the system inserts Tax Settings in the Tax
Calculation Mode box on the Financial tab of the Sales Orders (SO301000) form. This option is inserted regardless
of the price settings in the BigCommerce store and the configuration of tax calculation in Acumatica ERP.

Import of Taxes: Process Activity

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.

Step 1: Configuring the Sales Tax in BigCommerce


To configure the sales tax for New York in the BigCommerce store, do the following:
1. In the le pane of the control panel, click Settings.
2. On the Settings page, in the Setup section, click Tax.
3. On the Tax page, which opens, in the Set up your own tax rules section, click Edit.
On the General tab, notice that the manual tax setup has been enabled.
4. On the Tax Classes tab, review the default tax classes.
Integration with BigCommerce | 142

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.

A tax rate in BigCommerce corresponds to a tax in Acumatica ERP.

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.

Step 2: Reviewing the Tax Configuration in Acumatica ERP


To review the taxes that have been predefined, in Acumatica ERP, do the following:
1. Open the Tax Categories (TX2055PL) form.
Tax categories in Acumatica ERP correspond to tax classes in BigCommerce. Notice that there are only two
tax categories on the form (TAXABLE and EXEMPT).
2. Open the Tax Zones (TX206000) form.
3. In the Tax Zone ID box, select NYSTATE.
4. On the Applicable Taxes tab, in the row of NYSTATETAX, click the link in the Tax ID column.
The system opens the Taxes (TX205000) form in a pop-up window. Review the settings of the NYSTATETAX
tax.
On the Tax Schedule tab, notice the current tax rate (effective starting 1/1/2023), which is 8.875.
On the Categories tab, notice that the TAXABLE category has been added for this tax. On the Zones tab,
notice that the NYSTATE tax zone has been added for the tax. With these settings, the NYSTATETAX tax is
applied to all taxable items (that is, items assigned to the TAXABLE tax category) sold to customers assigned
to the NYSTATE tax zone.
Integration with BigCommerce | 143

Step 3: Configuring Tax Synchronization


To configure the synchronization of taxes between Acumatica ERP and the BigCommerce store, 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 Order Settings tab (Taxes section), specify the following settings:
• Tax Synchronization: Selected
• Default Tax Zone: NYSTATE
With this setting specified, if a tax zone cannot be determined during the import of an order from the
BigCommerce store, the NYSTATE tax zone will be used.
4. In the Substitution Lists section, note the substitution lists used for taxes (BCСTAXCODES) and tax
categories (BCCTAXCLASSES). These substitution lists are predefined and are inserted as the default values
in these boxes. For the purposes of this activity, you do not need to change the selected values; you will
instead update these substitution lists. However, in a production environment, you can create other
substitution lists on the Substitution Lists (SM206026) form and specify them in these boxes.
5. On the form toolbar, click Save.

Step 4: Updating the Substitution List for Tax Categories


As you may have noticed while completing Steps 1 and 2, in Acumatica ERP, two tax categories (TAXABLE and
EXEMPT) have been defined, whereas in the BigCommerce store, there are four tax classes—Default Tax Class,
Non-Taxable Products, Shipping, and Gi Wrapping. To make sure that stock and non-stock items exported from
Acumatica ERP are assigned the correct tax class in the BigCommerce store, do the following:
1. Open the Substitution Lists (SM206026) form.
2. In the Substitution List box of the Summary area, select BCCTAXCLASSES.
Notice that the table contains the only row with Original Value set to TAXABLE and Substitution Value set
to Default Tax Class.
3. In the table, add one more row with the following settings:
• Original Value: EXEMPT
• Substitution Value: Non-Taxable Products
With these settings, non-stock and stock items that have the TAXABLE tax category in Acumatica ERP will be
assigned the Default Tax Class tax class in the BigCommerce store when they are exported. Non-stock and
stock items of the EXEMPT category will be assigned the Non-Taxable Products tax class.
4. On the form toolbar, click Save.

Step 5: Updating the Substitution List for Taxes


For smooth import of online orders on which you collect taxes from the SweetStore - BC store to Acumatica ERP,
the tax names defined in both systems must be the same. In Step 1, you created the New York State Tax tax rate in
the BigCommerce store. (A tax rate is defined in BigCommerce; in Acumatica ERP, a tax is the entity you define.).
The same tax has the name NYSTATETAX in Acumatica ERP. To make the import of sales orders work, you can either
update the tax names (in either system or both systems) so that they match, or map the different tax names in a
substitution list. The mappings of tax names between a BigCommerce store and Acumatica ERP are specified in
the predefined BCCTAXCODES substitution list, which by default is specified on the BigCommerce Stores (BC201000)
form as the tax substitution list to be used for synchronization with the store.
To map tax names in a substitution list, do the following:
Integration with BigCommerce | 144

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.

3. On the form toolbar, click Save to save your changes.

Step 6: Exporting the Stock Items


1. Open the Prepare Data (BC501000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Prepare Mode: Full
• Start Date: Cleared
3. In the table, select the check box in the row of the Stock 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 Stock Item 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 Stock Item 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.

Step 8: Viewing the Synchronized Stock Items in the Store


To review the items that have been synchronized between Acumatica ERP and the BigCommerce store and verify
that they have been exported to the BigCommerce store with the correct tax category, do the following:
1. In the le pane of the control panel of the BigCommerce store, click Products > View.
2. In the list of products, for the KIWIJAM96 product, click the link in the Product Name column.
3. On the product management page, which opens, review the details of the KIWIJAM96 product.
Notice that in the Pricing section, the Tax Class is set to Default Tax Class. The system assigned this tax class
to the product because the KIWIJAM96 stock item has the TAXABLE tax category in Acumatica ERP.
Integration with BigCommerce | 145

You can verify that the tax category is assigned correctly to non-stock items by completing instructions
similar to those described above.

Step 9: Creating an Online Order


To make sure that the taxes applied to taxable products in an online order are imported correctly during the order
synchronization, you need to create an order in the BigCommerce store and import it to Acumatica ERP.
To create an order with the taxable products, while you are signed in to the control panel of the BigCommerce
store, do the following:
1. In the le pane, click Orders > Add.
2. On the Add an Order page (Customer Info step), create the order as follows:
a. In the Customer Information section, select the Existing Customer option button right of Order for.
b. In the Search box, start typing the customer's name, Isabelle, and select Isabelle Bober in the list of
search results.
c. In the Billing Information section, click Use this address right of the address details for William Duncan.
The billing address elements are filled with the settings from the previously saved address of this
customer.
d. Clear the Save to customer's address book check box.
e. In the lower right, click Next.
3. On the Add an Order > Items page, under Add Products, do the following:
a. In the Search box, start typing kiwi, and in the list of search results, select KIWIJAM96 and specify the
quantity of 5.
b. 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. Make a note of the amount of the tax applied to the order ($20.04).
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.

Step 10: Importing the Sales Order to Acumatica ERP


To import the sales order, in Acumatica ERP, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Prepare Mode: Incremental
3. In the table, in the row of the Sales Order entity, select the Selected check box.
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.
Integration with BigCommerce | 146

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.

Step 11: Reviewing the Taxes in the Imported Sales Order


To review how the taxes are displayed in the imported sales order, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Entity: Sales 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 order that have been imported.
In the Summary area, notice that the Tax Total amount matches the tax amount of the order in the
BigCommerce store ($20.04), as shown in the following screenshot. On the Taxes tab, which lists all taxes
applied to individual order lines, notice that the NYSTATETAX is displayed.
On the Details tab, notice that for the only line with the KIWIJAM96 item, Tax Category is set to TAXABLE.
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) form and is not imported from the tax class assigned to the item in the
BigCommerce store.

Figure: Sales order with calculated taxes

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

Importing Orders with Discounts

In this chapter, you will learn how to set up the import of orders with discounts from the BigCommerce store to
Acumatica ERP.

Import of Orders with Discounts: General Information

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.

Displaying of Discounts in Imported Orders


If the Customer Discounts feature is enabled on the Enable/Disable Features (CS100000) form, when you configure
the order synchronization settings, you have the option to select the level at which discounts that have been
applied to an online sales order will be displayed in the order aer it is imported to Acumatica ERP from the
BigCommerce store. On the Order Settings tab of the BigCommerce Stores (BC201000) 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 BigCommerce store and importing an order with the discounts, see
Import of Orders with Discounts: Process Activity.

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 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.

Step 1: Updating Discount-Related Settings


To review the settings specified in Acumatica ERP for the import of online orders with discounts, 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 Order Settings tab (Order section), in the Show Discounts As box, select Document Discounts.
With this option selected, the system aggregates discounts applied to particular lines of the order in the
BigCommerce store and displays these discounts at the document level.
If the Line Discounts option were selected, the system would show all discounts in the imported orders on
the Details tab split between order lines.
Integration with BigCommerce | 149

4. On the form toolbar, click Save.

Step 2: Defining the First Discount


In the BigCommerce store, you can define automatic discounts that will be applied to the order when certain
conditions are met. In this step, you will define the first discount, a "buy one, get one free" discount that will be
applied to the Banana jam 96 oz product.
In the control panel of the BigCommerce store, do the following:
1. In the le pane, click Marketing > Promotions.
The Promotions page opens.
2. In the upper right of the Automatic tab, click Create > With advanced editor.
The Create Promotion page opens.
3. In the Name your promotion box (Summary section), type Buy one, get one free (Banana jam
96 oz).
4. Under Schedule, make sure that the date and time inserted by default are earlier than the current date and
time. The discount should be effective when you create an order with this item later in this activity.
5. In the Rules section, click Add rule.
6. In the Choose a template for your discount dialog box, select Buy one, get one free and click Apply
template.
7. On the Create Promotion > Rules page, define the promotion rule as follows:
• If the customer: Buys Products
• Reaching a: Quantity 1 products
• Including products: Individual Products Banana jam 96 oz
• Then reward: A gi in their cart Once per cart
• Include: 1 Banana jam 96 oz in the customer's cart for free.
8. In the lower right, click Add rule to promotion to save the rule and return to the Create Promotion page.
9. In the lower right, click Create promotion.

Step 3: Define a Second Discount


To define a 10% discount that will be applied to the price of the Plum jam 96 oz product, do the following:
1. While you are viewing the Promotions page (Automatic tab), click Create > With advanced editor.
The Create Promotion page opens.
2. In the Name your promotion box (Summary section), type 10% off Plum jam 96 oz.
3. Under Schedule, make sure that the date and time inserted by default are earlier than the current date and
time. The discount should be effective when you create an order with this item later in this activity.
4. In the Rules section, click Add rule.
5. In the Choose a template for your discount dialog box, select Custom and click Apply template.
6. On the Create Promotion > Rules page, define the promotion rule as follows:
• If the customer: No conditions
• Then reward: Discount on products Unlimited times
• By a: Percentage 10% from Each product's price
• Applied on: All products
• Including products already on sale: Cleared
Integration with BigCommerce | 150

• Including products: Individual Products Plum jam 96 oz


7. In the lower right, click Add rule to promotion to save the rule and return to the Create Promotion page.
8. In the lower right, click Create promotion.

Step 4: Defining a Third Discount


To define a discount that will be applied to all orders that exceed the $100 threshold, do the following:
1. While you are viewing the Promotions page (Automatic tab), click Create > With advanced editor.
The Create Promotion page opens.
2. In the Name your promotion box (Summary section), type 5% discount on orders of $100 or
more.
3. Under Schedule, make sure that the date and time inserted by default are earlier than the current date and
time. The discount should be effective when you create an order with this item later in this activity.
4. In the Rules section, click Add rule.
5. In the Choose a template for your discount dialog box, select Discount order subtotal and click Apply
template.
6. On the Create Promotion > Rules page, define the promotion rule as follows:
• If the customer: Reaches an order sub-total
• Spending at least: 100 on the order
• Then reward: Discount on order sub-total Once per cart
• Discounting by a: Percentage 5 from the order sub-total
7. In the lower right, click Add rule to promotion to save the rule and return to the Create Promotion page.
8. In the lower right, click Create promotion.

Step 5: Creating a Sales Order


To create an order for the Banana jam 96 oz and Plum jam 96 oz products (to which the first and second discounts
apply), do the following:
1. In the le pane of the control panel of the BigCommerce store, click Orders > Add.
2. On the Add an Order > Customer Info page, complete the order as follows:
a. In the Customer Information section, select the Existing Customer option button right of Order for.
b. In the Search box, start typing the customer's name, Isabelle, and select Isabelle Bober in the list of
search results.
c. In the Billing Information section, click Use this address right of the address details for William Duncan.
The billing address elements are filled with the settings from the previously saved address of this
customer.
d. Clear the Save to customer's address book check box.
e. In the lower right, click Next.
3. On the Add an Order > Items page, under Add Products, do the following:
a. In the Search box, start typing plum, and in the list of search results, select Plum jam 96 oz.
b. In the only row for Plum jam 96 oz, in the Qty. column, make sure 1 is specified.
Notice that in the Item Price column, the price of the product is $45.15, which is the default price, but the
Item Total is $40.63, which is the price aer the first product discount has been applied.
Integration with BigCommerce | 151

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 aer 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.

Step 6: Importing the Sales Order


To import the sales order, in Acumatica ERP, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Prepare Mode: Incremental
3. In the table, in the row of the Sales Order entity, select the Selected check box.
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.
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 you created in this activity.
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.

Step 7: Reviewing the Discounts in the Imported Sales Order


To review how the discounts are displayed in the imported sales order, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Entity: Sales Order
Integration with BigCommerce | 152

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).

Figure: Discounts exported from the store

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 aer 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.

Step 8 (Optional): Deactivating the Discounts


To deactivate the discounts that you have set up in this activity, while you are signed in to the control panel of the
BigCommerce store, do the following:
1. In the le pane, click Marketing > Promotions.
2. On the Automatic tab, switch off the toggle in the Active? column for each of the discounts.

Importing Orders with Freight Charges

The topics of this chapter provide information about the representation of freight charges in sales orders imported
to Acumatica ERP from the BigCommerce store.

Importing an Order with Freight Charges: General Information

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.

Freight Charges in Imported Orders


When you set up your BigCommerce store, one of the things you do is configuring shipping. This includes specifying
the address of the shipping origin and the geographical areas to which you plan to ship products (the shipping
zones), as well as configuring the shipping options available to customers (the shipping methods). For each
shipping zone, you can also specify a fee for handling orders. The shipping options and their accompanying costs
are displayed to the customer in the cart and at checkout. The sales order includes the total of the shipping fees
corresponding to the shipping method selected by the customer and the handling fees, if any have been configured
for the customer's shipping zone. For more information about the configuration of shipping in the BigCommerce
store, see Shipping Setup in the BigCommerce documentation.
During the configuration of the synchronization settings of the store on the BigCommerce Stores (BC201000) form
of Acumatica ERP, in the Shipping Zone Mapping section on the Order Settings tab, you map each shipping
method set up in BigCommerce with the ship via code (which represents a particular service method provided by a
carrier and determines the freight cost) and, optionally, and, optionally, with the shipping zone or shipping terms
(or both) configured in Acumatica ERP. For more information about ship via codes and shipping terms in Acumatica
ERP, see Integration with Carriers and Freight Price Calculation.

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.

Importing an Order with Freight Charges: Activity

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

Step 1: Configuring a Shipping Rule in the BigCommerce Store


To configure a shipping rule in the BigCommerce store, do the following:
1. In the le menu of the control panel, click Store Setup > Shipping.
2. On the Shipping Manager page, which opens, in the Checkout Shipping Options section, click Add
shipping zone > Add a custom zone.
3. On the Zone tab of the Add custom zone dialog box, which opens, specify the following settings:
• Name: New York, Manhattan
• Type: Advanced Selection
• Multiple postcodes: Selected
• Country: United States
• Multiple postcodes: 100*, 101*, 102*
These masks cover most of the ZIP codes of Manhattan. For more information about using masks in this
box, see the BigCommerce documentation.
4. On the Handling fee tab, in the Default handling fee section, select the Apply a single handling fee to all
shipping methods in this zone option button.
5. In the Handling Fee Type box, which appears, select Fixed.
6. In the Handling Fee box, which appears, specify 5.00.
7. Click Submit to save your changes and close the dialog box.
8. On the Shipping Manager page, in the Default shipping rules section, click Configure in the row of the
New York, Manhattan shipping zone.
9. On the New York, Manhattan page, which opens, in the Static shipping quotes section, switch on the
toggle to enable the Flat Rate shipping rule.
10.In the Flat Rate Options dialog box, specify the following settings:
• Display name: Flat rate (entered by default)
• Shipping rate: 30.00
• Type: Per Order
11.Click Submit to save your changes and close the dialog box.

Step 2: Updating the Store's Settings in Acumatica ERP


To map the shipping rule you created in Step 1 with the ship via code in Acumatica ERP, do the following:
1. Sign in to the Acumatica ERP instance with the U100 dataset preloaded and the BigCommerce store
configured by using the gibbs username and 123 password.
2. Open the BigCommerce Stores (BC201000) form.
3. To map the shipping rule configured in BigCommerce with the ship via code in Acumatica ERP in the
Shipping Zone Mapping section of the Order Settings tab, click the Ship Via column in the row of the
New York, Manhattan store shipping zone and the Flat Rate store shipping method, and select LOCAL in the
lookup table.
For the purposes of this activity, leave the Shipping Zone and Shipping Terms columns empty.
4. On the form toolbar, click Save.
Integration with BigCommerce | 156

Step 3: Creating a Sales Order


To create a sales order for the GOODFOOD customer in the BigCommerce store, do the following:
1. In the le menu of the control panel of the BigCommerce store, click Orders > Add.
2. On the Add an Order - Customer Info page, complete the order as follows:
a. In the Customer Information section, set Order for to Existing Customer.
b. In the Search box, start typing the customer name, GOODFOOD, and select the GoodFood One Restaurant
customer from the list of search results.
c. In the Transactional Currency section, make sure that US Dollar - USD is selected in the Currency box.
d. In the Billing Information section, click Use this address right of the address boxes to use the existing
customer address as a billing address.
The billing address elements are filled with the settings from the previously saved customer's address.
e. At the bottom of the page, click Next.
3. On the Add an Order - Items page, under Add Products, do the following:
a. In the Search box, start typing Cherry, and from the list of search results, select Cherry jam 96 oz.
b. In the only row for Cherry jam 96 oz, in the Qty column, type 30.
Notice that in the Item Price column, the price of the product is $45.15, which is the default price of the
CHERJAM96 stock item that was imported from Acumatica ERP.
c. At the bottom of the page, click Next.
4. On the Add an Order - Shipping page, in the Shipping Method section, click the Fetch Shipping Quotes
link.
5. In the box with the list of shipping options, select Flat Rate ($35.00).
Note that this amount combines a $30 shipping fee, which corresponds to the flat-rate shipping rule, and a
$5 handling fee, which you configured for the New York, Manhattan shipping zone (to which the customer's
shipping address belongs).
For the purposes of this activity, you can assume that the billing address and shipping address are the same.
6. At the bottom of the page, click Next.
7. On the Add an Order - Finalize page, 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. At the bottom of the page, click Save & Process Payment.
9. On the View Orders page, which opens, notice that the order has been created.

Step 4: Importing the Sales Order


To import the sales order you created in Step 3 to Acumatica ERP, do the following:
1. Sign in to Acumatica ERP by using the gibbs username.
2. Open the Prepare Data (BC501000) form.
3. In the Summary area, specify the following settings:
• Store: The name of your BigCommerce store
• Prepare Mode: Incremental
4. In the table, in the row of the Sales Order entity, select the unlabeled check box.
Integration with BigCommerce | 157

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. On the Process Data (BC501500) form, on the form toolbar, click Process All to process all out-of-sync
synchronization records.
8. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.

Step 5: Reviewing the Imported Sales Order


To review how the freight charges are displayed in the imported sales order, do the following:
1. Open the Sales Orders (SO3010PL) form.
2. In the list of orders, click the order number link of the sales order for the GOODFOOD customer that you
created in Step 3 and imported in Step 4.
3. On the Sales Orders (SO301000) form, on the Totals tab, review the freight details in the Freight Info
section.
Notice that the $35.00 amount is displayed in the Freight Price box. During the import of the sales order,
the system combined the $30 shipping fee and the $5 handling fee.

Importing Non-Card Refunds

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.

Importing Non-Card Refunds: General Information

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.

Configuration of the Import of Refunds


To configure the import of refunds from a BigCommerce store to Acumatica ERP, you perform the following general
steps:
1. Define a return order type.
On the Order Types (SO201000) form, you define an order type to be used for return orders created during
the import of refunds from the BigCommerce store to Acumatica ERP. A return order type should be created
with the following settings selected on the Template tab:
• Automation Behavior: RMA Order
• Default Operation: Receipt
• AR Document Type: Credit Memo
2. Define an item to represent imported refund amounts.
On the Non-Stock Items (IN202000) form, you define a non-stock item that will represent imported refund
amounts in sales orders and in return orders. For this non-stock item, you should specify the following
settings on the General tab:
• Tax Category: A tax category corresponding to tax-exempt items
• Require Receipt: Cleared
• Require Shipment: Cleared
3. Define a reason code.
On the Reason Codes (CS211000) form, you create a define a reason code to be inserted in return orders for
refunds imported from the BigCommerce store. This reason code must be of the Issue usage type.
4. Activate the Refund entity.
On the Entity Settings tab of the BigCommerce Stores (BC201000) form, you activate the Refund entity for
the BigCommerce store.
5. Specify the refund import settings.
On the Order Settings tab, you specify the identifiers of the entities you have created (in Steps 1 through 3)
in the following boxes:
• Return Order Type
• Refund Amount Item
• Refund Reason Code
6. Specify the payment methods for which you need to import refunds.
On the Payment Settings tab of the BigCommerce Stores form, you select the Process Refunds check box
for each payment method for which you want to import refunds.

Import of Refunds for Non-Card Payment Methods


Refunds are imported from the BigCommerce store to Acumatica ERP as part of the synchronization of the
Refund entity, which can be synchronized only in the Import direction. During the preparation of refund data for
synchronization, the system creates one synchronization record for all refunds that have been issued for a single
sales order in the BigCommerce store.
For a refund to be imported successfully, all of the following conditions must be met for the sales order associated
with the refund:
• The original sales order has been synchronized.
Integration with BigCommerce | 159

• 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.

Importing Non-Card Refunds: Implementation Activity

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

Step 1: Activating the Refund Entity


Before you start importing refunds from the BigCommerce store to Acumatica ERP, you need to activate the Refund
entity as follows:
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, 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's data needs to be synchronized
between Acumatica ERP and the BigCommerce store.
4. On the form toolbar, click Save to save your changes.

Step 2: Reviewing the Refund Import Settings


To review the settings that will be applied to refunds imported from the BigCommerce store, do the following:
1. While you are still viewing the BigCommerce Stores (BC201000) form, go to the Order Settings tab.
2. In the Order section of the Order Settings tab, make sure that the following settings have been specified:
• Return Order Type: ER - eCommerce Return Order
This order type is based on the RC order template.
• Refund Amount Item: REFUNDAMT
This tax-exempt non-stock item is used to represent the refunded amounts in documents.
• Refund Reason Code: EREFUND
This reason code of the Issue usage type is inserted in documents to indicate that the line represents a
refund issued.
3. On the form toolbar, click Save to save your changes.

Step 3: Activating the Import of Refunds for a Non-Card Payment Method


To import refunds for the Manual Payment payment method, which you have configured in Initial Configuration: To
Establish and Configure the Store Connection, do the following:

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

Selected CUSTOM USD ONLINE 10250ST Cleared Selected

Selected CUSTOM USD ONLINE 10250ST Cleared Selected


(CUSTOM)
Integration with BigCommerce | 161

3. On the form toolbar, click Save to save your changes.

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).

Importing Non-Card Refunds: Implementation Checklist

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.

Form Criteria to Check

Enable/Disable Features (CS100000) The following features have been enabled:


• Commerce Integration
• BigCommerce Connector
• Custom Order Types

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

Importing Non-Card Refunds: Order-Level Refunds

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 aer 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.

Importing Non-Card Refunds: Item-Level Refunds

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 aer 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.

Importing Non-Card Refunds: To Process a Refund for a Not-Yet-Shipped Order

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.

Step 1: Creating an Order


To place an order for ten 96-ounce jars of banana jam, do the following:
1. In the le pane of the control panel of the BigCommerce store, click Orders > Add.
2. On the Add an Order page (Customer Info step), create the order as follows:
a. In the Customer Information section, select the Existing Customer option button right of Order for.
b. In the Search box, start typing the customer name, GOODFOOD; select the GoodFood One Restaurant
customer in the list of search results.
c. Near the top of the Billing Information section, click Use this address to use the existing customer
address as the billing address.
Integration with BigCommerce | 168

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.

Step 2: Importing the Sales Order


To import the sales order into Acumatica ERP, do the following:
1. Sign in to Acumatica ERP by using the following credentials:
• Username: gibbs
• Password: 123
2. Open the Prepare Data (BC501000) form.
3. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Prepare Mode: Incremental
4. In the table, in the row with the Sales Order entity, select the Selected check box.
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. In the row with the Sales Order entity, click the link 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 in the Summary area, select the unlabeled check box in the row with the sales order that you
created in the previous step (which you can identify by its order number in the External ID column).
9. On the form toolbar, click Process.
Integration with BigCommerce | 169

10.In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.

Step 3: Reviewing the Imported Sales Order


To review the imported sales order, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Entity: Sales 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 sales order as follows:
a. In the Summary area, notice that the sales order has the Open status. The Description box shows the
status of the order in the BigCommerce store, which is Awaiting Fulfillment.
b. On the Details tab, review the quantity of the BANJAM96 item, which is 10.
c. On the Payments tab, review the details of the prepayment that was imported from the BigCommerce
store along with the sales order. Notice that the Payment Method and Cash Account columns show the
payment method and cash account (ONLINE and 10250ST, respectively) that were defined in Acumatica
ERP and mapped to the Manual Payment store payment method. The prepayment has the Balanced
status. Before you can process and import a refund in the BigCommerce store, you need to release this
prepayment.

Step 4: Releasing the Imported Payment


To release the payment that was imported from the BigCommerce store along with the sales order, do the
following:
1. While you are still viewing the Payments tab of the Sales Orders (SO301000) form, click the link with the
prepayment number in the Reference Nbr. column.
2. On the Payments and Applications (AR302000) form, which opens in a pop-up window with the prepayment
selected, click Release on the form toolbar.
Once the prepayment is successfully released, its status is changed to Open.

Step 5: Issuing a Refund for an Individual Item


To issue a refund for units of an individual item in your BigCommerce store, while you are signed in to the control
panel of the BigCommerce store, do the following:
1. In the le pane, click Orders > View.
2. On the View Orders page, in the row with the order for GoodFood One Restaurant, on the Actions menu,
click Refund.
3. On the Refund order page, which opens, on the Refund individual items tab (Refundable items section),
specify 5 in the Units to refund column in the row with the banana jam.
4. In the bottom right, click Continue.
5. On the Confirm refund page, which opens, in the Refund method section, select the Refund customer
through third party provider option button.
6. In the bottom right, click Confirm Refund.
Integration with BigCommerce | 170

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.

Step 6: Importing the Refund


To import the refund to Acumatica ERP, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Prepare Mode: Incremental
3. In the table, select the Selected check box in the row with the Refund 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. Click the link in the Ready to Process column in the row with the Refund entity.
7. On the Process Data (BC501500) form, which opens with the SweetStore - BC store and the Refund entity
selected in the Summary area, select the unlabeled check box in the row with the refund (which you can
identify by the number of the order it refers to in the External ID column).
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.

Step 7: Reviewing the Results of the Import


To review how the refund has been imported to Acumatica ERP, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Entity: Sales Order
3. On the Processed tab, in the row of the refund that you have just imported (which you can locate by the
external ID of the related order), click the link in the ERP ID column.
On the Sales Orders (SO301000) form, which opens in a pop-up window, review the order as follows:
• On the Details tab, notice that the quantity of the BANJAM96 stock item has been reduced from 10 to 5.
• In the Summary area, notice that the order total has been reduced to reflect the new item quantities. The
Description box now shows the updated status of the order in the BigCommerce store, which is Partially
Refunded.
4. On the Payments tab, click the link of the prepayment number in the Reference Nbr. column.
On the Payments and Applications (AR302000) form, which opens with the prepayment selected, notice that
the applied amount and the available balance reflect the reduced order amount and the refunded amount,
respectively.

Step 8: Reviewing and Releasing the Customer Refund


1. Open the Payments and Applications (AR3020PL) form.
Integration with BigCommerce | 171

2. Filter the list of records as follows:


a. In the list of records, click the header of the Description column.
b. In the list of filter conditions, select Contains.
c. In the text box, type SweetStore.
d. Click OK to apply the filter.
In the list of documents, notice that a new Customer Refund document has been created for the refund you
imported in Step 6. (You can identify it by the order number and transaction type shown in the Description
column).
3. In the Reference Nbr. column, click the link with the identifier of the customer refund.
4. On the form toolbar of the Payments and Applications (AR302000) form, which opens with the customer
refund selected, click Release.
Once the processing of the customer refund is finished, its status changes to Closed.
5. On the Application History tab, which shows the prepayment to which the customer refund was applied, in
the only row, click the link in the Reference Nbr. column.
6. On the Payments and Applications form, which opens with the prepayment selected, notice that the
available balance has become zero.

You have now imported a partial refund for ordered items in an order that has not yet been shipped and processed
this partial refund.

Importing Non-Card Refunds: To Process a Refund for a Shipped Order

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, aer 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 aer 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.

Step 1: Creating a Sales Order in BigCommerce


To place an order for ten 96-ounce jars of plum jam, do the following:
1. In the le pane of the control panel of the BigCommerce store, click Orders > Add.
2. On the Add an Order page (Customer Info step), create the order as follows:
a. In the Customer Information section, select the Existing Customer option button right of Order for.
b. In the Search box, start typing the customer name, west; select the West BBQ Restaurant customer in
the list of search results.
c. Near the top of the Billing Information section, click Use this address to use the existing customer
address as the billing address.
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:
Integration with BigCommerce | 173

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.

Step 2: Importing the Sales Order


To import the sales order you created into Acumatica ERP, do the following:
1. Sign in to Acumatica ERP by using the following credentials:
• Username: gibbs
• Password: 123
2. Open the Prepare Data (BC501000) form.
3. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Prepare Mode: Incremental
4. In the table, in the row with the Sales Order entity, select the unlabeled check box.
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. In the row with the Sales Order entity, click the link 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 in the Summary area, select the unlabeled check box in the row with the sales order that you
created in the previous step.
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.
Integration with BigCommerce | 174

Step 3: Reviewing the Imported Order


To review the imported sales order, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Entity: Sales 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 sales order.
In the Summary area, notice that the sales order has the Open status. The Description box shows the status
of the order in the BigCommerce store, which is Awaiting Fulfillment.
On the Details tab, review the quantity of the PLUMJAM96 item, which is 10.
On the Payments tab, review the details of the prepayment that was imported from the BigCommerce store
along with the sales order. Notice that the Payment Method and Cash Account columns show the payment
method and cash account (ONLINE and 10250ST, respectively) that were defined in Acumatica ERP and
mapped to the Manual Payment store payment method. The prepayment has the Balanced status. Before
you can process and import a refund in the BigCommerce store, you need to release this prepayment.

Step 4: Releasing the Imported Payment


To release the payment that was imported from the BigCommerce store along with the sales order, do the
following:
1. While you are still viewing the Payments tab of the Sales Orders (SO301000) form, click the link with the
prepayment number in the Reference Nbr. column.
2. On the form toolbar of the Payments and Applications (AR302000) form, which opens in a pop-up window
with the prepayment selected, click Release.
Once the processing of the prepayment finishes successfully, its status is changed to Open.
3. Close the pop-up window with the Payments and Applications form to return to the Sales Orders form.

Step 5: Creating a Shipment for the Imported Order


To create a shipment for the order you have imported, do the following:
1. While you are viewing the imported order on the Sales Orders (SO301000) form, click Create Shipment on
the form toolbar.
2. In the Specify Shipment Parameters dialog box, which opens, make sure the current date and the RETAIL
warehouse are selected, and click OK. The system creates a shipment and opens it on the Shipments
(SO302000) form.

Step 6: Confirming the Shipment for the Imported Order


To confirm the shipment for the order, do the following:
1. While you are still viewing the shipment on the Shipments (SO302000) form, review the line on the Details
tab. Make sure of the following:
• The correct order line is included in the shipment.
Integration with BigCommerce | 175

• The RETAIL warehouse is specified for the item.


• The shipped quantity is equal to the ordered quantity.
2. On the form toolbar, click Confirm Shipment.

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.

Step 7: Synchronizing the Shipment with the BigCommerce Store


To synchronize with the BigCommerce store the shipment that you have created and confirmed, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Prepare Mode: Incremental
3. In the table, select the Selected check box for the Shipment 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 with the Shipment 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 Shipment entity
selected in the Summary area, select the unlabeled check box for the shipment that you created and
confirmed (which you can identify by the shipment number in the ERP ID column).
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.

Step 8: Issuing a Refund for an Individual Item


To issue a refund for units of an individual item in your BigCommerce store, do the following:
1. In the le pane of the control panel of the BigCommerce store, click Orders > View.
2. On the View Orders page, in the list of orders, locate the order for the West BBQ Restaurant customer that
you created and imported.
Notice that the status of the order has changed to Shipped.
3. In the row with the same order, on the Actions menu, click Refund.
4. On the Refund order page, which opens, on the Refund individual items tab (Refundable items section),
specify 2 in the Units to refund column in the row with the Plum jam 96 oz item.
5. In the bottom right, click Continue.
6. On the Confirm refund page, which opens, in the Refund method section, select the Refund customer
through third party provider option button.
7. In the bottom right, click Confirm Refund.
8. On the View Orders page, which opens, notice that the number of returned items (which is 2) is now
displayed under the number of ordered plum jam jars, and the order status has changed to Partially
Refunded. The refunded amount is also displayed under Grand Total.
Integration with BigCommerce | 176

Step 9: Issuing a Partial Refund of the Order Amount


To reimburse the customer for having to return part of the purchase in person, do the following:
1. While you are still viewing the order for which you created a refund in the previous step, on the Actions
menu, click Refund.
2. On the Refund order page, on the Apply an order level refund tab (Refundable items section), specify 10
in the Amount to be refunded box.
3. In the bottom right, click Continue.
4. On the Confirm refund page, which opens, in the Refund method section, select the Refund customer
through third party provider option button.
5. In the bottom right, click Confirm Refund.
6. On the View Orders page, which opens, notice that the refunded amount under Grand Total has increased
by $10.

Step 10: Importing the Refunds


To import the refunds into Acumatica ERP, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Prepare Mode: Incremental
3. In the table, select the Selected check box in the row with the Refund 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. Click the link in the Ready to Process in the row with the Refund entity.
7. On the Process Data (BC501500) form, which opens with the SweetStore - BC store and the Refund entity
selected in the Summary area, select the unlabeled check box in the row with the refund that you issued in
the previous step.
8. On the form toolbar, click Process.
You can identify the refund you need by the number of the order it pertains to in the External ID column.
Because the refund has not been synchronized before, it does not have a value in the ERP ID column. Notice
that only one synchronization record was created for both refunds issued in the BigCommerce store for the
same order.
9. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.

Step 11: Reviewing the Return Orders


To review the return orders created in Acumatica ERP as a result of the importing of refunds, do the following:
1. Open the Sales Orders (SO3010PL) form.
2. Filter the list of records as follows:
a. In the list of records, click the header of the Customer.
b. In the list of filter conditions, select Equals.
Integration with BigCommerce | 177

c. In the text box, type WESTBBQ.


d. Click OK to apply the filter.
Notice that two orders of the ER type have been created for the WESTBBQ customer. Because the
original sales order had the Completed status, return orders were created. The return orders have the
ER type because this type was selected in the Return Order Type box on the Order Settings tab of the
BigCommerce Stores (BC201000) form in Importing Non-Card Refunds: Implementation Activity.
3. In the row with the return order for the WESTBBQ customer and an ordered quantity of 2, click the link in the
Order Nbr. column.
4. On the Sales Orders (SO301000) form, which opens with the return order selected, review the order as
follows:
• In the Summary area, notice that the Customer Order Nbr. and Description boxes contain the reference
number of the original order in the BigCommerce store. In the External Reference box, the system has
inserted the identifier of the refund in the BigCommerce store.
• On the Details tab, the system has created a line with the returned item (PLUMJAM96) and the quantity
you specified while creating the refund in the BigCommerce store (which is 2). Notice that in the Reason
Code column of this line, the system has inserted EREFUND, which is the reason code you specified in the
Refund Reason Code box on the Order Settings tab of the BigCommerce Stores form in Importing Non-
Card Refunds: Implementation Activity.
5. On the form toolbar, click Go to Next Record to open the second return order.
On the Details tab of this order, notice that a line has been created for the REFUNDAMT non-stock item with
the order-level refund amount that you specified in the BigCommerce store ($10). The system inserted this
item because it was specified in Refund Amount Item box on the Order Settings tab of the BigCommerce
Stores form in Importing Non-Card Refunds: Implementation Activity.

Step 12: Reviewing the Customer Refunds


To review the customer refunds created for each of the return orders, do the following:
1. Open the Payments and Applications (AR3020PL) form.
2. Filter the list of records as follows:
a. In the list of records, click the header of the Customer.
b. In the list of filter conditions, select Equals.
c. In the text box, type WESTBBQ.
d. Click OK to apply the filter.
Notice that two documents of the Customer Refund type have been created for the WESTBBQ customer, one
for each of the refunds you issued in the BigCommerce store. The Payment Ref. column shows the identifier
of each of these refunds in the BigCommerce store.
3. In the Reference Nbr. column, click the link with the reference number of the customer refund created for
the two returned jars of the plum jam. (Of the two customer refunds for the WESTBBQ customer, the one you
need has a smaller identifier in the Payment Ref. column.)
4. On the Payments and Applications form, which opens with the customer refund selected, review the
document settings in the Summary area.
In the Description box, notice the information about the store name, sales order number, and store
payment method to which the refund was applied. The Available Balance column reflects the amount
refunded in the BigCommerce store. The Payment Method and Cash Account boxes have the same values
as the original prepayment (ONLINE and 10250ST, respectively).
On the Sales Orders tab, notice that the customer refund has been linked to the first return order.
5. On the form toolbar, click Go to Next Record to open the second customer refund.
Integration with BigCommerce | 178

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.

Importing Card Refunds

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.

Importing Card Refunds: General Information

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.

Configuration of Refund Import


To configure the import of refunds from a BigCommerce store to Acumatica ERP, you perform the following general
steps:
1. Define a return order type.
On the Order Types (SO201000) form, you define an order type to be used for return orders imported from
the BigCommerce store to Acumatica ERP. A return order type should be created with the following settings
selected on the Template tab:
• Automation Behavior: RMA Order
• Default Operation: Receipt
• AR Document Type: Credit Memo
Integration with BigCommerce | 179

2. Define a refund amount item.


On the Non-Stock Items (IN202000) form, you define a non-stock item that will represent imported refund
amounts in sales orders and in return orders. This non-stock item should be defined with the following
settings on the General tab:
• Tax Category: A category corresponding to tax-exempt items
• Require Receipt: Cleared
• Require Shipment: Cleared
3. Define a reason code.
On the Reason Codes (CS211000) form, you create a define a reason code to be inserted in return orders for
refunds imported from the BigCommerce store. This reason code must be of the Issue usage type.
4. Activate the Refund entity.
On the Entity Settings tab of the BigCommerce Stores (BC201000) form, you activate the Refund entity for
the BigCommerce store.
5. Specify the refund import settings.
On the Order Settings tab, you specify settings in the following boxes:
• Return Order Type
• Refund Amount Item
• Refund Reason Code
6. Specify payment methods for which you need to import refunds.
On the Payment Settings tab of the BigCommerce Stores form, you select the Process Refunds check
box for each payment method for which you want to import refunds. For store payment methods that
are mapped to card-based payment methods in Acumatica ERP, this check box is selected by default and
cannot be edited.

Import of Refunds for Card-Based Payment Methods


Refunds are imported from the BigCommerce store to Acumatica ERP as part of the synchronization of the
Refund entity, which can be synchronized only in the Import direction. During the preparation of refund data for
synchronization, the system creates one synchronization record for all refunds that have been issued for a single
sales order in the BigCommerce store.
For a refund to be imported successfully, all of the following conditions must be met:
• The original sales order has been synchronized.
• 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 original payment 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 Card Refunds: To Process a Refund for a Not-Yet-Shipped
Order and Importing Card Refunds: To Import a Refund for a Shipped Order.

Importing Card Refunds: Implementation Activity

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

Step 1: Activating the Refund Entity


Before you start importing refunds from the BigCommerce store to Acumatica ERP, you need to activate the Refund
entity as follows:
1. Open the BigCommerce Stores (BC201000) form.
Integration with BigCommerce | 181

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 2: Reviewing the Refund Import Settings


To review the settings that will be applied to refunds imported from the BigCommerce store, do the following:
1. While you are still viewing the BigCommerce Stores (BC201000) form, go to the Order Settings tab.
2. In the Order section of the Order Settings tab, make sure that the following settings have been specified:
• Return Order Type: ER - eCommerce Return Order
This order type is based on the RC order template.
• Refund Amount Item: REFUNDAMT
This tax-exempt non-stock item is used to represent refunded amounts in documents.
• Refund Reason Code: EREFUND
This reason code of the Issue usage type is inserted in documents to indicate that the line represents a
refund issued.
3. 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

Selected AU- USD ALLCARDS 10250ST AUTHNET- Cleared Selected


THORIZENET COM
(BIG-
PAY_TO-
KEN)

Selected AU- USD ALLCARDS 10250ST AUTHNET- Cleared Selected


THORIZE.NET COM
(CREDIT_CARD)

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.

Importing Card Refunds: Implementation Checklist

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.

Form Criteria to Check

Enable/Disable Features (CS100000) The following features have been enabled:


• Commerce Integration
• BigCommerce Connector
• Custom Order Types

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.

Importing Card Refunds: Order-Level Refunds

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 aer 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.

Importing Card Refunds: Item-Level Refunds

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
aer 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.

Importing Card Refunds: To Process a Refund for a Not-Yet-Shipped Order

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 aer 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 aer 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.

Step 1: Creating an Order


To place an order for ten 96-ounce jars of kiwi jam through the storefront, do the following:
1. In the le pane of the control panel, click View Store.
2. On the storefront, in the list of product categories, click Jams.
3. On the page of products of the Jams category, click the tile of the Kiwi jam 96 oz product.
4. On the page for the Kiwi jam 96 oz. product, which opens, specify a quantity of 10, and click Add to Cart.
5. In the pop-up window that opens, click Proceed to checkout.
6. On the checkout page, specify the needed settings as follows:
a. In the Customer section, in the Email Address box, specify melody@example.com, and click Continue as
guest.
b. In the Shipping 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
• My billing address is the same as my shipping address: Selected
c. In the Shipping Method section, make sure that the Free Shipping option is selected, and click Continue.
7. In the Payment section, select the Authorize.Net option button, and specify the following card settings:
• Credit Card Number: 4111 1111 1111 1111
• Expiration: 12/23
• Name on Card: Melody Keys
8. Click Place Order to place your order.
Your order has been created, and on the confirmation page, the order number is displayed. You will process
the order with this order number further in this activity.
For the purposes of this activity, you can skip creating a store account.

Step 2: Capturing the Payment in the Control Panel


To capture the payment for the sales order that you placed in the previous step, do the following:
Integration with BigCommerce | 190

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.

Step 3: Importing the Sales Order


To import the sales order into Acumatica ERP, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Store box of the Summary area, select SweetStore - BC.
3. In the Prepare Mode box, select Incremental.
4. In the table, in the row with the Sales Order entity, select the unlabeled check box.
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. In the row with 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 store and the Sales Order entity selected in
the Summary area, select the unlabeled check box in the row with the sales order that you created in this
activity (which you can identify by the order 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.

Step 4: Reviewing the Imported Sales Order


To review the settings of the imported sales order, do the following:
1. Open the Sales Orders (SO3010PL) form.
2. In the list of orders, click the link of the order number of the last sales order of the EO type for eCommerce
Guest Customer.
3. On the Sales Orders (SO301000) form, which opens, review the settings of the sales order.
In the Summary area, notice that the sales order has the Open status. The Description box shows the status
of the order in the BigCommerce store, which is Awaiting Fulfillment.
On the Details tab, review the quantity of the KIWIJAM96 item, which is 10.

Step 5: Reviewing and Releasing the Payment


To review and release the payment imported with the sales order from the BigCommerce store, do the following:
Integration with BigCommerce | 191

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.

Step 6: Issuing a Refund for an Individual Item


To create a refund for three jars of kiwi jam in your BigCommerce store, do the following:
1. While you are still signed in to the BigCommerce store, in the le pane, click Orders > View.
2. On the View Orders page, in the row with the order that you created in Step 1, in the Actions menu, click
Refund.
3. On the Refund order page, which opens, on the Refund individual items tab (Refundable items section),
in the only row, specify 3 in the Units to refund column.
4. On the Confirm refund page, which opens, in the Refund method section, select the Authorize.Net option
button.
5. In the bottom right, click Confirm Refund.
6. On the View Orders page, which opens with the partially refunded order expanded, notice that the number
of refunded items (which is 3) is now displayed under the number of ordered items. The refunded amount is
also displayed under Grand Total.

Step 7: Importing the Refund


To import the refund to Acumatica ERP, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Store box, select SweetStore - BC.
3. In the Prepare Mode box, select Incremental.
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 - BC 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.
Integration with BigCommerce | 192

10.In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.

Step 8: Reviewing the Results of the Import


To review how the refund has been imported to Acumatica ERP, do the following:
1. On the Sales Orders (SO301000) form, open the sales order that you created and imported earlier in this
activity.
On the Details tab, notice that the quantity of the KIWIJAM96 stock item has been reduced from 10 to 7.
In the Summary area, the order total has been reduced to reflect the new item quantity. The Description
box now shows the updated status of the order in the BigCommerce store, which is Partially Refunded.
2. On the Payments tab, click the prepayment number link in the Reference Nbr. column.
3. On the Payments and Applications (AR302000) form, which opens with the prepayment selected, notice that
the applied amount and the available balance reflect the reduced order amount and the refunded amount,
respectively.

Step 9: Reviewing and Releasing the Customer Refund


1. Open the Payments and Applications (AR3020PL) form.
In the list of documents, notice that a new Customer Refund document has been created for the refund you
imported in Step 7. (You can identify it by the order number and transaction type shown in the Description
column).
2. Click the link with the identifier of the customer refund in the Reference Nbr. column.
On the Payments and Applications (AR302000) form, which opens with the customer refund selected, review
the details of the customer refund. In the Description box of the Summary area, notice the information
about the store name, sales order number, and store payment method to which the refund was applied.
The Payment Method and Cash Account boxes contain the same settings that were used in the original
prepayment. The Orig. Transaction box shows the identifier of the card transaction of the original
prepayment.
On the Card Processing tab, notice that the transaction type of the card transaction (shown in the Tran.
Type box) is Refund, and the Proc. Center Response Reason column shows Imported External Transaction,
which indicates that the refund was imported from an external e-commerce system rather than issued in
Acumatica ERP.
3. On the form toolbar, click Remove Hold, and then click Release.
Once the processing of the customer refund is finished, its status changes to Closed, and on the Application
History tab, the system now shows the original prepayment to which the customer refund was applied.
4. On the Application History tab, in the only row, click the link in the Reference Nbr. column.
5. On the Payments and Applications form, which opens in a pop-up window with the original prepayment
selected, notice that the available balance has become zero.

You have now imported to Acumatica ERP a partial refund for the ordered items for the order that has not yet been
shipped.

Importing Card Refunds: To Import a Refund for a Shipped Order

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 aer 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 aer 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, aer 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 aer 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.

Step 1: Creating an Order


To place an order for ten 96-ounce jars of pear jam through the storefront, do the following:
1. In the le pane of the control panel, click View Store.
2. On the storefront, in the list of product categories, click Jams.
3. On the page of products of the Jams category, click the tile of the Pear jam 96 oz product.
4. On the page for the Pear jam 96 oz. product, which opens, specify a quantity of 10, and click Add to Cart.
5. In the pop-up window that opens, click Proceed to checkout.
6. On the checkout page, specify the needed settings as follows:
a. In the Customer section, in the Email Address box, specify melody@example.com, and click Continue as
guest.
b. In the Shipping 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
• My billing address is the same as my shipping address: Selected
c. In the Shipping Method section, make sure that the Free Shipping option is selected, and click Continue.
7. In the Payment section, select the Authorize.Net option button, and specify the following card settings:
• Credit Card Number: 4111 1111 1111 1111
• Expiration: 12/23
• Name on Card: Melody Keys
8. Click Place Order to place your order.
Your order has been created, and on the confirmation page, the order number is displayed. You will process
the order with this order number further in this activity.
For the purposes of this activity, you can skip creating a store account.
Integration with BigCommerce | 195

Step 2: Capturing the Payment in the Control Panel


To capture the payment for the sales order that you placed in the previous step, do the following:
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.

Step 3: Importing the Sales Order


To import the sales order to Acumatica ERP, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Store box of the Summary area, select SweetStore - BC.
3. In the Prepare Mode box, select Incremental.
4. In the table, select the unlabeled check box in the row of the Sales Order 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. 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 store and the Sales Order entity selected, select
the unlabeled check box in the row of the order you created in Step 1 (which you can identify by the order
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.

Step 4: Reviewing the Imported Order


To review the settings of the imported sales order, do the following:
1. Open the Sales Orders (SO3010PL) form.
2. In the list of orders, click the order number link of the last sales order of the EO type for eCommerce Guest
Customer, which is the order you imported in the previous step.
3. On the Sales Orders (SO301000) form, which opens, review the settings of the sales order.
In the Summary area, notice that the sales order has the Open status. The Description box shows the status
of the order in the BigCommerce store, which is Awaiting Fulfillment.
On the Details tab, review the quantity of the PEARJAM96 item, which is 10.
Integration with BigCommerce | 196

Step 5: Reviewing and Releasing the Payment


To review and release the payment imported with the sales order from the BigCommerce store, do the following:
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 changes to Open.

Step 6: Creating a Shipment for the Imported Order


To create a shipment for the order, do the following:
1. While you are viewing the imported order on the Sales Orders (SO301000) form, click Create Shipment on
the form toolbar.
2. In the Specify Shipment Parameters dialog box, which opens, make sure the current date and the RETAIL
warehouse are selected, and click OK. The system creates a shipment and opens it on the Shipments
(SO302000) form.

Step 7: Confirming the Shipment for the Imported Order


To confirm the shipment for the order, do the following:
1. While you are still viewing the shipment on the Shipments (SO302000) form, review the line on the Details
tab. Make sure of the following:
• The correct order lines are included in the shipment.
• The RETAIL warehouse is specified for the items.
• The shipped quantities are equal to the ordered quantities.
2. On the form toolbar, click Confirm Shipment.

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.

Step 8: Synchronizing the Shipment with the BigCommerce Store


To synchronize with the BigCommerce store the shipment that you created and confirmed in Steps 6 and 7, do the
following:
1. On the Prepare Data (BC501000) form, in the Summary area, select the following settings:
Integration with BigCommerce | 197

• 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.

Step 9: Issuing a Refund for an Individual Item


To issue a refund for an individual item in your BigCommerce store, do the following:
1. In the le pane of the control panel of the BigCommerce store, click Orders > View.
2. On the View Orders page, in the list of orders, locate the order for Melody Keys that you created and
imported in the previous steps.
Notice that the status of the order has changed to Shipped.
3. In the row of the order, in the Actions menu, click Refund.
4. On the Refund order page, which opens, on the Refund individual items tab of the Refundable items
section, specify 2 in the Units to refund column in the row of the Pear jam 96 oz item.
5. In the bottom right, click Continue.
6. On the Confirm refund page, which opens, in the Refund method section, select the Authorize.Net option
button.
7. In the bottom right, click Confirm Refund.
8. On the View Orders page, which opens, notice that the number of returned items (which is 2) is now
displayed under the number of ordered pear jam jars and the order status has changed to Partially
Refunded. The refunded amount is also displayed under Grand Total.

Step 10: Issuing a Partial Refund of the Order Amount


To reimburse the customer for having to return part of the purchase in person, do the following:
1. While you are still viewing the order for which you created a return in the previous step, in the Actions
menu, click Refund.
2. On the Refund order page, on the Apply an order level refund tab (Refundable items section), in the
Amount to be refunded box, specify 10.
3. In the bottom right, click Continue.
4. On the Confirm refund page, which opens, in the Refund method section, select the Authorize.Net option
button.
5. In the bottom right, click Confirm Refund.
6. On the View Orders page, which opens, click the plus in the row of the order to expand the order details.
Integration with BigCommerce | 198

Notice that the refunded amount under Grand Total has increased by $10.

Step 11: Importing the Refunds


To import the refunds to Acumatica ERP, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Store box, select SweetStore - BC.
3. In the Prepare Mode box, select Incremental.
4. In the table, select the unlabeled check box in the row of 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 in the row of the Refund entity.
8. On the Process Data (BC501500) form, which opens with the SweetStore - BC store and the Refund entity
selected in the Summary area, select the unlabeled check box in the row of the refund that you issued in the
previous step.
9. On the form toolbar, click Process.
You can identify the refund you need by the number of the order it pertains to in the External ID column.
Because the refund has not been synchronized before, it does not have a value in the ERP ID column. Notice
that only one synchronization record was created for both refunds issued in the BigCommerce store for the
same order.
10.In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.

Step 12: Reviewing the Return Orders


To review the return orders created in Acumatica ERP as a result of the refund import, do the following:
1. Open the Sales Orders (SO3010PL) form.
Notice that two orders of the ER type have been created for Melody Keys. Because the original sales order
had the Completed status, return orders were created. The return orders have the ER type because this
type was selected in the Return Order Type box on the Order Settings tab of the BigCommerce Stores
(BC201000) form in Importing Card Refunds: Implementation Activity.
2. In the row of the return order for Melody Keys with the ordered quantity of 2 (which you can identify by the
Ordered Qty. column), 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 BigCommerce store. In the External Reference box, the system inserted
the identifier of the refund in the BigCommerce store.
On the Details tab, the system created a line with the returned item (PEARJAM96) with the quantity you
specified while creating the refund in the BigCommerce store (which is 2). Notice that in the Reason Code
column of this line, the system inserted EREFUND, which is the reason code you specified in the Refund
Reason Code box on the Order Settings tab of the BigCommerce Stores form in Importing Card Refunds:
Implementation Activity.
3. On the form toolbar, click Go to Next Record to open the second return order.
On the Details tab, notice that a line has been created for the REFUNDAMT non-stock item with the order-
level refund amount that you specified in the BigCommerce store ($10). The system inserted this item
Integration with BigCommerce | 199

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.

Step 13: Reviewing the Customer Refunds


To review the customer refunds created for each of the return orders, do the following:
1. Open the Payments and Applications (AR3020PL) form.
Notice that two documents of the Customer Refund type have been created for Melody Keys, one for each
of the two refunds you issued in the BigCommerce store. The Payment Ref. column shows the identifier of
each of these refunds in the BigCommerce store.
2. In the Reference Nbr. column, click the link with the reference number of the customer refund created for
the two returned jars of the pear jam. Of the two customer refunds for Melody Keys, the one you need has a
smaller identifier in the Payment Ref. column.
3. On the Payments and Applications (AR302000) form, which opens with the customer refund selected, review
the document details.
In the Description box, notice the information about the store name, sales order number, and store
payment method to which the refund was applied. In the Summary area, notice that the Payment Method
and Cash Account boxes contain the same settings that were used in the original prepayment. The Orig.
Transaction box shows the identifier of the card transaction of the original prepayment.
On the Sales Orders tab, notice that the customer refund has been linked to the return order.
On the Card Processing tab, notice that the transaction type of the card transaction (shown in the Tran.
Type box) is Refund, and the Proc. Center Response Reason column shows Imported External Transaction,
which indicates that the refund was imported from an external e-commerce system rather than issued in
Acumatica ERP.
4. On the form toolbar, click Remove Hold, and then click Release.
Once the processing of the customer refund is finished, its status changes to Closed, and on the Application
History tab, the system now shows the original prepayment to which the customer refund was applied.
5. In the Reference Nbr. box of the Summary area, select the second customer refund created for Melody
Keys. Notice that it has the same settings as the first customer refund, except for the identifier of the refund
transaction (which is shown in the Payment Ref. box), refund identifier (shown in the Description box), and
the available balance (which reflects an order-level refund of $10 issued in the BigCommerce store).
6. On the form toolbar, click Remove Hold, and then click Release.
Once the processing of the customer refund is finished, its status changes to Closed, and on the Application
History tab, the system now shows the original prepayment to which the customer refund was applied.
7. On the Application History tab, in the only row, click the link in the Reference Nbr. column.
8. 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 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.

Selling and Accepting Gi Certificates

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

Gi Certificates: General Information

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.

Selling Gi Certificates


In order to be able to sell gi certificates to customers and then import sales orders containing the gi cards from
the BigCommerce store to Acumatica ERP, you perform the following general steps:
1. In the control panel of the BigCommerce store, you enable the gi certificate functionality and define gi
certificates that will be available to shoppers online.
2. In Acumatica ERP, define a non-stock item that will be used to represent a gi certificate in imported sales
orders.
3. On the Order Settings tab of the BigCommerce Stores (BC201000) form, in the Gi Certificate Item box,
you specify the non-stock item that will represent sold gi certificates in imported sales orders.

Accepting Gi Certificates as Payment


To be able to import orders that are paid, fully or in part, by gi certificates from the BigCommerce store to
Acumatica ERP, you need to map the store payment method representing a gi card to a payment method defined
in Acumatica ERP on the Payment Settings tab of the BigCommerce Stores (BC201000) form.
When a sales order that has been fully or partially paid by a gi certificate is imported to Acumatica ERP, a
document of the Prepayment type is created on the Payments and Applications (AR302000) form for the gi
certificate payment. The Description of the prepayment contains the identifier of the gi certificate in the
BigCommerce store.
For step-by-step instructions for implementing gi certificates, see Gift Certificates: Process Activity.

Gi Certificates: Process Activity

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.

The following activity is based on the U100 dataset.


Integration with BigCommerce | 201

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 (aer 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

Step 1: Configuring the Store Settings


To specify the gi certificate settings in Acumatica ERP, perform the following instructions:
1. Open the BigCommerce Stores (BC201000) form.
2. In the Store Name box of the Summary area, select SweetStore - BC
3. On the Order Settings tab (Order section), in the Gi Certificate Item box, select GIFTCERT.
All purchases of gi certificates in the online store will be recorded in Acumatica ERP as purchases of this
item.
4. In the table of the Payment Settings tab, in the row of the GIFTCERTIFICATE (GIFT_CERTIFICATE) store
payment method, specify the following settings:
• Active: Selected
• ERP Payment Method: GIFTCARDS
• Cash Account: 10250ST
5. On the form toolbar, click Save.

Step 2: Configuring Gi Certificates in the Store


To enable the gi certificate functionality, in the BigCommerce store, do the following:
1. In the le pane of the control panel, click Marketing > Gi Certificates.
2. On the Gi Certificates page (Gi Certificate Settings section), in the Select a currency box, make sure US
Dollar -USD is selected.
3. Right of Enable Gi Certificates?, select the Yes, enable the gi certificate system check box.
4. Right of Gi Certificate Values, make sure the Specify a list of allowed gi certificate amounts option
button is selected. In the box that is located under the option button, specify the following values (each
value in a separate row of the box):
• 10.00
• 25.00
5. In the lower right, click Save to save your changes.
The system adds the dollar sign ($) in front of the gi certificate amounts.

Step 3: Purchasing a Gi Certificate


To create an order in which you purchase a $25 gi certificate in the BigCommerce store, do the following:
1. In the le pane of the control panel, click View Store to open the storefront.
2. On the storefront, at the upper right, click Gi Certificates.
3. On the Gi Certificates page which opens, on the Purchase Gi Certificate tab, specify the following
information:
• Your Name: Your name
• Your Email: Your email address
• Recipient's Name: The name of a test recipient
• Recipient's Email: The recipient's email address
For the purposes of this activity, you can specify the same email address as both your email and
recipient's email address.
Integration with BigCommerce | 203

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.

Step 4: Completing the Order


To capture the payment and complete the order in the BigCommerce store, do the following:
1. Return to the control panel of the BigCommerce store, and in the le pane, click Orders > View.
2. On the View Orders page, which opens, click the plus button next to the order that you have noted earlier to
expand the order details.
The order has the $25.00 value in the Total column, as shown in the screenshot below. The Status of the
order is set to Awaiting Payment. In the Billing section, the Capture Funds link is displayed. This means that
the payment funds have not yet been captured because the Authorize.Net payment option is configured in
the BigCommerce store to only authorize the payment amount when the order is placed.
Integration with BigCommerce | 204

Figure: The BigCommerce order with the gi certificate

3. In the Billing section, click Capture Funds.

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.

4. Refresh the page.


In the order summary line, the order status changes to Completed. An email with the gi certificate code is
sent to the gi certificate recipient's email address (Recipient’s Email) that you specified in the order with
the certificate.

Step 5: Paying for the Order with a Gi Certificate


To create an order and pay for part of it with the gi certificate, in the control panel of the BigCommerce store, do
the following:
1. In the le pane, click View Store to open the storefront.
2. On the storefront, start typing kiwi in the search box.
3. In the search results, click Kiwi jam 96 oz.
4. On the page for the Kiwi jam 96 oz product, which opens, select a quantity of 3, and click Add to Cart.
5. In the pop-up window that opens, click Proceed to checkout.
6. On the checkout page, in the Order Summary section, click Coupon/Gi Certificate.
7. In the box that appears, enter the gi certificate code that was sent to your recipient email address. Then
click Apply.
Notice that the order amount has been decreased by the gi certificate amount ($25).

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.

8. Complete the order settings as follows:


a. In the Customer section, in the Email Address box, specify melody@example.com, and click Continue.
b. In the Shipping section, fill in the shipping address boxes as follows:
• First Name: Melody
• Last Name: Keys
• Address: 3402 Angus Road
• City: New York
Integration with BigCommerce | 205

• Country: United States


• State/Province: New York
• Postal Code: 10003
• My billing address is the same as my shipping address: Selected
c. In the Shipping Method section, make sure that the Free Shipping option is selected, and click Continue.
9. In the Payment Method section, select the Authorize.Net option button, and specify the following card
settings:
• Credit Card Number: 4111 1111 1111 1111
• Expiration: 12/23
• Name on Card: Melody Keys
10.Click Place Order to place your order.
On the confirmation page, notice that the reference number of the created order.

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.

Step 7: Reviewing the Imported Sales Order


To review the settings of the imported sales order, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Entity: Sales 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 in a pop-up window, review the settings of the order (as
shown in the screenshot below).
Integration with BigCommerce | 206

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.

Selling Matrix Items in a BigCommerce Store

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.

Selling Matrix Items: General Information

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 aer the template
item was synchronized with the BigCommerce store, and you need the changes to be reflected in the
product settings in the store.

Configuration of Template Item Synchronization


Before exporting template items defined in Acumatica ERP to the BigCommerce store, you need to perform the
following general steps:
1. Activate the Template Item entity. on the BigCommerce Stores (BC201000) form, you select the store, and on
the Entity Settings tab, you select the Active check box for the Template Item entity.
2. Configure the default visibility and purchasability settings for items exported to the BigCommerce store. For
details, see Product Synchronization: Default Store Settings.
3. Determine which template items and matrix items should be exported and define the visibility and
purchasability settings for individual items.

Synchronization of Template Items


Template items are exported to the BigCommerce store during the synchronization of the Template Item entity.
Matrix items (both stock items and non-stock items) based on a template item are synchronized along with the
template item.
During the export, the system updates the availability and visibility settings of each item exported to BigCommerce
based on the settings specified for the template item on the eCommerce tab of the Template Items (IN203000)
form, for the matrix items on the eCommerce tab of the Stock Items (IN202500) form or on the Non-Stock Items
(IN202000) form and for the store on the Inventory Settings tab of the BigCommerce Stores (BC201000) form.
For details about the information exported to the BigCommerce store during the synchronization of a template
item, see Template Item Entity.

Excluding Items from Synchronization


The template item is exported to the BigCommerce store if it meets the following criteria:
• The template item's status is Active, No Purchases, or No Request.
• The Export to External System check box is selected for this template item on the eCommerce tab of the
Template Items (IN203000) form.
• At least one matrix item based on this template item has the Active, No Purchases, or No Request status and
Export to External System check box selected on the eCommerce tab of the Stock Items (IN202500) form or
of the Non-Stock Items (IN202000) form.
You can exclude a template item from synchronization with the BigCommerce store by clearing the Export to
External System check box on the eCommerce tab of the Template Items form.
If you select this check box for a template item, the system selects it on the eCommerce tab of the Stock Items form
or of the Non-Stock Items form for all matrix items of this template item when these matrix items are generated.
You can clear the Export to External System check box for an individual matrix item to exclude it from the export
to the BigCommerce store. If the matrix item has already been exported to the BigCommerce store, during the next
Integration with BigCommerce | 208

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.

Visibility of an Exported Template Item


You can specify the visibility settings for an individual template item on the eCommerce tab of the Template Items
(IN203000) form. To make the template item visible on the storefront immediately aer it is exported, you select
Visible in the Visibility box of the eCommerce tab. To make it visible on the storefront and include it in the group of
featured products (which are displayed in specific places across the storefront, depending on the theme set up for
the store), you select Featured in this box.
The option selected in the Visibility box for a particular template item takes precedence over the default visibility
setting specified for the store in the Default Visibility box on the Inventory Settings tab of the BigCommerce
Stores (BC201000) form. If Store Default is selected, the store's default visibility settings applies.

Availability Settings of an Exported Template Item


When a template item is exported to a BigCommerce store, it is assigned an availability (purchasability) status in
the Purchasability section of the product management page in the store's control panel. In Acumatica ERP, you
can determine which status is to be assigned to an item exported to BigCommerce by selecting a corresponding
option in the Availability box on the eCommerce tab of the Template Items (IN203000) form:
• 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 settings applies.
For information about tracking quantities of exported template and matrix items, see Selling Matrix Items: Export of
Product Availability Data.

Availability Settings of an Exported Matrix Item


For each matrix item, you can specify availability settings on the on the eCommerce tab of the Non-Stock Items
(IN202000) form (if the matrix item is a non-stock item) or the Stock Items (IN202500) form (if the matrix item is a
stock item).
These settings will be exported to the BigCommerce store during the synchronization of the Template Item entity;
however, the actual availability of the matrix item for purchase on the storefront depends on the purchasability of
the template item itself.
To make a particular matrix item unavailable for purchase even if the template item is available for purchase
or for pre-order, on the eCommerce tab of the Non-Stock Items form or the Stock Items form , you select Set as
Unavailable in the Availability box. When the template item is synchronized with the BigCommerce store, the
Purchasable check box becomes cleared for the matrix item in the Variants table on the product management
Integration with BigCommerce | 209

page of the template item. With any other option selected in the Availability box, the Purchasable check box
becomes selected for the matrix item.

Selling Matrix Items: To Export Matrix Items

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

APL-16OZ-GBT Apple juice in glass bottles of 16 fluid ounces

APL-32OZ-GBT Apple juice in glass bottles of 32 fluid ounces

CHR-32OZ-GBT Cherry juice in glass bottles of 32 fluid ounces

ORG-16OZ-GBT Orange juice in glass bottles of 16 fluid ounces

ORG-32OZ-GBT Orange juice in glass bottles of 32 fluid ounces

PCH-32OZ-GBT Peach juice in glass bottles of 32 fluid ounces

PNL-16OZ-GBT Pineapple juice in glass bottles of 16 fluid ounces

SWB-32OZ-GBT Strawberry juice in glass bottles of 32 fluid ounces

TMT-16OZ-GBT Tomato juice in glass bottles of 16 fluid ounces

• On the Attributes (CS205000) form, the attributes and the attribute values listed in the following table

Attribute Attribute Values

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

Attribute Attribute Values

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.

Step 1: Reviewing the Template Item and the Matrix Items


To review the JUICE template item and the matrix items that have been generated based on it, do the following:
1. Open the Template Items (IN203000) form.
2. In the Template ID box, select JUICE.
3. On the Configuration tab, review the attributes specified for the template item and their settings.
In the Attributes table, notice that the following attributes of the Variant type have been defined (and can
be used for the matrix items of the template item):
Integration with BigCommerce | 211

• 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.

Step 2: Activating the Template Item Entity


You can skip this step, if you activated the Template Item entity while performing the following activity: Initial
Configuration: To Establish and Configure the Store Connection.

To activate the Template Item entity, 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 Entity Settings tab, select the Active check box in the row of the Template Item entity.
4. On the form toolbar, click Save.

Step 3: Updating the Filtering Condition


To configure the Template Item entity to export to the BigCommerce store only template items of the MJUICE item
class, do the following:
1. Open the Entities (BC2020PL) form.
2. In the Store Name box of the Selection area, select SweetStore - BC.
3. In the Entity column, click the Template Item link.
The system opens the Entities (BC202000) form with the SweetStore - BC store and the Template Item entity
selected in the Summary area. Notice that this entity can only be exported to the BigCommerce store (that
is, Sync Direction is set to Export), and that only two tabs, Export Mapping and Export Filtering, are
displayed.
4. To create a filtering condition for template items, on the Export Filtering tab, click Add Row on the table
toolbar, and specify the following settings in the row:
• Active: Selected
• Field Name: Item Class
• Condition: Equals
• Value: MJUICE
5. On the form toolbar, click Save to save your changes.
Now when you prepare and process the Template Item entity, only the template items of the MJUICE item
class will be exported to the BigCommerce store.
Integration with BigCommerce | 212

Step 4: Preparing the Template Item Data for Synchronization


To prepare the template item data (which includes the data of the matrix items generated based on the template
item) for synchronization, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Prepare Mode: Incremental
Incremental indicates that only records that have been modified since the last successful data preparation
will be prepared. However, because you have not prepared the Template Item entity for SweetStore - BC
before, all records will be prepared (as they would be if Full were selected).
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.
Notice that the Ready to Process column shows the number of synchronization records that have been
prepared for the Template Item entity.

Step 5: Processing the Prepared Template Item Data


To process the prepared data of the template item, do the following:
1. While you are still viewing the Prepare Data (BC501000) form with the SweetStore - BC store selected, click
the link in the Ready to Process column in the row of the Template Item entity.
2. On the Process Data (BC501500) form, which opens with the SweetStore - BC 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).
3. On the form toolbar, click Process.
4. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.

Step 6: Viewing the Exported Item


To view the exported Juice template item in the BigCommerce store, do the following:
1. Sign in to the control panel of the BigCommerce store as the store administrator.
2. In the le pane, click Products > View.
3. On the View Products page, which opens, locate the Juice product, and click the link in the Product Name
column.
4. On the product management page of the Juice product, review the exported settings.
In the Product Options section, notice that in the Variant Options section, the option names (which
correspond to the attributes that were configured and added for the template item in Acumatica ERP) and
their values are displayed.
In the Variants table, the variants of the Juice product (which are the matrix items that were generated in
Acumatica ERP) are displayed. The SKU column of the table shows the identifiers of matrix items assigned
by Acumatica ERP.
5. At the top of the page, click View on Storefront.
Integration with BigCommerce | 213

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.

Selling Matrix Items: Export of Product Images

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 aer the template item was synchronized with the BigCommerce store, and you need the changes to be
reflected in the product settings in the store.

Export of Images for Template Items


In Acumatica ERP, you can associate images with template items in two ways:
• As links to external storage: In the Media URLs table on the eCommerce tab of the Template Items
(IN203000) form
• As attachments to an item: On the Configuration tab of the same form
Images specified as links in the Media URLs table on the eCommerce tab are exported along with the template
item (that is, during the synchronization of the Template Item entity). When the template item is exported to the
BigCommerce store, the images are added to the Images & Videos section of the product management page of the
exported template item. For successful synchronization, images must be publicly accessible (that is, access to them
should not require authentication or authorization).
Images that have been attached to a template item on the Template Items form are exported to the BigCommerce
store during the synchronization of the Product Image entity. The items the images belong to must be exported to
the BigCommerce store or created in the BigCommerce store before the images attached to it are exported. The
system exports the files attached to the item only if they have extensions for which the Image check box is selected
on the File Upload Preferences (SM202550) form.

Export of Videos for Template Items


For a template item, you can add links to YouTube videos in the Media URLs table on the eCommerce tab
of the Template Items (IN203000) form. During the synchronization of this template item (that is, during the
synchronization of the Template Item entity), these videos are added to the Images & Videos section of the product
Integration with BigCommerce | 214

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).

Export of Images for Matrix Items


In Acumatica ERP, you can attach images to a matrix item on the Attributes tab of the Stock Items (IN202500) or
Non-Stock Items (IN202000) form (depending on the type of the item).

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.

Selling Matrix Items: To Export Product Images

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.

Step 1: Adding an Image to the Template Item


To add an image to the JUICE template item, do the following:
1. Open the Template Items (IN203000) form.
2. In the Inventory ID box of the Summary area, select Juice.
3. On the Configuration tab, drag the Juice1.png file, which you have downloaded, to the Image area.
The file is uploaded, and you can browse it in the Image area or access it by clicking Files on the form title
bar.
4. On the eCommerce tab, in the Media URLs table, add a row with the settings shown in the following table.

URL Type

https://acumatica-builds.s3.amazonaws.com/builds/Universi- Image
ty/CommerceTraining/Juice3.png

5. On the form toolbar, click Save.


Integration with BigCommerce | 216

Step 2: Adding an Image to the Matrix Item


To add an image to the PCH-32OZ-GBT stock item, which is a matrix item based on the JUICE template item, do the
following:
1. Open the Stock Items (IN202500) form.
2. In the Inventory ID box of the Summary area, select PCH-32OZ-GBT.
3. On the Attributes tab, drag the Juice2.png file, which you downloaded, to the Image area.
The file is uploaded, and you can browse it in the Image area or access it by clicking Files on the form title
bar.
4. On the form toolbar, click Save.

Step 3: Synchronizing the Template Item Data


To prepare and process the template item data (which includes the data of the matrix items generated from the
template item) for synchronization, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Store box, select SweetStore - BC.
3. In the Prepare Mode box, leave Incremental.
Incremental indicates that only the records that have been modified since the last successful data
preparation will be prepared.
4. In the table, select the Selected check box in the row of the Template Item 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. In the row of the Template Item entity, click the link in the Ready to Process column.
8. On the Process Data (BC501500) form, which opens with the SweetStore - BC 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).
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.

Step 4: Reviewing the Synchronized Images


To review the images that have been exported to the BigCommerce store for the Juice template item, do the
following:
1. Sign in to the control panel of the BigCommerce store as the store administrator.
2. In the le menu, click Products > View.
3. On the View Products page, which opens, locate the Juice product, and click the link in the Product Name
column.
On the product management page of the Juice product, which opens, notice that the Images & Videos
section contains only one image; you added this image to the Juice template item as an external link in the
Media URLs table on the eCommerce tab of the Template Items (IN203000) form. Images added to this table
are synchronized as part of the synchronization of the Template Item entity.
Integration with BigCommerce | 217

Step 5: Activating the Product Image Entity


To activate the Product Image entity, 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, select the Active check box in the row of the Product Image entity.
4. On the form toolbar, click Save.

Step 6: Synchronizing the Product Image Data


To prepare and process the product image data (which includes the data of the images attached to template items
and matrix items) for synchronization, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Prepare Mode: Incremental
3. In the table, select the Selected check box in the row of the Product Image 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 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 - BC 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.

Step 7: Reviewing the Exported Images


To review the images that have been exported to the BigCommerce store for the Juice template item and the matrix
item, do the following:
1. While you are signed in to the control panel of the BigCommerce store, in the le menu, click Products >
View.
2. On the View Products page, which opens, locate the Juice product, and click the link in the Product Name
column.
On the product management page of the Juice product, which opens, notice that two more images have
been added. The image you attached to the JUICE template item was added to the Images & Videos
section, and the image you attached to the PCH-32OZ-GBT stock item was added to the Image column of the
Variants table of the Variations section.

Selling Matrix Items: Export of Product Availability Data

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.

Configuration of Product Availability Synchronization


Before you start exporting available quantities of stock items between Acumatica ERP and a BigCommerce store,
you need to perform the following general steps:
1. Activate the Product Availability entity. 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 Product Availability entity.
2. Specify the quantity calculation settings for the store on the Inventory Settings tab of the BigCommerce
Stores form. For details, see Product Availability: Calculation of Available Quantities.
3. Determine the template and matrix items for which available quantities should be exported.

Tracking Available Quantities of Exported Template and Matrix Items


You can track available quantities of template items exported to a BigCommerce store and make them available
for purchase via the storefront only when they are in stock. You can also determine how the system should handle
items that go out of stock.
To make an exported template item available for purchase via the storefront and enable quantity tracking for
it, on the eCommerce tab of the Template Items (IN203000) form, you select Set as Available (Track Qty.) in the
Availability box.
When the item is synchronized, in BigCommerce, on the product management page for the item, the system
applies the following settings:
• 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 variant level option button is also selected because the
quantity of a template item is calculated as the sum of quantities of its variants.
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 the template item if its quantity becomes 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.
Integration with BigCommerce | 219

• 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.

Synchronization of Availability Qualities


The availability settings of a template item in the BigCommerce store are updated as part of the synchronization
of the Template Item entity. During the export, the system updates the availability and visibility settings of each
item exported to BigCommerce based on the settings specified for the template item on the eCommerce tab of the
Template Items (IN203000) form, for the matrix items on the eCommerce tab of the Stock Items (IN202500) form or
on the Non-Stock Items (IN202000) form and for the store on the Inventory Settings tab of the BigCommerce Stores
(BC201000) form.
For template items whose quantities are tracked and have been synchronized with the BigCommerce store, during
the synchronization of the Template Item entity, the system also checks if each of its matrix item is in stock. 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 status according to the When Qty. Unavailable setting specified for the matrix item on
the eCommerce tab of the Stock Items form. If neither of the matrix items is in stock and the template item has
no available quantity, the system updates the template item's purchasability status according to the When Qty.
Unavailable setting specified for the template item on the eCommerce tab of the Stock Items form.

Units of Measure of Available Item Quantities


An item's available quantity is exported to the BigCommerce store in the item's sales unit of measure, which is
defined on the General tab of the Stock Items (IN202500) form. If an item's base UOM is different from its sales
UOM, during the synchronization of the Product Availability entity, the item's available quantity is converted to the
sales UOM before being exported to the BigCommerce store.

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 aer
changing its sales UOM so that new orders for the item are created in the BigCommerce store with the
updated UOM.

Selling Matrix Items: To Export Product Availability Data

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.

Step 1: Updating the Default Availability Settings


To specify the availability settings that the system will apply by default to items exported from Acumatica ERP to
the BigCommerce store, 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 Inventory Settings tab, specify the following settings:
• Default Availability: Set as Available (Don't Track Qty.)
• Availability Mode: Available for Shipping
• Warehouse Mode: Specific Warehouses
• Warehouse: RETAIL
• Location ID: JS3
With these settings, by default, items exported to the BigCommerce store will be available for purchase
through the storefront, and their quantity will not be tracked. For each item, only its quantity available for
shipping in the JS3 location of the RETAIL warehouse is synchronized with the BigCommerce store.
4. On the form toolbar, click Save to save the settings.

Step 2: Updating the Availability Settings of the JUICE Template Item


To specify the availability settings that the system will apply to the JUICE template item when it is exported from
Acumatica ERP to the BigCommerce store, do the following:
1. Open the Template Items (IN203000) form.
2. In the Template ID box of the Summary area, select JUICE.
3. On the eCommerce tab, specify the following settings:
• Availability: Set as Available (Track Qty.)
• When Qty. Unavailable: Set as Unavailable
With these settings specified, when you synchronize the Template Item entity with the BigCommerce
store, the system will override the default settings specified for the store, and the quantities of matrix
items based on the JUICE template item (product variants) will be tracked. If all juice variants are sold
out, the JUICE product can no longer be purchased via the storefront of the BigCommerce store.
4. On the form toolbar, click Save.

Step 3: Updating the Availability Settings of the Matrix Items


Suppose that you do not need the SWB-32OZ-GBT item, which is a matrix item based on the JUICE template item, to
be available for purchase in the store. To make it unavailable for purchase aer it is exported to the BigCommerce
store, do the following:
1. Open the Stock Items (IN202500) form.
Integration with BigCommerce | 222

2. In the Inventory ID box, select SWB-32OZ-GBT.


3. On the eCommerce tab, in the Availability box, select Set as Unavailable.
4. On the form toolbar, click Save.
The Store Default option is specified in this box for all other matrix items based on the JUICE template item;
you will not change this option.

Step 4: Reviewing the Available Quantities of the Matrix Items


To review the available quantities of the matrix items in the RETAIL warehouse, do the following:
1. Open the Storage Details by Item Warehouse Location (IN408055) form.
2. In the Selection area, in the Warehouse box, select RETAIL.
The system displays the quantities of all items stored in the RETAIL warehouse.
3. Click the header of the Location ID column, and in the dialog box that opens, select Equals, type JS3 in the
text box, and click OK.
The system now displays only the items that are stored in the JS3 warehouse location. Notice the quantities
in the Location Available for Shipping column.

Step 5: Synchronizing the Product Availability Data


To synchronize the availability settings and the quantities of the matrix items you reviewed in the previous step, do
the following:
1. Open the Prepare Data (BC501000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Prepare Mode: Full
• Start Date: Cleared
• End Date: Cleared
3. In the table, select the Selected check box in the rows of the Template Item entity and the Product
Availability entity.
Before the quantity of a matrix item and its availability settings can be exported, the template item (and the
matrix items based on this template item) must be synchronized with the BigCommerce 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. 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 - BC 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.
10.In the Entity box of the Summary area, select Product Availability.
11.On the form toolbar, click Process All.
12.In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
Integration with BigCommerce | 223

Step 6: Reviewing the Synchronized Data


To review the synchronized availability data in the BigCommerce store, do the following:
1. Sign in to the control panel of the BigCommerce store as an administrator.
2. In the le pane of the control panel, click Products > View.
3. On the View Products page, which opens, locate the Juice product, and click the link in the Product Name
column.
4. On the product management page of the Juice product, review the exported settings.
In the Inventory section, notice that the Track inventory check box is selected, and below this check box,
the On the variant level option button is selected.
In the Variants table of the Product Options section (Variations subsection), notice that the quantities of
items that you reviewed in Step 4 are now displayed in the Stock column.

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.

Selling Matrix Items: Export of Item Prices

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.

Types of Prices that Can Be Synchronized for Matrix Items


The following types of prices that you keep in Acumatica ERP can be synchronized with the BigCommerce store for
matrix items:
• Default prices: The default price of a particular matrix item is specified on the Stock Items (IN202500) form
(if the matrix item is a stock item) or the Non-Stock Items (IN202000) form (if the matrix item is a non-stock
item) and is exported to the BigCommerce store during the processing of the Template Item entity—that is,
during synchronization of the template item the matrix item is based on.
Integration with BigCommerce | 224

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.

Limitations of Sales Price Synchronization for Matrix Items


The following price types maintained in Acumatica ERP are not exported to the BigCommerce store for matrix
items:
• Customer-specific prices: Prices defined in Acumatica ERP for a particular customer—that is, prices that have
the Customer type on the Sales Prices (AR202000) form—cannot be exported to the BigCommerce store.
• 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 sales prices defined for the sales UOM of the item can be
exported to BigCommerce.
• Warehouse-specific prices: If the Multiple Warehouses feature is enabled on the Enable/Disable Features form,
you can define a sales price that is applied only when products are sold from a particular warehouse. If a
warehouse is specified for a price, the price is not exported to the BigCommerce store.
• Volume-dependent prices: If the Volume Pricing feature is enabled on the Enable/Disable Features form, you
can define sales prices that are applied when a customer purchases a quantity of an item that is greater
than the specified threshold (break quantity). However, prices of matrix items with a nonzero break quantity
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, 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.

Selling Matrix Items: To Export Base 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

APL-16OZ-GBT Apple juice in glass bottles of 16 fluid ounces

APL-32OZ-GBT Apple juice in glass bottles of 32 fluid ounces

CHR-32OZ-GBT Cherry juice in glass bottles of 32 fluid ounces

ORG-16OZ-GBT Orange juice in glass bottles of 16 fluid ounces

ORG-32OZ-GBT Orange juice in glass bottles of 32 fluid ounces

PCH-32OZ-GBT Peach juice in glass bottles of 32 fluid ounces

PNL-16OZ-GBT Pineapple juice in glass bottles of 16 fluid ounces

SWB-32OZ-GBT Strawberry juice in glass bottles of 32 fluid ounces

TMT-16OZ-GBT Tomato juice in glass bottles of 16 fluid ounces

• 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

Step 1: Adding Base Sales Prices for the Matrix Items


To add sales prices of the Base type for the matrix items based on the JUICE template item, do the following:
1. Open the Sales Price Worksheets (AR2020PL) form.
2. In the row of the sale price worksheet with the description Juices, January 2022, click the link in the
Reference Nbr. column.
3. On the Sales Price Worksheets (AR202010) form, which opens, review the details of the worksheet and the
individual price records.
In the table, notice that each sales price has the Base type and a nonzero value in the Pending Price
column.
In the Summary area, notice that Effective Date is set to 1/1/2022 and there is no value in the Expiration
Date column. Only prices that are effective at the time of the synchronization are exported to the
BigCommerce store.
4. On the form toolbar, click Remove Hold and then click Release to release the sales price worksheet.
5. Open the Sales Prices (AR202000) form.
6. In the Item Class ID box of the Summary area, select MJUICE.
Notice that the table displays all sales prices from the sales price worksheet you released in this step.

Step 2: Activating the Needed Entity


To export sales prices of the base type, you need to activate the Base Sales Price entity as follows:
1. Open the BigCommerce Stores (BC201000) form.
2. 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.
3. On the form toolbar, click Save.

Step 3: Synchronizing the Base Sales Prices


To synchronize the base sales prices, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Prepare Mode: Incremental
3. In the table, select the Selected check box for the Base Sales Price 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 Base Sales Price entity, click the link in the Ready to Process column.
Integration with BigCommerce | 227

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.

Step 4: Reviewing the Exported Base Prices


To view the exported prices of the matrix items based on the JUICE template item, do the following:
1. Sign in to the control panel of the BigCommerce store as the store administrator.
2. In the le pane, click Products > View.
3. On the View Products page, which opens, locate the JUICE item in the list of products, and in the row of this
item, click the link in the Product Name column.
4. On the product management page, which opens, in the Variations subsection of the Product Options
section, click Edit Columns right of Variants, and in the menu, select the Sale Price check box.
Notice that the sales prices that you added in Step 1 and synchronized in Step 3 are displayed in the Sale
Price column.

Selling Matrix Items: Import of Orders with Matrix Items

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.

Selling Matrix Items: To Import an Order with Matrix Items

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.

Step 1: Creating an Order


To create an order for 10 bottles of peach juice and 5 bottles of apple juice through the storefront, do the following:
1. In the le pane of the control panel, click View Store.
2. On the storefront, select the Other category in the list at the top of the page.
3. On the page that lists the products in the Other category, click Juice.
4. On the page for Juice, select the following options:
• Ingredients: Peach
• Package: Glass bottle
• Volume: 32 fl oz
• Quantity: 10
5. Click Add to Cart.
6. In the confirmation pop-up window that opens, click Close.
7. On the page for Juice, select the following options:
• Ingredients: Apple
• Package: Glass bottle
Integration with BigCommerce | 229

• 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.

11.Specify the needed settings as follows:


a. In the Customer section, in the Email Address box, specify melody@example.com, and click Continue as
guest.
b. In the Shipping section, specify the following settings, and click Continue:
• First Name: Melody
• Last Name: Keys
• Address: 3402 Angus Road
• City: New York
• Country: United States
• State/Province: New York
• Postal Code: 10003
• My billing address is the same as my shipping address: Selected
12.In the Payment section, select the Authorize.Net payment method, and fill in the card details as follows:
• Credit Card Number: 4111 1111 1111 1111
• Expiration: 12/23
• Name on Card: Melody Keys
13.Click Place Order to place your order.
Your order has been created, and on the confirmation page, the order number is displayed. You will process
the order with this order number further in this activity.

Step 2: Importing the Sales Order


To import the order that you created to Acumatica ERP, do the following:
1. Sign in to Acumatica ERP by using the following credentials:
• Username: gibbs
• Password: 123
2. Open the Prepare Data (BC501000) form.
3. In the Summary area, specify the following settings:
• Store: SweetStore - BC
• Prepare Mode: Incremental
4. In the table, select the Selected check box in the row of the Sales Order 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.
Integration with BigCommerce | 230

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.

Step 3: Reviewing the Imported Sales Order


To review the details of the imported sales order, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area of the form, specify the following settings:
• Store: SweetStore - BC
• Entity: Sales 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 for the imported order, review the order details.
On the Details tab, notice that a separate line was added for each product variant that was sold. The
Inventory ID column contains the identifiers of the matrix items generated for the JUICE template item
(which are PCH-32OZ-GBT and APL-16OZ-GBT) and not the identifier of the JUICE template item itself.

For the purposes of this activity, you do not need to process the sales order.
Integration with Shopify | 231

Integration with Shopify


This part of the guide describes the minimum configuration of the Shopify integration, as well as the
implementation of the e-commerce functionality in Acumatica ERP.

Initial Configuration of a Shopify Store

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.

Initial Configuration: General Information

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.

Each of these steps is described in greater detail below.

Setup of a Shopify Store


Before you can connect Acumatica ERP to a Shopify store, you need to set up the store. For a test implementation,
we recommend that you sign up for a Shopify trial account. For more information, see the Shopify pricing page.
If you are registered in the Shopify Partner Program, you can create a new development store and use it instead.

Preparation of the Acumatica ERP Instance


During the configuration of the connection to the Shopify store, you need to specify certain values coming from the
Acumatica ERP instance, such as the numbering sequence to be used for generating the identifiers of customers
imported from the Shopify store, and the payment methods that will be mapped to the payment methods
configured in the Shopify store. Some of these values can be created on the fly. However, we recommend that the
Acumatica ERP instance be prepared in advance.
For more information, see Initial Configuration: To Prepare the Acumatica ERP Instance.
Integration with Shopify | 232

Establishing of the Connection to the Shopify Store


You can establish a connection between your Shopify store and the Acumatica ERP instance in the following ways:
• By using the public Acumatica Cloud ERP app, which you add to your Shopify store from the Shopify App
Store. For step-by-step instructions of connecting a store with the public app, see Initial Configuration: To
Establish the Store Connection with a Public App.

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.

Initial Configuration of the Store Connection


Aer you have successfully established a connection to the Shopify store, you can perform the basic required
configuration. This step involves the following substeps:
1. Activating the entities that need to be synchronized. On the Entity Settings tab of the Shopify Stores
(BC201010) form, you activate the needed entities—that is, you select the Active check box in the row of
each entity whose records you want to synchronize between Acumatica ERP and the Shopify store.
The synchronization of a particular entity may require that some other entities be synchronized as a
prerequisite. When you select the Active check box for such an entity, the system automatically selects it for
all other entities required as a prerequisite. Similarly, when you clear the Active check box for an entity that
is a required entity for other entities, the check box becomes cleared for all dependent entities.
In this substep, you also review the following default synchronization settings for each entity for which the
Active check box is selected, and make sure the default settings are appropriate for your configuration
needs:
• Sync Direction: The direction of the synchronization, which can be Import (data is imported to
Acumatica ERP), Export (data is exported to the Shopify store), and Bidirectional (data is both exported to
the Shopify store and imported to Acumatica ERP).
• Primary System: The system, ERP (Acumatica ERP) or External System (the Shopify store), whose data
takes precedence if conflicts occur during the synchronization.
• Real-Time Import: The status of the real-time import process. At the time of the initial configuration,
this status is either Stopped (real-time synchronization is supported but has not been started) or Not
Supported (real-time synchronization cannot be started).
• Real-Time Export: The status of the real-time export process. At the time of the initial configuration,
this status is either Stopped (real-time synchronization is supported but has not been started) or Not
Supported (real-time synchronization cannot be started).
• Real-Time Mode: The mode of the processing 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
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 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 most of the settings on this tab 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.
Integration with Shopify | 233

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 aer 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.

Configuration of the Entities Enabled for Synchronization


For each entity that you want to synchronize between Acumatica ERP and the Shopify store and that you have
activated on the Entity Settings tab of the Shopify Stores (BC201010) form, you can also set up the mapping of
custom fields for synchronization and synchronization filtering settings on the Entities (BC202000) form.
For more information about defining filtering and mapping settings for the needed entities, see Preparing Entities
for Synchronization.
Integration with Shopify | 234

Synchronization of Data
Aer 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.

Initial Configuration: Implementation Checklist

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.

API Credentials to Capture in the Shopify Store


If you connect a Shopify store to Acumatica ERP by using a custom app, you need to capture the API credentials
of the custom app in the Shopify store, which are listed in the following table. You will need to specify these
credentials on the Connection Settings tab of the Shopify Stores (BC201010) form when you establish the store
connection. For more information, see Initial Configuration: To Establish the Store Connection with a Custom App.

Required Information Description

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.

Settings in the Shopify Store


In the table below, you will find the information about the settings that you should specify in the Shopify store
before you start setting up the integration with Acumatica ERP. For more information, see Initial Configuration: To
Set Up a Shopify Store.

Required Settings Description

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

Required Settings Description

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.

Taxes The tax settings that apply to your online store.

Settings in Acumatica ERP


The table below contains the features that need to be enabled, the entities that need to be created, and the
settings that need to be specified in Acumatica ERP before you can specify the appropriate settings on the Shopify
Stores (BC201010) form.

Form Criteria to Check Notes

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.

If this feature is en-


abled, the import of
sales orders will not
work.

The following recommended fea-


tures are enabled:
• Drop Shipments
• External Tax Calculation Integra-
tion
• Customer Discounts
• Multiсurrency Accounting
• Multiple Warehouses
• Multiple Warehouse Locations
• Shipping Carrier Integrations
Integration with Shopify | 236

Form Criteria to Check Notes

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

Initial Configuration: Setting Up a Shopify Store

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.

Setting Up a Shopify Store


You use the admin area in Shopify to initially set up and configure your store, as well as to perform ongoing
management of products, customers, and orders. By using the admin area, you set up the store by performing the
following general steps:
1. Signing up for a Shopify account
2. Setting up a Shopify store
3. Setting the store time zone
4. Setting up the currencies in which goods will be available for purchase and the payment methods that you
will accept
5. Setting up taxes
6. Configuring the shipping zones and shipping rules

Signing Up for a Shopify Trial Account


Before you implement the integration with Acumatica ERP on the production Shopify store, we recommend that
you test your desired configuration in a test environment.
If you have a Shopify Partner account, you can create a new development store. Otherwise, you need a Shopify trial
account, which you can sign up for on https://www.shopify.com/. The registration requires that you provide a valid
email address, the name of your store, your name and contact details, and your admin password.

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.

Setting Up a Shopify Store


The following sections of this topic list the groups of settings that need to be specified in a Shopify store for
configuring the initial integration of Acumatica ERP and Shopify. For general information about initial configuration
of a Shopify store, refer to the Initial setup articles in the Shopify Help Center.

Setting the Store Time Zone


The time zone of your store is used in time conversion so that if different time zones have been set up in the store
and in the Acumatica ERP instance, orders, payments, and other data is assigned the correct time in the target
Integration with Shopify | 238

system aer 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.

Setting Up the Store Currency and Payment Methods


You set up the store currency that your customers will be charged in the Store currency section of the Store
details settings page of the Shopify admin area. The currency you select in this section is locked aer the first sale
and cannot be changed.
In Shopify, you can configure additional currencies in which prices will be displayed for customers. However,
customers will be able to check out only by using the store currency selected on the Store details settings page.
Once the store currency has been set up, you can configure payment methods that will be used to accept
payments. You configure payment providers and payment methods on the Payments settings page. For
information about configuring payment methods, see the Getting paid article in the Shopify Help Center.

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.

Initial Configuration: To Set Up a Shopify Store

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

Step 1: Signing Up for a Shopify Trial Account

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.

Create a Shopify trial account as follows:


1. On the http://www.shopify.com webpage, enter your email address in the text box and click Start free trial.
2. Enter a new password and the name of your store, and click Create your store.
The store name you enter will be used in the URL of the store (<storename>.myshopify.com). Make sure to
memorize the password because you will need it to sign in to the store.
In subsequent activities, SweetStore - SP will be used as the store name.
3. In Step 1 of the questionnaire, click Skip.
4. In Step 2 of the questionnaire, specify the following information:
• First name: John
• Last name: Smith
• Address: 2330 Hoffman Avenue
• City: New York
• Country/region: United States
• State: New York
• ZIP code: 11003
• Phone: 516 555 0150
The address you enter at this point will be the default address of your store, which is used for calculation of
shipping rates.
5. Click Enter my store.
You will be signed in to your Shopify store.

Step 2: Setting the Store Time Zone


While you are signed in to the admin area of your Shopify store, do the following:
1. In the lower le, click Settings > Store details.
2. On the Store details settings page, which opens, in the Standards and formats section, set Time zone to
(GMT-05:00) Eastern Time (US & Canada).
3. In the upper right, click Save.

Step 3: Setting Up the Store Currency


To select the currency that will be used for charging customers, do the following:
1. While you are still viewing the Store details settings page, review the currency settings in the Store
currency section.
Notice that in the Store currency box, US dollars (USD) is selected. This value is selected automatically
based on the address of your store that you have specified in Step 1.
Integration with Shopify | 240

2. If Store currency is set to any value other than US dollars (USD), change it to US dollars (USD) and click Save.

Step 4: Reviewing the Default Shipping Options


To review shipping options that will be available to shoppers, do the following:
1. While you are signed in to the admin area of your Shopify store, click Settings > Shipping and delivery.
2. On the Shipping and delivery page, which opens, in the Shipping section, click the Manage rates link right
of General shipping rates.
3. On the General profile page, which opens, review that the settings that have been defined by default during
the creation of the store.
Notice that the Shipping from section displays the address that you specified for your store while creating
the trial account. In the Shipping to section, notice that two shipping zones (Domestic and Rest of the World)
have been created by default, and a set of rates has been defined for each of these zones. These shipping
zones will be used in subsequent activities.

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.

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.

Step 1: Creating a Custom App


Before you can establish a connection between your instance of Acumatica ERP and the online store, you need to
create a custom app for the store as follows:
1. In the Shopify admin area, in the lower le, click Settings > Apps and sales channels.
2. In the top right, click Develop apps.
3. On the page that opens, click Create an app.
4. In the Create an app dialog box, specify the following settings:
• App name: Acumatica Custom
• App developer: The account of the app developer
The app developer can be the store owner or any staff or collaborator account with the Develop apps
permission.
5. Click Create app.
The system creates the custom app, closes the dialog box, and opens the page of the Acumatica Custom app.

Step 2: Specifying the App Permissions


Aer you have created the custom app, you need to assign API scopes to it. To do this, while you are still viewing the
Acumatica Custom page, do the following:
1. On the Overview page, click Configure Admin API scopes.
2. In the Admin API access scopes section of the Configuration tab, select the check boxes for all listed
scopes.
3. In the Webhook subscriptions section, leave the default value, which is the current version of the Shopify
API.
4. In the lower right, click Save to save your changes.

Step 3: Obtaining the API Credentials


To obtain an access token and shared secret for the custom app, while you are still viewing the Acumatica Custom
page, do the following:
1. On the API credentials tab, click Install app.
2. In the dialog box that opens, click Install.
The system generates an access token and closes the dialog box.
3. In the Admin API access token section, click Reveal token once.

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

Step 4: Establishing the Store Connection


To establish a connection with the Shopify store, in your instance of Acumatica ERP, do the following:
1. Open the Shopify Stores (BC201010) form.
2. In the Store Name box of the Summary area, specify SweetStore - SP.
3. On the Connection Settings tab, use the information that you have captured in the previous step to specify
the settings as follows:
• In the Store Admin URL box, enter the path of your Shopify store with /admin added to the end.
The full URL usually looks like this: https://<store name>.myshopify.com/admin.
• In the API Access Token box, enter the access token that was generated for the custom app that you have
installed in your Shopify store.
• In the API Secret Key box, enter the API secret key that was generated for the custom app that you have
installed in your Shopify.
4. On the form toolbar, click Save to save your changes.
5. Click Test Connection to verify that 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.

Initial Configuration: To Establish the Store Connection with a Public App

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

Step 1: Installing the Acumatica Cloud ERP App


To install the Acumatica Cloud ERP app, while you are signed in to your Shopify store, do the following:
1. In the le menu, click Apps.
2. In the upper right of the Apps page, which opens, click Customize your store.
3. If prompted, sign in with your Shopify credentials.
The main page of the Shopify App Store opens.
4. In the search bar, type acumatica.
5. In the search results, click Acumatica Cloud ERP.
6. On the page of the Acumatica Cloud ERP app, which opens, click Add app.
7. On the app installation page of your Shopify store, which opens, review the permissions the Acumatica
Cloud ERP app will be granted in your store, and click Install app.
The system installs the Acumatica Cloud ERP app and opens the first page of a wizard that walks you
through connecting Acumatica ERP to the Shopify store.

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.

Step 2: Connecting the Acumatica ERP Instance


To connect Acumatica ERP to your Shopify store, while you are viewing the first step of the connection wizard, do
the following:
1. In the Connect to Acumatica step, right of Do you have an instance of Acumatica ERP ready for connection?,
click Yes.
2. In the Connect your Acumatica ERP Account step, specify the following settings:
• Acumatica ERP URL with full path: The full public URL of your Acumatica ERP instance deployed for
training
• Tenant: The name of the tenant with the U100 dataset
3. Click Authorize.
4. On the Acumatica ERP sign-in page, which opens in a pop-up window, make sure the correct tenant is
selected, enter the gibbs username and 123 password, and click Sign In.
The app establishes the connection to the Acumatica ERP instance and creates a new Shopify store on the
Shopify Stores (BC201010) form.

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

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 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

Step 1: Enabling the Needed Features


To make sure the needed features for e-commerce functionality have been enabled, do the following:
1. Open the Enable/Disable Features (CS100000) form.
2. Make sure that the following features are enabled:
• Inventory
• Business Account Locations
Integration with Shopify | 245

• 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.

Step 4: Reviewing the Order Settings


To review the order type created for the orders coming from the Shopify store, do the following:
1. Open the Order Types (SO201000) form.
2. In the Order Type box, select EO - eCommerce Order.
Integration with Shopify | 246

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.

Step 5: Reviewing the Shipping Settings


To review the Acumatica ERP shipping settings that you will need to specify during the configuration of the store
connection, do the following:
1. On the Ship via Codes (CS207500) form.
2. In the Ship Via box, select SWEETSHIP.
Because SweetLife is going to deliver the products by using only its own fleet of vehicles, you will specify
this shipping option when you configure the store connection.

Step 6: Reviewing the Cash Account and Payment Method Settings


To review the payment method in Acumatica ERP that will be mapped to the Shopify payment methods configured
in the online store, do the following:
1. Open the Payment Methods (CA204000) form.
2. In the ERP Payment Method box, select ONLINE.
For simplicity, this payment method will be mapped to all payment methods configured in the Shopify
store. On the Allowed Cash Accounts tab, notice that the table contains only one cash account, 10250ST -
Company Merchant Account.
3. In the Cash Account column, click the link with the cash account name.
4. On the Cash Accounts (CA202000) form, which opens in a pop-up window, review the cash account settings.
In the Summary area, notice that the 10250ST cash account has been configured for the USD currency and
the RETAIL branch.
5. Close the dialog box.

Initial Configuration: To Configure the Store Connection

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

Step 1: Specifying the Entity Settings


Do the following to specify the entity settings:
1. On the Shopify Stores (BC201010) form, open the SweetStore - SP store.
2. On the Entity Settings tab, select the Active check box in the table for the following entities:
• Customer
• Stock Item
• Sales Order
• Payment
• Shipment
Leave the default settings of the activated entities as they are.

Step 2: Specifying the Customer Settings


To specify the settings that will be used by default for importing customers from the Shopify store to Acumatica
ERP, do the following:
1. While you are still viewing the Shopify Stores (BC201010) form, open the Customer Settings tab.
2. In the Customer section, select the following values:
• Customer Class: ECCUSTOMER
Integration with Shopify | 248

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.

Step 3: Specifying the Order Settings


To specify the order-related settings, do the following:
1. While you are still viewing the Shopify Stores (BC201010) form, got to the Order Settings tab.
2. In the General section, set Branch to RETAIL.
The RETAIL branch will be inserted by default in sales orders imported from the SweetStore - SP store.
3. In the Order section, select the following options:
• Order Type for Import: EO - eCommerce Order
This order type has been configured specifically for sales orders imported from Shopify stores.
• Refund Amount Item: REFUNDAMT - eCommerce Refund Amount Item
This non-stock item is used as a dummy product to reflect refunded amounts in sales orders and return
orders for refunds initiated in the Shopify store. Although the Refund Amount Item box is required and
you need to specify its value during the initial setup, it will only be used during the configuration and
processing of refunds, which is described in Importing Non-Card Refunds and Importing Card Refunds.
• Tag Ext. Order with ERP Order Nbr.: Selected.
With this check box selected, for each order imported from the Shopify store to Acumatica ERP, two
tags will be added in the Shopify store—ERP and a tag with the order number assigned to the order in
Acumatica ERP.
4. In the Taxes section, leave the Tax Synchronization check box cleared.
For simplicity, you do not need to configure the synchronization of taxes at this point.
5. On the form toolbar, click Save to save your changes.

Step 4: Specifying the Shipping Settings


To map the shipping methods defined in Shopify with the ship via options defined in Acumatica ERP, do the
following:
1. While you are still viewing the Shopify Stores (BC201010) form, go to the Shipping Settings tab.
Notice that the system has automatically added a row for each shipping option defined in the Shopify store.
2. In the table of this tab, in the rows of the Domestic store shipping zone, specify the settings described in the
following table.

Active Store Shipping Store Shipping Ship Via Shipping Zone Shipping
Zone Method Terms

Selected Domestic Standard SWEETSHIP Leave empty Leave empty

Selected Domestic Economy SWEETSHIP Leave empty Leave empty


Integration with Shopify | 249

Step 5: Reviewing the Payment Method Mapping


If you want to import payments based on a particular payment method activated in the Shopify store to Acumatica
ERP, you need to map the payment method to a corresponding payment method configured in Acumatica ERP. To
configure the payment method mapping, do the following:
1. While you are still viewing the Shopify Stores (BC201010) form, go to the Payment Settings tab.
2. In the table of this tab, add a row, and in the added row, map the payment method set up in the Shopify
store with the payment method activated in Acumatica ERP as follows.

Active Store Payment Store Cur- ERP Payment Cash Ac- Release Payments
Method rency Method count

Selected MANUAL USD ONLINE 10250ST Cleared

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.

Overview of Data 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.

Data Synchronization: General Information

Aer 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.

Stages of the Synchronization Process


The process of the synchronization of data between Acumatica ERP and the e-commerce store consists of the
following stages:
• Preparing out-of-sync data for synchronization. For details, see the Preparation of Out-of-Sync Data for
Synchronization section below.
• Processing out-of-sync data, as described in the Processing of Out-of-Sync Data section below.
Integration with Shopify | 250

Preparation of Out-of-Sync Data for Synchronization


During the preparation of data for synchronization, the system receives the data that needs to be synchronized
between Acumatica ERP and the e-commerce system and puts it in the processing queue. The following
mechanisms can be used for obtaining data:
• Data preparation process: The data preparation process pulls the data to be synchronized from Acumatica
ERP and the e-commerce system through API calls and puts it in the processing queue. It can be performed
in the following modes:
• Full mode: In this mode, all records of the entity that have been created or modified during the specified
date range are pulled from Acumatica ERP and the e-commerce system and put in the processing queue,
regardless of whether they have been processed previously or not.
• Incremental mode: In this mode, only the records that have been modified since the date of the last
successful data preparation are pulled.
• Incremental by Date mode: In this mode, only records that have been modified during the specified date
range and that have not yet been processed are pulled.
The pulled data is then filtered according to the filtering criteria defined on the Entities (BC202000) form
and saved in the processing queue as synchronization records with the Prepared status, which indicates
that these synchronization records have not yet been processed. The synchronization records are then
processed as described in the Processing of Out-of-Sync Data.
The data preparation process can be started in the following ways:
• Manually, on the Prepare Data (BC501000) form. For information on manual synchronization, see Data
Synchronization: Manual Synchronization.
• By an automation schedule. For details about scheduling synchronization, see Automated
Synchronization: General Information.
• Push notifications: If real-time synchronization is enabled for an entity on the Entities (BC202000) form,
whenever a record is changed in the source system, the e-commerce connector is immediately notified
about the change, and the corresponding synchronization record is created or updated in the processing
queue.
This synchronization record is saved with the Prepared status and remains in the processing queue until it is
processed.
The following diagram shows the process of preparing data for synchronization.
Integration with Shopify | 251

Figure: Preparing data for synchronization

Processing of Out-of-Sync Data


During the data processing stage, the system processes the synchronization records in the processing queue
according to the synchronization settings defined for the corresponding entity on the Entities (BC202000) form or
on the Entity Settings tab of the Shopify Stores (BC201010) form, and the synchronized data is saved in Acumatica
ERP, in the Shopify store, or in both systems.
Integration with Shopify | 252

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.

The processing of out-of-sync data can be started as follows:


• You can start data processing manually, as described in Data Synchronization: Manual Synchronization.
• You can configure an automation schedule that will start data processing at regular intervals, as described
in Automated Synchronization: General Information.
• You can configure the system to immediately start data processing for each synchronization record created
or updated as a result of the real-time synchronization process. To do this, on the Entities (BC202000)
form, you set Real-Time Mode for an entity to Prepare & Process. For more information about real-time
synchronization, see Automated Synchronization: Real-Time Synchronization.
In the following diagram, you can see the flow of the processing of data prepared for synchronization.
Integration with Shopify | 253

Figure: Processing prepared data

Preparation of Deleted Records


If a previously processed entity record is deleted in Acumatica ERP, in the external system, or in both systems,
its synchronization record is assigned the Deleted status on the Sync History (BC301000) form. When the entity is
prepared, the synchronization record is assigned the Prepared status in the following cases:
• If the entity record was deleted in the primary system or in both systems and then was restored in the
primary system
• If the entity record was deleted only in the secondary system and then was modified in the primary system
During the entity preparation, synchronization records that were never processed and were manually assigned the
Deleted status on the Sync History form, are assigned the Prepared status regardless of the changes to the entity
records in either of the systems.
Integration with Shopify | 254

Data Synchronization: Synchronization Statuses

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.

Skipped The synchronization record was manually excluded from synchronization by a


user.

Deleted The record in the synchronization record has been deleted in Acumatica ERP, in
the external system, or in both systems.

Invalid The synchronization record cannot be processed because its synchronization is


not possible.

Filtered The entity has been filtered as a result of applying a filter defined in the code or
on the Entities form.

Data Synchronization: Manual Synchronization

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.

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.

Step 1: Finding and Reviewing the Stock Items to Be Sold Online


To find and review the stock items that will be sold online, do the following:
1. Open the Stock Items (IN2025PL) form.
2. Filter the stock items to display only the items of the Jam item class as follows:
a. In the Item Class column, click the column header.
b. In the menu that opens, select the Equals filter condition.
c. In the box at the bottom of the menu, type Jam.
d. Click OK to apply the filter.
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 Shopify store.
Integration with Shopify | 257

Step 2: Configuring the Export of a Subset of Stock Items


To configure the Stock Item entity to export to the Shopify store only stock items of the Jam item class, do the
following:
1. Open the Entities (BC2020PL) form.
2. In the Store Name box of the Selection area, select SweetStore - SP.
3. In the Entity column of the table, click the Stock Item link.
The system opens the Entities (BC202000) form with the SweetStore - SP store and the Stock Item entity
selected in the Summary area. Notice that this entity can only be exported to the Shopify store (that is, Sync
Direction is set to Export), and that only two tabs, Export Mapping and Export Filtering, are displayed.
4. To create a filtering condition for stock items, on the Export Filtering tab, click Add Row on the table
toolbar, and specify the following settings in the row:
• 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 Shopify 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.

Step 3: Preparing the Product Data for Synchronization


To prepare the stock item data that needs to be synchronized to the Shopify store, 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
This setting controls which data will be loaded. Incremental indicates that the system will load only
the data that has been modified since the previous data synchronization. Because you start the data
preparation process for the Stock Item for the first time, all stock item data will be prepared.
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.
In the table on the form, notice that the Ready to Process column shows the number of synchronization
records that have been prepared and are ready to be processed. The Processed Records column shows the
number of records that have been processed (that is, records that have been successfully synchronized and
assigned the Processed status).
Integration with Shopify | 258

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.

Step 4: Reviewing the Results of Data Preparation


To review the results of preparation of product data for synchronization, do the following:
1. While you are still viewing the Prepare Data (BC501000) form, click the link in the Total Records in the row of
the Stock Item entity.
The Sync History (BC301000) form opens in a new browser tab with the SweetStore - SP store and the Stock
Item entity selected in the Summary area.
2. On the Filtered tab, review the synchronization records.
Notice that all synchronization records on this tab have the Filtered status. These are the stock items that
were excluded from synchronization based on the filtering conditions that you configured earlier.
3. Go to the Ready to Process tab,
Notice that the table is displaying only synchronization records with the Prepared status, as shown in
the screenshot below. This status means that these records have been prepared and are now ready to be
processed.
For each of these items, the ERP ID column displays a link that you can click to open the item on the Stock
Items (IN202500) form. The text of the link corresponds to the description of the stock item on the Stock
Items form. Notice that the External ID column currently does not display any values because the stock
items have not yet been exported to the Shopify store.

Figure: Data prepared for processing

Step 5: Processing the Prepared Product Data


To process the prepared product data (that is, to synchronize it with the Shopify store), do the following:
Integration with Shopify | 259

1. Open the Process Data (BC501500) form.


2. In the Summary area, select the following settings:
• Store: SweetStore - SP
• Entity: Stock Item
The table displays only the list of the items that you have prepared for synchronization (that is, the items
with the Prepared status).
3. On the form toolbar, click Process All to synchronize all records displayed in the table.
4. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.

Step 6: Reviewing the Synchronization Status of the Product Data


To again review the synchronization status of the product data, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area of the form, select the following settings:
• Store: SweetStore - SP
• Entity: Stock Item
3. Go to the Processed tab.
The tab shows the list of items that have been processed (that is, synchronized with the Shopify store. For
each item, there is now a product identifier in the External ID column. In the table, the Last Operation
value has changed to Inserted Externally and the time stamp in the Last Attempt column has changed to the
date and time when you ran data processing on the Process Data (BC501500) form.

Step 7: Viewing an Exported Product in the Shopify Store


To view the KIWIJAM96 stock item (which has the description Kiwi jam 96 oz) in the Shopify store, do the following:
1. While you are still viewing the Sync History (BC301000) form, click the link in the External ID column in the
row of the synchronization record for the Kiwi jam 96 oz item.
The product management page for the Kiwi jam 96 oz product (which is a page in the admin area of the
Shopify store where you manage details of a particular product) opens in a new browser tab.
2. Scan the product details that have been exported to the Shopify store (the product name, SKU, image,
description, default price, and weight).

Step 8: Placing an Order from the Admin Area


To create an order for five 96-ounce jars of kiwi jam from the admin area of your Shopify store, do the following:
1. In the le menu, click Orders.
2. On the Orders page, which opens, click Create order.
3. On the Create order page, which opens, in the Products section, start typing Kiwi jam in the search bar.
4. In the list of search results, which are shown in a pop-up window, select the check box next to Kiwi jam 96 oz,
and click Add.
5. In the row of the Kiwi jam 96 oz product, change the quantity to 5.
6. In the Customer section, click in the search bar and in the menu that opens, select Create a new customer.
7. In the Create a new customer pop-up window, which opens, fill in the boxes as follows:
• First name: Larry
Integration with Shopify | 260

• Last name: Coleman


• Email: larry@example.com
• Address: 1970 Duncan Avenue
• City: New York
• Country/region: United States
• State: New York
• ZIP code: 10016
8. In the lower right, click Save customer.
9. In the Payment section, click Collect payment > Mark as paid.
10.In the Mark as paid dialog box, which appears, click Create order.
The system closes the Mark as paid 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.

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).

Step 9: Importing the Sales Order Data to Acumatica ERP


To import the order from the Shopify store to 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
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. Click the link in the Ready to Process (which shows 1 because you have created only one order in the
Shopify store) in the row of the Sales Order entity.
6. On the Process Data (BC501500) form, which opens with the SweetStore - SP store and the Sales Order entity
selected in the Summary area, select the unlabeled check box in the only row, and on the form toolbar, click
Process.
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 Data


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:
Integration with Shopify | 261

• 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.

Step 11: Reviewing the Imported Sales Order


To review the details of the imported sales order, do the following:
1. While you are still viewing the synchronization results on the Sync History (BC301000) form, click the link in
the ERP ID column for the sales order you imported.
2. On the Sales Orders (SO301000) form, which opens in a pop-up window, review the details of the order.

Figure: Sales order imported from the store

In the Summary area, notice the following:


• The imported order has the EO type (shown in the Order Type), which is configured on the Shopify Stores
(BC201010) form to be assigned to all sales orders imported from the SweetStore - SP store.
• In the Customer Order Nbr. box, the order number assigned to the order in the Shopify store is
displayed.
• In the External Reference box, the order identifier assigned to the order in the Shopify 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 Shopify store.
Integration with Shopify | 262

• 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.

Step 12: Creating and Confirming a Shipment


To process a shipment for the imported sales order, do the following:
1. While you are still viewing the sales order on the Sales Orders (SO301000) form, on the form toolbar, click
Create Shipment.
2. In the Specify Shipment Parameters dialog box, which opens, make sure the current date and the RETAIL
warehouse are selected, and click OK. The system creates a shipment and opens it on the Shipments
(SO302000) form.
3. On the form toolbar, click Confirm Shipment.
The shipment is assigned the Confirmed status; the sales order is assigned the Completed status.

Step 13: Synchronizing the Shipment with the Shopify Store


To synchronize with the SweetStore - SP store the shipment that you created and confirmed in the previous steps,
do the following:
1. In the Summary area on the Prepare Data (BC501000) form, select the following settings:
• Store: SweetStore - SP
• Prepare Mode: Incremental
2. In the table, select the Selected 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 to close the
dialog box.
5. Click the link in the Ready to Process (which shows 1 because only one shipment has been created) in the
row of the Shipment entity.
The Process Data (BC501500) form opens with the SweetStore - SP store and the Shipment entity selected.
6. Select the unlabeled check box for the only row of the table, and click Process on the form toolbar.
7. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.

Step 15: Reviewing the Updated Order and Shipment in Shopify


To check whether the shipment and the updated sales order have been exported to the Shopify store correctly, do
the following:
1. Open the Sync History (BC301000) form.
Integration with Shopify | 263

2. In the Summary area of the form, specify the following settings:


• Store: SweetStore - SP
• Entity: Shipment
3. On the Processed tab, notice that the synchronization record of the shipment is displayed in the only row of
the table. The External ID column displays the identifier of the shipment in Shopify, which consists of two
parts—the identifier of the order and the identifier of the shipment.
4. Click the link in the External ID column.
5. On the order page of the Shopify store, which opens in a new browser tab, notice the following:
• The fulfillment status of the order has been changed to Fulfilled. Notice the fulfillment number next to
the status and the quantity of fulfilled items.
• The order has been archived. By default, orders that have been fully paid and fulfilled are automatically
assigned the Archived status. You can change the default behavior on the Checkout settings page in the
admin area of the Shopify store.
• In the Tags section, two tags have been added to the order—ERP and a tag with the sales order number
from Acumatica ERP. Both tags were created during the order synchronization in Step 9.
You have now performed the first manual synchronization of products, sales orders, and shipments.

Preparing Entities for Synchronization

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.

Preparing Entities for Synchronization: General Information

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.

Configuration of Synchronization Preferences


During the initial configuration of the connection between Acumatica ERP and the Shopify store, you determine
which of the entities supported by the Shopify connector need to be synchronized between the two systems. To
do this, you select the Active check box for each required entity on the Entity Settings tab of the Shopify Stores
(BC201010) form. On this tab, you can also configure the following:
• The direction of the synchronization. For each entity, you specify whether data should be exported to
Shopify, 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, Shopify), 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 aer 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 the synchronization records before excluding them from further synchronization attempts.
You can also change these settings for each particular entity by using the Entities (BC202000) form.

Filtering and Field Mapping for Export and Import


For some of the entities supported by the e-commerce connector, on the Entities (BC202000) form, you
can configure the additional synchronization settings—for example, define a filter to be applied during the
synchronization of entity data, or define a new mapping between the fields in Acumatica ERP and the fields in
Shopify. You define filters and mappings for the import and export processes on the following tabs:
• Filtering for import: Import Filtering tab
• Filtering for export: Export Filtering tab
• Mapping for import: Import Mapping tab
• Mapping for export: Export Mapping tab

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.

Table: Availability of Filtering and Mapping Options for Entities

Entity in Acumatica Import Mapping Import Filtering Export Mapping Export Filtering
ERP
Customer Yes Yes Yes Yes

Customer Location No Yes No Yes


Integration with Shopify | 265

Entity in Acumatica Import Mapping Import Filtering Export Mapping Export Filtering
ERP
Stock Item No No Yes Yes

Non-Stock Item No No Yes Yes

Template Item No No Yes Yes

Product Image No No No No

Product Availability No No No No

Sales Order Yes Yes No No

Payment Yes Yes No No

Shipment No No Yes Yes

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.

Preparing Entities for Synchronization: Updating Product Details

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 aer 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. Aer 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. Aer 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.

Preparing Entities for Synchronization: Filtering

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.

Active Brackets Field Name Condition Value Value 2 Brackets Operator

Selected - Customer Does Not INTL Empty - And


Class Equal
Integration with Shopify | 267

The particular fields that you can select in the Field Name column depend on the selected entity.

If you change the export filter settings aer 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.

Export Filtering by Custom Fields


Export filtering by custom fields, which are fields added to a form as a result of publishing a customization project,
is available for the Customer, Stock Item, Non-Stock Item, Template Item, and Sales Order entities.
To use a custom field in a filtering condition, on the Export Filtering tab of the Entities (BC202000) form, you should
type the name of the field in the Field Name column of the table. The system validates the field name against the
API field list and displays an error if the field name cannot be found.

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.

Export Filtering by Attributes


Export filtering by attributes is available for the Customer, Stock Item, Non-Stock Item, and Template Item entities.
When an attribute is created and added to a customer class or item class, it becomes available for selection on the
Entities (BC202000) form. To use an attribute in a filtering condition, you should select it in the Field Name column
of the table on the Export Filtering tab. An attribute can be distinguished from other fields by the Attributes prefix
before its name.

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 aer 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.

Preparing Entities for Synchronization: Field Mapping

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.

Mapping of Fields for Export


Acumatica ERP Retail-Commerce Edition provides you with the ability to map fields, which are related to
synchronized entities, in Acumatica ERP with fields in the Shopify store. You can define additional mappings of
standard or custom fields as well as override the standard mappings provided with the Shopify integration.
You define the mappings of fields that should be processed during the export of data from Acumatica ERP to
Shopify on the Export Mapping tab of the Entities (BC202000) form. During the export 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 export process, you specify values in the following columns:
• Target 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.
• 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 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.
• 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.

Mapping of Fields for Import


Acumatica ERP Retail-Commerce Edition provides you with the ability to map fields, which are related to
synchronized entities, in Acumatica ERP with fields in Shopify. You can define additional mappings of standard or
custom fields, as well as override the standard mappings provided with the Shopify integration.
You define the mappings of fields that should be processed during the import of data from Shopify to 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.
Integration with Shopify | 269

• 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.

Removing Standard Mapping for a Field


You can remove the mapping for fields that you do not want to be synchronized between Acumatica ERP and the
external system. You perform the unmapping for import and export directions separately as follows:
1. On the Entities (BC202000) form, you select the store and the entity for which you want to modify field
mapping.
2. Depending on the synchronization direction, you do one of the following:
• To remove the mapping from an Acumatica ERP field so that it is not used during the import, on the
Import Mapping tab, you select the needed values in the Target Object and Target Field columns, and
then in the Source Object column, you select <<Unmap>>.
• To remove the mapping from a field in the external e-commerce system so that it is not used during the
export, on the Export Mapping tab, you select the needed values in the Target Object and Target Field
columns, and then in the Source Object column, you select <<Unmap>>.
During the synchronization, the system will not pull data from the unmapped fields or record data to these
fields.

Using of Formulas in Field Mapping


When you define mappings between fields in Acumatica ERP and in the external system on the Entities (BC202000)
form, you can use formulas to calculate the values to be displayed in the target fields. Formulas give you the ability
to use advanced calculations and data transformation functions if some values are calculated or depend on the
data from other sources.
You can enter the formula directly in the Source Field / Value column (Import Mapping tab) or Target Field / Value
column (Export Mapping) or in the Formula Editor Dialog Box, which you invoke by clicking the Edit button in these
columns.
Operators and functions that you can use in formulas on the Entities form are the same as the operators and
functions that are used on the Import Scenarios (SM206025) and Export Scenarios (SM207025) forms. For more
information about formulas, functions, and operators, see Formulas in Mapping, Operators, and Functions.

Import Mapping of Sales Order Details


You can map the fields with information about the products included in an order in Shopify with the fields used in
sales order detail lines in Acumatica ERP.
When you define the field mapping to be used for importing sales orders from an external system, you can use both
predefined and custom Acumatica ERP fields of sales order detail lines—that is, fields that are used in sales order
lines, which are displayed on the Details tab of the Sales Orders (SO301000) form. During order synchronization,
details of the products in an order placed in Shopify is sent to the mapped fields in Acumatica ERP.
To use a sales order detail field in import mapping, on the Import Mapping tab of the Entities (BC202000) form, you
do the following:
1. In the Target Object column, select the Sales Order → Details or Sales Order → Details → Advanced option.
2. In the Target Value column, select a field from the list of fields that hold information about sales order
details. Custom fields have the prefix Usr.
Integration with Shopify | 270

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.

Preparing Entities for Synchronization: Shopify Metafields

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.

Using Shopify Metafields in Field Mapping


You can map fields from Acumatica ERP to metafields created in a Shopify store for the following entities
maintained on the Entities (BC202000) form:
• Stock Item
• Non-Stock Item
• Template Item
• Customer
• Sales Order
To use a Shopify metafield in field mapping for data import, you need to select the appropriate option in the
Source Object column of the table on the Import Mapping tab of the Entities form. To use a Shopify metafield for
export, you select the option in the Target Object column in the table of the Export Mapping tab of the same form.
The options that are available for each of the entities are summarized in the following table.

Table: Source and Target Objects for Mapping Shopify Metafields

Entity Tab Source Object Target Object

Stock Item Export Mapping N/A Product → Metafields


Product → Product Variants →
Metafields

Non-Stock Item Export Mapping N/A Product → Metafields


Product → Product Variants →
Metafields

Template Item Export Mapping N/A Product → Metafields


Product → Product Variants →
Metafields

Customer Export Mapping N/A Customer → Metafields

Import Mapping Customer → Metafields N/A


Integration with Shopify | 271

Entity Tab Source Object Target Object

Sales Order Import Mapping Order Data - Metafields N/A


Order Data → Customer →
Metafields

Metafields in Shopify have several properties, including the following:


• Namespace: A category or container that groups some metafields and differentiates them from other
metafields
• Key: The name of the metafield; it is used to reference the information stored in the metafield
• Value: The content of the metafield
When you are configuring an import mapping for the Customer or Sales Order entity, to map a Shopify metafield
with an Acumatica ERP field, they need to select the metafield object in the Source Object column and type the
metafield name in the Source Field / Value column in the following format: Namespace.Key.
When you are configuring an export mapping for the Stock Item , Non-Stock Item, Template Item, or Customer entity,
to map an Acumatica ERP field with a Shopify metafield, you need to select the metafield object in the Target
Object column and type the metafield name in the Target column in the following format: Namespace.Key.
During the synchronization of the entity, the system will check whether the metafield with this name exists and do
either of the following:
• If the metafield exists, update its value based on the settings of the Source Field / Value column.
• If the metafield does not exist, create it with the specified namespace and key, and assign it the value
according to the mapping settings for the particular object.
You can also use metafields in formulas. When a metafield is used in a formula, its namespace and key should be
enclosed in square brackets: [Namespace.Key].

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.

Automated Synchronization: General Information

Aer 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 aer 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 and Real-Time Synchronization


You can automate the synchronization of data of a particular entity between Acumatica ERP and the Shopify store
in the following ways:
• You configure automation schedules for data preparation or data processing on the Automation Schedules
(SM205020) form. Data preparation or processing is started for the entity when the automation schedule
is executed. For information about scheduled synchronization, see Automated Synchronization: Scheduled
Synchronization.
• You turn on real-time synchronization for a particular entity on the Entities (BC202000) form. When real-
time synchronization is on, Acumatica ERP attempts to prepare or prepare and process data as soon as a
change is made to the entity in Acumatica ERP or in the e-commerce system. To learn more about real-time
synchronization, see Automated Synchronization: Real-Time Synchronization.
Scheduled synchronization and real-time synchronization do not interfere with each other or with manual
synchronization and can be used together. For recommendations on the frequency of synchronization, see
Automated Synchronization: Recommended Setup.

Automated Synchronization: Scheduled Synchronization

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.

Using Predefined Automation Schedules for Data Preparation and Processing


Acumatica ERP provides a number of predefined automation schedules—some for data preparation and others for
data processing—that you can use as starting points for setting up your own automation schedules. The following
table lists these schedules by the Description settings on the Automation Schedules (SM205020) form, along with
each schedule's predefined frequency of execution.

Table: Predefined Schedules for Data Preparation or Data Processing

Schedule Description Execution Frequency

Prepare Stock, Non-Stock, and Template Items Daily, once a day

Prepare Product Availability Daily, every hour

Prepare Sales Orders Daily, every 10 min

Prepare Shipments Daily, every 30 min

Prepare Refunds Daily, every 20 min

Process Non-Stock Items Daily, every hour


Integration with Shopify | 273

Schedule Description Execution Frequency

Process Stock Items Daily, every hour

Process Template Items Daily, every hour

Process Product Availability Daily, every hour

Process Sales Orders Daily, every 10 min

Process Shipments Daily, every 10 min

Process Refunds Daily, every 10 min

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.

2. You modify the schedule's settings as follows:


• On the Filters tab, add a filter condition to include the store for which the schedule should be executed.
• On the Schedule tab, adjust the schedule execution frequency, if necessary.

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

3. On the table toolbar, you click Schedule > Add.


The system opens the Automation Schedules form in a pop-up window. The settings that you have specified
appear on the Conditions and Filter Values tabs of the form.
4. You specify a name and description for the schedule, as well as its frequency, expiration information,
execution dates and times, and other settings.
5. You activate and save the schedule.

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.

To select all entities, clear the value in the Entity box.

2. On the table toolbar, you click Schedule > Add.


The Automation Schedules form opens in a pop-up window. The settings that you have specified appear on
the Filter Values tab of the form.
3. You specify a name and description for the schedule, as well as its frequency, expiration information,
execution dates and times, and other settings.
4. You activate and save the schedule.

For detailed instructions on creating a schedule for preparing and processing data, see Automated Synchronization:
To Configure a New Automation Schedule.

Automated Synchronization: Real-Time Synchronization

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

Turning On of Real-Time Synchronization


To turn on real-time synchronization for an entity, on the Entities (BC202000) form, you select the store and the
entity and then click Start Real-Time Sync on the form toolbar. Real-time synchronization is turned on for the
direction specified in the Sync Direction box of the Summary area as follows:
• If the Sync Direction is Export, only real-time export is turned on for the entity.
• If the Sync Direction is Import, only real-time import is turned on for the entity.
• If the Sync Direction is Bidirectional, both real-time export and real-time import are turned on for the entity.
The status of the real-time import and export processes for an entity are displayed in the Real-Time Import and
Real-Time Export boxes in the Summary area and can be either of the following:
• Running: Real-time synchronization has been turned on.
• Stopped: Real-time synchronization is off but can be turned on.
• Not Supported: Real-time synchronization cannot be turned on.
To turn off real-time synchronization for an entity, you select the store and the entity in the Summary area, and
then click Stop Real-Time Sync on the form toolbar.
For detailed instructions on how to enable real-time synchronization, see Automated Synchronization: To Turn On
Real-Time Synchronization.

Webhook URL for Real-Time Import


If the synchronization direction is set to Import or Bidirectional, when you click Start Real-Time Sync on the form
toolbar of the Entities (BC202000) form, the system displays the Start Real-Time Sync dialog box. In the Real-
Time Webhook URL box of this dialog box, you can update the URL which Acumatica ERP will use for webhook
notifications from the e-commerce system, if necessary. The webhook URL must be publicly accessible and have
SSL/TLS encryption. If a webhook cannot be delivered to the webhook URL, real-time import will not work. When
real-time synchronization is running, the URL that is currently used to receive webhooks for the entity is displayed
in the Real-Time Webhook URL box of the Summary area.

Limitations of Real-Time Synchronization


The use of real-time synchronization has the following limitations:
• Real-time synchronization in the Import direction is not reliable. Webhooks may be lost, disabled, or
deleted, in which case notifications about the changes will not be received and the synchronization will not
happen. We recommend that for each entity for which you have configured real-time synchronization, you
set up an automation schedule to run data preparation in Incremental mode at least once a night.
• The background process makes only one attempt to process each synchronization record placed in the
processing queue by the real-time synchronization process. If the attempt fails, processing continues for
other records in the queue. We recommend that you set up an automation schedule to regularly run data
processing to ensure that failed synchronization records are synchronized.
• In some cases, Acumatica ERP or an e-commerce system may generate multiple notifications for the same
record. For example, when a shipment is processed, Acumatica ERP generates multiple notifications about
updates to the sales order. For optimal performance, incoming notifications are processed with a delay of 15
to 20 seconds to ensure that all related notifications are processed simultaneously.
Integration with Shopify | 276

Automated Synchronization: Recommended Setup

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.

Table: Recommended Synchronization Setup for Lower Volumes

Entity Real-Time Synchronization Data Preparation Data Processing

Sales Order Started Daily, once a night Daily, once a night


Real-time mode: Prepare &
Process

Refund Started Daily, once a night Daily, once a night


Real-time mode: Prepare &
Process

Shipment Started Daily, once a night Daily, once a night


Real-time mode: Prepare &
Process

Stock Item, Non-Stock Started Daily, once a night Daily, once a night
Item, Template Item
Real-time mode: Prepare &
Process

Product Availability Stopped Daily, every 60 minutes Daily, every 60 minutes

Other entities Stopped Daily, once a night Daily, once a night

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 aer
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.

Table: Recommended Synchronization Setup for Higher Volumes

Entity Real-Time Synchronization Data Preparation Data Processing

Sales Order Stopped Daily, every 10 minutes Daily, every 10 minutes

Refund Stopped Daily, every 20 minutes Daily, every 10 minutes

Shipment Stopped Daily, every 30 minutes Daily, every 10 minutes

Stock Item, Non-Stock Stopped Daily, once a night Daily, every 60 minutes
Item, Template Item
Integration with Shopify | 277

Entity Real-Time Synchronization Data Preparation Data Processing

Product Availability Stopped Daily, every 60 minutes Daily, every 60 minutes

Other entities Stopped Daily, once a night Daily, once a night

Automated Synchronization: To Activate a Predefined Automation Schedule

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.

The following activity is based on the U100 dataset.

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.

Step 1: Activating and Setting Up the First Synchronization Schedule


To set up and activate the first predefined synchronization schedule, which will start the data preparation process
for the sales order data, do the following:
1. Open the Automation Schedules (SM205020) form.
2. In the Schedule ID box of the Summary area, select Prepare Sales Orders.
Integration with Shopify | 278

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.

Step 2: Activating and Setting Up the Second Synchronization Schedule


To set up and activate the second predefined synchronization schedule, which will start data processing for the
prepared sales order data, do the following:
1. Open the Automation Schedules (SM205020) form.
2. In the Schedule ID box of the Summary area, select Process Sales Orders.
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, data processing 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.
The schedule will now start the processing of the prepared sales order data for the SweetStore - SP store
every 10 minutes.

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

Automated Synchronization: To Configure a New Automation Schedule

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.

Step 1: Schedule the Automatic Data Preparation for Customers


To configure an automation schedule that will start the data preparation process for the Customer entity once every
night, 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
Integration with Shopify | 280

• Prepare Mode: Incremental


With this option selected, only data that has been modified since the previous data synchronization will
be placed in the processing queue.
3. In the table, select the Selected check box in the row of the Customer entity.
4. On the form toolbar, click Schedules > Add to open the Automation Schedules (SM205020) form.
5. In the Description box, enter Prepare Customers.
In the Summary area, the system has inserted Prepare Data in the Screen ID box and Prepare All in the
Action Name box.
Also, on the Conditions 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.

Active Field Name Condition Value

Selected Connector Equals Shopify

Selected Store Equals SweetStore - SP

Selected Entity Equals Customer

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.

Active Field Name Value

Selected Store SweetStore - SP

Selected Prepare Mode Incremental

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.

Step 2: Schedule Automatic Data Processing for Sales Orders


To configure an automation schedule that will start data processing for the Customer entity once a day, do the
following:
1. Open the Process Data (BC501500) form.
2. In the Summary area of the form, specify the following settings:
• Store: SweetStore - SP
• Entity: Customer
3. On the form toolbar, click Schedules > Add to open the Automation Schedules (SM205020) form.
4. In the Description box, enter Process Customers.
Integration with Shopify | 281

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.

Active Field Name Value

Selected Store SweetStore - SP

Selected Entity Customer

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).

Automated Synchronization: To Turn On Real-Time Synchronization

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.

Step: Enabling Real-Time Synchronization for Shipments


Perform the following instructions to enable real-time synchronization for shipments:
1. Open the Entities (BC2020PL) form.
2. In the Store Name box of the Selection area, select SweetStore - SP.
3. In the Entity column of the table, click the Shipment link.
The system opens the Entities (BC202000) form with the SweetStore - SP store and the Shipment entity
selected in the Summary area. Notice that this entity can only be exported to the Shopify store (that is, Sync
Direction is set to Export).
4. In the Real-Time Mode box, select Prepare & Process.
With this option selected, when the system creates or updates a synchronization record for a shipment as
part of real-time synchronization, it will also start processing this synchronization record so that out-of-sync
shipment data is saved in the Shopify store.
5. On the form toolbar, click Start Real-Time Sync.
Starting real-time synchronization can take a few seconds. Aer the real-time synchronization is turned on,
Real-Time Export is changed from Stopped to Running.

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.

Automated Synchronization: Business Events for Aborted Records

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.

Table: Predefined Business Events for Aborted Synchronization Records

Business Event ID Description Generic Inquiry Notification Tem-


plate

BCAbortedOrder Triggers notifications for aborted BC-DB-AbortedOrders Aborted Order Noti-


synchronization records of the Sales fication
Order entity

BCAbortedPayment Triggers notifications for aborted BC-DB-AbortedPayments Aborted Payment


synchronization records of the Pay- Notification
ment entity

BCAbortedRefund Triggers notifications for aborted BC-DB-AbortedRefunds Aborted Refund No-


synchronization records of the Re- tification
fund entity

BCAbortedShipment Triggers notifications for aborted BC-DB-AbortedShipments Aborted Shipment


synchronization records of the Ship- Notification
ment entity

For information about email notifications that are triggered by business events, see Business Events: Email
Notifications.

Automated Synchronization: To Activate a Predefined Business Event

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.

Step 1: Specifying the Store Administrator


To specify the administrator of the SweetStore - SP store, do the following:
1. Open the Shopify Stores (BC201010) form.
2. 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.
3. On the form toolbar, click Save.

Step 2: Activating the Business Event


To activate the business event that will trigger the sending of email notifications to the store administrator, do the
following:
1. Open the Business Events (SM302050) form.
2. In the Event ID box of the Summary area, select BCAbortedOrder.
Integration with Shopify | 285

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.

Step 3: Reviewing the Notification Template


To review the template for notifications about aborted sales order synchronization records sent to the
administrator of SweetStore - SP, do the following:
1. While you are still viewing the BCAbortedOrder business event on the Business Events (SM302050) form, on
the Subscribers tab, click the Aborted Order Notification link in the Subscriber ID column.
2. On the Email Templates (SM204003) form, which opens, review the details of the template.
In the To box, notice that instead of a specific user name or email address, a variable is used. So emails are
sent to whoever is specified as the administrator of the store to which the aborted synchronization record
belongs.
On the Message tab, review the details of the aborted synchronization record. The information includes the
store name, the entity type, the local and external identifiers of the record, the last operation, and the last
error. The email body also contains the link to the Sync History (BC301000) form, on which you can review
the status of all synchronization records and resynchronize them aer the issues are resolved.

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.

Customer Synchronization: General Information

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

• 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
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.

Synchronization of Customers Without Customer Locations


Before you can start synchronizing customer records between Acumatica ERP and the Shopify store, you need to
activate the Customer entity for the store. To do this, on the Shopify Stores (BC201010) form, you select the store,
and on the Entity Settings tab, you select the Active check box for the Customer entity. Then on the Customer
Settings tab, you need to also fill in the following boxes:
• 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 default settings. For information about creating a customer
class, see Accounts Receivable: Customer Classes and Customers: Customer Class Settings.
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 Shopify Stores (BC201010) form or to
the company this branch belongs to.
• Customer Numbering Template (available for editing only if the CUSTOMER segmented key has more
than one segment): The template that is used to provide the identifiers of new customers imported to
Acumatica ERP from the Shopify 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 Shopify store, as shown in the following example: ECUS-RET1-######. With
this setting, the identifiers of all customers imported from Shopify 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 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 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 Shopify 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).
Integration with Shopify | 287

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.

Synchronization of Customers with Customer Locations


To save shoppers time on entering address details with each purchase, Shopify provides the ability to store each
customer's shipping addresses in the customer's address book. In Acumatica ERP, you can save more than one
location for a customer account if the Business Account Locations feature is enabled on the Enable/Disable Features
(CS100000) form.
Before you can start synchronizing customer records along with customer location (address) records between
Acumatica ERP and the Shopify store, you need to activate the Customer Location entity for the store. To do
this, on the Shopify Stores (BC201010) 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 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 Shopify 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 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 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 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 Shopify 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.
Integration with Shopify | 288

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.

Creation of a Customer Without an Address


With the Customer and Customer Location entities activated on the Shopify Stores (BC201010) form, when a new
customer is created in the Shopify store without an address, aer the Customer entity is synchronized, a customer
record is created in Acumatica ERP with the MAIN location. In the MAIN location, the system populates the Country
and Ship Via values based on the customer class specified in the Customer Class box on the Customer Settings
tab of the Shopify Stores (BC201010) form. However, the address lines are le blank.
In Acumatica ERP, when a new customer is created, the default MAIN location is always created and specified for
the customer. When the Customer entity is exported, in the Shopify store, this customer is created with an address
record.
The following diagram illustrates the synchronization of customers created without an address.

Figure: Synchronization of customers created without an address

Creation of a Customer Address


If the Customer and Customer Location entities are activated on the Shopify Stores (BC201010) form and a new
address was created for a customer in the Shopify store, during the import of the Customer entity, the e-commerce
connector does one of the following:
• If the default MAIN location has empty address lines, the new address is used to populate the elements of
the MAIN location.
• If the default location has been deleted in Acumatica ERP, and there is a corresponding synchronization
record with the Deleted status on the Sync History (BC301000) form, the e-commerce connector creates a
new location and makes it the default.
• If the default location exists and the address lines in it are filled in, the connector creates a new location.
If a new location was created for a customer in Acumatica ERP, when the Customer entity is exported, the
corresponding new address is created for the customer in the Shopify store with the data of the new location.
The following diagram illustrates the synchronization of a new customer address.
Integration with Shopify | 289

Figure: Synchronization of a new customer address

Editing of a Customer Address


With the Customer and Customer Location entities activated on the Shopify Stores (BC201010) form, if an existing
customer address synchronized with Acumatica ERP is edited in the Shopify store, during the import of the
Customer entity, the corresponding customer location in Acumatica ERP is updated with the changes made to the
customer address in the Shopify store.
If an existing customer location is edited in Acumatica ERP, during the export of the Customer entity, the e-
commerce connector does one of the following:
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 Shopify 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 Shopify 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 Shopify store.
The following diagram illustrates the synchronization of an updated customer address.
Integration with Shopify | 290

Figure: Synchronization of an updated customer address

Deletion of a Customer Address


With the Customer and Customer Location entities activated on the Shopify Stores (BC201010) form, if a customer
address is deleted in the Shopify store, the import of the Customer entity proceeds as follows:
• If the corresponding customer location in Acumatica ERP is not the default customer location, the system
makes it inactive and its synchronization status changes to Deleted.
• If the corresponding customer location in Acumatica ERP is the default customer location, the connector
does one of the following:
• If the customer location is the only active location of a customer, the connector assigns the Deleted
status to the location's synchronization record.
• If other active locations exist for the customer, the connector makes this default location inactive,
assigns the Deleted status to its synchronization record, and makes one of the other active locations the
default one.
If an existing customer location is made inactive in Acumatica ERP, when the Customer entity is exported, the
inactive customer location is not synchronized with the Shopify store.
The following diagram illustrates the synchronization of a deleted customer address.
Integration with Shopify | 291

Figure: Synchronization of a deleted customer address

Customer Synchronization: To Perform Bidirectional Synchronization

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.

Step 1: Reviewing the Synchronization Settings of the Customer Entity


To review the synchronization settings of the Customer entity, do the following:
1. Open the Shopify Stores (BC201010) form.
2. In the Store Name box, select SweetStore - SP.
3. On the Entity Settings tab, in the row with the Customer entity, make sure that the following settings have
been specified:
• Active Selected
• Sync Direction: Bidirectional
• Primary System: External System
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 will be
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.
5. If you have changed any of the settings, click Save on the form toolbar to save your changes.

Step 2 Step 1: Configuring the Filtering Condition


To configure the export of only customer records of the COMMERCEBB customer class, do the following:
1. Open the Entities (BC2020PL) form.
2. In the Store Name box of the Selection area, select SweetStore - SP.
3. In the Entity column of the table, click the Customer link.
The system opens the Entities (BC202000) form with the SweetStore - SP store and the Customer entity
selected in the Summary area.
4. To create a first filtering condition, on the Export Filtering tab, click Add Row on the table toolbar, and
specify the following settings in the row:
• Active: Selected
• Field Name: Customer Class
• Condition: Equals
• Value: COMMERCEBB
5. To create a second filtering condition, and another row and specify the following settings in the row:
• Active: Selected
• Field Name: Email
• Condition: Is Not Empty
6. On the form toolbar, click Save to save your changes.
Integration with Shopify | 294

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.

Step 3 Step 2: Preparing the Customer Data for Synchronization


To prepare the customer data for synchronization, 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
3. In the table, select the Selected check box in the row of the Customer 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.

Step 4 Step 3: Processing the Prepared Customer Data


To process the customer data you have prepared for synchronization, do the following:
1. While you are still viewing the Prepare Data (BC501000) form, click the link in the Ready to Process column
of the row with the Customer entity.
The Process Data (BC501500) form opens with the SweetStore - SP store and the Customer entity selected in
the Summary area. The table displays all synchronization records of the Customer entity that you prepared
in the previous step.
2. On the form toolbar, click Process All to process all 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.

Step 5 Step 4: Reviewing the Synchronization Status


To review the synchronization status of the synchronization records that you processed in Step 4, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area of the form, specify the following settings:
• Store: SweetStore - SP
• Entity: Customer
3. Go to the Processed tab.
The tab shows the items that have been successfully synchronized with the SweetStore - SP store (see
the following screenshot). For each customer, the system displays a Shopify identifier in the External ID
column. In the table, the Last Operation column is set to Inserted Externally and the time stamp in the
Last Attempt column now shows the date and time when you ran data processing on the Process Data
(BC501500) form.
Integration with Shopify | 295

Figure: Processed synchronization records for the Customer entity

Step 6 Step 5: Viewing the Exported Customer Records


To view the FRUITICO and JAMIFIQUE customers in the Shopify store, do the following:
1. While you are still viewing the Sync History (BC301000) form, locate the row with FRUITICO - Coffee and Cakes
in the ERP ID column, and click the link in the External ID column of that row.
The customer page of the admin area of the Shopify store opens.
2. On the customer page, which opens, click Edit right of Customer.
In the Edit customer dialog box, which opens, notice that the First Name and Last Name boxes have been
filled in with the information from the Account Name box of the Account Info section on the Customers
(AR303000) form because the Name box of the Primary Contact section is empty for this customer.
3. Click Cancel to close the Edit customer dialog box.
In the Default address subsection of the Customer section, notice that no address details are specified.
Because the Customer Location entity was not activated on the Entity Settings tab of the Shopify Stores
(BC201010) form, the location information has not been imported to the Shopify store for any of the
customers.
4. In the le menu, click Customers.
5. Click the row of the Colleen Plunkett customer.
6. On the customer page, which opens, click Edit right of Customer.
In the Edit customer dialog box, which opens, notice that the First Name and Last Name boxes have been
filled in with the information saved for the JAMIFIQUE customer from the Name box of the Account Info
section on the Customers (AR303000) form.

Customer Synchronization: To Synchronize Customers with Multiple Locations

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 1: Updating the Synchronization Settings of the Customer Location Entity


To update the synchronization settings of the Customer Locations entity, 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 Entity Settings tab, in the row of the Customer Location entity, select the Active check box.
Notice that all other 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 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 2: Creating a Customer in the Shopify Store


To create a customer and a first address, in the admin area of the Shopify store, do the following:
1. In the le menu of the Shopify admin area, click Customers.
2. On the Customers page, which opens, in the upper right, click Add customer.
3. On the page that opens, specify the following details in the Customer overview section:
• First name: Isabelle
• Last name: Bober
• Email: hoppy_info@example.com
4. In the Country/region box of the Address section, select United States. The State and ZIP code box appears
in the section.
5. In the same section, specify the following details:
Integration with Shopify | 298

• First name: Isabelle


• Last name: Bober
• Company: Hoppy Place Coffee and Cakes
• Address: 3690 Taylor Street
• City: New York
• State: New York
• ZIP code: 10007
6. In the upper right, click Save to save the customer record.
The customer page opens for Isabel Bober. Notice that in the Customer section, the email address is
displayed, and the Default Address section shows the address lines that you entered in this step.

Step 3: Adding an Address for the Customer


To add a second address for the customer you created in the previous step, do the following in the Shopify store:
1. While you are still viewing the Customers page for Isabelle Bober, under Default Address, click Add new
address.The Add new address dialog box opens.
2. In the Country/region box, select United States. The State and ZIP code box appears in the dialog box.
3. Fill in the boxes as follows:
• First name: William
• Last name: Duncan
• Company: Hoppy Wellby
• Address: 2671 Simons Hollow Road
• City: New York
• ZIP code: 10001
4. Click Save to save the address.

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

Step 5: Processing the Prepared Customer and Customer Location Data


To process the customer and customer location data you have prepared for synchronization, do the following:
1. While you are still viewing the Prepare Data (BC501000) form, click the link in the Ready to Process column
of the row with the Customer entity.
The Process Data (BC501500) form opens with the SweetStore - SP store and the Customer entity selected in
the Summary area. The table displays all synchronization records of the Customer entity that you prepared.
2. In the table, select the unlabeled check box in the only row that has a number in the External ID column but
does not have any value in the ERP ID column.
The empty ERP ID indicates that the record has been created in the Shopify 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.

Step 6: Reviewing the Imported Customer and Customer Locations


Perform the following instructions to review the customer and customer locations that have been imported to
Acumatica ERP:
1. Open the Customers (AR3030PL) form.
2. In the list of customers, in the Customer Name column, locate the Isabelle Bober customer, and click the
link for this customer in the Customer ID column.
3. On the Customers (AR303000) form, which opens for Isabelle Bober, on the Locations tab, review the
locations the system created when the customer record was synchronized.
Notice that the table displays the following locations, as shown in the screenshot below:
• The location with the MAIN identifier, which was created for the customer first in the Shopify store. This
location is also marked as the default (that is, the Default check box is selected for this location).
• The location with the identifier that the system assigned to it based on the numbering sequence selected
for locations in the store settings on the Shopify Stores (BC201010) form.

Figure: Customer locations imported from the store

4. Click the MAIN link in the Location ID column.


5. On the Customer Locations (AR303020) form, which the system has opened in a pop-up window, on the
General tab, review the location details that have been imported from the Shopify store.
Integration with Shopify | 300

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.

Step 7: Updating the Customer Location


Suppose that you need to update the contact and address details of the MAIN customer location for Isabelle Bober.
You do the following:
1. While you are still viewing the Customer Locations (AR303020) form with the MAIN location of the Isabelle
Bober customer, on the General tab, in the Additional Location Info section, type Gail Anderson in the
Attention box.
2. In the Location Address section, change Address Line 1 to 3650 Taylor Street.
3. On the form toolbar, click Save & Close to save your changes.

Step 8: Synchronizing the Updated Location with the Shopify Store


To synchronize the updated customer location with the Shopify store in order to update the address in the store, do
the following:
1. On the Sync History (BC301000) form, in the Summary area, specify the following settings:
• Store: SweetStore - SP
• Entity: Customer Location
2. On the Processed tab, select the unlabeled check box in the row of the MAIN, Hoppy Place Coffee and Cakes
location (which you can find in the ERP ID column), and on the form toolbar, click Sync.

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.

Step 9: Reviewing the Updated Customer Address in the Shopify Store


To review the updated customer address in the Shopify store, do the following:
1. While you are still viewing the Sync History (BC301000) form, in the row of the MAIN, Hoppy Place Coffee and
Cakes customer location, click the link in the External ID column.
The customer page of the admin area of the Shopify store opens for Isabelle Bober.
2. Under Default Address, review the updated details of the customer address.
Notice that the first name, last name, and the address line have been updated to reflect the changes that
you made to the customer location. The name is now Gail Anderson, and the address has been changed to
3650 Taylor Street.
Integration with Shopify | 301

Synchronizing Products

In the topics of this chapter, you will read about product synchronization between Acumatica ERP and the Shopify
store.

Product Synchronization: General Information

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 aer the item was synchronized with the
Shopify store so that the changes are reflected in the product settings in the store

Configuration of Product Synchronization


Before exporting stock and non-stock items defined in Acumatica ERP to the Shopify store, you need to perform the
following general steps:
1. Activate the Stock Item and Non-Stock Item entity. To do this, on the Shopify Stores (BC201010) form, you
select the store, and on the Entity Settings tab, you select the Active check box for the Stock Item and Non-
Stock Item entity.
2. Configure the default visibility and purchasability settings for items exported to the Shopify store. For
details, see Product Synchronization: Default Store Settings.
3. Determine which items should be exported and define the visibility and purchasability settings for
individual items. For details, see Product Synchronization: Settings of Individual Items.

Synchronization of Stock and Non-Stock Items


Depending on the item type, the settings of an item in the Shopify store are updated as part of the synchronization
of the Stock Item or Non-Stock Item entity.
During the export, the system updates the availability and visibility settings of each item exported to Shopify based
on the settings specified for the item on the eCommerce tab of the Non-Stock Items form or Stock Items form and
for the store on the Inventory Settings tab of the Shopify Stores (BC201010) form.
For details about the information exported to the Shopify store during the synchronization of a stock and non-stock
item, see Stock Item Entity and Non-Stock Item Entity.
Integration with Shopify | 302

Export of Sales Categories as Tags


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.

Product Synchronization: Default Store Settings

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.

Default Product Availability Settings


On the Inventory Settings tab of the Shopify Stores (BC201010) form, you define the default availability settings
that are applied to items exported from Acumatica ERP. These settings determine whether the exported item can
be purchased in the Shopify store. To define the default availability settings, you select one of the following options
in the Default Availability box:
• Set as Available (Track Qty.): The stock items exported to the Shopify store are available for purchase via the
storefront, and their quantities are tracked, meaning that the items can be purchased only if their quantities
are greater than zero. In Shopify, on the product management page for each of these items, the Online Store
sales channel is listed below the product status and the Track quantity check box in the Inventory section
is selected.
The non-stock items exported to the Shopify store are available for purchase via the storefront, and their
quantities are not tracked (that is, the Track quantity check box in the Inventory section is cleared).
• Set as Available (Don't Track Qty.): The non-stock and stock items exported to the Shopify store are available
for purchase via the storefront, and their quantities are not tracked. In Shopify, on the product management
page for each of these items, the Online Store sales channel is listed below the product status and the Track
quantity check box in the Inventory section is cleared.
• Do Not Update: The availability settings and quantity of the item in the Shopify store are not updated.
• Set as Unavailable: The non-stock and stock items exported to the Shopify store are not available for
purchase. In Shopify, on the product management page for each of these items, the Track quantity check
box (in the Inventory section) is cleared and the Online Store sales channel is not listed below the product
status (in the upper right).

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.

Default Visibility Settings


You can specify visibility settings that will be applied by default to each item exported to the Shopify store on
the Inventory Settings tab of the Shopify Stores (BC201010) form. To instruct the system to make all items by
default immediately available on the storefront aer they are exported to the Shopify store, you select Visible in the
Default Visibility box. To make items by default available for management in the store's admin area but hidden
from the storefront, you select Invisible in this box.

Product Synchronization: Settings of Individual Items

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.

Excluding Items from Synchronization


You can exclude an individual stock or non-stock item from synchronization with the Shopify store (or any other e-
commerce system) by clearing the Export to External System check box on the eCommerce tab of the Stock Items
(IN202500) or Non-Stock Items (IN202000) form.
The status of an item in Acumatica ERP affects the purchasability status of the item in Shopify. 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 the Status
box in the Summary area of the Non-Stock Items (IN202000) form or the Stock Items (IN202500) form—aer the
synchronization of the relevant entity, these items appear with the Online Store sales channel cleared, regardless of
the Availability setting of this item in Acumatica ERP.

Visibility of an Exported Item


You can specify the visibility settings for an individual item on the eCommerce tab of the Stock Items (IN202500) or
Non-Stock Items (IN202000) form. To make the item visible on the storefront immediately aer it is exported, you
select Visible in the Visibility box. To make the item available in the admin area of Shopify store but hidden from
the storefront, you select Invisible in this box.
The option selected in the Visibility box for a particular item takes precedence over the default visibility setting
specified for the store. If Store Default is selected, the store's default visibility setting applies.

Availability of an Exported Item


By default, the availability 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 stock item on the eCommerce tab of the Stock Items (IN202500) form and for a particular non-stock item
on the same tab of the Non-Stock Items (IN202000) form.
The options available for selection in the Availability box on the eCommerce tab are similar to the options of the
Default Availability box on the Shopify Stores form with the following exceptions:
• The Set as Available (Track Qty.) option does not appear in the Availability box for non-stock items.
• The Store Default option (which is not in the Default Availability box) is available in the Availability box
for stock and non-stock items. When this option is selected, the system applies the setting selected in the
Default Availability box on the Inventory Settings tab of the Shopify Stores form.
Integration with Shopify | 304

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,
aer 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 aer 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.

Product Synchronization: Product Images

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.

Export of Product Images


In Acumatica ERP, you can save images for stock and non-stock items in two ways:
• As attachments to an item: On the Attributes tab of the Stock Items (IN202500) and Non-Stock Items
(IN202000) forms
• As links to an external storage: In the Media URLs table on the eCommerce tab of the Stock Items and Non-
Stock Items forms
Images that have been attached to an item on the Stock Items or Non-Stock Items form are exported to the Shopify
store during the synchronization of the Product Image entity. The item they belong to must be exported to the
Shopify store or created in the Shopify store before images attached to it are exported. Of all files attached to the
item on the Stock Items or Non-Stock Items form, the system exports only the files with extensions for which the
Image check box is selected on the File Upload Preferences (SM202550) form.
Images specified as links in the Media URLs table on the eCommerce tab are exported together with the item
(that is, during the synchronization of the Stock Item and Non-Stock Item entities). When the item is exported to the
Shopify store, the images are added to the product management page of the exported item in the control panel
of the Shopify store. For successful synchronization, images must be publicly accessible (that is, access to them
should not require authentication or authorization).
Integration with Shopify | 305

Product Synchronization: To Sync Product Images

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.

Step 1: Adding an Image to the Stock Item


To add an image to the APJAM08 stock item in Acumatica ERP, do the following:
1. Open the Stock Items (IN202500) form.
2. In the Summary area, in the Inventory ID box, select APJAM08.
3. On the Attributes tab, drag each of the files you downloaded to the Image area.
The files are attached to the form. You can browse them in the Image area or access them by clicking Files
on the form title bar. The image that is visible in the Image area, aer being exported, will be the main image
of the product in the Shopify store.
4. On the eCommerce tab, in the Media URLs table, add the image URL as shown in the following table:

URL Type

http://acumatica-builds.s3.amazonaws.com/builds/Universi- Image
ty/CommerceTraining/AppleJam3.png

5. On the form toolbar, click Save.

Step 2: Preparing the Stock Item Data for Synchronization


Before you can synchronize images for a stock item, you need to synchronize the stock item itself. To prepare the
stock item data for synchronization, 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: Full
• Start Date: Cleared
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.

Step 3: Processing the Prepared Stock Item Data


To process the stock item data prepared for synchronization, do the following:
1. While you are still viewing the Prepare Data (BC501000) form, click the link in the Ready to Process column
in the row of the Stock Item entity.
The Process Data (BC501500) form opens with the SweetStore - SP store and the Stock Item entity selected in
the Summary area.
Integration with Shopify | 307

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.

Step 4: Reviewing the Synchronized Stock Item


To review the Apple jam 8 oz. stock item, in the Shopify store, do the following:
1. In the le menu, click Products.
2. On the Products page, which opens, click the row of the Apple jam 8 oz. product to open the product
management page of this product.
Notice that the Media section contains only one image, which you added as an external link to the Media
URLs table on the eCommerce tab of the Stock Items (IN202500) form. Images added to this table are
synchronized as part of the synchronization of the Stock Item entity.
In the next steps, you will synchronize the images that you uploaded on the Attributes tab of the Stock
Itemsform.

Step 5: Preparing the Image Data for Synchronization


To prepare the image data for synchronization, 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
Because you have not processed the Product Image entity before, the system will prepare all images
attached to the synchronized items as it would if Full mode were selected.

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.

Step 6: Processing the Prepared Image Data


To process the image data prepared for synchronization, do the following:
1. While you are still viewing the Prepare Data (BC501000) form, click the link in the Ready to Process column
in the row of the Product Image entity.
The Process Data (BC501500) form opens with the SweetStore - SP store and the Product Image entity
selected in the Summary area. The table displays two synchronization records of the Product Image entity.
Integration with Shopify | 308

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.

Step 7: Reviewing the Synchronized Images


To review the images that have been exported for the Apple jam 8 oz. product, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area of the form, specify the following settings:
• Store: SweetStore - SP
• Entity: Product Image
3. Open the Processed tab.
The table displays two synchronization records of the Product Image entity, as shown in the following
screenshot. In the External ID column, notice that the identifier of each image in the Shopify store consists
of two parts—the identifier of the product and the identifier of the image.

Figure: Synchronization records for the product images

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

Synchronizing Product Availability

The topics of this chapter explain the availability settings of stock items and non-stock items that are exported to
the Shopify store.

Product Availability: General Information

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.

Configuration of Product Availability Synchronization


Before you start exporting available quantities of stock items between Acumatica ERP and a Shopify, you need to
perform the following general steps:
1. Activate the Product Availability entity. To do this, on the Shopify Stores (BC201010) form, you select the
store, and on the Entity Settings tab, you select the Active check box for the Product Availability entity.
2. Specify the quantity calculation settings for the store on the Inventory Settings tab of the Shopify Stores
form. For details, see Product Availability: Calculation of Available Quantities.
3. Determine the stock items for which available quantities should be exported. For more information, see the
Tracking Available Quantities of Exported Stock Items section below.

Tracking Available Quantities of Exported Stock Items


You can track available quantities of stock items exported to a Shopify store and make them available for purchase
via the storefront only when they are in stock. You can also determine how the system should handle items that go
out of stock.
To make an exported stock item available for purchase via the storefront and enable quantity tracking for it, on the
eCommerce tab of the Stock Items (IN202500) form, you select Set as Available (Track Qty.) in the Availability box.
When the item is synchronized, in Shopify, on the product management page for the item, the Online Store sales
channel is listed below the product status and the Track quantity check box in the Inventory section is selected.
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:
Integration with Shopify | 310

• 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.

Synchronization of Availability Settings


The availability (purchasability) settings of a stock item in the Shopify store are updated as part of the
synchronization of the Stock Item entity. During the synchronization, the system updates the availability settings of
each item exported to Shopify based on the option selected in the Availability box on the eCommerce tab of the
Stock Items (IN202500) form.

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.

Synchronization of Available Quantities


Available quantities of stock items are exported to the Shopify store when the Product Availability entity is
synchronized.
The synchronization of the Product Availability entity affects only the stock items that have Availability set to Set as
Available (Track Qty.) on the eCommerce tab of the Stock Items (IN202500) form.
During the synchronization, the system updates the item's quantity in Shopify based on the Warehouse Mode
and Availability Mode settings specified on the Inventory Settings tab of the Shopify Stores (BC201010) form. For
details, see Product Availability: Calculation of Available Quantities.
If the item has no available quantity (that us 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.

Units of Measure of Available Item Quantities


An item's available quantity is exported to the Shopify store in the item's sales unit of measure, which is defined on
the General tab of the Stock Items (IN202500) form. If an item's base UOM is different from its sales UOM, during the
synchronization of the Product Availability entity, the item's available quantity is converted to the sales UOM before
being exported to the Shopify store,

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 aer
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

Product Availability: Calculation of Available Quantities

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.

Product Availability: To Export Product Availability Data

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.

Stock Item Availability When Qty. Unavailable

BANJAM96 Store Default Store Default

BANJAM08 Store Default Store Default


Integration with Shopify | 313

Stock Item Availability When Qty. Unavailable

PLUMJAM96 Set as Available (Track Qty.) Set as Pre-Order/Continue Selling

PLUMJAM08 Set as Available (Track Qty.) Set as Pre-Order/Continue Selling

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.

Step 1: Updating the Default Availability Settings


Now you need to specify the availability settings that the system will apply by default to stock items and non-stock
items exported from Acumatica ERP to the Shopify store. While you are still viewing the Shopify Stores (BC201010)
form for the SweetStore - SP store, do the following:
1. On the Inventory Settings tab, specify the following settings:
• Default Availability: Set as Available (Track Qty.)
With this setting, by default, a stock item exported to the Shopify store will be available for purchase
through the storefront (from the specified Shopify location), and its quantity will be tracked.
Integration with Shopify | 314

• When Qty. Unavailable: Set as Unavailable


With this setting, if the stock item's quantity becomes zero, the stock item will no longer be available for
purchase in the Shopify store.
• Availability Mode: Available for Shipping
• Warehouse Mode: Specific Warehouses
2. In the Warehouse Mapping for Inventory Export table, specify the following settings:
• Warehouse: RETAIL
• Location ID: JS1
• Shopify Location: 2330 Hoffman Avenue (which is the only location in the Shopify that was created when
you registered the SweetStore - SP store)
For each item, only its quantity available for shipping at the JS1 location in the RETAIL warehouse is
synchronized with the Shopify store's location.
3. On the form toolbar, click Save to save the settings.

Step 2: Reviewing the Available Quantities of Items


To review the item quantities available from the RETAIL warehouse, do the following:
1. Open the Storage Details by Item Warehouse Location (IN408055) form.
2. Click the header of the Location ID column, and in the dialog box that opens, select Equals, type JS1 in the
text box, and click OK.
The system now displays only the items that are stored in the JS1 warehouse location. Because in Step 1 you
have set the Availability Mode setting to Available for Shipping, the quantities of the items displayed in the
Location Available for Shipping column (which is shown in the following screenshot) will be synchronized
with the Shopify store. Notice that the BANJAM96 and PLUMJAM96 stock items are available at the JS1
location (a nonzero quantity is displayed for each of these items in the Location Available for Shipping
column), whereas the BANJAM08 and PLUMJAM08 stock items have zero quantities.

Figure: Quantities available for shipping at the JS1 location of the RETAIL warehouse

Step 3: Synchronizing the Product Availability Entity


To synchronize the availability settings and the quantities of the stock items you reviewed in Step 2, do the
following:
1. Open the Prepare Data (BC501000) form.
2. In the Summary area, make sure the following settings are specified:
Integration with Shopify | 315

• 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.

Step 4: Reviewing the Synchronized Data


To review the synchronized availability data, in the admin area of the Shopify store, do the following:
1. In the le menu, click Products.
2. On the Products page, click the row of Banana jam 96 oz..
On the product management page for the Banana jam 96 oz. stock item, which opens, in the Inventory
section, notice that the Track quantity check box is selected and the Continue selling when out of stock
check box is cleared. In the only line in the Quantity table, notice that the quantity in the Available column
is 40.
3. In the le menu, click Products to return to the list of products.
4. On the Products page, click the row of Banana jam 8 oz..
On the product management page for the Banana jam 8 oz. stock item, which opens, in the Inventory
section, notice that the Track quantity check box is selected, the Continue selling when out of stock
check box is cleared. In the only line in the Quantity table, notice that the quantity in the Available column
is zero.
5. At the top of the page, click Preview.
6. On the product page, notice that the Sold out message is displayed for the Banana jam 8 oz item and this
item is not available for purchase.
7. Return to the admin area of the Shopify store.
8. On the Products page, click the row of Plum jam 8 oz..
On the product management page for the Plum jam 8 oz. stock item, which opens, in the Inventory section,
notice that the Track quantity check box and the Continue selling when out of stock check box are
Integration with Shopify | 316

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.

Order Synchronization: General Information

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.

Minimal Configuration of Order Synchronization


To start importing sales orders from the Shopify store, you need to activate the required entities and specify the
minimal settings for the activated entities on the Shopify Stores (BC201010) form. On the Entity Settings 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 Shopify 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 Customer Synchronization: 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, and 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. On the Shipping Settings tab,
you map each shipping option (which is a combination of a shipping zone and shipping method) defined
in the Shopify store with the ship via code and, optionally, shipping zone and shipping terms defined in
Acumatica ERP.
Integration with Shopify | 317

The Order Time Zone


While you are performing the initial configuration of the Shopify store, on the Order Settings tab of the Shopify
Stores (BC201010) form, you can specify the Order Time Zone that 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.

Limiting the Date Range for Order Import


If you have had the Shopify store for a while before implementing Acumatica ERP, you might want to prevent old
orders from being imported to Acumatica ERP when you start synchronizing orders. On the Order Settings tab of
the Shopify Stores (BC201010) form, you specify the Earliest Order Date. Orders created before this date in the
Shopify store will be excluded from synchronization between Acumatica ERP and the Shopify store. Payments and
shipments created for such orders are excluded from synchronization too.

Tracking Imported Sales Orders in the Shopify Store


If your Shopify store accepts a large number of orders, it might be useful to be able to see at a glance which orders
have already been imported to Acumatica ERP. On the Order Settings tab of the Shopify Stores (BC201010) form,
you select the Tag Ext. Order with ERP Order Nbr. check box. When a sales order is imported from the Shopify
store and assigned an order number in Acumatica ERP, the order in Shopify is assigned two tags, ERP and a tag with
the order number from Acumatica ERP.

Mapping of Shipping Options


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
on the Shipping Settings tab of the Shopify Stores (BC201010) form. The Store Shipping Zone and Store Shipping
Method columns of the table are populated with the settings from Shopify automatically for shipping options
defined in the Shopify store.

Configuration of Payment Synchronization


If payments for at least one payment method set up in the Shopify store should be imported to Acumatica ERP, you
need to activate the Payment entity on the Entity Settings tab of the Shopify Stores (BC201010) form.
For each store payment method—that is, each payment method defined and activated in the Shopify 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 Shopify 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 Shopify 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.
Integration with Shopify | 318

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.

Synchronization of Sales Orders and Payments


Orders are imported from a Shopify store during the synchronization of the Sales Order entity. During the data
processing stage of the order import, the system does the following in Acumatica ERP:
1. Creates a sales order on the Sales Orders (SO301000) form. For information about the details and settings
that the system inserts in the created sales order, see Sales Order Entity.

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.

Workflow of Importing a Sales Order with a Manual Payment


The following diagram illustrates the workflow of importing a sales order to Acumatica ERP from a Shopify store
where it was placed and paid by a manual payment method or a card payment method without integrated card
processing.
Integration with Shopify | 319

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.

Order Synchronization: Implementation Checklist

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.

Table: Checklist for Order Import if Payments Do Not Require Processing

Form Criteria to Check

Enable/Disable Features (CS100000) The following features have been enabled:


• Commerce Integration
• Shopify Connector

Shopify Stores (BC201010) The necessary settings have been specified, as demonstrated in the ex-
ample of Initial Configuration: To Configure the Store Connection.

Table: Checklist for Order Import if Payments Require Processing

Form Criteria to Check

Enable/Disable Features (CS100000) The following features have been enabled:


• Commerce Integration
• Shopify Connector

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

Other Settings That Affect the Workflow


You can affect the workflow of the import of orders and payments by specifying additional settings. To
automatically release payments related to the imported order, select the Release Payments check box for the
store payment method on the Payment Settings tab of the Shopify Stores (BC201010) form.

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.

Order Synchronization: Card 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 aer they are imported
to Acumatica ERP.

Configuration of Shopify Payments for Integrated Card Processing


Shopify Payments is a payment provider available to Shopify customers in certain countries and regions. It
supports all major payment methods, does not require additional registration, and can be used as soon as the store
is created. For information about availability of Shopify Payments, see the Shopify documentation.
Before payments based on Shopify Payments can be imported from the Shopify store to Acumatica ERP, you need
to configure payment processing via Shopify Payments as follows:
1. Set up Shopify Payments in your Shopify store.
You activate Shopify Payments on the Payments settings page of your Shopify store. When you set up
Shopify Payments, you might be required to provide information about your business and bank account
details to receive payouts. For information about setting up Shopify Payments in the Shopify store, see the
Shopify documentation.
2. Activate integrated card processing.
You activate integrated card processing (that is, the ability to use additional card processing steps for
AR payments) by selecting the Enable Integrated CC Processing check box on the Accounts Receivable
Preferences (AR101000) form.
3. Configure a processing center for Shopify Payments in Acumatica ERP. You set up the processing center
on the Processing Centers (CA205000) form. During the configuration, you select the Shopify Payments API
plug-in as the Payment Plug-In (Type) and on the Plug-In Parameters tab, you specify the STORENAME
parameter, which is the name of the Shopify store as it is defined on the Shopify Stores (BC201010) form.
4. Configure a card-based payment method in Acumatica ERP.
Aer you have configured the processing center, on the Payment Methods (CA204000) form, you need to set
up a payment method that will be associated with the processing center. For information about setting up
payment methods in Acumatica ERP, see Cash Management: Payment Methods.
5. Map the card-based payment method with the Shopify Payments store payment method.
You map payment methods between Acumatica ERP and the Shopify store on the Shopify Stores (BC201010)
form. When a payment is imported from the Shopify store to Acumatica ERP, a prepayment is created on the
Integration with Shopify | 322

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.

Configuration of Authorize.Net Payment Method for Integrated Card Processing


Authorize.Net is a processing center that accepts transactions through an application programming interface and
processes payments online. Before card payments can be imported from a Shopify store, you need to configure
payment processing via Authorize.Net as follows:
1. Sign up for an Authorize.Net account.
For testing purposes, you can create a sandbox account. You will use the API login, transaction, and
optionally signature key generated during the account creation to connect the processing center to the
Authorize.Net server.
2. Activate integrated card processing.
You activate integrated card processing (that is, the ability to use additional card processing steps for
AR payments) by selecting the Enable Integrated CC Processing check box on the Accounts Receivable
Preferences (AR101000) form.
3. Configure the Authorize.Net processing center.
You set up the processing center on the Processing Centers (CA205000) form. For instructions on setting up a
Authorize.Net processing center in Acumatica ERP, see Integration with Authorize.Net Through the API Plug-in
and To Configure the Authorize.Net Processing Center with the API Plug-in.
4. Configure a card-based payment method.
Aer you have configured the processing center, on the Payment Methods (CA204000) form, you need to
create a payment method that will be associated with the processing center. For information about setting
up payment methods in Acumatica ERP, see Cash Management: Payment Methods.
5. Configure the Authorize.Net payment gateway in the Shopify store.
You set up the Authorize.Net payment provider in the Shopify store using the same API login and transaction
key that you have used to configure the processing center in Acumatica ERP. For information about
configuring the Authorize.Net payment provider in the Shopify store, refer to the Shopify documentation.
6. Map the card-based payment method with the Authorize.Net payment method defined in the Shopify store.
You map payment methods between Acumatica ERP and the Shopify store on the Shopify Stores (BC201010)
form. When a payment is imported from the Shopify store to Acumatica ERP, a prepayment is created on the
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 Authorize.Net payment method,
see Order Synchronization: To Configure and Import Authorize.Net Payments.

Mapping of Card-Based Payment Methods


During the configuration of a connection to the Shopify store, one of the steps you perform is the mapping of
payment methods configured in Acumatica ERP with payment methods configured in the Shopify store. You define
payment method mapping in the table on the Payment Settings tab of the Shopify Stores (BC201010) form.
You specify the following:
• Active: A check box that you select for a payment method to indicate that payments made in the e-
commerce system that are based on should be imported to Acumatica ERP.
• ERP Payment Method: The identifier of the payment method in Acumatica ERP that was configured to use
the same processing center as was used for setting up the payment provider in the online store.
Integration with Shopify | 323

• 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 aer 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 aer 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.

Import of Card Payments with Integrated Card Processing


When the pre-authorized payment is imported from Shopify 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 in the table
on the Payment Settings tab of the Shopify Stores (BC201010) 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, the system creates a row for the last successful operation with the credit card
transaction. In the PC 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. 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 admin area 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 Shopify 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 Shopify | 324

Deferred Processing of Imported Credit Card Payments


Credit card transactions created in Acumatica ERP during the import of payments based on credit card payment
methods require validation if the last operation on the credit card transaction has the Unknown status.
External credit card transactions that meet this condition are displayed on the Deferred Processing Required tab
of the Validate Card Payments (AR513000) form.
Integration with Shopify | 325

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.

Order Synchronization: To Configure and Import Shopify Payments

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 1: Activating Integrated Card Processing


To activate integrated card processing, do the following:
1. Open the Accounts Receivable Preferences (AR101000) form.
2. In the Data Processing Settings section, select the Enable Integrated CC Processing check box.
3. On the form toolbar, click Save.

Step 2: Creating the Processing Center


To create the processing center that will be connected to the Shopify Payments payment gateway, do the following:
1. Open the Processing Centers (CA205000) form.
2. On the form toolbar, click Add New Record, and in the Summary area, specify the following settings:
• Proc. Center ID: SHOPIFYPAY
This processing center represents the connection to the Shopify store for the credit card processing
transactions from the online store.
• Name: Shopify Payments
• Cash Account: 10250ST - Company Merchant Account
This cash account determines the currency in which the system will make the authorization and capture
credit card transactions.
• Active: Selected
• Payment Plug-In (Type): Shopify Payments API plug-in
The selected payment plug-in is a card processing plug-in supplied with Acumatica ERP that interacts
with the Shopify store.
3. While you are still viewing the Processing Centers (CA205000) form with Shopify Payments API plug-in
selected, on the Plug-In Parameters tab, in the table row of the STORENAME parameter, select SweetStore -
SP.
Integration with Shopify | 327

4. On the form toolbar, click Save.


5. On the form toolbar, click Test Credentials to test the connection settings.
If the test connection is successful, the system will display the following confirmation message: The
credentials were accepted by the processing center.

Step 3: Configuring a Payment Method That Represents Shopify Payments


To create the SHOPIFYPAY payment method for all payments by credit card, do the following:
1. Open the Payment Methods (CA204000) form.
2. On the form toolbar, click Add New Record.
3. In the Summary area, specify the following settings:
• Payment Method ID: SHOPIFYPAY
• Active: Selected
• Means of Payment: Credit Card
When you set Means of Payment to Credit Card, on the Settings for Use in AR tab, the Integrated
Processing check box becomes selected, and the Processing Centers tab appears.
• Description: Shopify Payments
• Use in AP: Cleared
• Use in AR: Selected
• Require Remittance Information for Cash Account: Cleared
4. On the Allowed Cash Accounts tab, do the following:
a. On the table toolbar, click Add Row.
b. In the new row, select the 10250ST cash account in the Cash Account column.
c. Make sure the Use in AR check box is selected.
5. On the Processing Centers tab, add a row, and specify the following settings in the row:
• Proc. Center ID: SHOPIFYPAY
• Active: Selected
• Default: Selected
6. On the form toolbar, click Save to save your changes.

Step 4: Activating Shopify Payments in the Shopify Store


To activate the Shopify Payments payment provider in the Shopify store, do the following:
1. In the lower le of the admin area, click Settings.
2. In the le menu of the page that opens, click Payments.
3. On the Payments page, which opens, in the Shopify Payments section, click Activate Shopify Payments.
4. In the Set up Shopify Payments dialog box, which opens, leave the default settings and click Complete
setup. The system opens the Shopify Payments page with additional business details that should be filled in
before you can start receiving payouts. You currently do not need to provide any details.
5. Click Back at the top of the page to return to the Payments page.
6. On the Payments page, click Manage in the upper right of the Shopify Payments section.
7. On the Shopify Payments page, which opens, review the payment method settings, and in the Test mode
section, select the Enable test mode check box.
Integration with Shopify | 328

8. In the lower right, click Save to save your changes.


9. At the top of the page, click Back.
10.On the Payments page, which opens, in the Payment capture section, click Manage.
11.In the Payment capture method dialog box, which opens, select the Manually capture payment for
orders option button, and click Save.

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.

Step 6: Creating an Order Through the Storefront


To purchase a jar of jam, so that you can later import the order and review the credit card payment, in the Shopify
store, do the following:
1. In the le menu of the admin area, under Sales Channels, click the Preview button right of Online Store.
2. On the storefront, start typing plum in the search bar, and in the list of search results, click Plum jam 96 oz.
3. On the page for the Plum jam 96 oz product, change the quantity to 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
melody@example.com.
b. In the Shipping address section, fill in the shipping address boxes as follows:
• Country/region: United States
• First name: Melody
• Last name: Keys
• Address: 3402 Angus Road
• City: New York
• State: New York
• ZIP code: 10003
c. At the bottom of the page, click Continue to shipping.
5. On the order creation page (Shipping step), in the Shipping method section, leave the Economy option
button selected, and click Continue to payment.
Integration with Shopify | 329

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.

Step 7: Reviewing the Sales Order in the Admin Area


To review the sales order that you placed in the previous step, in the admin area of the Shopify store, do the
following:
1. In the le menu, click Orders.
2. On the Orders page, which opens, click the row of the order for Melody Keys.
3. On the order details page, which opens, review the order details.
Notice that the payment status is Authorized and the Capture payment button is displayed.

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, aer /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.

Step 8: Importing the Sales Order


To prepare the sales order data for synchronization and then process it, 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, 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 in the Ready to Process column.
6. 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 only row, and click Process on the form toolbar.
7. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.
Integration with Shopify | 330

Step 9: Reviewing the Imported Sales Order


To review the settings of the imported sales order, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - SP
• Entity: Sales Order
3. On the Processed tab, in the row of the sales order that you have just imported, click the link in the ERP ID
column.
4. On the Sales Orders (SO301000) form, which opens for the imported order, review the settings of the order
(see the following screenshot).

In the Summary area, notice the following:


• The imported order has the EO type (shown in the Order Type), which is configured on the Shopify Stores
(BC201010) form to be assigned to all sales orders imported from the SweetStore - SP store.
• In the Customer Order Nbr. box, the order number assigned to the order in the Shopify store is
displayed.
• In the External Reference box, the order identifier assigned to the order in the Shopify 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 Shopify 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 Shopify store. The customer and location IDs were generated based on
the customer numbering sequence and location numbering sequence specified on the Shopify Stores
(BC201010) form
5. On the Payments tab, review the details of the created payment document of the Prepayment type.
The document includes the external credit card transaction associated with the purchase. The number
of the transaction (which in Shopify is shown in the Timeline section) is displayed in the Payment Ref.
column. The transaction's status, which is Pre-Authorized, is displayed in the Proc. Status column. In the
Payment Ref. box, the order identifier is displayed.
6. On the table toolbar, click Capture.
Once the capture operation is successfully completed, the status of the transaction in the Proc. Status
column is changed to Captured. The document's status has changed from Pending Processing to Open,
which means that the prepayment document has been released.
Integration with Shopify | 331

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.

Order Synchronization: To Configure and Import Authorize.Net Payments

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

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. Sign up for an Authorize.Net sandbox account at https://developer.authorize.net/hello_world/sandbox.html.
Aer 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.
3. Configure Acumatica ERP to use HTTPS. A secure connection with a Secure Socket Layer (SSL) certificate
is required for making transactions to the Authorize.Net payment gateway through the Acumatica ERP
website.
4. Launch the Acumatica ERP website with the U100 dataset preloaded, and sign in with the following
credentials:
• Username: gibbs
• Password: 123

Step 1: Activating Integrated Card Processing


To activate integrated card processing, do the following:
1. Open the Accounts Receivable Preferences (AR101000) form.
2. In the Data Processing Settings section, select the Enable Integrated CC Processing check box.
3. On the form toolbar, click Save.

Step 2: Creating the Processing Center


To create the processing center that will be connected to the Authorize.Net payment gateway, do the following:
1. Open the Processing Centers (CA205000) form.
2. On the form toolbar, click Add New Record, and in the Summary area, specify the following settings:
• Proc. Center ID: AUTHNETCOM
This processing center represents the connection to the Authorize.Net payment gateway for the credit
card processing transactions from the online store.
• Name: Authorize.Net Commerce
• Cash Account: 10250ST - Company Merchant Account
This cash account also determines the currency in which the system will make the authorization and
capture credit card transactions.
• Active: Selected
• Payment Plug-In (Type): Authorize.Net API plug-in
The selected payment plug-in is a card processing plug-in supplied with Acumatica ERP that interacts
with the payment gateway in PCI DSS-compliant mode. The sensitive information of the card is neither
stored in Acumatica ERP nor transferred between the system and the payment gateway.
• Allow Saving Payment Profiles: Selected (default state)
• Synchronize Deletion: Selected (default state)
• Accept Payments from New Cards: Selected (default state)
3. On the form toolbar, click Save.
Integration with Shopify | 333

Step 3: Specifying the Connection Settings for the Processing Center


To configure the connection to the Authorize.Net payment gateway (so that you can use the payment gateway in
test mode), do the following:
1. While you are still viewing the Processing Centers (CA205000) form with Authorize.Net API plug-in selected,
on the Plug-In Parameters tab, specify the values as listed in the following table.

ID Value

MERCNAME The API Login ID of your sandbox account

SIGNKEY Leave empty

TESTMODE 1

TRANKEY The Transaction Key of your sandbox account

VALIDATION Test Mode

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.

Step 4: Configuring a Payment Method That Represents Payments by Card


You can create one payment method for all credit cards, which is the approach you will take in this step.
(Alternatively, to categorize payments in Acumatica ERP by card payment systems, you could create a payment
method for each payment system supported by the gateway and specify the same merchant account for all
payment methods.)
To create the ALLCARDS payment method for all payments by credit card, do the following:
1. Open the Payment Methods (CA204000) form.
2. On the form toolbar, click Add New Record.
3. In the Summary area, specify the following settings:
• ERP Payment Method: ALLCARDS
• Active: Selected
• Means of Payment: Credit Card
• Description: All card payments
• Use in AP: Cleared
• Use in AR: Selected
• Require Remittance Information for Cash Account: Cleared
When you set Means of Payment to Credit Card, on the Settings for Use in AR tab, the Integrated
Processing check box becomes selected, and the Processing Centers tab appears.
4. On the Allowed Cash Accounts tab, do the following:
a. On the table toolbar, click Add Row.
b. In the new row, select the 10250ST cash account in the Cash Account column.
c. Make sure the Use in AR check box is selected.
Integration with Shopify | 334

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 5: Defining the Authorize.Net Payment Gateway in the Shopify Store


To define the Authorize.Net payment method that the store will accept for the United States Dollar (USD) currency,
do the following:
1. Sign in to the Shopify store as the store administrator.
2. In the bottom le of the, click Settings > Payments.
3. On the Payments settings page, which opens, in the Third-party providers section, click Choose third-
party provider.
4. On the Third-party payment providers page, which opens, click the row of Authorize.net.
5. On the payment provider settings page that opens for Authorize.net (Account information section), specify
the API Login ID and Transaction ID of your Authorize.net sandbox account, which you used to create a
processing center in Step 3.
6. In the Test mode section, select the Enable test mode check box.
7. In the bottom right, click Activate Authorize.net.
8. Click Back to return to the Payments page.
9. In the Payment capture section, make sure that the Manually capture payment for orders check box is
selected.
With this setting, the payment is authorized at the time of the order placement, and then you can manually
capture it in the admin area or aer the order is imported to Acumatica ERP.
10.In the bottom right, 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

Step 7: Creating an Order Through the Storefront


To purchase a jar of jam, so that you can later import the order and review the credit card payment, do the
following:
1. Sign in to the admin area of the Shopify store as the store administrator.
2. In the le pane, under Sales Channels, click the Preview button right of Online Store.
3. On the storefront, start typing plum in the search bar, and in the list of search results, click Plum jam 96 oz.
4. On the page for the Plum jam 96 oz product, click Add to Cart.
5. In the top right, click View Cart.
6. On the Your Cart page, which opens, change the quantity of the Plum jam 96 oz product to 3.
7. Click Check Out.
8. 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
melody@example.com.
b. In the Shipping address section, fill in the shipping address boxes as follows:
• First name: Melody
• Last name: Keys
• Address: 3402 Angus Road
• City: New York
• Country/Region: United States
• State: New York
• Postal Code: 10003
c. At the bottom of the page, click Continue to shipping.
9. On the order creation page (Shipping step), in the Shipping method section, select the Economy option
button, and click Continue to payment.
10.On the order creation page (Payment step), in the Payment section, select the Credit card option button,
and specify the following card settings:
• Credit number: 4111 1111 1111 1111
• Name on card: Melody Keys
• Expiration: 12/23
• Security code: 123
11.In the Billing address section, select the Same as shipping address option button.
12.Click Pay now to place and pay your order.
Your order has been created, and on the confirmation page, the order number is displayed. You will process
the order with this order number further in this activity.

Step 8: Reviewing the Sales Order in the Admin Area


To review the sales order that you placed in the previous step, do the following:
1. While you are signed in to the admin area of the Shopify store, in the le menu, click Orders.
2. On the Orders page, which opens, click the row of the order for Melody Keys.
3. On the order details page, which opens, review the order details.
Integration with Shopify | 336

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.

Step 9: Importing the Sales Order


To prepare the sales order data for synchronization and then process it, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Store box of the Summary area, select SweetStore - SP.
3. In the Prepare Mode box, select Incremental.
4. In the table, select the unlabeled check box in the row of the Sales Order entity, and 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 with the number of prepared synchronization records in
the Ready to Process column.
7. On the Process Data (BC501500) form, which opens with the SweetStore - SP store and the Sales Order 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.

Step 10: Reviewing the Imported Sales Order


To review the settings of the imported sales order, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - SP
• Entity: Sales Order
3. On the Processed tab, in the row of the sales order that you have just imported, click the link in the ERP ID
column.
4. On the Sales Orders (SO301000) form, which opens for the imported order, review the settings of the order.
In the Summary area, notice that the Customer Order Nbr. and Description boxes include the order
number from Shopify. In the Customer box, the system has inserted the ID of the customer that was
generated based on the customer numbering sequence defined on the Shopify Stores (BC201010) 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 (which in Shopify is shown in the Timeline)
is displayed in the Payment Ref. column and its status, which is Pre-Authorized, is displayed in the Proc.
Status column.
6. On the table toolbar, click Capture.
Aer the capture operation is successfully completed, Proc. Status is changed to Captured, and the status
of the prepayment document is changed from Pending Processing to Balanced, which means that the
prepayment document can now be released.
Integration with Shopify | 337

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.

Order Synchronization: Export of Orders to the Shopify Store

You can import sales orders placed in Acumatica ERP to the Shopify store.

Setting Up the Order Export


Before sales orders can be exported to a Shopify store, you need to specify the order type of the orders that can be
exported to the Shopify store. To do this, you select the type in the new Order Types for Export box on the Order
Settings tab of the Shopify Stores (BC201010) form.
Order types are available for selection in this box only if they are based on the SO (Sales Order) or SA (Sales Order
with Allocation) order template. The order template of an order type is specified on the Order Types (SO201000)
form.
The export of sales orders follows the same process as the order import does. That is, the Sales Order entity is first
prepared on the Prepare Data (BC501500) form and then processed on the Process Data (BC501500) form. During
the synchronization, the Sync Direction of the Sales Order entity should be set to Export or Bidirectional.
A sales order is exported if it has the order type selected in the store settings on the Shopify Stores form and if it has
one of the following statuses:
• Open
• Pending Processing
• Shipping
• Back Order
• Completed
When a sales order created in Acumatica ERP is exported, it is assigned the Paid status in Shopify regardless of its
open balance in Acumatica ERP. If the sales order has not yet been fully paid, you need to collect the payment and
create the corresponding payment document in Acumatica ERP.

Exporting Customers, Items, and Taxes


A customer specified in a sales order in Acumatica ERP is exported along with the order. If the customer has not
been previously exported to the Shopify store, the retail-commerce connector creates it in the Shopify store and
adds it to the exported sales order during the order export.
Stock and non-stock items added to a sales order in Acumatica ERP must be synchronized with the Shopify store.
Also, each item must be added in its sales unit of measure; otherwise, an error occurs during the export of the sales
order.
The synchronization of the taxes applied to a sales order depends on the state of the Tax Synchronization check
box on the Order Settings tab (Taxes section) of the Shopify Stores (BC201010) form for the store. If the Tax
Synchronization check box is selected, taxes corresponding to the tax IDs from the order settings are created and
applied to the exported sales order in the Shopify store. These tax IDs as listed on the Taxes tab of the Sales Orders
(SO301000) form.

Updating Synchronized Orders


Aer a sales order has been exported from Acumatica ERP to a Shopify store, you can still make changes to
the sales order in Acumatica ERP if these changes do not affect the order total. For example, you can update
Integration with Shopify | 338

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 aer 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 aer the sales order is resynchronized.

Order Synchronization: Import of Order Risk Information

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.

Configuration of the Import of Fraud Analysis Information


To set up the import of fraud analysis data along with sales orders from the Shopify store, you do the following in
the Order section of the Order Settings tab of the Shopify Stores (BC201010) form:
1. Select the Import Order Risks check box.
2. In the new Hold on Risk Status box, which becomes available when you select the check box, select one of
the following options:
• High Risk: The system will assign the Risk Hold status to imported sales orders with high risk.
• Medium or High Risk: The system will assign the Risk Hold status to imported sales orders with medium
risk and high risk.
The risk analysis information is imported from the Shopify store to Acumatica ERP along when the Sales Order
entity is synchronized. For more information about data synchronization, see Data Synchronization: General
Information.

Review of the Imported Risk Analysis Information


If a sales order imported from the Shopify store is assigned the Risk Hold status, before fulfilling the order, you
should review the following order risk information on the Risks tab of the Sales Orders (SO301000) form:
• The status in the Risk Status box, which can be Low, Medium, or High
• The score in the Score % column of the table
• The recommendations in the Recommendation column

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.

Table: Mapping of risk scores and statuses

Score % Risk Status

0.00–20.00 Low
Integration with Shopify | 339

Score % Risk Status

20.00–60.00 Medium

60.00–100.00 High

Aer 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.

Order Synchronization: Import of POS Orders

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.

Configuration of the Import of Shopify POS Orders


To define the import settings for Shopify POS orders, you perform the following steps on the Order Settings tab of
the Shopify Stores (BC201010) form:
1. Select the Import POS Orders check box.
2. In the POS Direct Order Type, select the order type to be assigned to the orders that do not involve
shipping and have already been fulfilled from the brick-and-mortar store. In this box, the order types with
the Invoice order type template are displayed.
3. In the POS Shipping Order Type, select the order type to be assigned to orders with shipping. In this box,
the order types with the Sales Order order type template are displayed. Orders of this type are included in
the shipment export process—that is, when a shipment is created and confirmed for it and the shipment is
synchronized with the Shopify store, the order is also updated in the Shopify store.
4. In the Warehouse Mapping for Order Import, map locations created in Shopify to specific warehouses
and warehouse locations in Acumatica ERP. When an order is imported, the system will assign the mapped
location to each order line. If the warehouses and locations are not specified, the system will use the default
warehouse and location specified in the settings of the item on the Stock Items (IN202500) form.

Create dedicated order types for Shopify POS orders so that it is easier to tell them from other orders.

Import of Archived Shopify POS Orders


By default, orders that have been paid and fulfilled are assigned the Archived status in the Shopify store. Orders
that have been placed in an online store (online orders) with this status are excluded from synchronization
with Acumatica ERP. When the Sales Order entity is prepared for synchronization, such orders are assigned the
Filtered status and are displayed on the Filtered tab of the Sync History (BC301000) form. POS orders, however,
are imported even if they have the Archived status in the Shopify store. When the Sales Order entity is prepared,
archived POS orders are assigned the Prepared status and are displayed on the Ready to Process tab of the Sync
History form.
Integration with Shopify | 340

Importing Orders with Taxes

In this chapter, you will learn how to configure tax synchronization between Acumatica ERP and the Shopify store.

Import of Taxes: General Information

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.

Import of Taxes: Manual Tax Setup

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

Determination of the Tax Zone


During the import of an order, the system searches for the tax zone that should be used for tax calculation as
follows, stopping the search when it finds a qualifying tax zone:
1. The system searches for the primary tax zone.
2. The system searches for the tax zone of the customer location.
3. The system tries to determine the tax zone based on the zip code of the shipping address.
4. The system searches for the default tax zone.

This process is illustrated in the following diagram.


Integration with Shopify | 342

Figure: Determining the tax zone for tax calculation

Import of Taxes: External Tax Provider

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.

Handling of Long Tax Names


If an external tax provider is used for tax calculation, sometimes tax names returned by the external tax provider
can exceed the maximum allowed length of tax IDs supported by Acumatica ERP, (which is currently 60 characters).
Long tax IDs are processed as follows:
• If there is no hyphen in the tax ID, any characters that exceed the maximum length are truncated.
• If there is a hyphen in the tax ID, the tax ID is processed as follows:
• If the tax ID contains the word SPECIAL, the part of the ID to the right of the hyphen is used. Any
characters that still exceed the maximum length are truncated.
• If the tax ID does not contain the word SPECIAL, the part of the ID to the le of the hyphen is used. Any
characters that still exceed the maximum length are truncated.

Import of Taxes: Tax Calculation Mode

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

Import of Taxes: To Set Up Tax Synchronization

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.

Step 1: Configuring Sales Tax Collection in the Shopify Store


To make sure that tax collection is set up in your store for New York State, in the Shopify store, do the following:
1. In the bottom of the le menu, click Settings.
2. In the le menu of the page that opens, click Taxes and duties.
3. On the Taxes and duties page, which opens, in the Countries/regions section, click the line with the United
States region.
Note that the United States tax region appears in this section automatically, because you specified that your
store is physically located in New York.
In the Manage tax collection section, notice that New York is displayed. If it is not displayed, add it as
follows:
a. In the Manage tax collection section, click Collect sales tax in the upper right.
b. In the Collect sales tax dialog box, which opens, in the State box, select New York.
c. Click Collect sales tax to save your changes and close the dialog box.

Step 2: Enabling the Needed Feature


To enable the External Tax Calculation Integration feature, which is required for integration of Acumatica ERP with
Avalara AvaTax, in Acumatica ERP, do the following:
1. Open the Enable/Disable Features (CS100000) form.
2. On the form toolbar, click Modify, and select the External Tax Calculation Integration check box under the
Third-Party Integrations group of features.
3. On the form toolbar, click Enable.

Step 3: Reviewing the Tax Configuration in Acumatica ERP


To review the tax configuration that has been predefined in Acumatica ERP, do the following:
1. Open the Tax Categories (TX2055PL) form.
Notice that there are only two tax categories on the form (TAXABLE and EXEMPT). Tax categories in
Acumatica ERP determine whether exported products will be taxable or non-taxable in the Shopify store.
In the following steps, you will review how these categories are mapped between Acumatica ERP and the
Shopify store.
Integration with Shopify | 346

2. Open the Tax Zones (TX206000) form.


3. In the Tax Zone ID box, select AVALARA.
Notice that the External Tax Provider check box is selected, which indicates that this tax zone is used for
setting up tax calculation by using an external tax provider, and AVALARA is selected as the tax provider.

Step 4: Configuring Tax Synchronization


To configure the synchronization of taxes between Acumatica ERP and the Shopify store, 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. On the Order Settings tab (Taxes section), specify the following settings:
• Tax Synchronization: Selected
• Default Tax Zone: AVALARA
• Use as Primary Tax Zone: Selected
With these settings specified, a sales order placed in the Shopify store will be imported to Acumatica ERP
with sales taxes that have been calculated for the order in the Shopify store. Tax rates and tax amounts
are not recalculated during the order import. However, when a shipment or an invoice is created for the
imported sales order, the taxes are recalculated based on the tax configuration in Acumatica ERP. Because
the AVALARA tax zone has been selected as the primary tax zone, the taxes will be recalculated by the Avalara
AvaTax service.
4. In the Substitution Lists section, note the substitution lists used for taxes (SPCTAXCODES) and tax
categories (SPCTAXCLASSES). These substitution lists are predefined and are inserted as the default values
in these boxes. For the purposes of this activity, you do not need to change the selected values. However, in
a production environment, you can create other substitution lists on the Substitution Lists (SM206026) form
and specify them in these boxes.
5. On the form toolbar, click Save to save your changes.

Step 5: Reviewing the Substitution List for Tax Categories


To make sure that stock and non-stock items exported from Acumatica ERP are assigned the correct tax category in
the Shopify store, do the following:
1. Open the Substitution Lists (SM206026) form.
2. In the Substitution List box, select SPCTAXCLASSES.
Notice that the table contains two rows, shown in the following table.

Original Value Substitution Value

TAXABLE TRUE

EXEMPT FALSE

With these settings, non-stock and stock items that have the TAXABLE tax category in Acumatica ERP, aer
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).

Step 6: Updating the Export Filter for Stock Items


To verify that stock items are exported to the Shopify store with the correct tax category, you need to synchronize
(or resynchronize) them between the two systems. Before you do it, you need to update the filter for stock items so
that more stock items are synchronized with the Shopify store (in this step, you will add stock items of the JUICER
item class). Do the following:
1. Open the Entities (BC2020PL) form.
2. In the Store Name box of the Selection area, make sure SweetStore - SP is selected.
3. In the Entity column of the table, click the Stock Item link.
The system opens the Entities (BC202000) form with the SweetStore - SP store and the Stock Item entity
selected in the Summary area.
4. On the Export Filtering tab, update the filter as follows:

Active Opening Field Name Condition Value Closing Operator


Brackets Brackets

Selected ( Item Class Equals Jam - Or

Selected - Item Class Equals Juicer ) And

5. On the form toolbar, click Save.

Step 7: Exporting the Stock Items


1. Open the Prepare Data (BC501000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - SP
• Prepare Mode: Full
• Start Date: Cleared
• End Date: Cleared
3. In the table, select the Selected check box in the row of the Stock 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 Stock 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 Stock Item entity
selected, click Process All on the form toolbar.
Integration with Shopify | 348

8. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.

Step 8: Viewing the Synchronized Stock Items in the Store


To review the items that have been synchronized between Acumatica ERP and the Shopify store and verify that
they have been exported to the Shopify store with the correct tax category, in the Shopify admin area, do the
following:
1. In the le menu, click Products.
2. On the Products page, click the row of the Commercial citrus juicer with a production rate of 2 liters per
minute product.
3. On the product management page, which opens for the Commercial citrus juicer with a production rate of 2
liters per minute product, review the product details.
Notice that in the Pricing section, the Charge taxes on this product check box is cleared. The system
assigned this tax category to the product because the JUICER20C stock item is assigned the EXEMPT tax
category in Acumatica ERP.
4. In the le menu, click Products to return to the Products page.
5. On the Products page, click the row of the Kiwi jam 96 oz product.
6. On the product management page, which opens for the Kiwi jam 96 oz product, review the product details.
Notice that in the Pricing section, the Charge taxes on this product check box is selected. The system
assigned this tax category to the product because the KIWIJAM96 stock item is assigned the TAXABLE tax
category in Acumatica ERP.

Step 9: Creating a Sales Order in the Shopify Store


To make sure that the taxes applied to taxable products in an online order are imported correctly during the order
synchronization, you need to create an order in the Shopify store and import it to Acumatica ERP.
To create an order with the taxable and non-taxable products, in the admin area of the Shopify store, do the
following:
1. In the le menu, click Orders.
2. On the Orders page, which opens, in the upper right, click Create order.
3. On the Create order page, which opens, in the Products section, start typing Kiwi jam in the search bar.
4. In the list of search results, select Kiwi jam 96 oz, and click Add.
5. In the Customer section, click in the search bar and in the menu that opens, select Melody Keys.
6. In the Payment section, click Add shipping, and in the dialog box, which appears, select the Economy
option button, and click Apply.
7. In the Payment section, click Collect payment > Mark as paid.
For the purposes of this activity, assume that the payment was received outside Shopify.
8. In the Mark as paid dialog box, which appears, click Create order to create the order and close the dialog
box.
The system closes the Mark as paid 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 Unfulfilled fulfillment status.
9. In the Paid section of the order page, which opens, click Show tax rates.
In the Tax rates dialog box, notice that the following taxes have been applied:
• New York State Tax (4%): $2.61
Integration with Shopify | 349

• The Bronx City Tax (4.5%): $2.93


• Metropolitan Commuter Transportation District (0.375%): $0.24
The total tax amount is $5.78.
Notice the identifier of the order (which is the number in the page URL that follows /admin/orders/). You will
use it to identify this order during the order import.

Step 10: Importing the Sales Order


To import the sales order to Acumatica ERP, in Acumatica ERP, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore
• 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.
7. 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 of the sales order that you created (which you can find
by its identifier in the External ID column and empty ERP ID), 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.

Step 11: Reviewing the Taxes in the Imported Sales Order


To review how the taxes are displayed in the imported sales order, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - SP
• Entity: Sales 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, as shown in the
screenshot below.
In the Summary area, the Tax Total amount matches the tax amount of the order in the Shopify store (which
is $5.78).
In the table on the Taxes tab, review the taxes that have been applied to the order lines. Notice that the
table shows the same taxes that you observed on the order page in the Shopify store.
Integration with Shopify | 350

Figure: Imported sales order with taxes

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.

Importing Orders with Discounts

In this chapter, you will learn how to set up the import of orders with discounts from the Shopify store to Acumatica
ERP.

Import of Orders with Discounts: General Information

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.

Displaying of Discounts in Imported Orders


If the Customer Discounts feature is enabled on the Enable/Disable Features (CS100000) form, when you configure
the order synchronization settings, you have the option to select the level at which discounts that have been
Integration with Shopify | 351

applied to an online sales order will be displayed in the order aer 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.

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.

Step 1: Configuring Discount-Related Settings


To update the store settings for the import of online orders with discounts, 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. On the Order Settings tab (Order section), in the Show Discounts As box, select Document Discounts.
With this option selected, the system aggregates discounts applied to particular lines of the order in the
Shopify store and displays these discounts at the document level in the imported sales orders (that is, on
the Discounts tab of the Sales Orders (SO301000) form).
4. Save your changes.

Step 2: Creating a Sales Order


To create an order for ten 96-ounce jars of plum jam, in the Shopify admin area, do the following:
1. In the le menu, click Orders.
2. On the Orders page, which opens, in the upper right, click Create order.
3. On the Create order page, which opens, in the Products section, start typing plum jam in the search bar.
4. In the All products dialog box, which opens with the search results, select the unlabeled check box in the
row with the Plum jam 96 oz product, and click Add.
5. In the row of the Plum jam 96 oz product, change the quantity to 10.
6. Start typing banana jam in the search bar.
7. In the All products dialog box, select the unlabeled check box in the row with the Banana jam 96 oz, and
click Add.
8. In the row of the Banana jam 96 oz product, change the quantity to 10.
9. In the Customer section, click in the search bar and in the menu that opens, select Melody Keys.
10.In the Products section, click the price of the Plum jam 96 oz product ($45.15).
11.In the Add discount dialog box, which opens, in the Discount type box, select Percentage, in the Discount
value box, enter 10, and click Apply.
Notice that the discount has been applied and the product price has changed to $40.64.
12.Click the price of the Banana jam 96 oz product (also $45.15).
13.In the Add discount dialog box, which opens, in the Discount type box, leave Amount, in the Discount
value box, enter 5, and click Apply.
Notice that the discount has been applied and the product price has changed to $40.15.
Integration with Shopify | 353

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.

Step 3: Importing the Sales Order


To import the sales order, 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
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 with the number of prepared synchronization records in
the Ready to Process column.
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.

Step 4: Reviewing the Discount in the Imported Sales Order


To review how the discount is displayed in the imported sales order, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - SP
• Entity: Sales Order
3. On the Processed tab, in the row of the sales order that you have just imported, click the link in the ERP ID
column.
4. On the Sales Orders (SO301000) form, which opens in a pop-up window, review the settings of the sales
order, as shown in the screenshot below.
On the Details tab, notice that in the Discount Amount and Discount Percent column, the system has
inserted zeros in both lines.
Integration with Shopify | 354

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.

Figure: Imported sales order with discounts

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 aer it has been imported to Acumatica ERP.

Importing Non-Card Refunds

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.

Importing Non-Card Refunds: General Information

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.

Configuration of the Import of Refunds


To configure the import of refunds from a Shopify store to Acumatica ERP, you perform the following general steps:
1. Define a return order type.
On the Order Types (SO201000) form, you define an order type to be used for return orders created during
the import of refunds from the Shopify store to Acumatica ERP. A return order type should be created with
the following settings selected on the Template tab:
• Automation Behavior: RMA Order
• Default Operation: Receipt
• AR Document Type: Credit Memo
2. Define an item to represent imported refund amounts.
On the Non-Stock Items (IN202000) form, you define a non-stock item that will represent imported refund
amounts in sales orders and in return orders. For this non-stock item, you should specify the following
settings on the General tab:
• Tax Category: A tax category corresponding to tax-exempt items
• Require Receipt: Cleared
• Require Shipment: Cleared
3. Define a reason code.
On the Reason Codes (CS211000) form, you create a define a reason code to be inserted in return orders for
refunds imported from the Shopify store. This reason code must be of the Issue usage type.
4. Activate the Refund entity.
On the Entity Settings tab of the Shopify Stores (BC201010) form, you activate the Refund entity for the
Shopify store.
5. Specify the refund import settings.
On the Order Settings tab, you specify the identifiers of the entities you have created (in Steps 1 through 3)
in the following boxes:
• Return Order Type
• Refund Amount Item
• Refund Reason Code
6. Specify the payment methods for which you need to import refunds.
On the Payment Settings tab of the Shopify Stores form, you select the Process Refunds check box for
each payment method for which you want to import refunds. For details, see Order Synchronization: General
Information.

Import of Refunds for Non-Card Payment Methods


Refunds are imported from the Shopify store to Acumatica ERP as part of the synchronization of the Refund entity,
which can be synchronized only in the Import direction. During the preparation of refund data for synchronization,
the system creates one synchronization record for all refunds that have been issued for a single sales order in the
Shopify store.
For a refund to be imported successfully, all of the following conditions must be met for the sales order associated
with the refund:
• The original sales order has been synchronized.
Integration with Shopify | 356

• 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.

Importing Non-Card Refunds: Implementation Activity

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

Step 1: Activating the Refund Entity


Before you start importing refunds from the Shopify store to Acumatica ERP, you need to activate the Refund entity
as follows:
1. Open the (BC201000) form.
2. In the Store Name box of the Summary area, select SweetStore - SP, which is the store that you created in
Initial Configuration: To 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's data needs to be synchronized
between Acumatica ERP and the Shopify store.
4. On the form toolbar, click Save to save your changes.

Step 2: Reviewing the Refund Import Settings


To review the settings that will be applied to refunds imported from the Shopify store, do the following:
1. While you are still viewing the Shopify Stores (BC201010) form, go to the Order Settings tab.
2. In the Order section of the Order Settings tab, make sure that the following settings have been specified:
• Return Order Type: ER - eCommerce Return Order
This order type is based on the RC order template.
• Refund Amount Item: REFUNDAMT
This tax-exempt non-stock item is used to represent the refunded amounts in documents.
• Refund Reason Code: EREFUND
This reason code of the Issue usage type is inserted in documents to indicate that the line represents a
refund issued.
3. On the form toolbar, click Save to save your changes.

Step 3: Activating the Import of Refunds for a Non-Card Payment Method


To turn on the import of refunds for the Manual payment method, which you have configured in Initial Configuration:
To Configure the Store Connection, do the following:

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

Selected MANUAL USD ONLINE 10250ST Cleared Selected

3. On the form toolbar, click Save to save your changes.

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

Importing Non-Card Refunds: Implementation Checklist

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.

Form Criteria to Check

Enable/Disable Features (CS100000) The following features have been enabled:


• Commerce Integration
• Shopify Connector
• Custom Order Types

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

Importing Non-Card Refunds: Order-Level Refunds

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 aer 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.

Importing Non-Card Refunds: Item-Level Refunds

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 aer 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.

Importing Non-Card Refunds: To Process a Refund for a Not-Yet-Shipped Order

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.

Step 1: Placing an Order


To create an order for ten 96-ounce jars of banana jam from the Shopify admin area, do the following:
1. In the le menu of the admin area, click Orders.
2. On the Orders page, which opens, in the top right, click Create order.
3. On the Create order page, which opens, in the Order details section, start typing Banana in the search bar.
4. In the list of search results, which are shown in a pop-up window, select Banana jam 96 oz, and click Add to
order.
5. In the row with the Banana jam 96 oz product, change the quantity to 10.
6. In the Find or create a customer section, start typing good in the search bar. In the list of search results,
select GoodFood One Restaurant.
7. In the bottom right, click Save Customer.
Integration with Shopify | 364

8. In the Payment section, click Mark as Paid.


9. In the Mark as paid pop-up window, in the Type of payment received box, select Other and click Create
order.
Note the order number and the identifier of the order in the address bar (the numeric part in the URL that
follows <store_name>.myshopify.com/admin/orders/).

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.

Step 2: Importing the Sales Order


To import the sales order you created in the previous step to Acumatica ERP, do the following:
1. Sign in to Acumatica ERP by using the following credentials:
• Username: gibbs
• Password: 123
2. Open the Prepare Data (BC501000) form.
3. In the Summary area, specify the following settings:
• Store: SweetStore - SP
• Prepare Mode: Incremental
4. In the table, select the unlabeled check box in the row with the Sales Order 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. In the row with 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 - SP store and the Sales Order entity
selected
9. On the form toolbar, click Process All.
10.In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.

Step 3: Reviewing the Imported Sales Order


To review the imported sales order, do the following:
1. Open the Sales Orders (SO3010PL) form.
2. In the list of orders, click the order number link of the last sales order of the EO type for GoodFood One
Restaurant (which is the order you imported in the previous step).
3. On the Sales Orders (SO301000) form, which opens, review the settings of the sales order.
In the Summary area, notice that the Customer Order Nbr. and Description boxes include the order
number from Shopify. In the Customer box, the system has inserted the ID of the customer that was
generated based on the customer numbering sequence defined on the Shopify Stores (BC201010) form.
On the Details tab, review the quantity of the BANJAM96 items, which is 10 pieces.
On the Payments tab, 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
Integration with Shopify | 365

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.

Step 4: Releasing the Imported Payment


To release the payment imported with the sales order from the Shopify store, do the following:
1. While you are still viewing the Payments tab of the Sales Orders (SO301000) form, click the link with the
prepayment number in the Reference Nbr. column.
2. On the form 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.

Step 5: Issuing a Refund for an Individual Item


To issue a refund for units of an individual item in your Shopify store, do the following:
1. Sign in to the admin area of your Shopify store.
2. In the le menu, expand the Orders node and click Orders.
3. On the Orders page, in the list of orders, open the order that you created and imported.
4. On the sales order page, which opens, on the page toolbar, click Refund.
5. On the Refund page, in the item quantity box, specify 3.
6. In the Summary section, review the refunded amount and click Refund $147.48.
The refund amount includes the item subtotal ($135.45) and applicable taxes ($12.03).

Step 6: Importing the Refund


To import the refund to Acumatica ERP, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Store box, select SweetStore - SP.
3. In the Prepare Mode box, select Incremental.
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 with 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.
Integration with Shopify | 366

Step 7: Reviewing the Results of the Import


To review how the refund has been imported to Acumatica ERP, do the following:
1. On the Sales Orders (SO301000) form, open the sales order that you created and imported earlier in this
activity, and review the order as follows:
• On the Details tab, notice that the quantity of the BANJAM96 stock item has been reduced from 10 to 7.
• In the Summary area, notice that the order total has been reduced to reflect the new item quantity.
The Description box now shows the updated status of the order in the Shopify store, which is Partially
Refunded.
2. On the Payments tab, click the link of prepayment number in the Reference Nbr. column.
3. On the Payments and Applications (AR302000) form, which opens with the prepayment selected, notice that
the applied amount and the available balance reflect the reduced order amount and the refunded amount,
respectively.

Step 8: Reviewing and Releasing the Customer Refund


1. Open the Payments and Applications (AR3020PL) form.
In the list of documents, notice that a new Customer Refund document has been created for the refund you
imported in Step 6. (You can identify it by the order number and transaction type shown in the Description
column).
2. In the Reference Nbr. column, click the link with the identifier of the customer refund.
3. On the form toolbar of the Payments and Applications (AR302000) form, which opens with the customer
refund selected, click Remove Hold, and then click Release.
Once the processing of the customer refund is finished, its status changes to Closed.
4. On the Application History tab, which shows the prepayment to which the customer refund was applied, in
the only row, click the link in the Reference Nbr. column.
5. On the Payments and Applications form, which opens with the prepayment selected, notice that the
available balance has become zero.

You have now imported a partial refund for ordered items in an order that has not yet been shipped and processed
this partial refund.

Importing Non-Card Refunds: To Process a Refund for a Shipped Order

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, aer 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

Step 1: Creating a Sales Order in Shopify


To create an order for ten 96-ounce jars of plum jam from the Shopify admin area, do the following:
1. In the le menu of the admin area, click Orders.
2. On the Orders page, which opens, in the top right, click Create order.
3. On the Create order page, which opens, in the Order details section, start typing plum in the search bar.
4. In the list of search results, which are shown in a pop-up window, select Plum jam 96 oz, and click Add to
order.
5. In the row with the Plum jam 96 oz product, change the quantity to 10.
6. In the Find or create a customer section, start typing west in the search bar. In the list of search results,
select West BBQ Restaurant.
7. In the bottom right, click Save Customer.
8. In the Payment section, click Mark as Paid.
9. In the Mark as paid pop-up window, in the Type of payment received box, select Other and click Create
order.
Note the order number and the identifier of the order in the address bar (the numeric part in the URL that
follows <store_name>.myshopify.com/admin/orders/).

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.

Step 2: Importing the Sales Order


To import the sales order you created in the previous step to Acumatica ERP, do the following:
1. Sign in to Acumatica ERP by using the following credentials:
• Username: gibbs
• Password: 123
2. Open the Prepare Data (BC501000) form.
3. In the Summary area, specify the following settings:
• Store: SweetStore - SP
• Prepare Mode: Incremental
4. In the table, select the unlabeled check box in the row with the Sales Order 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. In the row with 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 - SP store and the Sales Order entity
selected.
9. On the form toolbar, click Process All.
Integration with Shopify | 369

10.In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.

Step 3: Reviewing the Imported Sales Order


To review the imported sales order, do the following:
1. Open the Sales Orders (SO3010PL) form.
2. In the list of orders, click the order number link of the last sales order of the EO type for West BBQ
Restaurant.
3. On the Sales Orders (SO301000) form, which opens, review the settings of the sales order.
In the Summary area, notice that the Customer Order Nbr. and Description boxes include the order
number from Shopify. In the Customer box, the system has inserted the ID of the customer that was
generated based on the customer numbering sequence defined on the Shopify Stores (BC201010) form.
On the Details tab, review the quantity of the PLUMJAM96 item, which is 10.
On the Payments tab, 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 (ONLINE and 10250ST, respectively) that were defined in Acumatica ERP
and mapped to the MANUAL store payment method. The prepayment has the Balanced status. Before you
can process and import a refund in the Shopify store, you need to release this prepayment.

Step 4: Releasing the Imported Payment


To release the payment that was imported from the Shopify store along with the sales order, do the following:
1. While you are still viewing the Payments tab of the Sales Orders (SO301000) form, click the link with the
prepayment number in the Reference Nbr. column.
2. On the form 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.
3. Close the pop-up window with the Payments and Applications form to return to the Sales Orders form.

Step 5: Creating a Shipment for the Imported Order


To create a shipment for the order you have imported, do the following:
1. While you are viewing the imported order on the Sales Orders (SO301000) form, click Create Shipment on
the form toolbar.
2. In the Specify Shipment Parameters dialog box, which opens, make sure the current date and the RETAIL
warehouse are selected, and click OK. The system creates a shipment and opens it on the Shipments
(SO302000) form.

Step 6: Confirming the Shipment for the Imported Order


To confirm the shipment for the order, do the following:
1. While you are still viewing the shipment on the Shipments (SO302000) form, review the line on the Details
tab. Make sure of the following:
• The correct order line is included in the shipment.
• The RETAIL warehouse is specified for the item.
• The shipped quantity is equal to the ordered quantity.
Integration with Shopify | 370

2. On the form toolbar, click Confirm Shipment.

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.

Step 7: Synchronizing the Shipment with the Shopify Store


To synchronize with the Shopify store the shipment that you have created and confirmed, do the following:
1. On the Prepare Data (BC501000) form, do the following:
a. In the Summary area, select the following settings:
• Store: SweetStore - SP
• Prepare Mode: Incremental
b. In the table, select the unlabeled check box for the Shipment entity.
c. On the form toolbar, click Prepare.
d. In the Processing dialog box, which opens, review the results of the processing, and click Close when the
processing has completed.
2. In the row with the Shipment entity, click the link in the Ready to Process column.
3. On the Process Data (BC501500) form, which opens with the SweetStore - SP store and the Shipment entity
selected in the Summary area, select the unlabeled check box for the shipment that you created and
confirmed (which you can identify by the shipment number in the ERP ID column).
4. On the form toolbar, click Process.
5. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.

Step 8: Issuing a Refund in the Shopify Store


To issue a refund for units of an individual item in your Shopify store, do the following:
1. Sign in to the admin area of your Shopify store.
2. In the le menu, expand the Orders node and click Orders.
3. On the Orders page, in the list of orders, open the order that you created and imported.
4. On the sales order page, which opens, on the page toolbar, click Refund.
5. On the Refund page, in the item quantity box, specify 2.
6. In the Summary section, review the Refund total amount ($98.32, which includes $8.02 in taxes).
7. To reimburse the customer for having to return part of the purchase, in the Manual box, change the amount
to 108.32.
8. Click Refund $108.32.

Step 9: Importing the Refund


To import the refund to Acumatica ERP, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Store box, select SweetStore - SP.
3. In the Prepare Mode box, select Incremental.
Integration with Shopify | 371

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.

Step 11: Reviewing the Return Order


To review the return orders created in Acumatica ERP as a result of the importing of refunds, do the following:
1. Open the Sales Orders (SO3010PL) form.
Notice that an order of the ER type has been created for the WESTBBQ customer. Because the original sales
order had the Completed status, it could not be modified and the return order was created. The return order
has the ER 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 Non-Card Refunds: Implementation Activity.
2. In the row with the return order for the WESTBBQ customer, click the link in the Order Nbr. column.
3. On the Sales Orders (SO301000) form, which opens with the return order selected, review the order as
follows:
• 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 has inserted
the identifier of the refund in the Shopify store.
• On the Details tab, the system has inserted two lines: one with the returned item (PLUMJAM96) with a
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 Non-Card Refunds: Implementation
Activity.

Step 12: Reviewing the Customer Refund


To review the customer refund created for the return order, do the following:
1. Open the Payments and Applications (AR3020PL) form.
Notice that a document of the Customer Refund type has been created for the WESTBBQ customer.
2. In the row with this customer refund, click the link in the Reference Nbr. column.
3. On the Payments and Applications form, which opens with the customer refund selected, review the
document details.
In the Description box, notice the information about the store name, sales order number, and store
payment method to which the refund was applied. The Available Balance column reflects the amount
refunded in the Shopify store. The Payment Method and Cash Account boxes have the same values as the
original prepayment (ONLINE and 10250ST, respectively).
On the Sales Orders tab, notice that the customer refund has been linked to the return order.
Integration with Shopify | 372

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.

Importing Card Refunds

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.

Importing Card Refunds: General Information

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.

Configuration of Refund Import


To configure the import of refunds from a Shopify store to Acumatica ERP, you perform the following general steps:
1. Define a return order type.
On the Order Types (SO201000) form, you define an order type to be used for return orders imported from
the Shopify store to Acumatica ERP. A return order type should be created with the following settings
selected on the Template tab:
• Automation Behavior: RMA Order
• Default Operation: Receipt
• AR Document Type: Credit Memo
2. Define a refund amount item.
On the Non-Stock Items (IN202000) form, you define a non-stock item that will represent imported refund
amounts in sales orders and in return orders. This non-stock item should be defined with the following
settings on the General tab:
• Tax Category: A category corresponding to tax-exempt items
• Require Receipt: Cleared
Integration with Shopify | 373

• Require Shipment: Cleared


3. Define a reason code.
On the Reason Codes (CS211000) form, you create a define a reason code to be inserted in return orders for
refunds imported from the Shopify store. This reason code must be of the Issue usage type.
4. Activate the Refund entity.
On the Entity Settings tab of the Shopify Stores (BC201010) form, you activate the Refund entity for the
Shopify store.
5. Specify the refund import settings.
On the Order Settings tab, you specify settings in the following boxes:
• Return Order Type
• Refund Amount Item
• Refund Reason Code
6. Specify payment methods for which you need to import refunds.
On the Payment Settings tab of the Shopify Stores form, you select the Process Refunds check box for each
payment method for which you want to import refunds. For store payment methods that are mapped to
card-based payment methods in Acumatica ERP, this check box is selected by default and cannot be edited.

Import of Refunds for Card-Based Payment Methods


Refunds are imported from the Shopify store to Acumatica ERP as part of the synchronization of the Refund entity,
which can be synchronized only in the Import direction. During the preparation of refund data for synchronization,
the system creates one synchronization record for all refunds that have been issued for a single sales order in the
Shopify store.
For a refund to be imported successfully, all of the following conditions must be met:
• The original sales order has been synchronized.
• 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 original payment to which the refund pertains has been imported and released.
For more information about the synchronization process, see Data Synchronization: General Information. For more
information about the import of various types of refunds, see Importing Card Refunds: Order-Level Refunds and
Importing Card Refunds: Item-Level Refunds.

Importing Card Refunds: Implementation Activity

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 1: Activating the Refund Entity


Before you start importing refunds from the Shopify store to Acumatica ERP, you need to activate the Refund entity
as follows:
1. Open the Shopify Stores (BC201010) form.
2. In the Store Name box, select SweetStore - SP.
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 Shopify store.
4. On the form toolbar, click Save to save your changes.
Integration with Shopify | 375

Step 2: Reviewing the Refund Import Settings


To review the settings that will be applied to refunds imported from the Shopify store, do the following:
1. While you are still viewing the Shopify Stores (BC201010) form, go to the Order Settings tab.
2. In the Order section of the Order Settings tab, make sure that the following settings have been specified:
• Return Order Type: ER - eCommerce Return Order
This order type is based on the RC order template.
• Refund Amount Item: REFUNDAMT
This tax-exempt non-stock item is used to represent refunded amounts in documents.
• Refund Reason Code: EREFUND
This reason code of the Issue usage type is inserted in documents to indicate that the line represents a
refund issued.
3. On the form toolbar, click Save to save your changes.

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

Selected SHOPI- USD SHOPIFY- 10250ST SHOPIFY- Cleared Selected


FY_PAY- PAY PAY
MENTS

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.

Importing Card Refunds: Implementation Checklist

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

Form Criteria to Check

Enable/Disable Features (CS100000) The following features have been enabled:


• Commerce Integration
• Shopify Connector
• Custom Order Types

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.

Importing Card Refunds: Order-Level Refunds

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 aer 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.

Importing Card Refunds: Item-Level Refunds

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

Figure: Processing an item refund for a not-yet-shipped Shopify order

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
aer the sales order has been shipped.

Figure: Processing an item return for a shipped Shopify order

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.

Importing Card Refunds: To Process a Refund for a Not-Yet-Shipped Order

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.

Step 1: Placing an Order


To create an order for ten 96-ounce jars of kiwi jam from the Shopify admin area, do the following:
1. In the le menu, under Sales Channels, click the Preview button right of Online Store.
2. On the storefront, start typing kiwi in the search bar, and in the list of search results, click Kiwi jam 96 oz.
3. On the page for the Kiwi jam 96 oz product, click Add to cart.
4. In the top right, click View my cart.
5. On the Your cart page, which opens, change the quantity of the Kiwi jam 96 oz product to 10.
Integration with Shopify | 382

6. Click Check out.


7. 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
melody@example.com.
b. In the Shipping address section, fill in the shipping address boxes as follows:
• First name: Melody
• Last name: Keys
• Address: 3402 Angus Road
• City: New York
• Country/region: United States
• State: New York
• ZIP code: 10003
c. At the bottom of the page, click Continue to shipping.
8. On the order creation page (Shipping step), in the Shipping method section, select the Economy option
button, and click Continue to payment.
9. On the order creation page (Payment step), in the Payment section, select the Credit card option button,
and specify the following card settings:
• Card number: 4242 4242 4242 4242
• Name on card: Melody Keys
• Expiration: 12/23
• Security code: 123
10.In the Billing address section, select the Same as shipping address option button.
11.Click Pay now to place and pay your order.
Your order has been created, and on the confirmation page, the order number is displayed. You will process
the order with this order number further in this activity.

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).

Step 2: Reviewing the Sales Order in the Admin Area


To review the sales order that you placed in the previous step, while you are signed in to the admin area of the
Shopify store, do the following:
1. In the le menu, click Orders.
2. On the Orders page, which opens, click the row with the order for Melody Keys.
3. On the order details page, which opens, review the order details.
Notice that the payment status is Authorized and the Capture payment button is displayed. Because you
have configured the payment provider to only authorize (but not capture) the payment amount when the
order is placed, the payment funds have not yet been captured.
Integration with Shopify | 383

You can view the details of the card transaction by expanding the corresponding link in the
Timeline section.

Step 3: Importing the Sales Order


To import the sales order to Acumatica ERP, do the following:
1. Sign in to Acumatica ERP by using the following credentials:
• Username: gibbs
• Password: 123
2. Open the Prepare Data (BC501000) form.
3. In the Summary area, specify the following settings:
• Store: SweetStore - SP
• Prepare Mode: Incremental
4. In the table, select the Selected check box in the row with the Sales Order 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. In the row with 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 - 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.

Step 4: Reviewing the Imported Sales Order and Payment


To review the imported sales order, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - SP
• Entity: Sales 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 sales order.
In the Summary area, notice that the Customer Order Nbr. and Description boxes include the order
number from Shopify. In the Customer box, the system has inserted the ID of the customer that was
generated based on the customer numbering sequence defined on the Shopify Stores (BC201010) form.
On the Details tab, review the quantity of the KIWIJAM96 items, which is 10 pieces.
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 (which in Shopify is shown in the Timeline
section) is displayed in the Payment Ref. column and its status, which is Pre-Authorized, is displayed in the
Integration with Shopify | 384

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.

Step 5: Capturing and Releasing the Payment


To capture the funds and release the prepayment, do the following:
1. While you are viewing the Payments tab of the Sales Orders (SO301000) form, click the link with the
prepayment number in the Reference Nbr. column.
The Payments and Applications (AR302000) form opens in a pop-up window with the prepayment selected.
2. On the More menu (under Card Processing), click Capture.
Once the funds are successfully captured, the processing status of the payment changes to Captured, and its
status changes from Pending Processing to Balanced.
3. On the form toolbar, click Release to release the payment.
The status of the prepayment changes to Open.

Step 6: Issuing a Refund for an Individual Item


Now you will issue a refund for an individual item. While you are signed in to the admin area of the Shopify store, do
the following:
1. In the le menu, click Orders.
2. On the Orders page, click the row of the order that you created and imported earlier in this activity.
3. On the order page, which opens, click Refund on the page toolbar.
4. On the Refund page, in the item quantity box, specify 3.
In the Summary section, review the refunded amount, which includes the item subtotal ($135.45) and
applicable taxes ($12.02).
5. In the Summary section, click Refund $147.47.

Step 7: Importing the Refund


To import the refund to 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
3. In the table, select the Selected check box in the row with the Refund 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. Click the link in the Ready to Process column in the row with the Refund entity.
7. 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 of the refund (which you can
identify by the number of the order it refers to in the External ID column).
Integration with Shopify | 385

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.

Step 8: Reviewing the Results of the Import


To review how the refund has been imported to Acumatica ERP, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - SP
• Entity: Refund
3. On the Processed tab, in the row of the refund that you have just imported (which you can locate by the
external ID of the related order), click the link in the ERP ID column.
On the Sales Orders (SO301000) form, which opens in a pop-up window, review the order as follows:
• On the Details tab, notice that the quantity of the KIWIJAM96 stock item has been reduced from 10 to 7.
• In the Summary area, the order total has been reduced to reflect the new item quantity. The Description
box now shows the updated status of the order in the Shopify store, which is Partially Refunded.
4. On the Payments tab, click the prepayment number link in the Reference Nbr. column.
On the Payments and Applications (AR302000) form, which opens with the prepayment selected, notice that
the applied amount and the available balance reflect the reduced order amount and the refunded amount,
respectively.

Step 9: Reviewing and Releasing the Customer Refund


1. Open the Payments and Applications (AR3020PL) form.
2. Filter the list of records as follows:
a. In the list of records, click the header of the Description column.
b. In the list of filter conditions, select Contains.
c. In the text box, type SweetStore.
d. Click OK to apply the filter.
In the list of documents, notice that a new Customer Refund document has been created for the refund you
imported in Step 7. (You can identify it by the order number and transaction type shown in the Description
column).
3. Click the link with the identifier of the customer refund in the Reference Nbr. column.
On the Payments and Applications (AR302000) form, which opens with the customer refund selected, review
the details of the customer refund. In the Description box of the Summary area, notice the information
about the store name, sales order number, and store payment method to which the refund was applied.
The Payment Method and Cash Account boxes contain the same settings that were used in the original
prepayment. The Orig. Transaction box shows the identifier of the capture transaction of the original
prepayment.
On the Card Processing tab, notice that the transaction type of the card transaction (shown in the Tran.
Type box) is Refund, and the Proc. Center Response Reason column shows Imported External Transaction,
which indicates that the refund was imported from an external e-commerce system rather than issued in
Acumatica ERP.
4. On the form toolbar, click Release.
Integration with Shopify | 386

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.

Importing Card Refunds: To Process a Refund for a Shipped Order

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, aer 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.

Step 1: Placing an Order


To create an order for ten 96-ounce jars of pear jam from the Shopify admin area, do the following:
1. In the le menu, under Sales Channels, click the Preview button right of Online Store.
2. On the storefront, start typing pear in the search bar, and in the list of search results, click Pear jam 96 oz.
3. On the page for the Pear jam 96 oz product, click Add to cart.
4. In the top right, click View my cart.
5. On the Your cart page, which opens, change the quantity of the Pear jam 96 oz product to 10.
6. Click Check out.
7. 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
melody@example.com.
b. In the Shipping address section, fill in the shipping address boxes as follows:
• First name: Melody
• Last name: Keys
• Address: 3402 Angus Road
• City: New York
• Country/region: United States
• State: New York
• ZIP code: 10003
c. At the bottom of the page, click Continue to shipping.
8. On the order creation page (Shipping step), in the Shipping method section, select the Economy option
button, and click Continue to payment.
9. On the order creation page (Payment step), in the Payment section, select the Credit card option button,
and specify the following card settings:
Integration with Shopify | 388

• Card number: 4242 4242 4242 4242


• Name on card: Melody Keys
• Expiration date: 12/23
• Security code: 123
10.In the Billing address section, select the Same as shipping address option button.
11.Click Pay now to place and pay your order.
Your order has been created, and on the confirmation page, the order number is displayed. You will process
the order with this order number further in this activity.

Step 2: Reviewing the Sales Order in the Admin Area


To review the sales order that you placed in the previous step, while you are signed in to the admin area of the
Shopify store, do the following:
1. In the le menu, click Orders.
2. On the Orders page, which opens, click the row with the order for Melody Keys.
3. On the order details page, which opens, review the order details.
Notice that the payment status is Authorized and the Capture payment button is displayed. Because you
have configured the Shopify Payments 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.
• 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.

Step 3: Importing the Sales Order


To import the sales order to Acumatica ERP, do the following:
1. Sign in to Acumatica ERP by using the following credentials:
• Username: gibbs
• Password: 123
2. Open the Prepare Data (BC501000) form.
3. In the Summary area, specify the following settings:
• Store: SweetStore - SP
• Prepare Mode: Incremental
4. In the table, select the Selected check box in the row with the Sales Order 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. In the row with the Sales Order entity, click the link with the number of prepared synchronization records in
the Ready to Process column.
Integration with Shopify | 389

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.

Step 4: Reviewing the Imported Sales Order and Payment


To review the imported sales order, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - SP
• Entity: Sales 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 sales order.
In the Summary area, notice that the Customer Order Nbr. and Description boxes include the order
number from Shopify. In the Customer box, the system has inserted the ID of the customer that was
generated based on the customer numbering sequence defined on the Shopify Stores (BC201010) form.
On the Details tab, review the quantity of the PEARJAM96 items, which is 10 pieces.
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 (which in Shopify is shown in the Timeline
section) is displayed in the Payment Ref. column and its status, which is Pre-Authorized, is displayed in the
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.

Step 5: Capturing and Releasing the Payment


To capture the funds and release the prepayment, do the following:
1. While you are viewing the Payments tab of the Sales Orders (SO301000) form, click the link with the
prepayment number in the Reference Nbr. column.
The Payments and Applications (AR302000) form opens in a pop-up window with the prepayment selected.
2. On the More menu (under Card Processing), click Capture.
Once the funds are successfully captured, the processing status of the payment changes to Captured, and its
status changes from Pending Processing to Balanced.
3. On the form toolbar, click Release to release the payment.
The status of the prepayment changes to Open.
4. Close the pop-up window with the Payments and Applications form to return to the Sales Orders form.
Integration with Shopify | 390

Step 6: Creating a Shipment for the Imported Order


To create a shipment for the order, do the following:
1. While you are viewing the imported order on the Sales Orders (SO301000) form, click Create Shipment on
the form toolbar.
2. In the Specify Shipment Parameters dialog box, which opens, make sure the current date and the RETAIL
warehouse are selected, and click OK. The system creates a shipment and opens it on the Shipments
(SO302000) form.

Step 7: Confirming the Shipment for the Imported Order


To confirm the shipment for the order, do the following:
1. While you are still viewing the shipment on the Shipments (SO302000) form, review the line on the Details
tab. Make sure of the following:
• The correct order line is included in the shipment.
• The RETAIL warehouse is specified for the item.
• The shipped quantity is equal to the ordered quantity.
2. On the form toolbar, click Confirm Shipment.

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.

Step 8: Synchronizing the Shipment with the Shopify Store


To synchronize with the Shopify store the shipment that you created and confirmed in Steps 6 and 7, do the
following:
1. On the Prepare Data (BC501000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - SP
• Prepare Mode: Incremental
3. In the table, select the Selected check box for the Shipment 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. Click the link in the Ready to Process column in the row with the Shipment entity.
7. On the Process Data (BC501500) form, which opens with the SweetStore - SP 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 number in the ERP ID column).
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.
Integration with Shopify | 391

Step 9: Issuing a Refund in the Shopify Store


Now you will issue a refund for an individual item. While you are signed in to the admin area of your Shopify store,
do the following:
1. In the le menu, click Orders.
2. On the Orders page, click the row of the order that you created and imported earlier in the activity.
3. On the sales order page, which opens, click Refund on the page toolbar.
4. On the Refund page, in the item quantity box, specify 2.
5. In the Summary section, review the Refund total amount ($98.31, which includes $8.01 in taxes)
6. To reimburse the customer for having to return part of the purchase, in the Refund amount box, change the
amount to 108.31.
7. Click Refund $108.31.

Step 10: Importing the Refund


To import the refund to 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
3. In the table, select the Selected check box in the row with the Refund 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. Click the link in the Ready to Process column in the row with the Refund entity.
7. 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 of the refund (which you can
identify by the number of the order it refers to in the External ID column).
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.

Step 11: Reviewing the Return Order


To review the return order created in Acumatica ERP as a result of the refund import, do the following:
1. Open the Sales Orders (SO3010PL) form.
2. Filter the list of records as follows:
a. In the list of records, click the header of the Customer Name.
b. In the list of filter conditions, select Contains.
c. In the text box, type Melody.
d. Click OK to apply the filter.
Notice that an order of the ER type has been created for Melody Keys. Because the original sales order had
the Completed status, it could not be modified and the return order was created. The return order has the ER
Integration with Shopify | 392

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.

Step 12: Reviewing the Customer Refund


To review the customer refund created for the return order, do the following:
1. Open the Payments and Applications (AR3020PL) form.
2. Filter the list of records as follows:
a. In the list of records, click the header of the Customer Name.
b. In the list of filter conditions, select Contains.
c. In the text box, type Melody.
d. Click OK to apply the filter.
Notice that a document of the Customer Refund type has been created for Melody Keys and assigned the
Balanced status.
3. In the row with this customer refund, click the link in the Reference Nbr. column.
On the Payments and Applications (AR302000) form, which opens with the customer refund selected, review
the details of the customer refund. In the Description box of the Summary area, notice the information
about the store name, sales order number, and store payment method to which the refund was applied.
The Payment Method and Cash Account boxes contain the same settings that were used in the original
prepayment. The Orig. Transaction box shows the identifier of the card transaction of the original
prepayment.
On the Sales Orders tab, notice that the customer refund has been linked to the return order.
On the Card Processing tab, notice that the transaction type of the card transaction (shown in the Tran.
Type box) is Refund, and the Proc. Center Response Reason column shows Imported External Transaction,
which indicates that the refund was imported from an external e-commerce system rather than issued in
Acumatica ERP.

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.

Selling and Accepting Gi Cards

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

Gi Cards: General Information

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.

Selling Gi Cards


In order to be able to sell gi cards to customers and then import sales orders containing the gi cards from the
Shopify store to Acumatica ERP, you perform the following general steps:
1. In the admin area of the Shopify store, enable the gi certificate functionality and define gi certificates that
will be available to shoppers online.
2. In Acumatica ERP, define a non-stock item that will be used to represent a gi certificate in imported sales
orders.
3. On the Order Settings tab of the Shopify Stores (BC201010) form, in the Gi Certificate Item box, specify
the created non-stock item that will represent sold gi certificates in imported sales orders.

Accepting Gi Cards as Payment


To be able to import orders that are paid, fully or in part, by gi cards from the Shopify store to Acumatica ERP, you
need to map the store payment method representing a gi card to a payment method defined in Acumatica ERP
on the Payment Settings tab of the Shopify Stores (BC201010) form. For information about payment mapping, see
Order Synchronization: General Information.

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

Gi Cards: Process Activity

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.

Step 1: Configuring Gi Cards in the Store


To enable the gi card functionality, in the Shopify store, do the following:
1. In the le menu, click Products > Gi cards.
2. On the Gi cards page, click Add gi card product.
3. On the Create gi card product page, specify the following settings:
• Title: SweetStore Gift Card
• Product status: Active
In the Denominations section, review the default balances of the gi cards ($10, $25, $50, and $100). Leave
all other settings as they are.
4. In the upper right, click Save to save your changes.

Step 2: Purchasing a Present and a Gi Card


To create an order in which you purchase a $25 gi card, in 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 gift in the search bar, and select SweetStore Gi Card from the list of search
results.
3. On the SweetStore Gi Card page, under Denominations, click $25.00, and then click Add to cart.
4. In the search bar, start typing kiwi, and select Kiwi jam 96 oz from the list of search results.
5. On the product page of Kiwi jam 96 oz, change the quantity to 3, and click Add to cart.
6. In the dialog box that appears, click View my cart.
7. On the Your cart page, click Check out.
8. 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 your email
address.

Specify a real email address to which you have access. The gi card will be sent to this
email aer the order is completed.

b. In the Shipping address section, fill in the address boxes as follows:


• Country/region: United States
• First name: Melody
• Last name: Keys
• Address: 3402 Angus Road
• City: New York
• State: New York
• ZIP code: 10003
c. At the bottom of the page, click Continue to shipping.
9. On the order creation page (Shipping step), select the Economy shipping option, and click Continue to
payment.
10.On the order creation page (Payment step), in the Payment section, specify the following settings under
Credit card:
Integration with Shopify | 396

• Card number: 4242 4242 4242 4242


• Name on card: Melody Keys
• Expiration date: 12/23
• Security code: 123
11.In the Billing address section, select the Same as shipping address option button.
12.Click Pay now to place and pay your order. The confirmation page with the order number opens.

Step 3: Sending the Gi Card to the Customer


To send the gi card to the customer, in the admin area of the Shopify store, do the following:
1. In the le menu, click Orders.
2. On the Orders page, which opens, click the row of the order for Melody Keys that you have created.
3. In the Unfulfilled section with the SweetStore Gi Card, click Send gi card.
4. On the Fulfill item page, which opens, click Fulfill item.
An email with the gi card code is sent to the email address that you have specified earlier in this activity.

Step 4: Reviewing the Settings


To review the gi card settings, in Acumatica ERP, perform the following instructions:
1. Open the Shopify Stores (BC201010) form.
2. In the Store Name box of the Summary area, select SweetStore - SP.
3. On the Order Settings tab, in the Gi Certificate Item box, select GIFTCERT.
4. On the Payment Settings tab, in the row of the GIFT_CARD store payment method, specify the following
settings:
• Active: Selected
• ERP Payment Method: GIFTCARDS
• Cash Account: 10250ST
5. On the form toolbar, click Save.

Step 5: Importing the Order with the Gi Card


To import the created 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 with the number of prepared synchronization records in
the Ready to Process column.
Integration with Shopify | 397

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.

Step 6: Reviewing the Imported Order


To review the details of the imported sales order in Acumatica ERP, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - SP
• Entity: Sales Order
3. On the Processed tab, in the row of the sales order that you have just imported, click the link in the ERP ID
column.
4. On the Sales Orders (SO301000) form, which opens for the imported order, review the order details.
On the Details tab, notice the line with the GIFTCERT non-stock item, which you specified as the Gi
Certificate Item on the Order Settings tab of the Shopify Stores (BC201010) form. The Line Description
column shows the description of the gi card in the Shopify store and the card denomination.

For the purposes of this activity, you do not need to process the created sales order further.

Step 7: Paying for the Order with the Gi Card

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.

d. At the bottom of the page, click Continue to shipping.


5. On the order creation page (Shipping step), in the Shipping method section, make sure that the Economy
option button is selected, and click Continue to payment.
6. On the order creation page (Payment step), in the Payment section, specify the following settings under
Credit card:
• Card number: 4242 4242 4242 4242
• Name on card: Danny Heady
• Expiration date: 12/23
• Security code: 123
7. In the Billing address section, select the Same as shipping address option button.
8. Click Pay now to place and pay your order. The order confirmation page opens. At the top of the page,
notice the order number.

Step 8: Reviewing the Sales Order


To review the sales order, in the admin area of the Shopify store, do the following:
1. In the le menu, click Orders.
2. On the Orders page, which opens, click the row of the order for Danny Heady.
On the order details page, which opens, review the order details.
3. In the Timeline section at the bottom of the page, expand the link of the gi card payment, and then
expand the Information from the gateway link.
Under Gi card last characters, notice the last four characters of the gi card that was used to pay the
order; under Gi card, notice the identifier of the gi card.

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.

Step 10: Reviewing the Imported Sales Order


To review the settings of the imported sales order, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - SP
• Entity: Sales Order
3. On the Processed tab, in the row of the sales order that you have just imported, click the link in the ERP ID
column.
4. On the Sales Orders (SO301000) form, which opens in a pop-up window, review the settings of the order, as
shown in the following screenshot.

Figure: Payment by a gi card applied to the sales order

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

Selling Matrix Items in a Shopify Store

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.

Sale of Matrix Items: General Information

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 aer the template
item was synchronized with the Shopify store, and you need the changes to be reflected in the product
settings in the store.

Configuration of Template Item Synchronization


Before exporting template items defined in Acumatica ERP to the Shopify store, you need to perform the following
general steps:
1. Activate the Template Item entity. on the Shopify Stores (BC201010) form, you select the store, and on the
Entity Settings tab, you select the Active check box for the Template Item entity.
2. Configure the default visibility and purchasability settings for items exported to the Shopify store. For
details, see Product Synchronization: Default Store Settings.
3. Determine which template items and matrix items should be exported and define the visibility and
purchasability settings for individual items.

Synchronization of Template Items


Template items are exported to the Shopify store during the synchronization of the Template Item entity. Matrix
items (both stock items and non-stock items) based on a template item are synchronized along with the template
item.
During the export, the system updates the availability and visibility settings of each item exported to BigCommerce
based on the settings specified for the template item on the eCommerce tab of the Template Items (IN203000)
form, for the matrix items on the eCommerce tab of the Stock Items (IN202500) form or on the Non-Stock Items
(IN202000) form and for the store on the Inventory Settings tab of the Shopify Stores (BC201010) form.
Integration with Shopify | 401

For details about the information exported to the Shopify store during the synchronization of a template item, see
Template Item Entity.

Excluding Items from Synchronization


The template item is exported to the Shopify store if it meets the following criteria:
• The template item's status is Active, No Purchases, or No Request.
• The Export to External System check box is selected for this template item on the eCommerce tab of the
Template Items (IN203000) form.
• At least one matrix item based on this template item has the Active, No Purchases, or No Request status and
Export to External System check box selected on the eCommerce tab of the Stock Items (IN202500) form or
of the Non-Stock Items (IN202000) form.
You can exclude a template item from synchronization with the Shopify store by clearing the Export to External
System check box for this item on the eCommerce tab of the Template Items form.
If you select this check box for a template item, the system also selects it on the eCommerce tab of the Stock
Items form or of the Non-Stock Items form for all matrix items of this template item when these matrix items are
generated.
You can clear the Export to External System check box for an individual matrix item to exclude it from the
export to the Shopify store. If the matrix item has already been exported to the Shopify store, during the next
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.

Visibility of an Exported Template Item


You can specify the visibility settings for an individual template item on the eCommerce tab of the Template Items
(IN203000) form. To make the item visible on the storefront immediately aer it is exported, you select Visible in the
Visibility box. To make the item available in the admin area of Shopify store but hidden from the storefront, you
select Invisible in this box.
The option selected in the Visibility box for a particular template item takes precedence over the default visibility
setting specified for the store. If Store Default is selected, the store's default visibility setting applies.

Availability Settings of Exported Matrix Items


For products with variants in Shopify, available item quantities are tracked on the level of each product variant, not
for an entire product. Because of this, availability settings specified for a template item on the eCommerce of the
Template Items (IN203000) form are not applied when the Template Item entity is synchronized with a Shopify store.

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

Sale of Matrix Items: To Export Matrix Items

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.

The following activity is based on the U100 dataset.

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.

Attribute Attribute Values

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

APL-16OZ-GBT Apple juice in glass bottles of 16 fluid ounces

APL-32OZ-GBT Apple juice in glass bottles of 32 fluid ounces

CHR-32OZ-GBT Cherry juice in glass bottles of 32 fluid ounces

ORG-16OZ-GBT Orange juice in glass bottles of 16 fluid ounces

ORG-32OZ-GBT Orange juice in glass bottles of 32 fluid ounces

PCH-32OZ-GBT Peach juice in glass bottles of 32 fluid ounces


Integration with Shopify | 403

Inventory ID Description

PNL-16OZ-GBT Pineapple juice in glass bottles of 16 fluid ounces

SWB-32OZ-GBT Strawberry juice in glass bottles of 32 fluid ounces

TMT-16OZ-GBT Tomato juice in glass bottles of 16 fluid ounces

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

Step 1: Reviewing the Template Item and the Matrix Items


To review the JUICE template item and the matrix items that have been generated based on it, do the following:
1. Open the Template Items (IN203000) form.
2. In the Template ID box, select JUICE.
3. On the Configuration tab, review the attributes specified for the template item and their settings.
In the Attributes table, notice that the following attributes of the Variant type have been defined (and can
be used for the matrix items of the template item):
• Ingredient
• Package
• Volume
Integration with Shopify | 404

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.

Step 2: Activating the Template Item Entity


You can skip this step, if you activated the Template Item entity while performing the following activity: Initial
Configuration: To Configure the Store Connection.

To activate the Template Item entity, 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 of the Entity Settings tab, select the Active check box in the row of the Template Item entity.
4. On the form toolbar, click Save.

Step 3: Updating the Filtering Condition


To configure the Template Item entity to export to the Shopify store only template items of the MJUICE item class,
do the following:
1. Open the Entities (BC2020PL) form.
2. In the Store Name box of the Selection area, select SweetStore - SP.
3. In the Entity column, click the Template Item link.
The system opens the Entities (BC202000) form with the SweetStore - SP store and the Template Item entity
selected in the Summary area. Notice that this entity can only be exported to the Shopify store (that is, Sync
Direction is set to Export), and that only two tabs, Export Mapping and Export Filtering, are displayed.
4. To create a filtering condition for template items, on the Export Filtering tab, click Add Row on the table
toolbar, and specify the following settings in the row:
• Active: Selected
• Field Name: Item Class
• Condition: Equals
• Value: MJUICE
5. On the form toolbar, click Save to save your changes.
Now when you prepare and process the Template Item entity, only the template items of the MJUICE item
class will be exported to the Shopify store.

Step 3: Preparing the Template Item Data for Synchronization


To prepare the template item data (which includes the data of the matrix items generated based on the template
item) for synchronization, 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
Integration with Shopify | 405

• Prepare Mode: Incremental


• Because you have not processed the Template Item entity for SweetStore - SP before, the system will
prepare all template item records will be prepared as it would if Full mode were selected.
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 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.

Step 4: Processing the Prepared Template Item Data


To process the prepared data of the template item, do the following:
1. While you are still viewing the Prepare Data (BC501000) form with the SweetStore - SP store selected, click
the link in the Ready to Process column in the row of the Template Item entity.
2. On the Process Data (BC501500) form, which opens with the SweetStore - SP store and the Template Item
entity selected, notice that the table contains a single row of the JUICE template item (for which the ERP ID
column shows Juice).
3. On the form toolbar, click Process All.
4. In the Processing dialog box, which opens, review the results of the processing, and click Close to close the
dialog box.

Step 5: Viewing the Exported Item


To view the exported Juice template item in the Shopify store, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area of the form, specify the following settings:
• Store: SweetStore - SP
• Entity: Template Item
3. On the Processed tab, in the row of the Juice template item, click the link in the External ID column.

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.

Sale of Matrix Items: Export of Product Images

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 aer the
template item was synchronized with the Shopify store, and you need the changes to be reflected in the
product settings in the store.

Export of Images for Template Items


In Acumatica ERP, you can associate images with template items in two ways:
• As links to external storage: In the Media URLs table on the eCommerce tab of the Template Items
(IN203000) form
• As attachments to an item: On the Configuration tab of the same form
Images specified as links in the Media URLs table on the eCommerce tab are exported along with the template
item (that is, during the synchronization of the Template Item entity). When the template item is exported to
the Shopify store, the images are added to the Media section of the product management page of the exported
template item. For successful synchronization, images must be publicly accessible (that is, access to them should
not require authentication or authorization).
Images that have been attached to a template item on the Template Items form are exported to the Shopify store
during the synchronization of the Product Image entity. The items the images belong to must be exported to the
Shopify store or created in the Shopify store before the images attached to it are exported. The system exports the
files attached to the item only if they have extensions for which the Image check box is selected on the File Upload
Preferences (SM202550) form.

Export of Images for Matrix Items


In Acumatica ERP, you can attach images to a matrix item on the Attributes tab of the Stock Items (IN202500) or
Non-Stock Items (IN202000) form (depending on the type of the item).

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

Sale of Matrix Items: To Export Product Images

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.

The following activity is based on the U100 dataset.

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

2. Download the following files to your 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

Step 1: Adding an Image to the Template Item


To add an image to the JUICE template item, do the following:
1. Open the Template Items (IN203000) form.
2. In the Summary area, in the Inventory ID box, select Juice.
3. On the Configuration tab, drag the Juice1.png file, which you have downloaded, to the Image area.
The file is uploaded, and you can browse it in the Image area or access it by clicking Files on the form title
bar.
4. On the eCommerce tab, in the Media URLs table, add a row with the settings shown in the following table.

URL Type

http://acumatica-builds.s3.amazonaws.com/builds/Universi- Image
ty/CommerceTraining/Juice3.png

5. On the form toolbar, click Save.

Step 2: Adding an Image to the Matrix Item


To add an image to the PCH-32OZ-GBT stock item, which is a matrix item based on the JUICE template item, do the
following:
1. Open the Stock Items (IN202500) form.
2. In the Summary area, in the Inventory ID box, select PCH-32OZ-GBT.
3. On the Attribute tab, drag the Juice2.png file, which you downloaded, to the Image area.
The file is uploaded, and you can browse it in the Image area or access it by clicking Files on the form title
bar.
4. On the form toolbar, click Save.

Step 3: Synchronizing the Template Item Data


To prepare and process the template item data (which includes the data of the matrix items generated from the
template item) for synchronization, 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
Integration with Shopify | 409

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.

Step 4: Reviewing the Synchronized Images


To review the images that have been exported to the Shopify store for the Juice template item, do the following:
1. Sign in to the admin area of the Shopify store as the store administrator.
2. In the le menu, click Products.
3. On the Products page, which opens, click the row of the Juice product to open its product management
page.
On the product management page of the Juice product, which opens, notice that the Media section
contains only one image; this is the image you added to the Juice template item as an external link in the
Media URLs table on the eCommerce tab of the Template Items (IN203000) form. Images added to this table
are synchronized as part of the synchronization of the Template Item entity.

Step 5: Activating the Product Image Entity


You can skip this step if you have completed the following activity: Product Synchronization: To Sync Product Images.
To activate the Product Image entity, 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 Entity Settings tab, select the Active check box in the row of the Product Image entity.
4. On the form toolbar, click Save.

Step 6: Synchronizing the Product Image Data


To prepare and process the product image data (which includes the data of the images attached to template items
and matrix items) for synchronization, 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 Product Image entity.
4. On the form toolbar, click Prepare.
Integration with Shopify | 410

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.

Step 7: Reviewing the Exported Images


To review the images that have been exported to the Shopify store for the Juice template item and the matrix item,
do the following:
1. In the le menu of the admin area of the Shopify store, click Products.
2. On the Products page, which opens, click the row of the Juice product.
On the product management page of the Juice product, which opens, notice that two more images have
been added to the Media section: one added for the JUICE template item on the Configuration tab of the
Template Items (IN203000) form, and the other added for the PCH-32OZ-GBT stock item on the Attributes tab
of the Stock Items (IN202500) form. Both images were exported during the synchronization of the Product
Image entity. The image that was attached to the template item on the Configuration tab of the Template
Items form is the main product image and appears larger than other thumbnails.
In the Variants section, notice that the image added for the PCH-32OZ-GBT stock item is also displayed for
the peach juice as a thumbnail image.
3. In the top right, click Preview, and review how the imported images are displayed on the product page on
the storefront.
4. At the top of the page, click Catalog, locate the Juice 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.

Sale of Matrix Items: Export of Product Availability Data

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.

Configuration of Product Availability Synchronization


Before you start exporting available quantities of stock items between Acumatica ERP and a Shopify store, you
need to perform the following general steps:
1. Activate the Product Availability entity. To do this, on the Shopify Stores (BC201010) form, you select the
store, and on the Entity Settings tab, you select the Active check box for the Product Availability entity.
2. Specify the quantity calculation settings for the store on the Inventory Settings tab of the Shopify Stores
form. For details, see Product Availability: Calculation of Available Quantities.
3. Determine the matrix items for which available quantities should be exported.

Synchronization of Available Quantities


Available quantities of matrix items are exported to the Shopify store during the synchronization of the Product
Availability entity.
Because available quantities of products with variants in Shopify are tracked on the variant level, the
synchronization of the Product Availability entity affects only the matrix items that have Availability set to Set as
Available (Track Qty.) on the eCommerce tab of the Stock Items (IN202500) form.
During the synchronization, the system updates the matrix item's quantity in Shopify based on the Warehouse
Mode and Availability Mode settings specified on the Inventory Settings tab of the Shopify Stores (BC201010)
form. For details, see Product Availability: Calculation of Available Quantities.
If the matrix item has no available quantity (that us its calculated quantity is less than or equal to zero), the system
updates the matrix item's purchasability settings according to the When Qty. Unavailable setting specified on the
eCommerce tab of the Stock Items form.

Units of Measure of Available Item Quantities


An item's available quantity is exported to the Shopify store in the item's sales unit of measure, which is defined on
the General tab of the Stock Items (IN202500) form. If an item's base UOM is different from its sales UOM, during the
synchronization of the Product Availability entity, the item's available quantity is converted to the sales UOM before
being exported to the Shopify store,

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 aer
changing its sales UOM so that new orders for the item are created in the Shopify store with the
updated UOM.

Sale of Matrix Items: To Export Product Availability Data

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

Step 1: Activating the Needed Entity


You can skip this step if you have completed the following activity: Product Availability: To Export Product Availability
Data.

To activate the Product Availability entity, do the following:


1. Open the Shopify Stores (BC201010) form.
2. On the Entity Settings tab, select the Active check box in the row of the Product Availability entity.
3. On the form toolbar, click Save.

Step 2: Updating the Default Availability Settings


To specify the availability settings that the system will apply by default to items exported from Acumatica ERP to
the Shopify store, 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 Inventory Settings tab, specify the following settings:
• Default Availability: Set as Available (Don't Track Qty.)
• Availability Mode: Available for Shipping
• Warehouse Mode: Specific Warehouses
4. In the Warehouse Mapping for Inventory Export table, add a row with the following settings:
• Warehouse: RETAIL
• Location ID: JS3
• Shopify Location: 2330 Hoffman Avenue
With these settings, by default, items exported to the Shopify store will be available for purchase through
the storefront, and their quantities will not be tracked. For each item, only its quantity available for shipping
in the JS3 location of the RETAIL warehouse is synchronized with the Shopify store.
5. On the form toolbar, click Save to save the settings.

Step 3: Updating the Availability Settings of the JUICE Template Item


To specify the availability settings that the system will apply to the JUICE template item when it is exported from
Acumatica ERP to the Shopify store, do the following:
1. Open the Template Items (IN203000) form.
2. In the Template ID box of the Summary area, select JUICE.
3. On the eCommerce tab, specify the following settings:
• Availability: Set as Available (Track Qty.)
• When Qty. Unavailable: Set as Unavailable
Integration with Shopify | 414

4. On the form toolbar, click Save.

Step 4: Updating the Availability Settings of the Matrix Items


To specify the availability settings that the system will apply to the juice variants (that is, the matrix items
generated based on the JUICE template item) exported from Acumatica ERP to the Shopify store, do the following:
1. Open the Stock Items (IN202500) form.
2. In the Inventory ID box, select PCH-32OZ-GBT.
3. On the eCommerce tab, specify the following settings:
• Availability: Set as Available (Track Qty.)
• When Qty. Unavailable: Do Nothing
4. On the form toolbar, click Save.
5. Repeat the previous instructions for each of the matrix items listed in the following table, and specify the
indicated Availability and When Qty. Unavailable settings.

Stock Item Availability When Qty. Unavailable

ORG-16OZ-GBT Set as Available (Track Qty.) Set as Unavailable

PNL-16OZ-GBT Set as Unavailable N/A

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.

Step 5: Reviewing the Available Quantities of the Matrix Items


To review the available quantities of the matrix items in the RETAIL warehouse, do the following:
1. Open the Storage Details by Item Warehouse Location (IN408055) form.
2. In the Selection area, in the Warehouse box, select RETAIL.
The system displays the quantities of all items stored in the RETAIL warehouse.
3. Click the header of the Location ID column, and in the dialog box that opens, select Equals, type JS3 in the
text box, and click OK.
The system now displays only the items that are stored in the JS3 warehouse location. Notice the item
quantities in the Location Available for Shipping column.

Step 6: Synchronizing the Template Item Data


Before the quantity of a matrix item and its availability settings can be exported, the template item (and the matrix
items based on this template item) must be synchronized with the Shopify store.
To prepare and process the template item data, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - SP
• Prepare Mode: Full
• Start Date: Cleared
• End Date: Cleared
Integration with Shopify | 415

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.

Step 7: Synchronizing the Product Availability Data


To prepare and process the product availability data, do the following:
1. Open the Prepare Data (BC501000) form.
2. In the Summary area, specify the following settings:
• Store: SweetStore - SP
• Prepare Mode: Full
• Start Date: Cleared
• End Date: Cleared
3. In the Entity box of the Summary area, select Product Availability.
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 Product Availability 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 Product
Availability 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.

Step 8: Reviewing the Synchronized Data


To review the synchronized availability data in the Shopify store, do the following:
1. Sign in to the admin area of the Shopify store as the store administrator.
2. In the le menu, click Products.
3. On the Products page, click the row of Juice.
4. On the product management page for the Juice template item, review the exported settings.
In the Variants table, notice that the Quantity column shows quantities for only the PCH-32OZ-GBT and
ORG-16OZ-GBT items.
5. In the row of PCH-32OZ-GBT, click Edit.
6. On the product management page of Peach / Glass bottle / 32 fl oz, notice that the Track quantity and
Continue selling when out of stock check boxes (in the Inventory section) are selected, and in the
Available box of the Quantity subsection, the available quantity of the item is displayed.
7. In the Variants section, click Edit for Pineapple / Glass bottle / 16 fl oz.
Integration with Shopify | 416

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.).

Sale of Matrix Items: Import of Orders with Matrix Items

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.

Import of Orders with Matrix Items


Sales orders containing matrix items are imported from a Shopify store to Acumatica ERP the same way as any
other sales orders placed in the Shopify 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 Shopify 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 Shopify store.

Sale of Matrix Items: To Import an Order with Matrix Items

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.

Step 1: Creating an Order


To create an order for five 32-fluid-ounce bottles of peach juice and five 16-fluid-ounce bottles of apple juice in the
storefront, do the following:
1. In the le menu of the admin area, click Preview right of Online Store.
2. On the storefront, start typing juice in the search bar, and then select Juice in the search results.
3. On the page for Juice, select the following options:
• Ingredient: Peach
• Package: Glass bottle
• Volume: 32 fl oz
4. Click Add to cart.
5. On the page of Juice, select the following options:
• Ingredient: Apple
• Package: Glass bottle
• Volume: 16 fl oz
6. Click Add to cart.
7. In the confirmation pop-up window that opens, click View my cart.
8. In your cart, specify a quantity of 5 for each product, and click Check out.
9. On the order creation page, specify the needed settings as follows:
a. In the Contact information section, in the Email or mobile phone number box, type
melody@example.com.
Integration with Shopify | 418

b. In the Shipping address section, specify the following settings:


• First name: Melody
• Last name: Keys
• Address: 3402 Angus Road
• City: New York
• Country/region: United States
• State: New York
• ZIP code: 10003
c. At the bottom of the page, click Continue to shipping.
10.On the order creation page (Shipping step), in the Shipping method section, make sure that the Economy
option button is selected, and click Continue to payment.
11.On the order creation page (Payment step), in the Payment section, specify the following settings under
Credit card:
• Card number: 4242 4242 4242 4242
• Name on card: Melody Keys
• Expiration date: 12/23
• Security code: 123
12.In the Billing address section, select the Same as shipping address option button.
13.Click Pay now to place and pay your order.
Your order has been created, and on the confirmation page, the order number is displayed. You will process
the order with this order number further in this activity.

Step 2: Importing the Sales Order


To import the order that you created to Acumatica ERP, do the following:
1. Sign in to Acumatica ERP by using the following credentials:
• Username: gibbs
• Password: 123
2. Open the Prepare Data (BC501000) form.
3. In the Summary area, specify the following settings:
• Store: SweetStore - SP
• Prepare Mode: Incremental
4. In the table, select the Selected check box in the row of the Sales Order 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. 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 - SP 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.
Integration with Shopify | 419

Step 3: Reviewing the Imported Sales Order


To review the details of the imported sales order, do the following:
1. Open the Sync History (BC301000) form.
2. In the Summary area of the form, specify the following settings:
• Store: SweetStore - SP
• Entity: Sales 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 for the imported order, review the order details.
On the Details tab, notice that a separate line was added for each product variant that was sold. The
Inventory ID column contains the identifiers of the matrix items generated for the JUICE template item
(which are PCH-32OZ-GBT and APL-16OZ-GBT) and not the identifier of the JUICE template item itself.

For the purposes of this activity, you do not need to process the sales order.
Retail-Commerce Edition Form Reference | 420

Retail-Commerce Edition Form Reference


This section describes the UI elements on forms that are specific to Acumatica ERP Retail-Commerce Edition.

BigCommerce Stores

Form ID: (BC201000)


You use this form to set up a connection to an online store created on the shopping cart soware hosted by
BigCommerce. Aer the connection has been established, on this form, you specify the store settings, select
the entities that need to be synchronized, and define the default settings for the synchronization of customers
and customer locations, inventory items, and orders. You also use this form to map shipping rules and payment
methods between Acumatica ERP and the BigCommerce store.
During the initial specification of settings, the required settings on the Entity Settings, Customer Settings,
Inventory Settings, Order Settings, and Payment Settings must be specified at the same time. You will not be
able to save your changes until all required settings on these tabs of the form are filled in.

• 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.

Connection Settings Tab


The connection settings tab includes the path and connection details that are used to connect Acumatica ERP to
the BigCommerce 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.

Table: REST Settings Section

Element Description

API Path The URL of the BigCommerce API.

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

Table: WebDAV Settings Section

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.

Table: System Settings Section

Element Description

Locale The locale of Acumatica ERP to be synchronized with the BigCommerce


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 BigCommerce store.

Table: Store Properties Section


The read-only boxes of this section are filled in automatically as soon as the connection to the BigCommerce store
is established.

Element Description

Default Currency The currency specified as the default in the BigCommerce store.

Store Time Zone The time zone of the BigCommerce store.

Table: Store Administrator Details Section

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

Table: License Restrictions Section

Element Description

Max. Number of Stores The maximum number of BigCommerce stores that can be connected to the
Acumatica ERP instance.

Entity Settings Tab


The rows of this tab are automatically populated with the entities that can be synchronized between Acumatica
ERP and the BigCommerce store. You can activate the entities that you need to synchronize between the systems;
you can also view and specify synchronization settings for these entities.
The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.

Table: Table Columns

Column Description

Active A check box that indicates (if selected) that the entity is synchronized be-
tween Acumatica ERP and the BigCommerce store.

If an entity requires other entities to be synchronized when


this entity is synchronized, if you select this check box for the
entity, the system also selects the Active check box for these
required entities.

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.

Customer Settings Tab


The settings that you specify on this tab are used to create customers and customer locations in Acumatica ERP
when you import customers and customer addresses from the BigCommerce store.

Table: Customer Section

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.

Inventory Settings Tab


This tab contains the default inventory settings that need to be set up in Acumatica ERP for exporting items to the
BigCommerce store.

Table: Inventory Settings Section

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.

Order Settings Tab


On this tab, you define the default settings for the import of sales orders. You also map shipping zones and shipping
rules between Acumatica ERP and the BigCommerce store, and specify if taxes should be synchronized between
the two systems.
Retail-Commerce Edition Form Reference | 432

Table: General Section

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.

Table: Order Section

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.

Table: Taxes Section

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.

Table: Substitution Lists Section

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.

Table: Shipping Option Mapping Table


In this table, you define the mapping of each shipping option (which is a combination of a shipping zone and
shipping method) defined in BigCommerce 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 BigCommerce when the correct API credentials are entered and saved on the
Connection Settings tab. The list of mappings can be updated in the following ways:
• The system automatically adds the shipping options (store shipping zones and store shipping methods) to
the table or removes them from the table based on the shipping options that are active in the BigCommerce
store. You can make changes to the settings in the Ship Via, Shipping Zone, and Shipping Terms columns.
However, you cannot remove the automatically added shipping options by using the Delete Row button on
the table toolbar.
• You can manually add rows for active shipping options in the BigCommerce store by using the Add Row
button on the table toolbar; you can also delete the manually added rows by using the Delete Row button
on the table toolbar.
• The system automatically adds a shipping option to the table if during the sales order import, the shipping
zone and the shipping method specified in a particular sales order is missing from the table.
The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.

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.

Payment Settings Tab


On this tab, you map the payment methods configured in the BigCommerce store with the payment methods
defined in Acumatica ERP. The Store Payment Method and Store Currency columns are initially populated
based on the settings from the BigCommerce store when the correct API credentials are entered and saved on
the Connection Settings tab. Whenever a new payment method is created in the BigCommerce store, a row is
automatically added to this table with the Store Payment Method and Store Currency columns filled in. You can
manually add rows to the table by clicking Add Row on the table toolbar and delete manually added rows from the
table by clicking Delete Row on the table toolbar. If you delete a row that was automatically added to the table by
the API, the deleted row will reappear when you click Refresh on the table toolbar or Save on the form toolbar.
The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.
Retail-Commerce Edition Form Reference | 436

Table: Table Columns

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

Form ID: (BC201010)


You use this form to set up a connection to an online store created on the shopping cart soware hosted by Shopify.
Aer the connection has been established, on this form, you specify the store settings, select the entities that
need to be synchronized, and define the default settings for the synchronization of customers and customer
locations, inventory items, and orders. You also use this form to map shipping rules and payment methods
between Acumatica ERP and the Shopify store.
During the initial specification of settings, the required settings on the Entity Settings, Customer Settings,
Inventory Settings, Order Settings, and Payment Settings must be specified at the same time. You will not be
able to save your changes until all required settings on these tabs of the form are filled in.

• 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.

Connection Settings Tab


The connection settings tab includes the path and connection details that are used to connect Acumatica ERP to
the Shopify store.
Retail-Commerce Edition Form Reference | 439

Table: Store Settings Section

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.

Store Plan The subscription plan of the Shopify store.

Table: System Settings Section

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.

Table: Store Properties Section


The read-only boxes of this section are filled in automatically as soon as the connection to the Shopify store is
established.

Element Description

Store URL The URL of the Shopify store.

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.

Store Time Zone The time zone of the Shopify store.

API Version The version of the Shopify API used in the Acumatica ERP instance.

Table: Store Administrator Details Section

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

Table: License Restrictions Section

Element Description

Max. Number of Stores The maximum number of Shopify stores that can be connected to the
Acumatica ERP instance.

Entity Settings Tab


The rows of this tab are automatically populated with the entities that can be synchronized between Acumatica
ERP and the Shopify store. You can activate the entities that you need to synchronize between the systems; you can
also view and specify synchronization settings for these entities.
The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.

Table: Table Columns

Column Description

Active A check box that indicates (if selected) that the entity is synchronized be-
tween Acumatica ERP and the Shopify store.

If an entity requires other entities to be synchronized when


this entity is synchronized, if you select this check box for
the entity, the system also selects the Active check box for
these required entities.

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.

Customer Settings Tab


The settings that you specify on this tab are used to create customers and customer locations in Acumatica ERP
when you import customers and customer addresses from the Shopify store.

Table: Customer Section

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.

Inventory Settings Tab


This tab contains the default inventory settings that need to be set up in Acumatica ERP for exporting items to the
Shopify store.

Table: Inventory Settings Section

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

Table: Warehouse Mapping for Inventory Export Table


In this table, you can select the specific warehouses and locations in Acumatica ERP whose item quantities should
be used to calculate the item's available quantity and map them to specific warehouse locations in Shopify. 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 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.

Order Settings Tab


On this tab, you define the default settings for the import of sales orders. You also map shipping zones and shipping
rules between Acumatica ERP and the Shopify store, and specify if taxes should be synchronized between the two
systems.

Table: General Section

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

Table: Order Section

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.

You can select this option only if the Customer Dis-


counts feature is enabled on the Enable/Disable Features
(CS100000) form.
Retail-Commerce Edition Form Reference | 449

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.

Table: Taxes Section

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.

Table: Substitution Lists Section

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.

Table: POS Order Section


In this section, you can turn on the import of point-of sale (POS) orders from the Shopify store to Acumatica ERP
and specify the order types to be used for orders that involve and do not involve shipping. This section is displayed
only if the Shopify and Shopify POS Connector feature is enabled on the Enable/Disable Features 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.

Table: Warehouse Mapping for Order Import Table


In this table, you can specify the warehouses and warehouse locations in Acumatica ERP that the system should
use for each of the order lines when importing the orders from the Shopify store. If the warehouses and locations
are not specified, the system will use the default warehouse and location specified in the settings of the item on the
Stock Items (IN202500) form. The table is displayed only if the Shopify and Shopify POS Connector feature is enabled
on the Enable/Disable Features form.
Retail-Commerce Edition Form Reference | 451

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.

Payment Settings Tab


On this tab, you map the payment methods configured in the Shopify store with the payment methods defined in
Acumatica ERP. The Store Payment Method column is initially populated based on the settings from the Shopify
store when the correct API credentials are entered and saved on the Connection Settings tab. Whenever a new
payment method is created in the Shopify store, a row with the populated Store Payment Method column is
automatically added to this table. You can add rows to the table by clicking Add Row on the table toolbar and
delete manually added rows from the table by clicking Delete Row. If you delete a row that was added to the table
by the API, the deleted row will reappear when you click Refresh on the table toolbar or Save on the form toolbar.
The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.

Table: Table Columns

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.

Shipping Settings Tab


In the table on this 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. The list of mappings can be updated in the following ways:
• The system automatically adds the shipping options (store shipping zones and store shipping methods)
to the table or removes them from the table based on the shipping options that are active in the Shopify
store. You can make changes to the settings in the Ship Via, Shipping Zone, and Shipping Terms columns.
However, you cannot remove the automatically added shipping options by using the Delete Row button on
the table toolbar.
• You can manually add rows for active shipping options in the Shopify store by using the Add Row button on
the table toolbar; you can also delete the manually added rows by using the Delete Row button on the table
toolbar.
• The system automatically adds a shipping option to the table if during the sales order import, the shipping
zone and the shipping method specified in a particular sales order is missing from the 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

Form ID: (BC202000)


On this form, you specify the import and export settings for entities supported by the e-commerce connector.
Additionally, you can configure filters to determine which data needs to be synchronized or excluded from the
synchronization process. You can also use this form to define the rules for mapping Acumatica ERP fields to fields in
the online store—for example, to map additional standard or custom fields or to override the default mapping.
Retail-Commerce Edition Form Reference | 454

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.

Table: Start Real-Time Sync Dialog Box

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.

The dialog box also contains the following buttons.

Continue Starts the real-time synchronization process, sets the Real-Time Import
status to Running for the selected entity, and closes the dialog box.

Cancel Closes the dialog box without starting real-time synchronization.

Table: Clear Sync Data 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.

The dialog box also contains the following buttons.

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

Cancel Closes the dialog box without deleting synchronization information.

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.

Store The name of the online store.


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, but you can select another store.

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  

• Product Image (predefined as Export)


• Product Availability (predefined as Export)
• Payment (predefined as Import)
• Shipment (predefined as Export)
• Refund (predefined as Import)
For the Shopify stores, the direction of the synchronization is inserted 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)
• 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 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.

Import Mapping Tab


By using the table on this tab, you configure the mapping of standard or custom fields to be used in import
processing. This tab is displayed only if the Import direction is supported for the selected entity. You can use the
drag-and-drop functionality to arrange rows of the table in the needed order.
The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.

Table: Table Columns

Column Description

Active A check box that indicates (if selected) that the import
mapping rule is active.

Target Object The object in Acumatica ERP whose field is mapped to


the field of the object in the external system.
The list of available options depends on the selected
entity.
Retail-Commerce Edition Form Reference | 458

Column Description

Target Field The field of the selected target object in Acumatica


ERP that is mapped to the field of the object in the ex-
ternal system.
The list of fields available for selection depends on the
selected target object.

Source Object The object in the external e-commerce system whose


field is mapped to the field of the object in Acumatica
ERP.
The list of available options depends on the selected
entity and the e-commerce connector.

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.

Import Filtering Tab


By using the table on this tab, you can set up the rules according to which data will be included in or excluded from
the import processing. This tab is displayed only if the Import direction is supported for the selected entity. You can
use the drag-and-drop functionality to arrange rows of the table in the needed order.
The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.

Table: Table Columns

Column Description

Active A check box that indicates (if selected) that the condi-
tion is active and is used for filtering.

Opening Brackets The opening bracket or brackets for enclosing a logi-


cal expression. Brackets are used to designate the or-
der of the operation within the rule. There can be up to
five brackets (and up to five levels of nesting).

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.

Condition The logical operation to apply to the value of the


selected field. The following options are available:
Equals, Does Not Equal, Is Greater Than, Is Greater Than
or Equal To, Is Less Than, Is Less Than or Equal To, Con-
tains, Starts With, Ends With, Does Not Contain, Is Be-
tween, Is Empty, Is Not Empty, Is Null, and Is Not Null.
Retail-Commerce Edition Form Reference | 459

Column Description

Value The primary value of the condition to be compared


with the value of the selected field.

Value 2 The secondary value, if required by the selected con-


dition. Most of the conditions require only one value,
while Is Between requires two values.

Closing Brackets The closing bracket or brackets for enclosing a logical


expression.

Operator The logical operator, And or Or, to be used to join logi-


cal expressions on different lines.

Export Mapping Tab


By using the table on this tab, you configure manual mapping of standard or custom fields to be used in export
processing. This tab is displayed only if the Export direction is supported for the selected entity. You can use the
drag-and-drop functionality to arrange rows of the table in the needed order.
The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.

Table: Table Columns

Column Description

Active A check box that indicates (if selected) that the export
mapping rule is active.

Target Object The object in the external e-commerce system whose


field is mapped to the field of the object in Acumatica
ERP.
The list of available options depends on the selected
entity and the e-commerce connector.

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.

Source Object The object in Acumatica ERP whose field is mapped to


the field of the object in the external e-commerce sys-
tem.
The list of available options depends on the selected
entity and the e-commerce connector.
Retail-Commerce Edition Form Reference | 460

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.

Export Filtering Tab


By using the table on this tab, you can set up the rules according to which data will be included in or excluded from
the export processing. This tab is displayed only if the Export direction is supported for the selected entity. You can
use the drag-and-drop functionality to arrange rows of the table in the needed order.
The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.

Column Description

Active A check box that indicates (if selected) that the condi-
tion is active and is used for filtering.

Opening Brackets The opening bracket or brackets for enclosing a logi-


cal expression. Brackets are used to designate the or-
der of the operation within the rule. There can be up to
five brackets (and up to five levels of nesting).

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.

Condition The logical operation to apply to the value of the cho-


sen data field. The following options are available:
Equals, Does Not Equal, Is Greater Than, Is Greater Than
or Equal To, Is Less Than, Is Less Than or Equal To, Con-
tains, Starts With, Ends With, Does Not Contain, Is Be-
tween, Is Empty, Is Not Empty, Is Null, and Is Not Null.

Value The primary value of the condition to be compared


with the selected data field value.

Value 2 The secondary value, if required by the selected con-


dition. Most of the conditions require only one value,
while Is Between requires two values.

Closing Brackets The closing bracket or brackets for enclosing a logical


expression.

Operator The logical operator, And or Or, to be used to join logi-


cal expressions on different lines.
Retail-Commerce Edition Form Reference | 461

Prepare Data

Form ID: (BC501000)


By using this form, you can manually start the data fetch process for a single entity or multiple entities. For details
on the data fetch process, see Data Synchronization: General Information.

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

Store The name of the online store.


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.

Entity The entity for which the data preparation process


should be started.
Retail-Commerce Edition Form Reference | 462

Element Description

Prepare Mode An indicator of which data should be pulled from


Acumatica ERP and the online store and placed in the
processing queue during the data preparation process.
You select either of the following options:
• Incremental (default): Only document or entity
records that have been modified since the last
successful full or incremental data preparation
(whichever happened most recently) should be
pulled and put in the processing queue.
• Incremental by Date: Document or entity records
are pulled and placed in the processing queue on-
ly if they have been modified during the specified
date range, which you define by specifying the
Start Date and End Date, and if they have not been
processed.
• Full: All document or entity records created or
updated during the specified date range, which
you define by specifying the Start Date and End
Date, should be pulled and placed in the process-
ing queue, regardless of whether they have been
processed previously or not.

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.

Table: Table Columns

Column Description

Selected A check box that you select to include the row in pro-
cessing.
Retail-Commerce Edition Form Reference | 463

Column Description

Store The online store with which the entity is synchronized.


If you click the link with the store name, the system
opens the form with the store settings, which can be
BigCommerce Stores (BC201000) or Shopify Stores
(BC201010), in a pop-up window.

Entity The entity that has been activated for synchronization


with the store in the store settings.
If you click the link with the entity name, the system
opens the Entities (BC202000) form.

Sync Direction The direction of the synchronization. One of the fol-


lowing options may be displayed:
• Export: Data is exported from Acumatica ERP to the
external e-commerce system.
• Import: Data is imported to Acumatica ERP from the
external e-commerce system.
• Bidirectional: Data is synchronized between
Acumatica ERP and the external e-commerce sys-
tem in both directions.

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).

Ready to Process The number of synchronization records that have been


created for the entity and that have the Prepared and
Failed statuses.
If you click the link with the number of records, the
Process Data (BC501500) form opens with the store
and the entity selected in the Selection area and the
list of prepared and failed synchronization records dis-
played in the table.
Retail-Commerce Edition Form Reference | 464

Column Description

Processed Records The number of synchronization records that have been


successfully synchronized and assigned the Processed
status.
If you click the link with the number of records, the
Sync History (BC301000) form opens with the store and
entity selected in the Selection area and the list of suc-
cessfully processed synchronization records displayed
in the table of the Drilldown filter tab,

Total Records The total number of synchronization records hat have


been created for the entity.
If you click the link with the number of records, the
Sync History form opens with the store and entity se-
lected in the Selection area and the list of all records
displayed on the All Records filter tab.

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.

Connector A read-only column that shows the name of the e-com-


merce connector.
This column is hidden by default.

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.

Real-Time Export A read-only column that shows the status of real-time


export for the entity. The status can be one of the fol-
lowing:
• Stopped: Real-time synchronization is not enabled
for the Export direction.
• Running: Real-time synchronization is enabled for
the Export direction.
• Not Supported: Real-time synchronization is not
available for the Export direction.
This column is hidden by default.
Retail-Commerce Edition Form Reference | 465

Column Description

Real-Time Import A read-only column that shows the status of real-time


import for the entity. The status can be one of the fol-
lowing options:
• Stopped: Real-time synchronization is not enabled
for the Import direction.
• Running: Real-time synchronization is enabled for
the Import direction.
• Not Supported: Real-time synchronization is not
available for the Import direction.
This column is hidden by default.

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.

Sync Order A read-only column that shows the order of entity


synchronization. The entity with the lowest value is
processed first.
This column is hidden by default.

Process Data

Form ID: (BC501500)


By using this form, you can view the synchronization records that are pending synchronization between Acumatica
ERP and the external e-commerce system. You can manually start the data synchronization process for all of these
synchronization records or only those you select.

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 Starts the data synchronization process for the syn-


chronization records you have selected in the table.

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.

Set as Processed Sets the status of the selected synchronization record


or records (that is, all records for which the unlabeled
check box is selected) to Processed, updates the date
and time of the last synchronization with the cur-
rent date and time, and removes the synchronization
record or 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 Sets the status of the selected synchronization record


or records (that is, all records for which the unlabeled
check box is selected) to Skipped, which excludes the
selected synchronization record or records from fur-
ther synchronization and removes them from the ta-
ble.
Skipped records are listed on the Skipped filter tab of
the Sync History (BC301000) 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.

Entity The entity synchronized with the selected store for


which you want to display data pending synchroniza-
tion in the table.

Table
By using this table, you can select the synchronization records to be processed during the data synchronization
process.

Table: Table Columns

Column Description

Included An unlabeled check box that you select to indicate that


the record should be processed if you click Process on
the form toolbar.

Store The online store with which the entity is synchronized.

Entity The entity of the synchronization record.

ERP ID The ID of the document or entity record in Acumatica


ERP.
If you click the link in this column, the system opens
the corresponding Acumatica ERP form in a pop-up
window with the record selected.

External ID The ID of the document or entity record in the external


e-commerce system.
If you click the link in this column, the system opens
the corresponding page of the external e-commerce
system in a new window and displays the details of the
record.
The value in this column may be simple or combined.
A combined external ID includes two identifiers sep-
arated by a comma. For example, if the record rep-
resents a sales order that has been paid, the column
contains 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-commerce system. The value in this col-
umn depends on the entity type of the synchronization
record.
Retail-Commerce Edition Form Reference | 468

Column Description

Status The status of the synchronization record.


In this table, only synchronization records pending
synchronization (that is, synchronization records that
have the Prepared or Failed status) are displayed.

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.

Connector The e-commerce connector used for synchronization.


This column is hidden by default.

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 Direction The direction of the synchronization. One of the fol-


lowing options may be displayed:
• Export: Data is exported from Acumatica ERP to the
external e-commerce system.
• Import: Data is imported to Acumatica ERP from the
external e-commerce system.
• Bidirectional: Data is synchronized between
Acumatica ERP and the external e-commerce sys-
tem in both directions.
This column is hidden by default.

Sync Record ID The identifier of the synchronization record.


This column is hidden by default.

Sync History

Form ID: (BC301000)


By using this form, you can view the status of all synchronization records related to a particular entity or quickly
view particular groups of synchronization records related to the entity on separate tabs, based on what their status
is or whether they are active synchronization records.
You can also use the form to manually synchronize individual synchronization records between Acumatica ERP and
the external e-commerce system, delete synchronization records, and set the status of particular synchronization
records to Skipped or Processed.

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.

Table: Add or Edit Sync Status Dialog Box


By using this dialog box, you can create a new synchronization record or update an existing one.

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

Entity The entity for which data is synchronized.

ERP ID The identifier in Acumatica ERP of the record being synchronized.

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.

The dialog box also contains the following button.

OK Creates or updates the synchronization record with the specified values and
closes the dialog box.

Table: Sync Record Details Dialog Box


The table of this dialog box shows the details of the entity records that were synchronized during the processing of
the selected synchronization record.

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

Table: Table Columns

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.

Store The online store with which the entity is synchronized.

ERP ID The ID of the document or entity record in Acumatica ERP.


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 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

Status The status of the synchronization record.


The statuses for which active synchronization records are shown on a par-
ticular tab are generally indicated by the tab name. A synchronization
record can have any of the following statuses:, which can be any of the fol-
lowing:
• Failed: The processing of the synchronization record has failed.
• Prepared: The processing of the synchronization record has not yet
been performed.
• Processed: The synchronization process for the synchronization record
has been completed successfully.
• Aborted: The synchronization record was excluded from synchroniza-
tion by the system.
• Skipped: The synchronization record was manually excluded from syn-
chronization by a user.
• Deleted: The document or entity record associated with the synchro-
nization record has been deleted in one system or both systems.
• Invalid: The synchronization record cannot be processed because the
synchronization of the document or entity record associated with it is
not supported, for example, if the document or entity record was used
in the store settings.
• Filtered: The synchronization record has been excluded from process-
ing because the filtering conditions defined in the code or on the Enti-
ties (BC202000) form have been applied.

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.

Connector The e-commerce connector used for synchronization.


This column is hidden by default.
Retail-Commerce Edition Form Reference | 477

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.

Sync Record ID The identifier of the synchronization record.


This column is hidden by default.
Retail-Commerce Edition Entity Reference | 478

Retail-Commerce Edition Entity Reference


In this chapter, you will find reference topics that show the field mapping used during the synchronization of
entities between Acumatica ERP and external e-commerce systems, BigCommerce 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.

BigCommerce Mapping Reference

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.

Customer Export Mapping


The following table shows the mapping of Acumatica ERP fields to BigCommerce fields that is used during the
export of customer data to BigCommerce.
Retail-Commerce Edition Entity Reference | 479

Table: Customer Export Mapping

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

Customers (AR303000) form  

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

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

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

City General tab > Ac- Suburb/City Edit Customer page


count Address sec- > Customer Address
tion 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

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

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

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

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.

    Address Type Edit Customer Address Default: Resi-


page > Customer Ad- dential
dress Details section

Customer Import Mapping


The following table shows the mapping of BigCommerce fields to Acumatica ERP fields that is used during the
import of customer data from BigCommerce.

Table: Customer Import Mapping

Source Fields (BigCommerce) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

  Customers (AR303000) form

    Customer ID Summary area Auto-numbering


of customers must
be enabled, and
a numbering se-
quence must be se-
lected on the Cus-
tomer Settings tab
of the BigCommerce
Stores (BC201000)
form.

    Customer Status Summary area By default, a cus-


tomer imported
from a BigCom-
merce store is as-
signed the Active
status.
Retail-Commerce Edition Entity Reference | 483

Source Fields (BigCommerce) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

    Customer Class Summary area The default cus-


tomer class that
is specified on the
Customer Settings
tab of the BigCom-
merce Stores form is
used.

    General tab > Account Info section

Company Name Edit Customer Account Name General tab > Ac-  
page > Customer count Info section
Details section

    General tab > Additional Account Info 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.

Phone Number Edit Customer Phone 2 General tab > Addi-  


page > Customer tional Account Info
Details section section

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.

    General tab > Account Address section

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

Source Fields (BigCommerce) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

Suburb/City Edit Customer Ad- City General tab > Ac-  


dress page > Cus- count Address sec-
tomer Address De- tion
tails section

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

Customer Location Entity

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.

Customer Location Filtering


Filters are applied during the export of customer locations to BigCommerce. A customer location is skipped if any
of the following is true:
• The customer location is a location of the guest customer. The guest customer is excluded from
synchronization so its locations are not synchronized.
• The customer to which the customer location refers has not been synchronized.
During the import of customer locations to Acumatica ERP, the customer location is skipped if the corresponding
customer has not been synchronized.

Customer Location Export Mapping


The following table shows the mapping of Acumatica ERP fields to BigCommerce fields that is used during the
export of customer location data to BigCommerce.

Table: Customer Location Export Mapping

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

Customer Locations (AR303020) form  


Retail-Commerce Edition Entity Reference | 485

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

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

City General tab > Loca- Suburb/City Edit Customer Ad-  


tion 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

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

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

    Address Type Edit Customer Ad- Default: Residential


dress page > Cus-
tomer Address De-
tails section

Customer Location Import Mapping


The following table shows the mapping of Acumatica ERP fields to BigCommerce fields that is used during the
import of customer location data to Acumatica ERP.

Table: Customer Location Import Mapping

Source Fields (BigCommerce) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

  Customer Locations (AR303020) form

    Customer Summary area The customer ID is


generated based on
the numbering se-
quence specified
for customers on
the Customer Set-
tings tab of the Big-
Commerce Stores
(BC201000) form.

    Location ID Summary area The location ID is


generated based on
the numbering se-
quence specified
for customer loca-
tions on the Cus-
tomer Settings tab
of the BigCommerce
Stores form.
Retail-Commerce Edition Entity Reference | 487

Source Fields (BigCommerce) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

    Status Summary area By default, a cus-


tomer location im-
ported from a Big-
Commerce store is
assigned the Active
status.

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.

    General tab >Additional Location Info section

    Override General tab > Addi- Default: Selected


tional Location In-
fo section

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

    General Info > Location Address

    Override General tab > Loca- Default: Selected


tion Address sec-
tion

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

Source Fields (BigCommerce) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

Address Line 2 Edit Customer Ad- Address Line 2 General tab > Loca-  
dress page > Cus- tion Address sec-
tomer Address De- tion
tails section

Suburb/City Edit Customer Ad- City 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

Sales Category Entity

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.

Sales Category Mapping


The following table shows the mapping of Acumatica ERP fields and BigCommerce fields that is used during the
export of sales category data from Acumatica ERP to BigCommerce and during the import from BigCommerce to
Acumatica ERP.
Retail-Commerce Edition Entity Reference | 489

Table: Sales Category Export and Import Mapping

BigCommerce Acumatica ERP


Field Name Page Object Field Name Form Object

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.

Stock Item Entity

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.

Stock Item Filtering


Filters are applied during the export of stock items. A stock item is skipped if any of the following is true:
• The stock item is a matrix item—that is, a template is specified for the item in the Template ID box on the
General tab of the Stock Items (IN202500) form. Matrix items are synchronized as part of the synchronization
of template items.
• No item sales category is assigned to the stock item and no default category is selected in the Default Stock
Categories box on the Inventory Settings tab of the BigCommerce Stores (BC201000) form.

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.

Stock Item Export Mapping


The following table shows the mapping of Acumatica ERP fields to BigCommerce fields that is used during the
export of stock items to BigCommerce.
Retail-Commerce Edition Entity Reference | 490

Table: Stock Item Export Mapping

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

Stock Items (IN202500) form  

Inventory ID Summary area SKU Product manage- SKU also appears


ment page > Basic under Product
Information sec- Identifiers.
tion

Description Summary area Product Name Product manage- The Description


ment page > Basic in Acumatica ERP
Information sec- must be unique.
tion

    Product Type Product manage- Default: Physical


ment page > Basic
Information sec-
tion

Description Description tab Description Product manage-  


ment page > De-
scription section

Weight Packaging tab > Di- Weight Product manage-  


mensions section 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 | 491

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

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.

Current Cost Price/Cost tab > Cost Product manage-  


Standard Cost sec- ment page > Pricing
tion section

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

Category ID Attributes tab > Categories Product manage-  


Sales Categories ment page > Basic
table Information 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

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

Search Keywords eCommerce tab Search Keywords Product manage-  


ment page > Store-
front Details sec-
tion

Page Title eCommerce tab Page Title Product manage-  


ment page > Search
Engine Optimiza-
tion section

Meta Description eCommerce tab Meta Description Product manage-  


ment page > Search
Engine Optimiza-
tion section

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.

Custom URL eCommerce tab Product URL Product manage-  


ment page > Search
Engine Optimiza-
tion section
Retail-Commerce Edition Entity Reference | 493

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

URL (Image) eCommerce tab > Images Product manage-  


Media URLs table ment page > Images
& Videos section

URL (Video) eCommerce tab > Videos Product manage-  


Media URLs table ment page > Images
& Videos section

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

Non-Stock Item Entity

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.

Non-Stock Item Filtering


Filters are applied during the export of stock items. A non-stock item is skipped if any of the following is true:
• The non stock item is a matrix item—that is, a template is specified for the item in the Template ID box
on the General tab of the Non-Stock Items (IN202000) form. Matrix items are synchronized as part of the
synchronization of template items.
• No item sales category is assigned to the non-stock item and no default category is selected in the Default
Non-Stock Categories box on the Inventory Settings tab of the BigCommerce Stores (BC201000) form.
• The non-stock item is the gi certificate item—that is, the item selected in the Gi Certificate Item box in
the Order section on the Order Settings tab of the BigCommerce Stores form.

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

Non-Stock Item Export Mapping


The following table shows the mapping of Acumatica ERP fields to BigCommerce fields that is used during the
export of non-stock items to BigCommerce.

Table: Non-Stock Item Export Mapping

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

Non-Stock Items (IN202000) form  

Inventory ID Summary area SKU Product manage- SKU also appears


ment page > Basic under Product
Information sec- Identifiers.
tion

Description Summary area Product Name Product manage- The Description


ment page > Basic in Acumatica ERP
Information sec- must be unique.
tion

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

Description Description tab Description Product manage-  


ment page > De-
scription section

Weight Packaging tab > Di- Weight Product manage-  


mensions section 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

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

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.

Current Cost Price/Cost tab > Cost Product manage-  


Standard Cost sec- ment page > Pricing
tion section

General tab  

Category ID Attributes tab > Categories Product manage-  


Sales Categories ment page > Basic
table Information 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
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

Search Keywords eCommerce tab Search Keywords Product manage-  


ment page > Store-
front Details sec-
tion
Retail-Commerce Edition Entity Reference | 496

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

Page Title eCommerce tab Page Title Product manage-  


ment page > Search
Engine Optimiza-
tion section

Meta Description eCommerce tab Meta Description Product manage-  


ment page > Search
Engine Optimiza-
tion section

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.

Custom URL eCommerce tab Product URL Product manage-  


ment page > Search
Engine Optimiza-
tion section

URL (Image) eCommerce tab > Images Product manage-  


Media URLs table ment page > Images
& Videos section

URL (Video) eCommerce tab > Videos Product manage-  


Media URLs table ment page > Images
& Videos section

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

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

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

Template Item Entity

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.

Template Item Export Mapping


The following table shows the mapping of Acumatica ERP fields to BigCommerce fields that is used during the
export of template items to BigCommerce.

Table: Template Item Export Mapping

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

Template Items (IN203000) form  

Template ID Summary area SKU Product manage- SKU also appears


ment page > Basic under Product
Information sec- Identifiers.
tion

Description Summary area Product Name Product manage- The Description


ment page > Basic in Acumatica ERP
Information sec- must be unique.
tion

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

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

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

Description Description tab Description Product manage-  


ment page > De-
scription section

Weight Fulfillment tab > Weight Product manage-  


Dimensions section ment page > Basic
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.

Current Cost Price/Cost tab > Cost Product manage-  


Standard Cost sec- ment page > Pric-
tion ing section

General tab  
Retail-Commerce Edition Entity Reference | 499

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

Default Issue From General tab > Bin Picking Num- Product manage-  
Warehouse De- ber (BPN) ment page > Prod-
faults section uct Identifiers sec-
tion

Category ID Fulfillment tab > Categories Product manage-  


Sales Categories ment page > Basic
table Information 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

Search Keywords eCommerce tab Search Keywords Product manage-  


ment page > Store-
front Details sec-
tion

Page Title eCommerce tab Page Title Product manage-  


ment page > Search
Engine Optimiza-
tion section

Meta Description eCommerce tab Meta Description Product manage-  


ment page > Search
Engine Optimiza-
tion section
Retail-Commerce Edition Entity Reference | 500

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

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.

The This product


can be purchased
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.

Custom URL eCommerce tab Product URL Product manage-  


ment page > Search
Engine Optimiza-
tion section

URL (Image) eCommerce tab > Images Product man-  


Media URLs table agement page >
Images & Videos
section

URL (Video) eCommerce tab > Videos Product man-  


Media URLs table agement page >
Images & Videos
section
Retail-Commerce Edition Entity Reference | 501

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

Attribute Configuration tab > Option Name Product manage-  


Attributes section ment page > Vari-
ations section >
Variant Options ta-
ble

Attribute Value Item Creation tab > Values Product manage-  


table ment page > Vari-
ations section >
Variant Options ta-
ble

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.

Table: Matrix Item Export Mapping

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

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)

Description Summary area Variant Product manage-  


ment page > Varia-
tions section > Vari-
ants table

Inventory ID Summary area SKU Product manage-  


ment page > Varia-
tions section > Vari-
ants table

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

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

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

Product Availability Entity

This topic provides reference information about the standard field mapping used for the Product Availability entity
during the synchronization between Acumatica ERP and BigCommerce.

Units of Measure of Available Item Quantities


An item's available quantity is exported to the BigCommerce store in the item's sales unit of measure, which is
defined on the General tab of the Stock Items (IN202500) form. If an item's base UOM is different from its sales
UOM, during the synchronization of the Product Availability entity, the item's available quantity is converted to the
sales UOM before being exported to the BigCommerce store.

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 aer
changing its sales UOM so that new orders for the item are created in the BigCommerce store with the
updated UOM.

Product Availability Export Mapping


The following table shows the mapping of Acumatica ERP fields to BigCommerce fields that is used during the
export of availability data of stock items to BigCommerce.
Retail-Commerce Edition Entity Reference | 503

Table: Product Availability Export Mapping

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

BigCommerce Stores (BC2010000) form  

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.

Warehouse Mode: Inventory Settings Stock Product manage- Stock is calculated


All Warehouses tab ment page > Inven- based on quantities
tory section in all warehouses.

Warehouse Mode: Inventory Settings Stock Product manage- Stock is calculat-


Specific Warehouses tab ment page > Inven- ed based on quan-
tory section tities in only par-
ticular warehouses
and warehouse lo-
cations.

Stock Items (IN202500) form  

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

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

BigCommerce Stores form  

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.

Sales Order Entity

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

Sales Order Filtering


During the export of sales orders from Acumatica ERP, a sales order is skipped if any of the following conditions are
met:
• It has the Completed or Canceled status.
• Its type is not supported. Only the order types that are selected in the Order Types for Export box and the
Return Order Type boxes on the Order Settings tab (Order section) of the BigCommerce Stores (BC201000)
form are supported.
• The sales order is a guest order—that is, a previously imported order saved in Acumatica ERP with the
generic guest customer account (the customer specified in the Generic Guest Customer box on the
Customer Settings tab of the BigCommerce Stores form) or an order that was created in Acumatica ERP for
the generic guest customer.
During the import of sales orders, for each order with the Completed or Archived status in BigCommerce, the system
creates a synchronization record in Acumatica ERP and assigns it the Filtered status on the Sync History (BC301000)
form.

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.

Sales Order Export Mapping


The following table shows the mapping of Acumatica ERP fields to BigCommerce fields that is used during the
export of sales order data to BigCommerce.

Table: Sales Order Export Mapping

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

Sales Orders (SO301000) form  

Order Nbr. Summary area Order ID View Orders page  

Customer Summary area Customer View Orders page  

Date Summary area Date View Orders page  

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

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

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

Tax Total Summary area Tax View Orders page  

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

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

Address Line 2 Addresses tab > Address Line 2 Edit an Order page  
Bill-To Contact sec- > Billing Informa-
tion tion section

City Addresses tab > Suburb/City 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.

Postal Code Addresses tab > Zip/Postcode Edit an Order page  


Bill-To Contact sec- > Billing Informa-
tion tion section

Phone 1 Addresses tab > Phone Number Edit an Order page  


Bill-To Contact sec- > Billing Informa-
tion tion section

Email Addresses tab > Email Edit an Order page  


Bill-To Contact sec- > Billing Informa-
tion tion section

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

City Addresses tab > Suburb/City Edit an Order page  


Ship-To Address > Shipping section
section
Retail-Commerce Edition Entity Reference | 508

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

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.

Postal Code Addresses tab > Zip/Postcode Edit an Order page  


Ship-To Address > Shipping section
section

Phone 1 Addresses tab > Phone Number Edit an Order page  


Ship-To Contact > Shipping section
section

Inventory ID Details tab Product ID    

Quantity Details tab Qty Edit an Order page  


> Add Products sec-
tion

Unit Price Details tab Price Edit an Order page  


> Add Products sec-
tion

Line Description Details tab Product Name Edit an Order page  


> Add Products sec-
tion

Discount Amount Details tab Manual Discount Edit an Order page All discounts are
> Summary section summed and the
total amount is
added.

Sales Order Import Mapping


The following table shows the mapping of BigCommerce fields to Acumatica ERP fields that is used during the
import of sales order data from BigCommerce.

Table: Sales Order Import Mapping

Source Fields (BigCommerce) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

Order Summary Sales Orders (SO301000) form


Retail-Commerce Edition Entity Reference | 509

Source Fields (BigCommerce) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

    Order Type Summary area The order type is


specified in the Or-
der section on the
Order Settings tab
of the BigCommerce
Stores (BC201000)
form.

    Order Nbr. Summary area The identifier is


generated based on
the numbering se-
quence defined for
sales orders.

Date View Orders page Date Summary area  

    Description Summary area Default: <store


name> | Order: <or-
der number> | Sta-
tus: <order status>

Date View Orders page Requested On Summary area  

Currency Edit an Order page Currency Summary area To use a currency


> Transactional other than the base
Currency section currency, curren-
cy override must be
enabled for the cus-
tomer.

Order ID View Orders page External Reference Summary area  

Customer View Orders page Customer Summary area If an order is a guest


order, the customer
account selected in
the Generic Guest
Customer box on
the Customer Set-
tings tab of the Big-
Commerce Stores
form is used.
Retail-Commerce Edition Entity Reference | 510

Source Fields (BigCommerce) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

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.

Status View Orders page Status Summary area  

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)

    Branch Financial tab > Fi- The branch speci-


nancial Informa- fied in the General
tion section section on the Or-
der Settings tab of
the BigCommerce
Stores form is used.

    Override Freight Totals tab > Freight This check box is


Price Info section selected if the ship-
ping terms allow
freight calculation
on orders.

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

Source Fields (BigCommerce) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

    Override Address Addresses tab > The check box is se-


Bill-To Address sec- lected.
tion

    Override Contact Addresses tab > The check box is se-


Bill-To Contact sec- lected.
tion

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

Suburb/City Edit an Order page City 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.

Zip/Postcode Edit an Order page Postal Code Addresses tab >  


> Billing Informa- Bill-To Address sec-
tion section tion

Phone Number Edit an Order page Phone 1 Addresses tab >  


> Billing Informa- Bill-To Contact sec-
tion section tion

Email Edit an Order page Email Addresses tab >  


> Billing Informa- Bill-To Contact sec-
tion section tion

Shipping Info  
Retail-Commerce Edition Entity Reference | 512

Source Fields (BigCommerce) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

        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.

    Override Contact Addresses tab > The check box is se-


Ship-To Contact lected.
section

    Override Address Addresses tab > The check box is se-


Ship-To Address lected.
section

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

Suburb/City Edit an Order page City 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.

Zip/Postcode Edit an Order page Postal Code Addresses tab >  


> Shipping section Ship To Address
section
Retail-Commerce Edition Entity Reference | 513

Source Fields (BigCommerce) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

Phone Number Edit an Order page Phone 1 Addresses tab >  


> Shipping section Ship To Contact
section

Email View Orders page > Email Addresses tab >  


Shipping section Ship To Contact
section

    Ship Via Shipping tab > De- The system uses


livery Settings sec- the ship via code
tion mapped to the
store's shipping
zone and shipping
method in the Ship-
ping Option Map-
ping table on the
Order Settings tab
of the BigCommerce
Stores form.

    Shipping Terms Shipping tab > De- The system uses


livery Settings sec- the shipping terms
tion mapped to the
store's shipping
zone and shipping
method in the Ship-
ping Zone Map-
ping table on the
Order Settings tab
of the BigCommerce
Stores form.

    Shipping Zone Shipping tab > De- The system uses


livery Settings sec- the shipping zone
tion mapped to the
store's shipping
zone and shipping
method in the Ship-
ping Zone Map-
ping table on the
Order Settings tab
of the BigCommerce
Stores form.

Order Lines  

    Branch Details tab The branch speci-


fied in the General
section on the Or-
der Settings tab of
the BigCommerce
Stores form is used.
Retail-Commerce Edition Entity Reference | 514

Source Fields (BigCommerce) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

Product ID Not on the UI Inventory ID Details tab If the product is a


gi certificate, the
system uses the In-
ventory ID speci-
fied in the Gi Cer-
tificate Item box
on the Order Set-
tings tab of the Big-
Commerce Stores
form.

Qty Edit an Order page Quantity Details tab  


> Add Products sec-
tion

Item Price Edit an Order page Unit Price Details tab  


> Add Products sec-
tion

Product Name Edit an Order page Line Description Details tab  


> Add Products sec-
tion

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

    Disable Automatic Discounts tab The check box is se-


Discount Update lected.

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

Source Fields (BigCommerce) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

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).

Coupon Edit an Order page External Discount Discounts tab  


> Summary section 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.

Shipment Export Mapping


The following table shows the mapping of Acumatica ERP fields to BigCommerce fields that is used during the
export of shipment data to BigCommerce.

Table: Shipment Export Mapping

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

Shipments (SO302000) form  

Shipment Nbr. Summary area Shipment ID View Shipments  


page
Retail-Commerce Edition Entity Reference | 516

Source Fields (Acumatica ERP) Target Fields (BigCommerce)


Field Name Form Object Field Name Page Object Notes

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.

Tracking Number Packages tab Shipping Tracking View Shipments • If a shipment is a


Number page drop shipment,
the vendor ref-
erence number
from the pur-
chase order is
used.
• Multiple track-
ing numbers are
concatenated
together. If the
maximum length
is exceeded, the
value is truncat-
ed.

Notes   Shipment Com- View Shipments  


ments page

Inventory ID Details tab Product ID View Shipments  


page

Shipped Qty. Details tab Quantity View Shipments  


page

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

Payment Import Mapping


The following table shows the mapping of BigCommerce fields to Acumatica ERP fields that is used during the
import of payment data from BigCommerce.

Table: Payment Import Mapping

Source Fields (BigCommerce) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

  Payments and Applications (AR302000) form

    Type Summary area Default: Prepay-


ment

    Customer Summary area The customer ID is


the same as the cus-
tomer ID on the re-
lated sales order.

    Location Summary area The location is the


same as the loca-
tion on the related
order.

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.

GatewayTrans- Payment transac- Payment Ref. Summary area If GatewayTrans-


actionId or Refer- tion actionId is empty,
enceTransactionId ReferenceTransac-
tionId 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

Source Fields (BigCommerce) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

    Cash Account Summary area The cash account


corresponds to the
payment method
that is mapped to
the store's payment
methods used for
the purchase and
the transaction cur-
rency of the sales
order.

    Description Summary area Default: <store


name> | Payment
Method: <the pay-
ment method used
for purchase> | Or-
der: <order number>
| Payment ID: <pay-
ment number>

    Branch Financial tab > Link The branch speci-


to GL section fied in the General
section on the Or-
der Settings tab of
the BigCommerce
Stores form.

    Status Summary area The status depends


on the state of the
Release Payments
check box in the
row of the payment
method in the ta-
ble on the Pay-
ment Settings tab
of the BigCommerce
Stores form. If the
check box is select-
ed, the status is
Open (meaning that
the payment is re-
leased). If the check
box is cleared, the
status is Balanced
(indicating that the
payment is not re-
leased).
Retail-Commerce Edition Entity Reference | 519

Shopify Mapping Reference

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).

Customer Export Mapping


The following table shows the mapping of Acumatica ERP fields to Shopify fields that is used during the export of
customer data to Shopify.

Table: Customer Export Mapping

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

Customers (AR303000) form  

    Customer ID Visible in the The Customer ID is


page URL (<store generated by Shopi-
URL>/admin/cus- fy on import.
tomers/<Customer
ID>)

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

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

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

Account Email General tab > Addi- Email New customer  


tional Account Info page > Customer
section overview section

Address Line 1 General tab > Ac- Address New customer  


count Address sec- page > Address sec-
tion tion

Address Line 2 General tab > Ac- Apartment, suite, New customer  
count Address sec- etc. page >Address sec-
tion tion

Account Name General tab > Ac- Company New customer  


count Info section page > Address sec-
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

City General tab > Ac- City New customer  


count Address sec- page > Address sec-
tion tion

Country General tab > Ac- Country/region New customer  


count Address sec- page > Address sec-
tion tion

State General tab > Ac- State New customer  


count Address sec- page > Address sec-
tion tion

Postal Code General tab > Ac- ZIP code New customer  
count Address sec- page > Address sec-
tion tion
Retail-Commerce Edition Entity Reference | 521

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

Phone 1 General tab > Addi- Phone New customer  


tional Account Info page > Address sec-
section tion

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.

Customer Import Mapping


The following table shows the mapping of Shopify fields to Acumatica ERP fields that is used during the import of
customer data from Shopify.

Table: Customer Import Mapping

Source Fields (Shopify) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

    Customers (AR303000) form

    Customer ID Summary area Auto-numbering


of customers must
be enabled, and
a numbering se-
quence must be se-
lected on the Cus-
tomer Settings tab
of the Shopify Stores
(BC201010) form.

    Customer Status Summary area By default, a cus-


tomer imported
from a Shopify store
is assigned the Ac-
tive status.

    Customer Class Summary area The default cus-


tomer class that
is specified on the
Customer Settings
tab of the Shopify
Stores form is used.

    General tab > Account Info section


Retail-Commerce Edition Entity Reference | 522

Source Fields (Shopify) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

Company Customer page > Account Name General tab > Ac-  
Default Address count Info section
section

    General tab > Primary Contact 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

    General tab > Additional Account Info section

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

Phone Customer page > Phone 2 General tab > Addi-  


Default address tional Account Info
section 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.

    General tab > Account Address section

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

City Customer page > City General tab > Addi-  


Default address tional Account Info
section section
Retail-Commerce Edition Entity Reference | 523

Source Fields (Shopify) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

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

Customer Location Entity

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.

Customer Location Filtering


Filters are applied during the export of customer locations to Shopify. A customer location is skipped if any of the
following is true:
• The customer location is a location of the guest customer. The guest customer is excluded from
synchronization so its locations are not synchronized.
• The customer to which the customer location refers has not been synchronized.
During the import of customer locations to Acumatica ERP, the customer location is skipped if the corresponding
customer has not been synchronized.

Customer Location Export Mapping


The following table shows the mapping of Acumatica ERP fields to Shopify fields that is used during the export of
customer location data to Shopify.

Table: Customer Location Export Mapping

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

Customer Locations (AR303020) form  

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

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

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.

    Customer ID Not in the UI Customer ID of the


related customer,
generated by Shopi-
fy.

    Address ID Not in the UI Address ID is gener-


ated by Shopify.

Address Line 1 General tab > Loca- Address New customer  


tion Address sec- page > Address sec-
tion tion

Address Line 2 General tab > Loca- Apartment, suite, New customer  
tion Address sec- etc. page > Address sec-
tion tion

City General tab > Loca- City New customer  


tion Address sec- 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

Customer Location Import Mapping


The following table shows the mapping of Acumatica ERP fields to Shopify fields that is used during the import of
customer location data to Acumatica ERP.
Retail-Commerce Edition Entity Reference | 525

Table: Customer Location Import Mapping

Source Fields (Shopify) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

  Customer Locations (AR303020) form

    Customer Summary area The customer ID is


generated based on
the numbering se-
quence specified for
customers on the
Customer Settings
tab of the Shopify
Stores (BC201010)
form.

    Location ID Summary area The location ID is


generated based on
the numbering se-
quence specified for
customer locations
on the Customer
Settings tab of the
Shopify Stores form.

    Status Summary area By default, a cus-


tomer location im-
ported from a Shopi-
fy store is assigned
the Active status.

Company Customer page > Location Name Summary area If Company is emp-
Default address ty, First Name and
section Last Name are used.

    Override General tab > Addi- The Override check


tional Location In- box is selected.
fo section

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

Email Customer page > Email General tab > Addi-  


Customer section tional Location In-
fo section
Retail-Commerce Edition Entity Reference | 526

Source Fields (Shopify) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

Phone Customer page > Phone 1 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

City Customer page > City General tab > Lo-  


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

Stock Item Entity

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.

Stock Item Filtering


A stock item is skipped if it is a matrix item—that is, if a template is specified for the item in the Template ID box on
the General tab of the Stock Items (IN202500) form. Matrix items are synchronized as part of the synchronization of
template items.

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

Stock Item Export Mapping


The following table shows the mapping of Acumatica ERP fields to Shopify fields that is used during the export of
stock items to Shopify.

Table: Stock Item Export Mapping

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

Stock Items (IN202500) form      

    id Visible in the URL Product ID is gener-


of the product page ated by Shopify.
(<store URL>/ad-
min/products/<id>)

Description Summary area Title Product page  

Item Class General tab > Item Product Type Product page >  
Defaults section Product organiza-
tion section

Description Description tab Description Product page Images contained


in the description in
Acumatica ERP are
not exported.

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.

Search Keywords eCommerce tab Tags Product page >  


Product organiza-
tion section

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

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

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

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

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 Packaging tab > Di- Weight Product page >  


mensions section Shipping section >
Weight subsection

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

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

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.

Alternate Type: Cross-Reference Barcode (ISBN, Product page > In-  


Barcode tab UPC, GTIN, etc.) ventory section

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.

Page Title eCommerce tab Page title Product page >  


Search engine list-
ing section

Meta Description eCommerce tab Meta description Product page >  


Search engine list-
ing section

Item Classes (IN201000) 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

Non-Stock Item Entity

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.

Non-Stock Item Filtering


During the export of non-stock items, a non-stock item is skipped if it is a matrix item—that is, a template is
specified for the item in the Template ID box on the General tab of the Non-Stock Items (IN202000) form. Matrix
items are synchronized as part of the synchronization of template items

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.

Non-Stock Item Export Mapping


The following table shows the mapping of Acumatica ERP fields to Shopify fields that is used during the export of
non-stock items to Shopify.

Table: Non-Stock Item Export Mapping

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

Non-Stock Items (IN202000) form      

    id Visible in the URL Product ID is gener-


of the product page ated by Shopify.
(<store URL>/ad-
min/products/<id>)

Description Summary area Title Product page  

Item Class General tab > Item Product Type Product page >  
Defaults section Product organiza-
tion section

Description Description tab Description Product page Images contained


in the description in
Acumatica ERP are
not exported.

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

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

Search Keywords eCommerce tab Tags Product page >  


Product organiza-
tion section

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

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

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.

URL (Image) eCommerce tab >   Product page > Me-  


Media URLs table dia section

Alternate Type: Cross-Reference Barcode (ISBN, Product page > In-  


Barcode tab UPC, GTIN, etc.) ventory section

Item Classes (IN201000) form      


Retail-Commerce Edition Entity Reference | 534

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

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.

Template Item Entity

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.

Template Item Export Mapping


The following table shows the mapping of Acumatica ERP fields to Shopify fields that is used during the export of
template items to Shopify.

Table: Template Item Export Mapping

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

Template Items (IN203000) form      

    Product ID Visible in the Product ID is gener-


URL of the prod- ated by Shopify.
uct page (<store
URL>/admin/prod-
ucts/<product id>)

Description Summary area Title Product page  

Item Class General tab > Item Product Type Product page >  
Defaults section Product organiza-
tion section
Retail-Commerce Edition Entity Reference | 535

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

Description Description tab Description Product page Images contained


in the description in
Acumatica ERP are
not exported.

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.

Search Keywords eCommerce tab Tags Product page >  


Product organiza-
tion section

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

Table: Matrix Item Export Mapping

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

    Variant ID Visible in the URL Variant ID is gen-


of the product vari- erated by Shopify.
ant page (<store Shopify supports up
URL>/admin/prod- to 100 variants per
ucts/<product id>/ product.
variants/<variant
id>)

Template Items (IN203000) form      

Attribute Configuration tab >   Product variant Shopify supports up


Attributes section page > Options sec- to three options.
tion

Attribute Value Item Creation tab   Product variant  


page > Options sec-
tion

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

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

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.

Alternate Type: Cross-Reference Barcode (ISBN, Product variant  


Barcode tab UPC, GTIN, etc.) page > Inventory
section

Page Title eCommerce tab Page title Product variant  


page > Search en-
gine listing section

Meta Description eCommerce tab Description Product variant  


page > > Search en-
gine listing section

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

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

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.

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)

Inventory ID Summary area SKU (Stock Keep- Product variant  


ing Unit) page > Inventory
section
Retail-Commerce Edition Entity Reference | 539

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

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

Item Classes (IN201000) form      

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).

Product Availability Entity

This topic provides reference information about the standard field mapping used for the Product Availability entity
during the synchronization between Acumatica ERP and Shopify.

Units of Measure of Available Item Quantities


An item's available quantity is exported to the Shopify store in the item's sales unit of measure, which is defined on
the General tab of the Stock Items (IN202500) form. If an item's base UOM is different from its sales UOM, during the
synchronization of the Product Availability entity, the item's available quantity is converted to the sales UOM before
being exported to the Shopify store,

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 aer
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

Product Availability Export Mapping


The following table shows the mapping of Acumatica ERP fields to Shopify fields that is used during the export of
availability data of stock items to Shopify.

Table: Product Availability Export Mapping

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

Shopify Stores (BC201010) form      

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.

Stock Items (IN202500) form      

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

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

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.

Shopify Stores form      

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

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

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.

Sales Order Entity

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.

Sales Order Filtering


During the import of sales orders, a sales order is skipped if its status in Shopify is Canceled. For each order with the
Completed or Archived status in Shopify, the system creates a synchronization record in Acumatica ERP and assigns
it the Filtered status on the Sync History (BC301000) form.
During the export of sales orders, only sales orders that match the following conditions are exported:
• The order's type is selected in the Order Types for Export box on the Order Settings tab of the Shopify
Stores (BC201010) form.
• The order's status is Open, Pending Processing, Shipping, Back Order, or Completed—that is, the Status box
in the Summary area of the Sales Orders (SO301000) form is set to any of these values.

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.

Sales Order Import Mapping


The following table shows the mapping of Shopify fields to Acumatica ERP fields that is used during the import of
sales order data from Shopify.
Retail-Commerce Edition Entity Reference | 543

Table: Sales Order Import Mapping

Source Fields (Shopify) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

    Sales Orders (SO301000) form

    Order Type Summary area The order type is


specified in the Or-
der section on the
Order Settings tab
of the Shopify Stores
(BC201010) form.

    Description Summary area Default: <store


name> | Order: <or-
der number> | Sta-
tus: <payment sta-
tus>

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.

    Status Summary area Default: Open

Order Summary Information

Email Order page > Con- Email Addresses tab >  


tact Information Bill-To Contact sec-
section tion

Notes Order page > Notes Notes Form toolbar  


section

total_weight Not in the UI Order Weight Totals tab > Freight  


Info section

currency   Currency Summary area This is the currency


of the transaction.

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

Source Fields (Shopify) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

order_number Order page > order External Reference Summary area The External Ref-
summary erence contains the
order number and
the store name.

created_at Order page > order Date Summary area  


summary

contact_email Order page >Con- Email Addresses tab >  


tact Information Ship-To Contact
section section

Discounts

discount_codes Order page > dis- External Discount Discounts tab  


count amounts Code

Taxes

title Order page > tax Tax ID Taxes tab  


lines

rate Order page > tax Tax Rate Taxes tab  


lines

price Order page > tax Tax Amount Taxes tab  


lines

Billing Address

name Order page > Billing Attention Addresses tab >  


Address section Bill-To Contact sec-
tion

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

city Order page > Billing City Addresses tab >  


Address section Bill-To Address sec-
tion
Retail-Commerce Edition Entity Reference | 545

Source Fields (Shopify) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

zip Order page > Billing Postal Code Addresses tab >  
Address section Bill-To Address sec-
tion

phone Order page > Billing Phone 1 Addresses tab >  


Address section Bill-To Contact 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.

province_code Order page > Billing State Addresses tab >  


Address section Bill-To Address sec-
tion

Shipping Address

name Order page > Ship- Attention Addresses tab >  


ping Address sec- Ship-To Contact
tion section

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

city Order page > Ship- City 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

phone Order page > Ship- Phone 1 Addresses tab >  


ping Address sec- Ship-To Contact
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

Source Fields (Shopify) Target Fields (Acumatica ERP)


Field Name Page Object Field Name Form Object Notes

province_code Order page > Ship- State Addresses tab >  


ping Address sec- Ship-To Contact
tion section

Customer Details

id Order page > Con- Customer Summary area  


tact Information
section

email Order page > Con- Email Addresses tab >  


tact Information Ship-To Contact
section section

Sales Order Details

quantity Order page > line Quantity Details tab  


items

sku Order page > line Inventory ID Details tab  


items

price Order page > line Unit Price Details tab  


items

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.

Sales Order Export Mapping


The following table shows the mapping of Acumatica ERP fields to Shopify fields that is used during the export of
sales order data from Acumatica ERP to Shopify.
Retail-Commerce Edition Entity Reference | 547

Table: Sales Order Export Mapping

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

Sales Orders (SO301000) form

Date Summary area created_at Order page > order  


summary

Customer Order Summary area order_number Order page > order  


Nbr. summary

External Reference Summary area id Order page > order The order identifi-
summary er is displayed in
the URL of the order
page.

Discount Amt. Discounts tab amount Order page > dis-  


count amounts

Discount Code/Ex- Discounts tab code Order page > dis-  


ternal Discount count amounts
Code

Sales Order Details

Inventory ID Details tab sku / variant_id Order page > line  


items

Line Description Details tab title / variant_title Order page > line  
items

Quantity Details tab quantity Order page > line  


items

Disc. Unit Price Details tab price Order page > line  
items

Tax Category Details tab taxable Order page > line  


items

Sales Order Tax

Tax ID Taxes tab title Order page > tax  


lines

Tax Rate Taxes tab rate Order page > tax  


lines

Tax Amount Taxes tab price Order page > tax  


lines

Shipping Address
Retail-Commerce Edition Entity Reference | 548

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

Account Name Addresses tab > company Order page > Ship-  
Ship-To Contact ping Address sec-
section tion

Attention Addresses tab > first_name, Order page > Ship-  


Ship-To Contact last_name ping Address sec-
section tion

Phone 1 Addresses tab > phone Order page > Ship-  


Ship-To Contact ping Address sec-
section tion

Email Addresses tab > email Order page > Con-  


Ship-To Contact tact Information
section section

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

City Addresses tab > city Order page > Ship-  


Ship-To Address ping Address sec-
section tion

Country Addresses tab > country_code 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

State Addresses tab > province_code 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

Attention Addresses tab > first_name, Order page > Billing  


Bill-To Contact sec- last_name Address section
tion
Retail-Commerce Edition Entity Reference | 549

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

Phone 1 Addresses tab > phone Order page > Billing  


Bill-To Contact sec- Address section
tion

Email Addresses tab > email Order page > Con-  


Bill-To Contact sec- tact Information
tion section

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

City Addresses tab > city Order page > Billing  


Bill-To Address sec- Address section
tion

Country Addresses tab > country_code Order page > Billing  


Bill-To Address sec- Address section
tion

State Addresses tab > province_code 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

Email Addresses tab > email Order page > Con-  


Ship-To Contact tact Information
section section

Account Name Addresses tab > first_name, Order page > Cus-  
Ship-To Contact last_name tomer section
section

Order Totals

Order Weight Shipping tab > Or- total_weight    


der Shipping Set-
tings section
Retail-Commerce Edition Entity Reference | 550

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Page Object Notes

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.

Shipment Export Mapping


The following table shows the mapping of Acumatica ERP fields to Shopify fields that is used during the export of
shipment data to Shopify.

Table: Shipment Export Mapping

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Notes

Shipments (SO302000) form    

    Fulfillments

Carrier Name   tracking_company  

Tracking Number Packages tab tracking_number, track-  


ing numbers

    Line Items

Shipped Qty. Summary area quantity  

Sales Orders form    


Retail-Commerce Edition Entity Reference | 551

Source Fields (Acumatica ERP) Target Fields (Shopify)


Field Name Form Object Field Name Notes

Inventory ID Details tab sku  

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.

Payment Import Mapping


The following table shows the mapping of Shopify fields to Acumatica ERP fields that is used during the import of
payment data from Shopify.

Table: Payment Import Mapping

Source Fields (Shopify) Target Fields (Acumatica ERP)


Field Name Field Name Form Object Notes

  Payments and Applications (AR302000) form

  Type Summary area Default Prepayment.

  Customer Summary area The customer ID is the


same as the customer ID
in the related sales order.

  Location Summary area The location is the same


as the location in the re-
lated order.

currency Currency Summary area This box is shown only


if the Multicurrency Ac-
counting feature is en-
abled on the Enable/Dis-
able Features (CS100000)
form.
Retail-Commerce Edition Entity Reference | 552

Source Fields (Shopify) Target Fields (Acumatica ERP)


Field Name Field Name Form Object Notes

created_at (for the order) Application Date Summary area The payment transaction
date is used.

amount Payment Amount Summary area The payment transaction


amount is used.

authorization Payment Ref. Summary area The number of the relat-


ed credit card transaction
in the processing center.

transaction_id Payment Ref.   The number of the relat-


ed credit card transaction
in the processing cen-
ter. The transaction_id is
used only if the authoriza-
tion field is empty.

gateway Payment Method Summary area The payment method


that is mapped to the
store's payment method
on the Payment Settings
tab of the Shopify Stores
form.

  Cash Account Summary area The cash account corre-


sponds to the payment
method that is mapped
to the store's payment
methods used for the pur-
chase and the transaction
currency of the sales or-
der.

  Description Summary area Default: <store name> |


Order: <store order num-
ber and payment num-
ber> | Type: <type of trans-
action> | Status: <status
of transaction> Gateway:
<gateway name>

  Branch Financial tab > Link to GL The branch specified in


section the General section on
the Order Settings tab of
the Shopify Stores form.
Retail-Commerce Edition Entity Reference | 553

Source Fields (Shopify) Target Fields (Acumatica ERP)


Field Name Field Name Form Object Notes

  Status Summary area The status depends on


the state of the Release
Payments check box in
the row of the payment
method in the table on
the Payment Settings
tab of the Shopify Stores
form. If the check box is
selected, the status is
Open (meaning that the
payment is released). If
the check box is cleared,
the status is Balanced
(indicating that the pay-
ment is not released).
Payments based on cred-
it card payment meth-
ods are created with the
Pending Processing sta-
tus.

  Proc. Center Card Processing tab The processing center


configured for the pay-
ment method mapped
with the store payment
method on the Payment
Settings tab of the Shopi-
fy Stores form.

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

Source Fields (Shopify) Target Fields (Acumatica ERP)


Field Name Field Name Form Object Notes

  PC Response Reason Card Processing tab This column is set to Im-


ported External Transac-
tion to indicate that the
transaction was imported
from an external system.

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.

Aer 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

Figure: Parameters View of Report Form

1. Report Form Toolbar


2. Template Area
3. Details Area

Report Form Toolbar


The following table lists the buttons of the report form toolbar when you are configuring a report.

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.

Remove Tem- Removes the previously saved template.


plate
This button is available only when you select a template.

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.

Table: Select Schedule Name Dialog Box

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.

Merging Order The number of the report in the net report.

Report Toolbar
The following table lists the buttons of the toolbar aer you run the configured report.

Buttons Icon Description

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.
/

First   Displays the first page of the report.

Previous   Displays the previous page.

Next   Displays the next page.

Last   Displays the last page of the report.

Print   Opens the browser dialog box so you can print the report.
Appendix | 558

Buttons Icon Description

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.

Table: Template Area Elements

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.

Report Parameters Tab


The Report Parameters tab includes sections where you can specify the contents of the report depending on the
current report and vary in the following regards:
• How many elements and which elements are available on a particular report
• Whether elements contain default values
• Whether specific elements require values to be selected
• Whether elements may be le blank to let you display a broader range of data

Additional Sort and Filters Tab


The Additional Sort and Filter tab contains additional sorting and filtering conditions:
• Additional sorting conditions: Defines the sorting order. You can add a line, select one of the report-
specific properties, and select the Descending or Ascending sort order for the column.
• Additional filtering conditions: Defines the report filter. You can add a line, select one of the report-
specific properties, and define a condition and its value. The list of conditions include one-operand and
two-operand conditions. To create a more complicated logical expression, you can use brackets and logical
operations between brackets. For more information on creating filters, see Managing Advanced Filters. For
detailed procedures on using ad hoc filters, see Working with Reports: Process Activity.
Appendix | 559

Print and Email Settings Tab


If you plan to print the report or save the report as a PDF, select the appropriate settings in the Print Settings area.

Table: Print Settings Section

Element Description

Deleted Records Selects the visibility of the data deleted from the database.

Print All Pages Causes all pages of the report to be printed.

Print in PDF format Displays the report in PDF format.

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.

Table: Email Settings Section

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.

Email Account The email address of the recipient.

CC An additional addressee to receive a carbon copy (CC) of the email.

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.

Subject The subject of the email.

Report Versions Tab


If the report has multiple versions, you can select one of them.
This tab displays the data only to users assigned with report designer user role.
Report versions are designed in the Report Designer. To activate editing report versions, give the user report
designer role.

Table: Report Versions Tab Toolbar

Button Description

Refresh Refreshes the list of report versions.


Appendix | 560

Button Description

Select Temporarily activates the selected report version.

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.

Buttons Icon Description

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.
/

First   Displays the first page of the report.

Previous   Displays the previous page.


Appendix | 561

Buttons Icon Description

Next   Displays the next page.

Last   Displays the last page of the report.

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

Figure: The form toolbar and the More menu


Appendix | 562

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.

Standard Form Toolbar Buttons


The following table lists the standard buttons of the form toolbar. A form toolbar may include some or all of these
buttons.

Table: Standard Form Toolbar Buttons

Button Icon Description

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.

If the system opened the current form in a pop-up window (from


a different form), this button is not displayed. To return to the
original form, click Close.

Save & Close   Saves the changes made to the entity, and navigates to the list of records that
is related to the current form.

Save   Saves the changes made to the entity.

Cancel   Depending on the context, does one of the following:


• Discards any unsaved changes you have made to entities and retrieves the
last saved version.
• Clears all changes and restores the default settings.

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

Button Icon Description

Clipboard   Provides menu commands you can use to do the following:


• Copy: Copy the selected entity to the clipboard.
• Paste: Paste an entity or template from the clipboard.
• Save as Template: Create a template based on the selected entity.
• Import from XML: Import an entity or a template from an .xml file.
• Export to XML: Export the selected entity to an .xml file.
For more information on templates and copy-and-paste operations in
Acumatica ERP, see Using Forms. For more information on importing and ex-
porting .xml files, see Importing and Exporting Data to Excel and XML in the
Acumatica ERP User Guide.

Go to First Record   Displays the first entity (in the list of entities of the specific type) and its de-
tails.

Go to Previous   Displays the previous entity and its details.


Record

Go to Next Record   Displays the next entity and its details.

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.

Inquiry Form Toolbar Buttons


Acumatica ERP inquiry forms present data in a tabular format; they may also have selection criteria you can use
to filter the data in the table. Predefined inquiry forms are provided as part of Acumatica ERP out of the box, and
inquiry forms can be designed by a user with the appropriate access rights by using the Generic Inquiry tool (for
details, see Managing Generic Inquiries in the Acumatica ERP Reporting Tools Guide). A form toolbar of an inquiry
form contains both the standard form toolbar buttons (described in the table above) and the additional buttons
described below.

Button Icon Description

Refresh   Refreshes the inquiry data in the table.

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

Button Icon Description

Add New Record   Initiates the creation of a new entity.

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.

The More Menu and Form-Specific Buttons


If there are multiple form-specific commands on the form toolbar, they are displayed on a single menu—the More
menu—and listed under descriptive categories, which makes it easier to find the needed menu command. On the
More menu, you can easily define your favorite menu commands, which eases access to them.
On some forms, the system places a button (which is highlighted in green) on the form toolbar for the expected next
command, which represents the likely next step to be performed on the selected record. The following screenshot,
which shows the Cash Transactions (CA304000) form, illustrates an example of the form toolbar and the More menu,
which contains categories and menu commands.

Figure: The form toolbar of the Transactions form

The numbered items in the screenshot indicate the following:


1. A highlighted button for the expected next command, which represents the next logical step to be
performed on the record selected on the form
2. Another button for a command that is commonly performed on the form
3. The More button, which you click to open the More menu
Appendix | 565

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 oen 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.

Highlighted Buttons and Commands


On some forms, the system applies predefined logic to commands for specific records. Based on this logic, the
system may place a button on the form toolbar, highlight it using some color, or do both of these things.
If a command is the expected next command (that is, the command that is most likely to be clicked for a record
with the current status), it is shown both on the form toolbar and on the More menu. The primary command on the
form toolbar is highlighted in green (see Item 1 in the following screenshot), and on the More menu, it is marked
with a green dot (Item 2). Below is an example of a cash transaction on the Cash Transactions (CA304000) form that
has the On Hold status (Item 3). Before you can process it, you need to remove it from hold. Because Remove Hold
is the next logical command, it is displayed as a button on the form toolbar and highlighted in green.
Appendix | 566

Figure: The highlighted command and the corresponding status

Unavailable Commands on the More Menu


By default, on the More menu, the system displays all commands that could be available for the form, based on the
system configuration. Some of these commands may be unavailable (that is, they are listed but cannot be clicked).
These are the commands that are not applicable to the record based on its current status or other factors.

The Responsive Form Toolbar and More Menu


The form toolbar and the More menu have a responsive layout, meaning that they dynamically adjust to different
screen sizes. When there is enough space, buttons for highlighted and favorite commands are displayed on the
form toolbar. When the screen size decreases, the system moves the commands off the form toolbar one by one but
keeps them on the More menu.
If there are multiple categories on the More menu, the categories and menu commands can be displayed in
multiple columns on the More menu, depending on the screen size and the number of categories. When the
screen size decreases, the system moves some categories and menu commands to the le to decrease the number
of columns, and in the screens of the smallest size, all categories are displayed in one column. Below are two
examples of the same menu in different screen sizes for a record on the Bills and Adjustments (AP301000) form.
Appendix | 567

Figure: The form toolbar and More menu on a wide screen

Figure: The form toolbar and More menu on a narrow screen


Appendix | 568

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).

Figure: Table toolbar

Standard Table Toolbar Buttons


The following table describes the standard table toolbar buttons. A table toolbar may include some or all of those
buttons. If a table toolbar includes table-specific buttons, they are described in the reference help topic.

Button Icon Description

Refresh   Refreshes the data in the table.

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.

Delete Row   Deletes the selected row.


Appendix | 569

Button Icon Description

Move Row Up   Moves the selected row one position up.

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.

Download   Downloads the selected file.

File Upload Dialog Box


With the File Upload dialog box, you select a file of one of the supported formats (.csv or .xlsx) to import data
from the file.

Element Description

File Path The path to the file you want to upload.


To select the file, click Browse, and then find and select the file you want to upload.

The dialog box has the following button.

Upload Closes the dialog box and opens the Common Settings dialog box, where you specify the
import settings.
Appendix | 570

Common Settings Dialog Box


In the Common Settings dialog box, which opens if you click Upload in the File Upload dialog box, you specify the
import settings for a file that you has selected in the File Upload dialog box.

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.

Encoding The encoding that is used in the imported file.


This box appears only if you import data from a .csv file.

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.

The dialog box has the following buttons.

OK Closes the dialog box and opens the Columns dialog box.

Cancel Closes the dialog box without importing the data from the file.

Columns Dialog Box


In the Columns dialog box, which opens if you click OK in the Common Settings dialog box, you match the
columns in the imported file that you have selected in the File Upload dialog box to the columns in the Acumatica
ERP table to which you are importing data.

Element Description

Column Name The name of the column in the uploaded file.

Property Name The name of the corresponding column in the table in Acumatica ERP.
Appendix | 571

Element Description

The dialog box has the following buttons.

OK Closes the dialog box and imports the selected file.

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

You might also like