Overview Authentication and permissions Making requests Retrieve basic site information

Idempotency-Key header Rate limits Responses & error handling Upgrade Changelog Glossary FAQ

Overview GET: Retrieve all inventory GET: Retrieve specific inventory POST: Adjust stock quantities

Overview POST: Create an order POST: Fulfill an order GET: Retrieve all orders GET: Retrieve a specific order

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

Overview GET: Retrieve all profiles GET: Retrieve specific profiles

Overview GET: Retrieve all transactions GET: Retrieve specific transactions

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

Overview of Commerce APIs

With Squarespace Commerce APIs, you can build applications to manage the commerce features of a Squarespace merchant site.

Inventory API: Read and adjust stock information for product variants.

Orders API: Access order history for one-time purchases and subscription orders or import orders from third-party sales channels.

Products API: Manage physical products, including their variants and images.

Profiles API: Retrieve customers, mailing list subscribers, and donors that are traditionally accessible through the Profiles panel.

Transactions API: Access financial transactions for orders and donations.

Webhook Subscriptions API: Subscribe to notifications from a site, like when an order was created, by configuring a webhook endpoint.

Structure and design

All Commerce APIs are built on HTTPS and designed with REST principles in mind. Every endpoint uses HTTPS features such as authentication, standard verbs, and standard response status codes. In addition, APIs that support resource updates via POST allow partial updates.

Authentication for Commerce APIs also provides permissions to keep Squarespace merchant site data private and secure.

Next steps

Become familiar with commerce terms and how they're related to the APIs
Learn how to send authenticated requests
Read the FAQ for answers to common questions
Read our brand guidelines