Skip to main content

Squarespace

Squarespace is a website building and e-commerce platform. Its Commerce APIs let developers work with a merchant's store data — orders, transactions, inventory, products, profiles, and contacts — for reporting, fulfillment, and integration use cases. Nexla connects to the Squarespace Commerce APIs to read store data into Nexsets and to write records such as orders, products, and contacts back to a Squarespace site.

Squarespace icon

Power end-to-end data operations for your Squarespace API with Nexla. Our bi-directional Squarespace connector is purpose-built for Squarespace, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Squarespace or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Squarespace workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Squarespace credential, you need to generate an API key for the Squarespace site you want to connect to. The Squarespace Commerce APIs authenticate requests with an API key that carries the permissions you assign when the key is generated. Generating a Developer API Key requires a Commerce Advanced plan on the Squarespace site.

To generate an API key, follow these steps:

  1. Log in to your Squarespace site.

  2. In the left navigation, click Settings, then scroll down and click Advanced.

  3. Click Developer API Keys.

  4. Click the Generate Key button.

  5. Provide a name for the key and select the permissions your integration needs. Each Commerce API — Orders, Transactions, Inventory, Products, Profiles, Contacts, and Forms — can be granted Read Only or Read/Write access, depending on the API. Grant Read Only for source flows and Read/Write where you intend to write data back to Squarespace.

  6. Copy and store the generated key securely. This is the only time the API key is displayed, so save it before leaving the page.

For more details on authentication, permissions, and the available Commerce APIs, see the Squarespace Commerce APIs documentation.

Authenticate

Credentials required

FieldRequiredSecretDescription
API KeyYesYesAPI key.

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your Squarespace Developer API Key in the API Key field. This is the key you generated in Prerequisites. The API key authenticates all requests to the Squarespace Commerce APIs and must be kept confidential.

    If your API key is compromised, revoke it under Settings > Advanced > Developer API Keys on your Squarespace site and generate a new one. The key grants access to your store data according to the permissions selected when it was created.

    For detailed information about authentication, permissions, and available endpoints, see the Squarespace Commerce APIs documentation.

  4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Squarespace connector tile, then select the credential that will be used to connect to the Squarespace site, and click Next; or, create a new Squarespace credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Squarespace endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

List Orders

This endpoint template retrieves orders from your Squarespace store. Use it when you need order data for reporting, analytics, or downstream integration.

Requires the Orders permission on your Squarespace API key. For details on the response structure and query parameters, see the Squarespace Commerce APIs documentation.

Get Order

This endpoint template retrieves details for a specific order by order ID. Use it when you need to fetch a single order rather than a full list.

Requires the Orders permission on your Squarespace API key. For details on the response structure, see the Squarespace Commerce APIs documentation.

List Transactions

This endpoint template retrieves transactions from your Squarespace store. Use it when you need transaction and payment records for financial reporting or reconciliation.

Requires the Transactions permission on your Squarespace API key. For details on the response structure, see the Squarespace Commerce APIs documentation.

List Products

This endpoint template retrieves products from your Squarespace store. Use it when you need product catalog data for analysis, syncing, or integration.

Requires the Products permission on your Squarespace API key. For details on the response structure, see the Squarespace Commerce APIs documentation.

List Inventory

This endpoint template retrieves inventory from your Squarespace store. Use it when you need current stock levels for product variants.

Requires the Inventory permission on your Squarespace API key. For details on the response structure, see the Squarespace Commerce APIs documentation.

Get Inventory

This endpoint template fetches stock data for specific product variants using comma-separated variant IDs. Use it when you need inventory for a known set of variants rather than the full list.

Requires the Inventory permission on your Squarespace API key. For details on the response structure, see the Squarespace Commerce APIs documentation.

List Store Pages

This endpoint template retrieves store pages from your Squarespace store. Use it when you need the store page structure for your site.

Requires the appropriate Squarespace API key permissions. For details on the response structure, see the Squarespace Commerce APIs documentation.

List Contacts

This endpoint template retrieves a paginated list of contacts for the website. Use it when you need contact records for marketing, CRM sync, or reporting.

Requires the Contacts permission on your Squarespace API key. For details on the response structure and pagination, see the Squarespace Commerce APIs documentation.

List Profiles

This endpoint template retrieves profiles from your Squarespace store. Use it when you need customer profile data for analysis or integration.

Requires the Profiles permission on your Squarespace API key. For details on the response structure, see the Squarespace Commerce APIs documentation.

Get Profile

This endpoint template fetches information for specific profiles using comma-separated profile IDs. Use it when you need profiles for a known set of IDs rather than the full list.

Requires the Profiles permission on your Squarespace API key. For details on the response structure, see the Squarespace Commerce APIs documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Squarespace data sources can also be manually configured to ingest data from any valid Squarespace Commerce API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Squarespace data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Squarespace destination, and select the Send to Destination option from the menu. Select the Squarespace connector from the list of available destination connectors, then select the credential that will be used to connect to the Squarespace site, and click Next; or, create a new Squarespace credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Squarespace endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Create Order

This endpoint template creates an order using information from a third-party sales channel. Use it to push orders from your Nexla flows into your Squarespace store.

Requires the Orders Read/Write permission on your Squarespace API key. Each record from your Nexset is sent as a separate request. For the required request body format, see the Squarespace Commerce APIs documentation.

Fulfill Order

This endpoint template marks an order as fulfilled and optionally records shipment information and notifies the customer. Use it to automate fulfillment updates from your Nexla flows.

Requires the Orders Read/Write permission on your Squarespace API key. For the required request body format, see the Squarespace Commerce APIs documentation.

Adjust Inventory

This endpoint template adjusts stock quantities for product variants — increment, decrement, set an exact value, or mark unlimited. Use it to keep Squarespace inventory in sync with your Nexla flows.

Requires the Inventory Read/Write permission on your Squarespace API key. For the required request body format, see the Squarespace Commerce APIs documentation.

Create Product

This endpoint template creates a new product with variants — physical, service, gift card, or digital. Use it to add products to your Squarespace store from your Nexla flows.

Requires the Products Read/Write permission on your Squarespace API key. Each record from your Nexset is sent as a separate request. For the required request body format, see the Squarespace Commerce APIs documentation.

Update Product

This endpoint template updates product information via a partial update. Use it to modify existing Squarespace products from your Nexla flows.

Requires the Products Read/Write permission on your Squarespace API key. Include the ID of the product to be updated. For the required request body format, see the Squarespace Commerce APIs documentation.

Create Contact

This endpoint template creates a new contact with first name, last name, locale, and primary email. Use it to add contacts to your Squarespace site from your Nexla flows.

Requires the Contacts Read/Write permission on your Squarespace API key. For the required request body format, see the Squarespace Commerce APIs documentation.

Update Contact

This endpoint template updates a contact's name, locale, or email preferences using a JSON merge patch. Use it to modify existing contacts from your Nexla flows.

Requires the Contacts Read/Write permission on your Squarespace API key. For the required request body format, see the Squarespace Commerce APIs documentation.

Manual configuration

Squarespace destinations can also be manually configured to send data to any valid Squarespace Commerce API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Squarespace Commerce APIs typically expect JSON format for most operations. For update operations, include the ID of the object to be updated in the request URL.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Squarespace endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Squarespace endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.