What we do
Tools
Industries
Department
How we workLet's talk →
Home/Squarespace/Squarespace API
Squarespace

Squarespace API: What You Can Reach, With Which Key, on Which Plan

Yes, Squarespace has a documented API: the Commerce APIs, for orders, inventory, products, transactions and contacts. Before writing a line of code, though, there's a decision that shapes everything else: a simple API key from the store's settings, or an OAuth app built as a Squarespace Extension. Only one of them can receive webhooks.

API key or OAuth extension

One store, your own code

Developer API key

  • Created under Settings, Advanced, Developer API Keys. You pick which APIs it can use and whether each is read-only or read and write.
  • Shown once when it's generated, and it doesn't expire while the site stays active.
  • Squarespace's docs say custom-application keys need the Commerce Advanced plan.
  • Can't create webhook subscriptions, so your code has to ask for changes on a schedule.
  • Creating orders is capped at 100 requests an hour per site with a key.
Apps, or anything needing webhooks

OAuth, through a Squarespace Extension

  • Squarespace says Extensions are required to use OAuth, and are available to customers on any plan.
  • Webhook subscriptions only work with an OAuth token, so this is how you get notified when an order's created.
  • The 100-an-hour cap on creating orders doesn't apply.
  • More setup: an OAuth flow, token storage, and the extension itself.

For one store that only needs orders pulled into accounting every few minutes, a key is usually enough. If the integration has to react the moment an order lands, or you're building for many stores, it's OAuth.

Which Commerce API does the job

If you want to Use Keep in mind
Pull orders into QuickBooks, Xero or a fulfillment tool Orders API, read access. It covers one-time and subscription orders. Pair it with the Transactions API for the money side: payments, refunds and fees for each order or donation.
Bring in orders sold somewhere else Orders API, write access. It can import orders from third-party channels. With an API key, that's 100 order creations an hour per site.
Keep stock in step with a POS or warehouse Inventory API, which holds stock per product variant. Decide which system wins when both change the same variant at once.
Create or update the catalog Products API: physical, service, gift card and download products, with images and variants. Variants carry their own stock, so a product change and a stock change are separate calls.
Send customers to a CRM or email tool Contacts API: customers, subscribers and donors, with marketing preferences. The older Profiles API is in maintenance mode. Squarespace says new integrations should use Contacts.

Developer Mode is a different thing

Developer Mode isn't part of the Commerce APIs. It opens a site's template code for custom design work, with local development and version control. It's for changing how a site looks and is structured, and it only applies to version 7.0 sites, not 7.1.

If what you want is order or inventory automation, you don't need Developer Mode at all. You need the Commerce APIs above and somewhere for the integration code to run.

Where a Squarespace integration stalls

Building on a key, then needing webhooks

How you'll know: The plan was to react to new orders instantly, and the key can't subscribe to anything.

Fix: Settle the trigger first. A short polling interval on the Orders API is fine for accounting, but if seconds matter, start with OAuth.

Hitting the rate limit on a backfill

How you'll know: Responses turn into 429 Too Many Requests and the job stalls for a minute.

Fix: The Commerce APIs allow 300 requests a minute, about five a second. Pace the requests and pause for the one-minute cooldown when a 429 comes back.

A store on the wrong plan

How you'll know: The store's plan doesn't allow API keys for a custom application.

Fix: Either the store moves to Commerce Advanced, or the integration is built as an extension using OAuth.

Treating an order as the whole story

How you'll know: Revenue in the books doesn't match the payout, because refunds and fees were never pulled.

Fix: Read the Transactions API alongside Orders, so each sale lands with its payments, refunds and processing fees.

Questions people ask

Does Squarespace have an API?

Yes. The Commerce APIs cover orders, inventory, products, transactions, contacts, discounts and webhook subscriptions, and they're officially documented. Template work goes through Developer Mode instead.

What is Squarespace Developer Mode?

A setting that opens a site's template code for custom design and local development. It's separate from the Commerce APIs, applies to version 7.0 sites, and has nothing to do with orders or inventory.

Does Squarespace support webhooks?

Yes, through the Webhook Subscriptions API, for events like an order being created. Subscriptions need an OAuth token, which means a Squarespace Extension. A plain API key can't set them up.

Can I pull Squarespace orders automatically into another system?

Yes. The Orders API returns each order with its line items and customer, and a webhook or a short polling interval picks up new ones. n-frames builds that link to accounting, fulfillment or a CRM, with Transactions data so refunds and fees land too.

Which Squarespace plan do I need for API access?

Squarespace's developer docs tie custom-application API keys to the Commerce Advanced plan. OAuth through a Squarespace Extension is open to customers on any plan.

Do I need to hire a Squarespace developer?

It depends on the work. Template and design changes in Developer Mode are front-end development. A Commerce API integration is REST, OAuth and webhook work, plus whatever it connects to. That second kind is what n-frames builds, so it's worth being clear which one your job is before you hire.

Let's talk

Tell us the one thing your team does manually that eats up time. We read every message and reply within a day.