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

Changelog

Stay up to date with the latest developer and Squarespace Commerce API changes. With each update, we'll provide notable details below.

New Version of Products API, Read-only access for download products

October 31, 2023

A new version of the Products API has been released. This version enables read-only access to download products. Download products can now be retrieved by retrieve all products and retrieve specific products endpoints. A new query parameter type has been added to the retrieve all products endpoint, which filters results by products type. To learn more about the differences between physical and download products, see the Products API Overview.

New response code for expired websites

November 30, 2021

If a request is made on behalf of an expired site a new status code, 402 PAYMENT REQUIRED, will be returned indicating that the request is denied because the website is in an expired billing state.

Products API: Product sale prices

April 20, 2021

When creating and updating Products, variants.salePrice.value will now be set to the lesser of the variant's regular price or sale price when variants.onSale is false. Previously, this field would be set to 0 when the variant was not on sale.

Profiles API: Profiles API read/write scope restrictions

March 29, 2021

Moving forward, creating new profiles and updating existing profiles will be restricted to allowed developers.

Products API: Product attributes limit increased to six

March 2, 2021

The limit of attributes on a product have been increased from three to six. Visit our documentation about product attributes and managing product atttributes to learn more.

Profiles API is now available

February 23, 2021

We've released the Profiles API to general availability. The Profiles API enables you to read and manage customers, mailing list subscribers, and donors that are traditionally accessible through the Profiles panel. Check out the Profiles API page to learn more.

Webhook notification test endpoint is now available

February 18, 2021

Now you can test your webhook subscriptions. To learn more, visit our documentation.

Webhooks are now available

February 2, 2021

Now you can use webhooks to subscribe to OAuth disconnection events and Order events. To learn more, visit our webhooks documentation.

New Profiles API: Sign up for the beta

December 8, 2020

The Profiles API offers a programmatic means to read and manage customers, mailing list subscribers, and donors that are traditionally accessible through the Profiles panel. We're accepting beta participants until December 18. Click here to apply to be a beta participant.

Products API is now available

July 27, 2020

We've released the Products API to general availability. This allows you to retrieve or create product information within your store's products. Check out the Products API page to learn more.

Orders API: Order creation is now available

July 13, 2020

Now you can import orders from a third-party sales channel into a Squarespace store. To learn more, visit the documentation for the new Create an order endpoint.

Full Featured Products API: Sign up for the beta

February 4, 2020

Version 0.2 of the Products API is now in beta, allowing developers to create, update, delete – as well as read – a Squarespace store's product data.

Introducing Read-Only Scopes

January 28, 2020

You can now grant read-only access when generating API keys.

Time zone and location added to authorization profiles

January 14, 2020

We've added timeZone and location fields to the authorization profile endpoint. Learn more about authorization profiles.

Transactions API is now available

December 9, 2019

We've released the Transactions API to general availability. This allows you to retrieve financial information about your store's orders and donations. Check out the Transactions API page to learn more.

Orders API: New Channel field now included on orders

November 7, 2019

A new channel property is now available on the orders resource through the Orders API. This allows you to know where your order originated from. Check out the Orders API page to learn more.

Transactions API: Sign up for the beta

September 11, 2019

We're making our new Transactions API available to a select group of developers. With this API, you can easily retrieve your store's order and donation financial data. Interested in trying it out and sharing your feedback as you integrate it?

Products API: Sign up for the beta

July 29, 2019

Sign up for the Products API beta and be one of the first to integrate with it. This new API allows you to retrieve a store's product data for physical products, and we'd love your feedback on the experience.

Orders API: Variant IDs now included on orders

July 16, 2019

The product variant's variantId property is now available on the orders resource via the Orders API. This allows you to know exactly which variant was purchased when an order comes in. Visit the Orders API page to learn more.

Inventory API is now available

June 6, 2019

We're excited to introduce the new Inventory API, which allows you to read and write stock levels. Learn more about the Inventory API.