Squarespace Integration with SmythOS

Want to automate your e-commerce operations? Connect your Squarespace store to SmythOS and empower your agents to manage products, sync inventory, and process orders automatically.

TL;DR

Securely link your Squarespace store to SmythOS using an API key generated from your Developer Tools. Then, use our suite of components to automate a wide range of e-commerce tasks, from creating new products to updating stock quantities.

List of Squarespace Components

Quickly compare Squarespace components by what they do and their key I/O. Click any component name to jump directly to its detailed guide.

Component	Action	What it Does	Inputs	Key Outputs	Use Case
Create Product	Write	Creates a new physical product in your store.	required storePageId, name, sku	product_id, url	Adding a new item to your catalog from an external system.
Update Product	Write	Updates the information for an existing product.	required productId, Body	product_id	Changing a product's name or description.
Delete Product	Write	Permanently deletes a product and all its variants.	required product_id	Response	Removing discontinued items from your store.
Get Products	Read	Retrieves a list of all products in your store.	required trigger	products	Getting a full catalog export for analysis.
Get Specific Products	Read	Retrieves information for one or more specific products.	required product_ids	products	Fetching details for a select group of items.
Create Product Variant	Write	Creates a new variant (e.g., size or color) for a product.	required product_id, sku, basePrice	productVariantId	Adding a "Large" size option to a t-shirt.
Update Product Variant	Write	Updates a specific variant of a product.	required productId, variantId, Body	productVariantId	Updating the price or SKU of a specific product size.
Delete Product Variant	Write	Deletes a specific variant from a product.	required productId, variantId	Response	Removing the "Small" size option when it's sold out.
Increase Stock Quantity	Write	Increases the stock quantity for product variants.	required variantId, quantity	Response	Adding new stock after a shipment arrives.
Decrease Stock Quantity	Write	Decreases the stock quantity for product variants.	required variantId, quantity	Response	Syncing inventory after an in-store sale.
Set Unlimited Stock	Write	Sets the stock for variants to be unlimited.	required variantIds	Response	Marking a digital product as having unlimited stock.
Get All Inventory	Read	Retrieves stock information for all product variants.	required trigger	inventory	Performing a full inventory audit.
Get Specific Inventory	Read	Retrieves stock information for specific variants.	required variantIds	inventory	Checking the stock level for a particular item.
Get All Orders	Read	Retrieves all order information from your store.	required trigger	orderResults	Exporting order data for custom reporting.
Get Specific Order	Read	Retrieves information for a single, specific order.	required orderId	orderId	Fetching details to process a customer support query.
Get All Transactions	Read	Retrieves all financial transaction information.	required trigger	transactions	Syncing financial data with accounting software.
Get Specific Transactions	Read	Retrieves one or more specific financial transactions.	required transactionIds	transactions	Investigating a particular payment.
Upload Product Image	Write	Uploads a new image to a product's gallery.	required productId, image	imageId	Automating the addition of new product photos.
Update Product Image	Write	Updates the alt text for a product image.	required productId, imageId, altText	imageId	Improving image SEO programmatically.
Delete Product Image	Write	Deletes an image from a product's gallery.	required productId, imageId	Response	Removing outdated product photos.
Assign Product Image to Variant	Write	Links a product image to a specific product variant.	required productId, variantId, imageId	Response	Showing the red t-shirt when the "Red" variant is selected.
Reorder Product Image	Write	Changes the display order of images in a product gallery.	required productId, imageId, afterImageId	Response	Making a new photo the primary image for a product.
Get Store Pages	Read	Retrieves all store pages on your site.	required trigger	storePages	Finding the correct storePageId to create a product on.

INFO

Why Integrate Squarespace with Your Agent?

Your Squarespace store is the heart of your e-commerce business. Integrating it with SmythOS allows you to build powerful agents that automate your operations, saving you time and reducing manual errors.

• Automated Inventory Management: Create agents that sync your Squarespace inventory with an external supplier's stock levels, preventing overselling and ensuring your product availability is always accurate.
• Streamlined Order Fulfillment: When a new order is placed, an agent can automatically retrieve the order details and send them to your shipping provider or fulfillment center's API.
• Dynamic Product Catalogs: Build agents that can create or update products in your Squarespace store based on data from a spreadsheet, a PIM (Product Information Management) system, or another database.
• Custom Reporting: Schedule agents to fetch all order or transaction data daily and format it into a custom report, giving you insights that go beyond the standard Squarespace analytics.

