Child pages
  • Shopify/ACUMEN Documentation
Skip to end of metadata
Go to start of metadata

Shopify/ACUMEN Integration App Documentation

Our integration provides an automated way to move orders from Shopify into ACUMEN, and product data from ACUMEN into Shopify.  It saves data entry, speeds order processing and improves the customer experience. 

Getting Started with the Integration

Follow these steps to begin configuring the integration.  We're here to help.  So as you have questions, contact Support via email at Jaydip@web2market.com.

Step 1: Contact us (W2M) to create your Account.

Step 2: Get following details from CyberWolf your support representative and forward it to Jaydip@web2market.com:

  1. ACUMEN API URL (Make sure this API URL have SSL)
  2. ACUMEN API Site Code
  3. ACUMEN API Password
  4. API Message Version
  5. ACUMEN API Site ID

We'll notify you when you can proceed to Step 3.

Step 3: Accept the collaborator account access that we'll be sending via Shopify.  We need this access to help you configure the app and enter settings.

Step 4: After we configure the ACUMEN API details, you can enter settings in the app (like mapping shipping methods, mapping sales tax, etc.).  Instructions for that are below.


How Add the Shopify/ACUMEN Private APP in Shopify

  • Login to your Shopify store admin panel
  • Go to Apps
  • Scroll Down and Click on "Manage private apps"

  • Click on "Create new private app" button

  • Private app name - What ever you want
  • Emergency developer email - info@web2market.com
  • Admin API - You need to Active Permission for this APP is: "Customers- Read and Write", "Fulfillment services - Read and Write", "Inventory - Read and Write",  "Locations - Read and Write", "Orders - Read and Write", "Product listings - Read and Write", "Products - Read and Write", "Script tags - Read and Write" permission

  • Click on "Save" button after that popup will open
  • Click on "Create APP" into popup

  • Next, copy the "API key" and "Password"


Configuring your ACUMEN server API detail:

We typically configure this for our clients.  For reference though, our service needs to be able to access your Shopify software.  Contact your ACUMEN support representative for these system details.  Once you have them, you can login to our app and configure settings.

  1. Goto https://accumenappdev.web2market.com/private/login
  2. Login your account using Email/Password
  3. Go to Setting page
    1. ACUMEN API setting (Please ask your CyberWolf support representative for the following information)

                                                    i.     Select ACUMEN into API field

                                                   ii.     ACUMEN API URL

                                                  iii.     ACUMEN API Site Code

                                                  iv.     ACUMEN API Password

                                                   v.     API Message Version

                                                  vi.     ACUMEN API Site ID


 

Note:  If you want to test the connection between your ACUMEN server and the Shopify app, you can use the following instructions:

Go to https://accumenappdev.web2market.com/private/login and login the ACUMEN account using the email and password (Contact us to get email/password first time)

  • After you successfully login, you will redirect to the "Store Settings" page
  • Next create a Create Private app into your Shopify store and fill the detail here. (Please check next step how to create Private APP into Shopify)

  • Click on "Test Connection!", You will get a success message if API detail is correct
  • Click on "Connect to Shopify" button to save this API detail.



Configuring App Settings

