Squarespace

Squarespace Commerce: read orders, products, inventory, customer profiles and transactions, and adjust stock levels.

10 actions API key 9 read1 write Calls api.squarespace.com

Connect

TypeScript

const conn = await setu.connections.initiate({ userId: "user_1", toolkit: "squarespace" });
console.log(conn.connectUrl); // show this to your user
await conn.waitUntilActive();

Permissions requested

This toolkit uses a single credential and requests no scopes.

Actions

Adjust inventorywritesquarespace.adjust_inventoryChange stock: increment or decrement quantities, set exact quantities, or mark variants unlimited. Needs a unique idempotency_key per intended change; re-using a key applies nothing a second time.

Input	Type		Description
`idempotency_key`	string	Required	Unique key (a UUID) for this adjustment
`increment`	array of object	Optional	[{variantId, quantity}] to add stock
`decrement`	array of object	Optional	[{variantId, quantity}] to remove stock
`set_finite`	array of object	Optional	[{variantId, quantity}] to set exact quantities
`set_unlimited`	array of string	Optional	Variant ids to mark as unlimited stock

TypeScript

await setu.execute({
  userId: "user_1",
  action: "squarespace.adjust_inventory",
  input: {
    "idempotency_key": "<idempotency_key>"
  },
});

Get inventory for a variantreadsquarespace.get_inventory_itemRead the stock level of one product variant by its variant id.

Input	Type		Description
`variant_id`	string	Required	Product variant id

TypeScript

await setu.execute({
  userId: "user_1",
  action: "squarespace.get_inventory_item",
  input: {
    "variant_id": "<variant_id>"
  },
});

Retrieve orderreadsquarespace.get_orderRetrieve one order by id: number, customer, line items, totals and fulfillment status.

Input	Type		Description
`order_id`	string	Required	Squarespace order id

TypeScript

await setu.execute({
  userId: "user_1",
  action: "squarespace.get_order",
  input: {
    "order_id": "<order_id>"
  },
});

Retrieve productreadsquarespace.get_productRetrieve one product by id (Commerce Products API v2), including its variants.

Input	Type		Description
`product_id`	string	Required	Squarespace product id

TypeScript

await setu.execute({
  userId: "user_1",
  action: "squarespace.get_product",
  input: {
    "product_id": "<product_id>"
  },
});

Retrieve profilereadsquarespace.get_profileRetrieve one customer profile by id, with its order summary.

Input	Type		Description
`profile_id`	string	Required	Squarespace profile id

TypeScript

await setu.execute({
  userId: "user_1",
  action: "squarespace.get_profile",
  input: {
    "profile_id": "<profile_id>"
  },
});

List inventoryreadsquarespace.list_inventoryList stock levels for every product variant (SKU, descriptor, quantity, unlimited flag), 50 per page.

Input	Type		Description
`cursor`	string	Optional	Cursor from the previous response's pagination.nextPageCursor

TypeScript

await setu.execute({
  userId: "user_1",
  action: "squarespace.list_inventory",
  input: {},
});

List ordersreadsquarespace.list_ordersList orders, 50 per page, oldest modified first. Filter by fulfillment status or modified time window (modified_after and modified_before must be given together).

Input	Type		Description
`fulfillment_status`	string	Optional	PENDING, FULFILLED or CANCELED
`modified_after`	string	Optional	ISO 8601 UTC time, e.g. 2026-09-01T00:00:00Z
`modified_before`	string	Optional	ISO 8601 UTC time
`customer_id`	string	Optional	Only this customer's orders
`cursor`	string	Optional	Cursor from the previous response's pagination.nextPageCursor. Cannot be combined with other filters

TypeScript

await setu.execute({
  userId: "user_1",
  action: "squarespace.list_orders",
  input: {},
});

List productsreadsquarespace.list_productsList store products (Commerce Products API v2), 50 per page. Optionally search by text or filter by type and modified time.

Input	Type		Description
`query`	string	Optional	Text search over product names
`type`	string	Optional	Product type: PHYSICAL, SERVICE, GIFT_CARD or DIGITAL
`modified_after`	string	Optional	ISO 8601 UTC time
`modified_before`	string	Optional	ISO 8601 UTC time
`cursor`	string	Optional	Cursor from the previous response's pagination.nextPageCursor. Cannot be combined with other filters

TypeScript

await setu.execute({
  userId: "user_1",
  action: "squarespace.list_products",
  input: {},
});

List profilesreadsquarespace.list_profilesList customer, subscriber and donor profiles, 50 per page. The Profiles API is in maintenance mode at Squarespace but still works.

Input	Type		Description
`filter`	string	Optional	Semicolon-separated: isCustomer, hasAccount, or email (email cannot combine with the others)
`email`	string	Optional	Exact email to look up (use filter=email)
`sort_field`	string	Optional	createdOn, id, email or lastName
`sort_direction`	string	Optional	asc or dsc
`cursor`	string	Optional	Cursor from the previous response's pagination.nextPageCursor. Cannot be combined with other filters

TypeScript

await setu.execute({
  userId: "user_1",
  action: "squarespace.list_profiles",
  input: {},
});

List transactionsreadsquarespace.list_transactionsList financial transaction documents (payments, refunds, fees, taxes per order). Filter by order or modified window.

Input	Type		Description
`order_id`	string	Optional	Only transactions of this order
`modified_after`	string	Optional	ISO 8601 UTC time
`modified_before`	string	Optional	ISO 8601 UTC time
`cursor`	string	Optional	Cursor from the previous response's pagination.nextPageCursor. Cannot be combined with other filters

TypeScript

await setu.execute({
  userId: "user_1",
  action: "squarespace.list_transactions",
  input: {},
});