Volusion

Installation Instructions

Step 1 – Generate an API URL

Before you can connect a Volusion store with Vextras, you will need to generate an API URL.

How To Generate a Volusion API URL

1. Login to your Volusion dashboard.
2. Go to your ‘Customers‘ tab, then select ‘Administrators‘.
3. Create a new Administrator.
4. Set the ‘Access Key‘ as ‘Administrator’ – note: you can also limit access to the API only in the ‘Customer Access Rules‘.
5. Login to your new Administrator account.
6. Once logged in, go to the ‘Inventory‘ tab and select ‘Import/Export‘.
7. Click on ‘Volusion API‘ tab.
8. Click the ‘Run’ button beside ‘Generic/Orders.’
9. Click the blue ‘Run’ button at the top of the page.
10. Copy the API URL that is generated at the top.

Example Volusion API URL

https://storename.com/net/[email protected]&EncryptedPassword=6ECDE9F0FB 54613F15CBD1E6AB205789FBE55D2A9614110D1B311146DE3D6FB1&EDI_Name=GenericOrders

Important Volusion API URL Information

• The Volusion API URL can be generated from any administrator account.
• If you log in with the newly created admin account, the password will need to be updated every 90 days. When this occurs, the API URL will also change.
• Any API connection you have will be disconnected, and you will need to update each one with the new API URL.
• You may use the same API URL for multiple 3rd party API connections.

Step 2 – Add API URL to Vextras dashboard

1. Login to your Vextras account
2. Click “Add New” on the bottom left
3. Add a new “Store”
4. Add “Volusion”
5. Give your store a name (can be modified at any time)
6. Paste in the API URL you created in Step 1

Step 3 – Add installation snippet to your template

1. In the same “Connection” area where you added your API URL in step 2, copy the installation snippet.
2. Login to your Volusion store as admin.
3. Navigate to ‘Design’ > ‘File Editor’ in the top menu.
4. Choose the main template file, which should be available in the ‘Shortcuts’ area in the right sidebar. Each store will have a unique template name, e.g., template_240.html.
5. Scroll to the bottom of the template file.
6. Paste the installation snippet directly above the ending  </body> tag.
7. Click the blue ‘Save’ button, and you’re done!

Installation Snippet

The Vextras installation script is used to capture shopping cart data in real-time. Apps and workflows depend on this code to be present at all times to work correctly.

Example Installation Snippet

<!-- BEGIN VEXTRAS CODE--><script src="https://s3-us-west-2.amazonaws.com/vextras/production_scripts/store_9VJ8P2PRHJ9JTB52G3M78Y7YGF.js"></script><!-- END VEXTRAS CODE-->

Connection

When your Volusion store is active with Vextras, the ‘Connection’ tab for your store will show key indicators about the installation.

• Status
• Platform
• Store Name
• API URL
• Install Code Status
• Install Script (required) – paste the script into the footer area of your Volusion template before the ending </body> tag.

Settings

• Store information – basic contact details for your store, this is required for CAN-SPAM compliance if you want to use any of our workflows.
• Social links – attach your social links to any of our workflow e-mail templates. When added, the URL’s will automatically link to your social profiles.
• Locale settings – set your country and currency.
• Google Analytics integration – activate Google Analytics to display key metrics in your store’s dashboard.

API URL Updates

Unless you are able to create a permanent API URL for your Volusion store, you will need to update it every 90 days. This is triggered when your admin password is changed.

1. Login to your Volusion dashboard.
2. Once logged in, go to the ‘Inventory‘ tab and select ‘Import/Export‘.
3. Click on ‘Volusion API‘ tab.
4. Click the ‘Run’ button beside ‘Generic/Orders’.
5. Click the blue ‘Run’ button at the top of the page.
6. Copy the API URL that is generated at the top.
7. Paste the new API URL in Vextras (Store > Connection > API URL)
8. Save

Volusion API/XSD Resets

If custom fields are used in your Volusion store, you will need to reset the API when they are modified. This includes situations where you create, update or delete fields for customers or orders. If modified, the API connection will break. As a result, Vextras (or any other 3rd party service) will be unable process data while it’s broken.

How Reset Your Volusion API

1. Log into your Volusion store’s FTP using a client like Filezilla or Transmit.
2. With the FTP user (make sure you have root “/” access, along with read/write privileges).
3. Navigate to the /vspfiles/schema/Generic directory.
4. Delete the files named “orders.xsd” and “customers.xsd”.

Volusion API Reset Notes

• The files that were deleted via FTP will eventually be regenerated.
• Your API connection will break when any customer or order custom field is modified.
• When your API is reset, our system picks up where things left off so data stays in sync.
• MailChimp campaign tracking will not be captured, as it relies on a real-time API connection.

Removing Your Store

1. Login to your Volusion store admin area.
2. Navigate to ‘Design’ > ‘File Editor’.
3. Choose the main template file (should be available in the ‘Shortcuts’ area in the right sidebar).
4. Scroll to the bottom of the template file.
5. Remove the Vextras installation code directly above the ending </body> tag.
6. Login to your Vextras dashboard.
7. Delete the Volusion store from the ‘Stores’ tab.

More Information

Processing Times

• All new order data is processed in real-time through standard web checkout.
• Phone or manual orders are processed at 15-minute intervals.

Order Update Times

• Our systems poll your store’s API on set intervals i.e. every 4, 6, 8 hours etc. At that time, we filter through each record in our system and look for any order status change.
• By default, we check for order status changes every 10 hours.

Order Monitoring

• Before an order status is Shipped, each order status is monitored for 60 days. After an order is Shipped, our systems continue to monitor the order for 30 days.

Bandwidth Usage

Because of the way this shopping cart’s API is designed, we must poll your store’s API periodically to check for order updates. Although unlikely, this could result in increased bandwidth usage. How much usage is dependent on your store’s order volume.

Valid SSL Required

• If a store lacks a valid SSL certificate, we are unable to process any order information.
• If an SSL expires on your domain, Vextras apps and workflows will not function.
• An SSL can be purchased from the shopping cart provider or any 3rd party SSL vendor.
• Installation of an SSL will need to be facilitated with your shopping cart provider.

Localization

• All major currencies supported
• All time zones supported

Limitations

Platform

• An order must be placed through the standard web checkout before any phone or manual orders will process.