> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Squarespace

> How to set up the Squarespace connector, plus the actions and events that are available.

![Squarespace](https://stackone-logos.com/api/squarespace/filled/svg)

v2.0.2[See changelog](https://docs.stackone.com/connectors/squarespace/changelog.md)

[27 actions](#actions) · [10 events](#events) · 2 auth methods

E-Commerce

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/squarespace/guides/connector-profile/api-key.md)
>
> Generate an API key from your Squarespace site settings to authenticate Commerce API requests.

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/squarespace/guides/connector-profile/oauth-2-0.md)
>
> Requires a Squarespace developer app, which starts in Demo Mode until reviewed. Idle connections expire after 7 days.

Optionally, configure receiving Events for Squarespace into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/squarespace/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/squarespace/guides/link-account/api-key.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/squarespace/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

OAuth 2.0

No auth methods found

Scopes

Select all
|
Clear

inventory

inventory.read

orders

orders.read

products

products.read

profiles.read

transactions.read

website.contacts.read

website.inventory

website.inventory.read

website.orders

website.orders.read

website.products

website.products.read

website.transactions.read

No scopes found

27 actions

ActionDescriptionRequired scopes

Get Site Information`squarespace_get_site_information`

Retrieve basic website information for the connected Squarespace site.

List Inventory`squarespace_list_inventory`

Retrieve all inventory items with pagination support.

`inventory.read``website.inventory.read`

Get Inventory`squarespace_get_inventory`

Retrieve inventory details for specific items by their variant IDs.

`inventory.read``website.inventory.read`

Adjust Stock Quantities`squarespace_adjust_inventory`

Adjust inventory stock quantities using increment, decrement, set finite, or set unlimited operations.

`inventory``website.inventory`

List Orders`squarespace_list_orders`

Retrieve all orders with optional filtering by customer, date range, fulfillment status, and payment state.

`orders.read``website.orders.read`

Get Order`squarespace_get_order`

Retrieve a specific order by its ID.

`orders.read``website.orders.read`

Create Order`squarespace_create_order`

Import a third-party order into Squarespace.

`orders``website.orders`

Fulfill Order`squarespace_fulfill_order`

Add shipment information to an order to mark it as fulfilled.

`orders``website.orders`

List Products`squarespace_list_products`

Retrieve all products with optional filtering by modification date, product type, or search query.

`products.read``website.products.read`

Get Product`squarespace_get_product`

Retrieve specific products by their IDs.

`products.read``website.products.read`

Create Product`squarespace_create_product`

Create a new product in a store page with at least one variant.

`products``website.products`

Update Product`squarespace_update_product`

Update an existing product's name, description, tags, visibility, or pricing.

`products``website.products`

Delete Product`squarespace_delete_product`

Permanently delete a product and all its variants and images.

`products``website.products`

Create Product Variant`squarespace_create_product_variant`

Add a new variant to an existing product with SKU and pricing.

`products``website.products`

Update Product Variant`squarespace_update_product_variant`

Update an existing product variant's SKU, pricing, attributes, or shipping measurements.

`products``website.products`

Delete Product Variant`squarespace_delete_product_variant`

Delete a variant from a product (product must have more than one variant).

`products``website.products`

Upload Product Image`squarespace_upload_product_image`

Upload an image file to a product (JPEG, PNG, or GIF, max 20MB).

`products``website.products`

Get Product Image Upload Status`squarespace_get_product_image_status`

Check the processing status of an uploaded product image.

`products.read``website.products.read`

Update Product Image`squarespace_update_product_image`

Update the alt text of a product image for SEO and accessibility.

`products``website.products`

Reorder Product Image`squarespace_reorder_product_image`

Change the display order of a product image.

`products``website.products`

Assign Product Image To Variant`squarespace_assign_product_image_to_variant`

Assign a product image to a specific variant or remove the assignment.

`products``website.products`

Delete Product Image`squarespace_delete_product_image`

Remove a product image and all variant references to it.

`products``website.products`

List Profiles`squarespace_list_profiles`

Retrieve all customer, subscriber, and user profiles with optional filtering by status, email, and sorting.

`profiles.read``website.contacts.read`

Get Profile`squarespace_get_profile`

Retrieve specific profiles by their IDs.

`profiles.read``website.contacts.read`

List Store Pages`squarespace_list_store_pages`

Retrieve all store pages on the merchant site.

`products.read``website.products.read`

List Transactions`squarespace_list_transactions`

Retrieve all transactions with optional filtering by modification date or order ID.

`transactions.read``website.transactions.read`

Get Transaction`squarespace_get_transaction`

Retrieve specific transactions by their document IDs.

`transactions.read``website.transactions.read`

## Events

Tags

Select all
|
Clear

Contacts

Extensions

Orders

Webhooks

No tags found

10 events

EventDescriptionTags

Order Created`squarespace_webhook_order_created`

Fires when an order is created on the Squarespace site.

OrdersWebhooks

Order Updated`squarespace_webhook_order_updated`

Fires when an order is fulfilled, refunded, canceled, marked pending, or has its email changed.

OrdersWebhooks

Contact Created`squarespace_webhook_contact_created`

Fires when a contact (customer, subscriber, or donor) is created on the Squarespace site.

ContactsWebhooks

Contact Updated`squarespace_webhook_contact_updated`

Fires when the fields, email, marketing preference, or default shipping address of a contact change.

ContactsWebhooks

Contact Deleted`squarespace_webhook_contact_deleted`

Fires when a contact is removed from the Squarespace site.

ContactsWebhooks

Address Created`squarespace_webhook_address_created`

Fires when an address book entry is added for a contact.

ContactsWebhooks

Address Updated`squarespace_webhook_address_updated`

Fires when an address book entry of a contact is changed.

ContactsWebhooks

Address Deleted`squarespace_webhook_address_deleted`

Fires when an address book entry is removed from a contact.

ContactsWebhooks

Extension Uninstalled`squarespace_webhook_extension_uninstalled`

Fires when the site owner uninstalls the StackOne OAuth extension from the Squarespace site.

ExtensionsWebhooks

Unmapped Event`squarespace_unmapped_event`

Acknowledges Squarespace notifications for topics this connector does not map.

Webhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.