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

Making requests to Commerce APIs

In three steps, you can send a successful request to any Commerce API to manage numerous commerce features of any Squarespace merchant site.

Inventory: Read and adjust stock information for product variants.

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

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

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

Transactions: 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.

1. Generate an API key or start the OAuth process

If you don't have an API key or are a registered OAuth client already, read the Authentication and permissions guide.

2. Format your request headers

For a successful request, every Commerce API request must use the headers and URL format shown below. The current version number for each API is located on the API's overview page. To learn more about versioning, read the Upgrade guide.

Caution: All requests sent over HTTP instead of HTTPS are rejected.

curl "https://api.squarespace.com/{api-version}/{resource-path}" \
  -H "Authorization: Bearer YOUR_API_KEY_OR_OAUTH_TOKEN" \
  -H "User-Agent: YOUR_CUSTOM_APP_DESCRIPTION" \

  // Add a Content-Type header when making requests with a body.
  -H "Content-Type: application/json"

Recommendations

Accept header: it's okay to use one, but not necessary
Although an Accept header is conventional in HTTPS requests, it's not necessary as Commerce APIs support JSON responses only.

User-Agent header: it's okay to use default values for testing, but not recommended
Default values for User-Agent are often injected by HTTP client applications (e.g."User-Agent: curl/7.54.0"). Although they're okay to use, doing so may be subject to stricter rate limiting. Requests without a User-Agent header are rejected.

3. Start making requests

Read the endpoint documentation for any APIs you want to use and then start to make requests! But, ensure all requests abide by Squarespace rate limits.

All APIs responses are formatted in JSON and use standard status and error codes. Response codes are listed for every endpoint.

Next steps

Learn how Commerce APIs handle responses and errors
Read the FAQ for answers to common questions
Read our brand guidelines