Prerequisites

Before you begin, please ensure you have the following:

• An active SmythOS account. (Sign up here).
• A Squarespace account on a Business plan or higher.
• A Squarespace API Key with the necessary permissions.

Getting Started With Squarespace

The connection between SmythOS and Squarespace is configured using a secure API Key.

Step 1: Get Your Squarespace API Key

1. Log in to your Squarespace Dashboard and select the site you want to connect.
2. In the main menu, go to Settings > Developer Tools.
3. Click on Developer API Keys.
4. Click Generate Key.
5. Give your key a descriptive name (e.g., "SmythOS Agent").
6. Under Permissions, check the scopes your agent will need (e.g., Products: Read and Write, Orders: Read and Write).
7. Click Generate Key.
8. Copy the generated API Key immediately. It will not be shown again.

Step 2: Store Your API Key in SmythOS Vault

Your API Key is a sensitive credential. Use the SmythOS Vault to store it securely.

1. In your SmythOS dashboard, navigate to the Vault.
2. Create a new secret and paste your Squarespace API Key as the value. Give it a memorable name, like squarespace_api_key.
3. For more details, see the Vault Documentation.

Step 3: Configure a Squarespace Component

1. In your SmythOS agent graph, drag and drop any Squarespace component.
2. Click the component to open its Settings panel.
3. In the API Key field, select the secret you saved in the Vault (e.g., squarespace_api_key).
4. Your connection is now configured for that component.

Heads-up

You must add the API Key from the Vault to each Squarespace component you use. This ensures all your API calls are properly authenticated.

Which Squarespace Component Should I Use?

If you need to…	Target	Use this Component	Why this one?
Add a new t-shirt to your store	A store page	Create Product	The primary method for adding a new product to your catalog.
Change a product's description	A productId	Update Product	Modifies the top-level details of an existing product.
Update the price of the 'Large' size	A variantId	Update Product Variant	Offers granular control to edit a specific product variant.
Sync inventory from a supplier	A variantId and quantity	Increase Stock Quantity	The correct way to adjust stock levels without overwriting other data.
Get a list of all unshipped orders	All orders	Get All Orders	Retrieves all orders, which you can then filter in your agent.
Add a new photo to a product page	A productId and image file	Upload Product Image	The standard way to add new images to a product's gallery.

Component Details

This section provides detailed information for each Squarespace component.

Create Product

Creates a new physical product with at least one variant on a specified store page.

INFO

This component requires an API Key for authentication.

Inputs

Field	Type	Required	Notes
storePageId	string	Yes	The unique identifier of the store page where the product will be created.
name	string	Yes	The name of the new product.
sku	string	Yes	The Stock Keeping Unit for the product's primary variant.
basePrice	string	Yes	The price of the product's primary variant.
description	string	Optional	The product's description.

Outputs

Field	Type	Description
product_id	string	The unique ID of the newly created product.
url	string	The URL slug of the new product's detail page.
variants	array	An array containing the details of the product's variants.
Response	object	The full, raw JSON response from the Squarespace API.

Use Case

An agent reads new product data from a Google Sheet, then calls this component for each row to automatically populate a new collection in the Squarespace store.

Update Product

Updates the top-level information for a physical product.

INFO

This component requires an API Key for authentication.

Component-Specific Settings

• Body: A JSON editor containing the schema of the product fields to update.

Inputs

Field	Type	Required	Notes
productId	string	Yes	The unique identifier of the product you wish to update.

Outputs

Field	Type	Description
product_id	string	The unique identifier of the updated product.
Response	object	The full API response from Squarespace.

Use Case

An agent syncs data from a PIM system, using this component to update product names and descriptions on the Squarespace store to match the source of truth.

Body Schema is Key

The Body payload must be a valid JSON object matching the schema defined in the Squarespace Developer Documentation for updating products.

Delete Product

Permanently deletes a physical product, including all its variants and images.

INFO

This component requires an API Key for authentication.

Inputs

Field	Type	Required	Notes
product_id	string	Yes	The unique identifier of the product to delete.

