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

Commerce API upgrades

Each Commerce API has an independent version number, where the current version number is listed on an API's overview page. Versions are specified in request URIs per the following format.

Format

https://api.squarespace.com/{api-version}/{resource-path}

Example

https://api.squarespace.com/1.0/commerce/orders

Backward-compatible changes are embedded in existing API versions. These changes are non-breaking and are meant to resolve practical issues that may be found in existing APIs, as well as enable new use cases in the form of new data fields.

Note: On occasion, new resource fields are added to Commerce APIs to expose additional data. Keep this in mind during development so an application doesn't break for new fields.

Breaking changes

Breaking changes are only introduced in a new, numbered version, and don't affect existing integrations. For example, version 1.2 would introduce some breaking changes to version 1.1.

Legacy API versions

Squarespace supports legacy API versions for a long time. Supported legacy versions will be documented per API, including the information you'll need to upgrade your applications quickly.