Spree Account Integration


Spree Commerce is an open-source shopping cart platform that enables you to create and manage online stores. The integration between Sellercloud and Spree allows you to download orders into Sellercloud, send tracking information, and automate price and inventory updates.

Integrate with Spree

Sellercloud communicates with Spree via API. To integrate with Spree, you must obtain a Spree API Key, required for your API configuration in your Sellercloud account.

Spree API Key

Follow the below steps to generate a Spree API Key:

  1. Log in to the Admin Dashboard in Spree.
  2. Navigate to the Users tab and click on New User.
  3. Set up an Admin user. The email and password are not important, but it is critical that the user is an admin.
  4. Once you create the Admin account, click the Generate API key.

Configure API Settings

After you obtain a Spree API Key, you should configure your API settings in Sellercloud:

  1. Navigate to Settings > Companies > Manage Companies and select a company.
  2. From the Toolbox, select Sellercloud Plug-in Website > Cart General.
  3. Click Edit.
  4. In the Select Plugin field, select Spree.
  5. The Website URL should be set to http://example.com, where example is replaced with your website domain name.
  6. The API Token should be populated using the API Key generated from the new admin user in the Spree backend.
  7. The Default Shipping Category ID should be set to 1.
  8. Click Save.
  9. From the Options panel, select action Test Settings to check if the website integration is successful.

General Integration Settings

Once the connection has been established, set the parameters of the integration to automate key processes:

  1. Navigate to your company’s Toolbox and select Website General Settings.
  2. Click Edit.
  3. Choose Custom from the Store Type dropdown menu. 
  4. Select Spree from the Store Plugin list.
  5. Configure the integration Options settings, as desired:
    • Allow Inventory Upload – Enables Sellercloud to send automatic inventory updates for your Spree-enabled products.
    • Allow Price Upload – Activate this setting to enable Sellercloud to send automatic price updates for your Spree-enabled SKUs.
    • Allow Order Download – Enables Sellercloud to automatically download new Spree orders.
    • Allow Tracking Upload – Activate this setting to enable Sellercloud to send automatic shipping and tracking updates to Spree.
  6. Save your changes.


Was this article helpful?

Need Support?
Can't find the answer you're looking for?
Contact Support