Outputs

Field	Type	Description
Response	object	The full API response from Squarespace, detailing the deletion process.
Headers	object	HTTP headers providing additional data details.

Use Case

An agent runs a cleanup script to remove discontinued products from the store catalog.

Irreversible Action

This action is permanent and cannot be undone.

Get Products

Retrieves information for all products in your store.

INFO

This component requires an API Key for authentication.

Inputs

Field	Type	Required	Notes
trigger	string	Yes	An input to trigger the component execution.
type	string	Optional	The type of products to retrieve (e.g., PHYSICAL).

Outputs

Field	Type	Description
products	array	An array containing the details of each product.
Response	object	The full API response from Squarespace.

Use Case

An agent performs a full catalog export by fetching all products and writing their names, SKUs, and prices to a Google Sheet for analysis.

Get Specific Products

Retrieves information for one or more specific products by their IDs.

INFO

This component requires an API Key for authentication.

Inputs

Field	Type	Required	Notes
product_ids	string	Yes	A comma-separated list of product IDs to retrieve.

Outputs

Field	Type	Description
products	array	An array containing the details of each specified product.
Response	object	The full API response from Squarespace.

Use Case

After receiving a list of top-selling items, an agent uses this component to fetch the full details for only those specific products.

Create Product Variant

Creates a new variant for a physical product.

INFO

This component requires an API Key for authentication.

Inputs

Field	Type	Required	Notes
product_id	string	Yes	The unique identifier of the parent product.
sku	string	Yes	Stock keeping unit for the new variant.
basePrice	string	Yes	The base price of the new variant.
attributes	object	Optional	An object defining the variant's attributes (e.g., {"Size": "Large"}).

Outputs

Field	Type	Description
productVariantId	string	The unique identifier of the newly created product variant.
Response	object	The full API response from Squarespace.

Use Case

An agent adds a new "XXL" size option to an existing t-shirt product by creating a new variant with the appropriate attributes.

Update Product Variant

Updates a specific variant of a physical product.

INFO

This component requires an API Key for authentication.

Component-Specific Settings

• Body: A JSON editor where you define the fields to be updated, such as sku, pricing, or stock.

Inputs

Field	Type	Required	Notes
productId	string	Yes	The unique identifier of the parent product.
variantId	string	Yes	The unique identifier of the product variant to update.

Outputs

Field	Type	Description
productVariantId	string	The unique identifier of the updated product variant.
Response	object	The full, raw JSON response from the Squarespace API.

Use Case

A merchandising agent runs daily, finds all products in the "Summer Sale" category, and uses this component to apply a 20% discount to the salePrice of each variant.

Delete Product Variant

Deletes a specific variant from a product.

INFO

This component requires an API Key for authentication.

Inputs

Field	Type	Required	Notes
productId	string	Yes	The unique identifier of the product.
variantId	string	Yes	The unique identifier of the variant to delete.

Outputs

Field	Type	Description
Response	object	The full API response from Squarespace.
Headers	object	HTTP headers providing additional data details.

Use Case

When the "Small" size of a t-shirt is permanently discontinued, an agent removes that specific variant from the product.

Increase Stock Quantity

Increases the stock quantity for product variants.

INFO

This component requires an API Key for authentication.

Inputs

Field	Type	Required	Notes
variantId	string	Yes	The unique identifier of the product variant.
quantity	integer	Yes	The amount by which to increase the stock quantity.

Outputs

Field	Type	Description
Response	object	The full API response from Squarespace.

Use Case

When a new shipment is received at the warehouse, an agent updates the stock levels in Squarespace by calling this component for each variant.

Decrease Stock Quantity

Decreases the stock quantity for product variants.

INFO

This component requires an API Key for authentication.

Inputs

Field	Type	Required	Notes
variantId	string	Yes	The unique identifier of the product variant.
quantity	integer	Yes	The amount by which to decrease the stock quantity.

Outputs

Field	Type	Description
Response	object	The full API response from Squarespace.

Use Case

An agent syncs sales from a physical point-of-sale system, using this component to decrease the stock in Squarespace to match.

Set Unlimited Stock Quantity

Sets the stock for one or more product variants to be unlimited.

INFO

This component requires an API Key for authentication.

