Squarespace Integration

Connect MicroPIM to your Squarespace Commerce store in under 5 minutes. You generate one API key in Squarespace, paste it into MicroPIM, and MicroPIM keeps your products and inventory in sync.

Before you start

You need:

• A Squarespace site on a Business plan or higher (Developer API Keys are a Premium feature — they don’t work on Personal plans)
• Owner or admin access to the Squarespace site
• An active MicroPIM account

That’s it. No code, no OAuth setup, no developer account.

Step 1 — Open Developer Tools in Squarespace

In your Squarespace site, open Settings → Developer Tools.

Click Developer API Keys.

Step 2 — Generate a new API key

You’ll see an empty Developer API Keys page. Click GENERATE KEY.

A dialog opens with a “Premium Feature” notice at the top. This is normal — you stay on the dialog and fill in the form.

Step 3 — Name the key and choose permissions

Enter a Key Name that identifies this integration. We recommend:

MICROPIM-NET

Then enable the permissions MicroPIM needs:

Permission	Setting	Why MicroPIM needs it
Products	Read and Write	Push product data, prices, descriptions, and images from MicroPIM into Squarespace
Inventory	Read Only (minimum) — Read and Write recommended	Read stock levels back from Squarespace; write back if you manage inventory in MicroPIM
Forms	leave off	Only needed for Zapier — MicroPIM doesn’t use this

The minimum required to sync products is Products: Read and Write + Inventory: Read Only. Leave the other permissions off — MicroPIM doesn’t use them.

Step 4 — Generate and copy the key

When permissions look right, click GENERATE KEY in the top-right of the dialog.

Squarespace shows the API key once. Click COPY KEY immediately.

Save the key somewhere safe before closing this dialog. Squarespace will not show it again. If you lose it, you’ll need to revoke and generate a new one.

The key looks like ae07-... and is long. The summary screen also confirms which permissions are attached to it.

Step 5 — Connect MicroPIM to Squarespace

In MicroPIM:

1. Go to Integrations → Add Integration
2. Select Squarespace from the platform list
3. Fill in the fields:
   • API URL — https://api.squarespace.com
   • API User — any label you want (e.g., my-store); used for the User-Agent header Squarespace requires
   • API Secret — paste the API key you copied from Squarespace
4. Click Test Connection — MicroPIM calls GET /v2/commerce/products to verify the key works
5. Click Save

You’re connected.

How MicroPIM talks to Squarespace

Under the hood, MicroPIM uses the Squarespace Commerce API v2. Two HTTP headers are sent on every request:

Authorization: Bearer <your-api-key>
User-Agent: <api-user-label>

Both are required by Squarespace — the User-Agent is what shows up in your Squarespace activity logs to identify MicroPIM traffic.

What syncs

Data	Direction	Notes
Products	MicroPIM → Squarespace	Name, description (HTML), tags, visibility, SEO options, URL slug
Product variants	MicroPIM → Squarespace	SKU, attributes (e.g., size, color), pricing, stock, shipping dimensions
Product images	MicroPIM → Squarespace	Up to 100 images per product, with alt text
Pricing	MicroPIM → Squarespace	Base price, sale price, onSale flag, per-variant pricing
Stock	MicroPIM → Squarespace	Per-variant inventory

Product types supported: Physical, Service, Gift Card. Download products can be read but not created or deleted via the API (Squarespace limitation).

What gets read on each sync

When MicroPIM polls Squarespace for products, it calls:

GET https://api.squarespace.com/v2/commerce/products

Optional filters MicroPIM uses:

• modifiedAfter — only pull products changed since the last sync (incremental sync)
• type — restrict to specific product types
• cursor — page through results (50 per page)

Squarespace returns a list of products with full details: id, name, description, images, variants, pricing, visibility, tags, and timestamps. MicroPIM maps these to its own product fields automatically; you can customize the mapping from Integrations → Edit → Field Mapping.

Troubleshooting

401 Unauthorized when testing the connection The API key is wrong, expired, or was revoked in Squarespace. Generate a new key and reconnect.

403 Forbidden on products or inventory The API key is missing the Products or Inventory scope. In Squarespace, revoke the key and generate a new one with the right permissions — you can’t edit a key’s scopes after creation.

The “Generate Key” button is greyed out / shows “Premium Feature” Your Squarespace plan doesn’t include Developer API Keys. Upgrade to Business or higher in Settings → Billing.

Products in MicroPIM aren’t appearing in Squarespace

• Check the product is visible in MicroPIM (not in draft)
• Check that a Store Page exists in Squarespace and is enabled
• Squarespace requires both: a Store Page must be live AND each product’s isVisible must be true to show up to shoppers

Stock not updating Confirm the variant SKU matches between MicroPIM and Squarespace — Squarespace identifies variants by SKU when updating stock.

Rate limit / 429 errors Squarespace throttles API calls. MicroPIM retries automatically with exponential backoff. Large initial syncs may take several minutes to complete.

FAQ

Does this work with the Personal plan? No. Developer API Keys are a Business-plan-and-above feature.

Can I edit the permissions of an existing key? No — Squarespace doesn’t allow editing a key after creation. Revoke and regenerate with the new permissions.

Can I connect multiple Squarespace sites? Yes. Generate one API key per site and create one MicroPIM integration per site. Assign each to a different Publishing Channel if you want different products on each.

Does this support Squarespace’s Commerce API v1? MicroPIM uses Commerce API v2 (the current version). v1 endpoints are not used.

Does it support service products, gift cards, and downloads? Physical, service, and gift card products: full read/write. Download products: read-only (Squarespace’s API doesn’t support creating or deleting downloads).

Can I roll back a sync? Syncs are not reversible, but every change is recorded in the Audit Log.