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

Glossary

When developing with Commerce APIs, it's helpful to know Squarespace Commerce terms and how they're used by merchants and the APIs.

Inventory

A collection of products configured for a Squarespace merchant site.
A Squarespace merchant may use "inventory" in the following ways:

To refer to the Commerce > Inventory page in the Squarespace UI. This page lists every product that's been configured for a merchant site.
To refer to the quantity of an item, for example, "The inventory for this product is running low."

With respect to the Inventory API, an "inventory item" is any variant of a configured product that supports stock tracking, which is a feature of physical and service products.

Product

A sellable item on a Squarespace merchant site, which may be sold as variations (or "variants"). Multiple product types are supported for a Squarespace store including physical goods, services, gift cards, downloads, and subscriptions.

Product variant

A variant of a product sold on a Squarespace merchant site.
For example, a bakery may sell Pies and Cookies, where "Key Lime" and "Pecan" are variants of Pies and "Chocolate Chip" and "Oatmeal Raisin" are variants of Cookies.

Stock keeping unit (SKU)

A user-defined code assigned for the purpose of identifying a product variant.

SKUs help merchants keep track of product quantities and identify the variant of a product customers purchase. Squarespace merchants are not required to keep unique SKUs across all of their products, however, SKUs for variants of the same product must be unique.