> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/squarespace-commerce.md).

# Squarespace Commerce

Manage Squarespace Commerce orders, products, and inventory.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector            | Authentication |
| -------------------- | -------------- |
| Squarespace Commerce | API key        |

### Squarespace Commerce

Connect to Squarespace Commerce with a Developer API key.

#### Set up in Squarespace Commerce

1. Prepare the Squarespace Commerce account or service that the workflow will access. Grant access to the required resources and operations.
2. **API key:** Create a Commerce API key in Squarespace Settings > Advanced > Developer API Keys.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Squarespace Commerce**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                                                |
| ------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API key       | Yes      | Create a Commerce API key in Squarespace Settings > Advanced > Developer API Keys. [Provider instructions](https://developers.squarespace.com/commerce-apis/authentication-and-permissions). |

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Squarespace Commerce** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Adjust inventory

Increase, decrease, set, or unlimit stock for one product variant.

#### Inputs

| Field           | Type            | Required | Description                                                                                                                  |
| --------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
| Product variant | select (string) | Yes      | Choose the product variant whose stock should change. Options load from the selected connection.                             |
| Adjustment      | select (string) | Yes      | Choose how to change the variant's stock. Available values: Increase, Decrease, Set exact, Set unlimited. Default: increase. |
| Quantity        | integer         | No       | Number of units to add, subtract, or set.                                                                                    |

#### Outputs

| Field      | Type    | Description                                        |
| ---------- | ------- | -------------------------------------------------- |
| Variant ID | string  | Product variant whose inventory was adjusted.      |
| Adjustment | string  | Inventory adjustment that Squarespace accepted.    |
| Succeeded  | boolean | Whether Squarespace accepted the inventory change. |

### Fulfill order

Mark a Squarespace order fulfilled, with optional shipment tracking.

#### Inputs

| Field                | Type            | Required | Description                                                                    |
| -------------------- | --------------- | -------- | ------------------------------------------------------------------------------ |
| Order                | select (string) | Yes      | Choose the order to mark fulfilled. Options load from the selected connection. |
| Add shipment details | boolean         | No       | Attach carrier and tracking information to the fulfillment. Default: false.    |
| Carrier name         | string          | No       | Shipping carrier handling the package.                                         |
| Shipping service     | string          | No       | Carrier service level used for this shipment.                                  |
| Ship date            | datetime        | No       | Date and time when the package shipped.                                        |
| Tracking number      | string          | No       | Carrier tracking number for the package.                                       |
| Tracking URL         | string          | No       | Optional carrier webpage where the customer can track the package.             |
| Notify customer      | boolean         | No       | Email the customer about this fulfillment. Default: false.                     |

#### Outputs

| Field     | Type    | Description                                   |
| --------- | ------- | --------------------------------------------- |
| Order ID  | string  | Squarespace order that was fulfilled.         |
| Fulfilled | boolean | Whether Squarespace accepted the fulfillment. |

### Get order

Retrieve the complete details of one Squarespace order.

#### Inputs

| Field | Type            | Required | Description                                                              |
| ----- | --------------- | -------- | ------------------------------------------------------------------------ |
| Order | select (string) | Yes      | Choose the order to retrieve. Options load from the selected connection. |

#### Outputs

| Field | Type   | Description                                         |
| ----- | ------ | --------------------------------------------------- |
| Order | object | Complete structured details for the selected order. |

### List orders

Find Squarespace orders for fulfillment, support, or reporting.

#### Inputs

| Field              | Type                      | Required | Description                                                                                                                                                             |
| ------------------ | ------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Modified after     | datetime                  | No       | Only include orders changed after this UTC date and time.                                                                                                               |
| Modified before    | datetime                  | No       | Only include orders changed before this UTC date and time.                                                                                                              |
| Fulfillment status | select (string)           | No       | Limit results to orders in one fulfillment state. Available values: Pending, Fulfilled, Canceled.                                                                       |
| Payment states     | multiple\_select (string) | No       | Limit results to one or more payment states. Available values: Not Charged, Authorized, Paid, Refunded, Pending, Failed, Refund Pending, Refund Failed, Partially Paid. |
| Result target      | integer                   | No       | Soft result target. The complete final Squarespace page is returned, so the result can be slightly larger. Minimum: 1. Maximum: 1000. Default: 100.                     |
| Next cursor        | string                    | No       | Continue a previous order listing from its returned cursor.                                                                                                             |

#### Outputs

| Field       | Type          | Description                                         |
| ----------- | ------------- | --------------------------------------------------- |
| Orders      | object\_array | Structured Squarespace orders matching the filters. |
| Next cursor | string        | Cursor for continuing when more orders remain.      |

### List products

Browse and search the Squarespace product catalog.

#### Inputs

| Field           | Type     | Required | Description                                                                                          |
| --------------- | -------- | -------- | ---------------------------------------------------------------------------------------------------- |
| Search          | string   | No       | Search the catalog for matching products.                                                            |
| Modified after  | datetime | No       | Only include products changed after this UTC date and time.                                          |
| Modified before | datetime | No       | Only include products changed before this UTC date and time.                                         |
| Maximum results | integer  | No       | Maximum number of products to return in this workflow call. Minimum: 1. Maximum: 1000. Default: 100. |
| Next cursor     | string   | No       | Continue a previous product listing from its returned cursor.                                        |

#### Outputs

| Field       | Type          | Description                                           |
| ----------- | ------------- | ----------------------------------------------------- |
| Products    | object\_array | Structured Squarespace products matching the filters. |
| Next cursor | string        | Cursor for continuing when more products remain.      |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/squarespace-commerce.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
