Menu

Spark Pay: Add a Store in ShipWorks

Avatar

ShipWorks Content Team

Updated

Background

ShipWorks connects directly to your Spark Pay account. With one click, or on an automated schedule, your orders are downloaded from Spark Pay. As soon as you process a shipment, ShipWorks communicates the updated order status, shipping method and tracking information back to Spark Pay.

First Things First

Before you set up your Spark Pay store in ShipWorks you will need to obtain connection information from within your Spark Pay administration / Dashboard webpage. Please also be sure that you can launch ShipWorks and log in with administrator rights.

We recommend that you run the latest version of the ShipWorks software. This allows you to access the latest tools and features and ensures the steps in this article will work for you. For assistance with checking your version of ShipWorks or with upgrading to the latest version, please see the How Do I Upgrade ShipWorks help article.

The Process

Configuring Spark Pay

1. Log into your Spark Pay administration / Dashboard page. Near the bottom of the Spark Pay Dashboard navigation menu click Tools Apps & Addons.

SparkPay_SB_ToolsAppsAddons

2. Scroll to the bottom of the Application List and click API Apps & Integrations.

SparkPay_BTN_APIAppsIntegrations_MRK

3. Click the New button at the top right.

SparkPay_BTN_ApiApps_NEW_MRK

4. Input ShipWorks as the App Name and ShipWorks as the App Description. Then click Next.

SparkPay_AppNameAppDescription_BTN_NEXT_MRK

5. Click the Select button in the Single Token Flow section.

SparkPay_AuthFlow_BTN_SingleTokenSelect_MRK

6. Setup the permissions to grant full access to all modules. Specifically, check the boxes for all the following listed below.

  • View and change customer, user, or profile data

  • View and change order data

  • View and change catalog data

  • View and change blog, page, and other content-related data

  • View and change adcode, discount, and other marketing-related data

  • View and change theme data

  • (Tools Permission) Send email on behalf of the store Perform

  • bulk data imports

  • Manage custom fields

  • Manage custom rules

  • (Other Permissions) View and change configuration settings

  • Perform system tasks

  • View encrypted data

  • Stay logged in without expiration

7. After all the above noted options are checked, click the Save button.

8. Locate and copy (to your clipboard, CTRL+C) the Access Token value.

SparkPay_AccessToken_MRK

9. Click Finish.

360019751711-5c51f84115836.png

Adding Spark Pay to ShipWorks

1. Click on the Manage tab, then on the Stores button. Then, click Add Store.

Click the Manage tab then the Stores button. Then click Add Store.

2. Select the platform you are adding to ShipWorks from the What platform do you sell on? drop-down menu. Then, click Next.

Select the store type from the dropdown menu.
Box highlights the Next button.

3. Input your Spark Pay Store URL (like: https://shipworks.shipworks.com, or similar).

4. Paste (from your clipboard, CTRL+V) in your Access Token that you found from step 8 above.

WIZ_AddStore_SparkPay_CREDS

Complete the Setup Wizard

Great! You are connected. Now, you will need to fill out a few more screens.

1. On the Store Information screen, enter your Store Name: and Address:. Then, click Next.

Generic store information screen in Add store wizard

2. Enter the additional Contact Information: for your store. Then, click Next.

Note: This information is optional.

generic contact info screen in add store wizard

3. Select how much order history you would like to download into ShipWorks during your initial download. The default is to download 30 Days of order history into ShipWorks. You can modify this by clicking on the Edit link.

The store setup screen in ShipWorks is displayed and the Edit link is highlighted.
Add Store wizard select download days

4. Verify that the settings for When the shipment is processed: are correct. Typically, you would leave the checkbox for Update my online orders with the shipment details checked.

update my online orders with shipment details add store wizard

5. Click Next and then Finish. Then, click Close.

Your orders will begin to download automatically.

Still Need Help?

Please feel free to reach out to one of our awesome Technical Support Representatives in St. Louis.  We are happy to help.

Have a comment to share about this article? We'd love to hear from you. You must be logged in to your Support Portal account to leave a comment.

Comments

0 comments