Inputs

Field	Type	Required	Notes
variantIds	string	Yes	A comma-separated list of variant IDs to set as unlimited stock.

Outputs

Field	Type	Description
Response	object	The full API response from Squarespace.

Use Case

For digital products or services that have no physical inventory, an agent uses this component to mark them as having unlimited stock.

Get All Inventory

Retrieves real-time stock information for all product variants.

INFO

This component requires an API Key for authentication.

Inputs

Field	Type	Required	Notes
trigger	string	Yes	An input to trigger the component execution.

Outputs

Field	Type	Description
inventory	array	An array containing the inventory details for each product variant.
Response	object	The full API response from Squarespace.

Use Case

A reporting agent runs a daily inventory audit by fetching all stock levels and flagging any items that have fallen below a certain threshold.

Get Specific Inventory

Retrieves real-time stock information for specific product variants.

INFO

This component requires an API Key for authentication.

Inputs

Field	Type	Required	Notes
variantIds	string	Yes	A comma-separated list of variant IDs to retrieve inventory for.

Outputs

Field	Type	Description
inventory	array	An array containing the inventory details for each specified product variant.
Response	object	The full API response from Squarespace.

Use Case

When a user views a product page, an agent could use this component to fetch the real-time stock level for the selected size and color variant.

Get All Orders

Retrieves all order information from your Squarespace store.

INFO

This component requires an API Key for authentication.

Inputs

Field	Type	Required	Notes
trigger	string	Yes	An input to trigger the component execution.

Outputs

Field	Type	Description
orderResults	array	An array containing the details of each order.
Response	object	The full API response from Squarespace.

Use Case

A fulfillment agent runs every hour, fetches all new orders, and sends the shipping details to a third-party logistics provider.

Get Specific Order

Retrieves information for a single, specific order.

INFO

This component requires an API Key for authentication.

Inputs

Field	Type	Required	Notes
orderId	string	Yes	The unique identifier of the order to retrieve.

Outputs

Field	Type	Description
orderId	string	The unique identifier of the retrieved order.
Response	object	The full API response, detailing the specific order.

Use Case

A customer service agent takes an order number from a support ticket and uses this component to fetch all the details of that order to resolve the customer's issue.

Get All Transactions

Retrieves all financial transaction information.

INFO

This component requires an API Key for authentication.

Inputs

Field	Type	Required	Notes
trigger	string	Yes	An input to trigger the component execution.

Outputs

Field	Type	Description
transactions	array	An array containing the details of each transaction.
Response	object	The full API response from Squarespace.

Use Case

An accounting agent runs monthly to fetch all transactions and syncs them with external accounting software like QuickBooks.

Get Specific Transactions

Retrieves one or more specific financial transactions by their IDs.

INFO

This component requires an API Key for authentication.

Inputs

Field	Type	Required	Notes
transactionIds	string	Yes	A comma-separated list of transaction IDs to retrieve.

Outputs

Field	Type	Description
transactions	array	An array containing the details of each specified transaction.
Response	object	The full API response from Squarespace.

Use Case

To investigate a customer's payment query, an agent retrieves the specific transaction details using the ID from their order.

Upload Product Image

Uploads a new image to a product's gallery.

INFO

This component requires an API Key for authentication.

Inputs

Field	Type	Required	Notes
productId	string	Yes	The unique identifier of the product.
image	binary	Yes	The image file you wish to upload.

Outputs

Field	Type	Description
imageId	string	The unique identifier of the uploaded image.
Response	object	The full API response from Squarespace.

Use Case

An agent automates adding new product photos from a cloud drive folder to the correct product pages on the store.

Update Product Image

Updates the alt text for a product image.

INFO

This component requires an API Key for authentication.

Inputs

Field	Type	Required	Notes
productId	string	Yes	The unique identifier of the product.
imageId	string	Yes	The unique identifier of the image.
altText	string	Yes	The new alt text for the image.

Outputs

Field	Type	Description
imageId	string	The unique identifier of the updated image.
imageUrl	string	The URL of the updated image.
Response	object	The full API response from Squarespace.

Use Case

An SEO agent generates descriptive alt text for product images using an AI model and then uses this component to update them in bulk.

Delete Product Image

Deletes an image from a product's gallery.

