Template Docs Commerce APIs Webhooks
Get Started
Template Docs Commerce APIs Webhooks
Get Started
Getting started
Overview Authentication and permissions Making requests Retrieve basic site information
Using Commerce APIs
Idempotency-Key header Rate limits Responses & error handling Upgrade Changelog Glossary FAQ
Inventory API
Overview GET: Retrieve all inventory GET: Retrieve specific inventory POST: Adjust stock quantities
Orders API
Overview POST: Create an order POST: Fulfill an order GET: Retrieve all orders GET: Retrieve a specific order
Products API
Overview About product attributes Managing attributes POST: Create a product POST: Create a product variant POST: Upload a product image GET: Retrieve all Store Pages GET: Retrieve all products GET: Retrieve specific products GET: Product image upload status POST: Assign a product image to variant POST: Reorder a product image POST: Update a product POST: Update a product variant POST: Update a product image DEL: Delete a product DEL: Delete a product variant DEL: Delete a product image
Profiles API
Overview GET: Retrieve all profiles GET: Retrieve specific profiles
Transactions API
Overview GET: Retrieve all transactions GET: Retrieve specific transactions
Webhook Subscriptions API
Overview POST: Create a webhook subscription POST: Update a webhook subscription GET: Retrieve all webhook subscriptions GET: Retrieve a specific webhook subscription DEL: Delete a webhook subscription POST: Send test notification POST: Rotate a subscription secret

Authentication and permissions

To keep Squarespace merchant site data private and secure, every request to Commerce APIs must be authenticated and have minimum permissions. However, authenticated requests automatically have access to public site data, such as site name, identifier, language, currency, time zone, and location.

Read the permission levels for each Commerce API below. Then, depending on your development needs, authenticate requests by using an API key or OAuth access token.

Remember: Requests only have access to data for the website that owns the API key or OAuth access token.

API permission levels

Forms API

  • Read Only: View form submission data; for Zapier integration only

Inventory API

  • Read Only: View inventory stock levels
  • Read and Write: Manage inventory stock levels

Orders API

  • Read Only: View order, fulfillment, and customer information (name, email, address, and more)
  • Read and Write: View customer information (name, email, address, and more); manage order and fulfillment information

Products API

  • Read Only: View product information, including information for any images and variants; view Store Page information
  • Read and Write: Manage product information, including information for any images and variants; view Store Page information

Profiles API

  • Read Only: View the name, address, email, marketing preferences, and other profile information of customers, subscribers, and other website users

Transactions API

  • Read Only: View transactional order, donation data, and customer information (email)

Authenticating requests

Depending on your development needs, you can use a generated API key or start the OAuth process with Squarespace to become a registered OAuth client. A Squarespace merchant site can use both API keys and OAuth for data access, but Squarespace Extensions are required to use OAuth.

Custom applications

With Squarespace's Commerce Advanced plan, you can develop a custom application for a Squarespace merchant site.

Follow the steps below to generate an API key for a custom application.

  1. Log in to a Squarespace site.
  2. In the left nav, click Settings; scroll down and click Advanced.
  3. Click Developer API Keys.
  4. Click the GENERATE KEY button.
  5. In the dialog, add a key name under "KEY NAME", and select one or more Commerce APIs under "PERMISSIONS" and permission level.
  6. Record the generated key in a safe and secure place.

For security reasons, this is the only time the API key is visible. API keys will never expire as long as the merchant site remains active.

Commercial development

Squarespace Extensions allow customers on any plan to optimize and expand their site in a few clicks. If you'd like to develop a new Extension, start the OAuth client process by filling out this form. Once you've obtained OAuth credentials, you can use our OAuth 2.0 Guide to learn how to authorize your application to integrate with Squarespace and use Squarespace APIs.

Next steps