Introduction

In this article, we describe how to integrate with a SquareSpace vendor. If your vendor has a SquareSpace store, Onport can automatically sync products and orders.

Getting Started

Squarespace Commerce offers a set of features for selling products and managing orders online. Onport offers two different types of integrations with SquareSpace vendors:

1. A full integration with the API, which allows for both inventory and order sync. This integration requires the vendor to be on the Advanced Commerce plan on SquareSpace.

2. A partial integration, which allows for publishing and syncing of inventory. This integration uses a free scraping method, but may not be supported on all plans and does not support order sync.

Here's how to set up either of these integrations.

Setting up a partial integration

The partial integration allows you to publish and automatically sync products between your SquareSpace vendors and your store. Tracking details can be entered by the vendor through a dropship portal. To learn more about how they view their orders from the dropship portal, read this.

❗️This integration requires the vendor's website to be set up in a particular way in order for the connection to work, and therefore it is not always reliable. See more information on this under the How products should be created in SquareSpace section of this article.

To set up this integration, you need to do the following steps:

1. Navigate to Contacts and click Add new dropship provider
2. Add the name of the store and save
3. Click on Inventory Feeds and add a New Inventory Feed
4. Click on the Squarespace icon. It will then ask you to enter the URL for the shop into Onport. No additional authentication details are required.

How do I know I have the right URL?

Sometimes there may be confusion about which URL is needed for the integration: it should be the URL of the shop, not the URL of the site.

The way your vendor can find the URL is either by visiting their shop's site directly and sending that URL to you, or they can also find it from their SquareSpace account, by clicking on the arrow that's on the top-right when editing the shop. 

How products should be created on SquareSpace?

For the partial integration to work, your vendors will need to create products in SquareSpace under the Inventory section. If products use a different method (such as a standalone page with static content), we may not be able to sync the information. To add a new product, the vendor should do the following:

1. Click on Commerce > Inventory

2. Click Add new product in the top-right corner.
   
   
3. Add the product details, and click save & publish

By doing this, when you re-fetch the vendor's inventory feed, the new product should show up in your Onport account.

Setting up a full integration

The full integration allows for inventory, order, and shipping sync, by connecting to the API of the store via an API key.

❗️This integration requires the vendor to be on the Advanced Commerce plan on SquareSpace.

To set up this integration, your vendor needs to generate and provide an API key on their store. This key will then be entered within Onport to establish the connection. Here are the instructions on how the vendor can generate the API key:

1. Navigate to Settings > Advanced > Developer API keys in the main menu in SquareSpace

2. Click on Generate key and give the integration a name (this is used for your own internal purposes).

3. For permissions, select read only for Products and Inventory and read and write for Orders. Then, generate the key.

4. Lastly, copy the key and send it to the store asking for the connection.

Once the vendor has provided the API key to the store asking for the connection, the key can be entered in the Vendor settings > Orders within Onport to establish an order sync.

Please check this article on how Squarespace vendors view an order.