Skip to main content

Squarespace Connector

The Squarespace connector links one merchant-owned Squarespace site to one eshopOS store. It is used for catalog import into eshopOS.

This is a connector, not a sales channel. After import, the eshopOS storefront reads eshopOS products, variants, prices, stock, and images.

Current Integration Mode

The current Squarespace connector uses:

  • a Squarespace API key
  • backend-only encrypted key storage
  • website validation before saving the connection
  • product preview before import
  • import jobs scoped to the selected eshopOS store

What It Imports

  • products
  • product slugs
  • descriptions
  • tags
  • visibility
  • variants
  • SKU values
  • base prices and sale prices
  • variant stock quantities
  • product image URLs

What It Does Not Import Yet

  • orders
  • customers
  • Squarespace checkout settings
  • Squarespace website themes or pages
  • two-way inventory writes back into Squarespace

Those need separate provider permissions and a different sync policy.

API Key Requirements

For product migration, create a Squarespace API key with Products Read Only access.

Use the smallest permission set that fits the job. Do not use an admin-wide key if the merchant only needs product import.

Merchant Setup Flow

  1. Open Connectors.
  2. Open Squarespace.
  3. Paste the Squarespace API key.
  4. Click Connect Squarespace.
  5. Confirm the connected site name and currency.
  6. Open Preview.
  7. Review product, variant, and image counts.
  8. Run Import.

API Setup

The dashboard uses the merchant connector endpoint:

POST /api/v1/merchant/stores/{store_id}/connectors/squarespace/connect

Request body:

{
"api_key": "squarespace_api_key",
"return_to": "/connectors/squarespace"
}

The backend validates the key against Squarespace before saving it.

Core Mapping

Squarespace fieldeshopOS target
product nameproduct name
URL slugproduct slug
descriptionproduct description
tagsproduct tags
visibilitypublished state
variant SKUvariant SKU
variant pricingproduct and variant prices
variant stockinventory quantity
product imagesproduct image URLs

Reruns update previously imported records when import mappings exist.

Security Notes

  • API keys are never shown back after setup.
  • Keys should be rotated if they are copied into chat, screenshots, logs, or support tickets.
  • Disconnecting removes provider access from eshopOS but does not delete imported catalog data.
  • Product import should use a read-only key until write-back sync is intentionally enabled.

Troubleshooting

The key fails to connect

Check that:

  • the key is active in Squarespace
  • the key has product read access
  • the key has not been revoked or rotated
  • the merchant is connecting the correct Squarespace site

Preview shows fewer products than expected

Check product visibility and whether the products are available through the Squarespace Commerce Products API.

Imported stock looks wrong

Squarespace can represent stock differently per variant. Review products with unlimited stock or missing variant quantities after import.