INFO

This component requires an API Key for authentication.

Inputs

Field	Type	Required	Notes
productId	string	Yes	The unique identifier of the product.
imageId	string	Yes	The unique identifier of the image to be deleted.

Outputs

Field	Type	Description
Response	object	The full API response from Squarespace.

Use Case

An agent performs a content cleanup, removing old or outdated photos from product pages.

Assign Product Image to Variant

Assigns an existing product image to a specific product variant.

INFO

This component requires an API Key for authentication.

Inputs

Field	Type	Required	Notes
productId	string	Yes	The unique identifier of the product.
variantId	string	Yes	The unique identifier of the variant.
imageId	string	Yes	The unique identifier of the image to be assigned.

Outputs

Field	Type	Description
Response	object	The full API response from Squarespace.

Use Case

After uploading a new photo of a red t-shirt, an agent uses this component to ensure that photo is displayed when a customer selects the "Red" color variant.

Reorder Product Image

Updates the display order of a product's images.

INFO

This component requires an API Key for authentication.

Inputs

Field	Type	Required	Notes
productId	string	Yes	The unique identifier of the product.
imageId	string	Yes	The ID of the image to move.
afterImageId	string	Yes	The ID of the image that the reordered image should be placed after.

Outputs

Field	Type	Description
Response	object	The full API response from Squarespace.

Use Case

An agent makes a newly uploaded photo the primary image for a product by reordering it to be the first in the gallery.

Get Store Pages

Retrieves all store pages on your site.

INFO

This component requires an API Key for authentication.

Inputs

Field	Type	Required	Notes
trigger	string	Yes	An input to trigger the component execution.

Outputs

Field	Type	Description
storePages	array	An array containing the details of each store page, including their IDs.
Response	object	The full API response from Squarespace.

Use Case

This is an essential first step for many workflows. An agent uses this component to find the correct storePageId before creating a new product.

Best Practices & Advanced Tips

• Secure Your API Key: Always store your Squarespace API key in the SmythOS Vault. If a key is compromised, generate a new one in Squarespace and update your Vault secret.
• Grant Specific Permissions: When generating your API key in Squarespace, grant only the permissions your agent needs. If an agent only reads orders, don't give it write access to products.
• Understand the Data Hierarchy: Remember the structure: a Product contains one or more Variants, and Inventory is tracked at the Variant level. You often need to get a product's variants first to find the correct variantId to update.
• Use the Body for Updates: For the Update Product and Update Product Variant components, you must construct the JSON payload in the Body setting. Refer to the Squarespace Developer documentation for the correct schema for each object.

Troubleshooting Common Issues

• Error: 401 Unauthorized

  • Cause: The API Key is incorrect, has been revoked, or lacks the necessary permissions for the requested action.
  • Solution: Verify your API Key is correct in the SmythOS Vault. In your Squarespace settings, check that the key is active and has the required scopes (e.g., Products: Read and Write).

• Error: 404 Not Found

  • Cause: An incorrect productId, variantId, or orderId was provided.
  • Solution: Double-check all IDs for typos. Ensure the item you are trying to access exists in your store.

• Error: 400 Bad Request

  • Cause: The JSON Body payload for an update or create operation is malformed or missing required fields.
  • Solution: Carefully check your JSON structure against the official Squarespace API documentation. Ensure all required fields are present and data types are correct.

What's Next?

You are now ready to build powerful e-commerce automations with the SmythOS Squarespace Integration!

Consider these ideas:

• Build an Agent That...

  • Acts as an inventory sync engine. It checks stock levels from a supplier's API and uses the Increase/Decrease Stock Quantity components to keep your Squarespace store perfectly in sync.
  • Automates order fulfillment. When a new order is retrieved with Get All Orders, the agent sends the customer and shipping details to your shipping provider's API.
  • Creates products from a spreadsheet. The agent reads product data from a Google Sheet, then uses Create Product and Upload Product Image to populate your store.

• Explore Other Integrations:

  • When a new order is placed, send a confirmation to the customer using Resend and post a "New Sale!" notification in a Discord channel.
  • Use an LLM component to write a product description, then use the Update Product component to add it to your store.
  • Log all new orders to a Firestore database for long-term analysis and custom reporting.