Template Docs Commerce APIs Webhooks
Get Started
Template Docs Commerce APIs Webhooks
Get Started
Getting started
Overview Authentication and permissions Making requests Retrieve basic site information
Using Commerce APIs
Idempotency-Key header Rate limits Responses & error handling Upgrade Changelog Glossary FAQ
Inventory API
Overview GET: Retrieve all inventory GET: Retrieve specific inventory POST: Adjust stock quantities
Orders API
Overview POST: Create an order POST: Fulfill an order GET: Retrieve all orders GET: Retrieve a specific order
Products API
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
Profiles API
Overview GET: Retrieve all profiles GET: Retrieve specific profiles
Transactions API
Overview GET: Retrieve all transactions GET: Retrieve specific transactions
Webhook Subscriptions API
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

Inventory API overview

Current version: 1.0
For versioning details, read the Upgrade guide.

Use the Inventory API to read and adjust stock information for product variants on a Squarespace merchant site. Inventory can be limited ("tracked") or unlimited ("not tracked").

What information isn't available?

  • Information for products that are not physical goods or services, e.g. gift cards, download products
  • Product variant information such as color, size, and weight
  • Whether the variant is visible for sale on the merchant site

API resources

The Inventory API returns InventoryItem resource objects. An InventoryItem is always a variant of a physical product or service product on a Squarespace merchant site, and provides stock information about an item.

For example, if a bakery on Squarespace sells Pies as a product, then "Key Lime" may be a product variant. The "Key Lime" variant's stock information would be available in an InventoryItem.

The resource also provides information like:

  • The stock keeping unit (SKU) code set by a merchant
  • The availability of the item, i.e. whether its unlimited or has a large enough quantity
  • A human-readable descriptor for identifying an item by its attributes

Resource fields are described under Response example for each Inventory API endpoint.

Further reading