1. Import setting

    1. Turn on the Import Enabled option by setting it to Yes
    2. Enter your ACUMEN Warehouse name
    3. Select Image import by (like product SKU.png or product ISBN.png)
    4. Enter your Image Server endpoint (Like URL of the server where you upload images by SKU or ISBN. Ex: https://example.com/images/, so system will get image URL like https://example.com/images/sku.jpg )
    5. Select Inventory field (Default is disable)
    6. Select Import Collections field (Default is No)
    7. Select Import Contributor field (Default is No)
    8. Select Import Review field (Default is No)
    9. Select Import Related product field (Default is No)

 

2. Click on the “Get products from ACUMEN” button if you want to sync products from ACUMEN to the app (Note: Products are not pushed into Shopify yet)


3. Next, you can click on “Import products to Shopify” button to push products into Shopify


4. Export Setting

    1. Set Export Enabled field to Yes to export orders into ACUMEN
    2. Enter E-mail address to field (ACUMEN email to you when place the order into ACUMEN)
    3. Set E-mail address from field (ACUMEN email from this when place the order into ACUMEN)
    4. Set E-mail subject field
    5. Enter a Customer Category if you want to set customer category
    6. Enter a Customer Type if you want to set customer type
    7. Enter a Customer Class  (Fill this field If you want to set customer class
    8. Enter a Default shipping method for when the Shopify order has no shipping method


How to Map Shipping and Tax data Between Shopify and ACUMEN

  1. Go to Order Mapping page in the Settings
    1. Choose Map Shipping Methods

                                                    i.  Enter a Default ACUMEN Shipping Method if you wish to override the export default shipping)

                                                   ii.  Click on add New button

                                                  iii.  Add Shopify Shipping method and ACUMEN shipping method

                                                  iv.  Save it


                  b. Map Tax Rates

                                                    i.     Default ACUMEN Tax code (it will be push if Tax code blank in Shopify)

                                                   ii.     Click on add New button

                                                  iii.     Add Shopify Tax code and ACUMEN Tax code

                                                  iv.     Save it



How to Manually Export orders from Shopify to ACUMEN

  1.  From with the app, go to Order -> Manual Order Export
    1. Add an Order Starting ID (empty = Start from beginning)
    2. Add an Ending ID (empty = until the last order)
    3. Select Status of order
    4. Select Financial Status
    5. Select Fulfillment Status
    6. Set Date Range From
    7. Set Date Range To
    8. Export only order not yet exported (check if you want to export only orders not marked as previously exported)
    9. Test Export (means orders are not marked as exported)


How to Set Auto Export orders from Shopify to ACUMEN

  1. Go to Order -> Auto orders export (inside APP)
    1. Enable (Check for Auto export orders)
    2. Select Status of order
    3. Select Financial Status
    4. Select Fulfillment Status
    5. Set Date Range From
    6. Set Date Range To

The Product Listing page

  1. Here you can see all products in Shopify
  2. For products already in Shopify, you can set ISBN and ACUMEN codes for them.


Warehouses

  1. If you have multiple warehouses in Shopify select default warehouse.
  2. By default system it will take first warehouse. And sync all products into default warehouse.

Orders listing

  1. In this page you can see your orders, if not just click on sync button.

Execution Log

  1. In this page you can see the execution log file.  It records manual and auto syncs of the order XML file.

FAQs

General Questions

  1. How often Product schedule run
    1. Product schedule will run once in a day.
  2. How often Order schedule run
    1. Order schedule will run once in every hour.
  3. I see ACUMEN order id into ACUMEN integration APP but can't find order information into ACUMEN
    1. ACUMEN has to process the order information to create invoices. Go to OE/AR -> eCommerce Site and make sure the Process New Orders box is checked on the General page of the site record. Save and close the site record then click the Receive button at the bottom of the eCommerce Site record list. When the receive button is clicked, ACUMEN looks for eCommerce Order records with a status of New and then processes the order data to create invoices. This is usually done as a manual process, but it's possible to set up a computer that will scan for new eCommerce Order record and process them automatically. 
  4. How ACUMEN matches Shopify orders with existing customers in ACUMEN:

    • First priority is the <PartyACUMENID>, the contents of which are used to search ACUMEN Customer ID's for a match.  Used for PW B2B sites, where the site knows the ACUMEN customer ID.  Few, if any, consumer sites will know/have the related ACUMEN customer ID.
    • Second priority is the <PartyID> tag.  The contents of that tag should be a unique ID from the website database for the user account.  ACUMEN prepends that ID with the ACUMEN eCommerce Site Code used to import the order and saves it with the ACUMEN Customer record as what ACUMEN calls an Old Code.  Eg <PartyID>123456</PartyID> imported using an eCommerce site record with a site code of SHP will create an Old Code of SHP123456 and save it with the customer used by the order.
    • Third priority is based on a setting in the eCommerce site record.  It can be Name, Zip, Phone, email, or simply email.  We recommend customers use the email search, rather than name, Zip, phone, email because the latter is so exacting. So, if no existing customer is found by the first two searches, ACUMEN should be configured to search for a match by email address alone.  If a match is found, the matching customer is updated with the Old Code from the second search, so even if the customer changes their email address for a future order, it will find the correct customer in ACUMEN.  If more than one customer record in ACUMEN has matching email address, the import will create a new customer record and record in the import log messages that a probable duplicate customer was created, matching email address for customer ID's 489823 and 982734

Shipping Mapping Settings

  1. Why do I need to Map my Shipping Name?
    1. If you want to create like Shopify have Fedex and ACUMEN should have "Fedex Ground"
  2. Do I need to add Default Shipping Name?
    1. No, It is not mandatory to add Default Shipping Name.   If you leave Default Shipping blank, your order will not have shipping method so ACUMEN will leave the shipping method blank.
  3. How Many Shipping Methods I can Map
    1. There is no limit.


Tax Mapping Settings

  1. Why do I need to Map my Taxes?
    1. If you want to create like Shopify have Florida tax and ACUMEN should have "Florida state".
  2. Do I need to add a Default Tax Name?
    1. No, It is not mandatory to add a Default Shipping Name.  If you leave default tax method blank, your order will not have a tax name so ACUMEN have blank tax name.
  3. How Many Taxes I can Map
    1. There is no limit.





  • No labels