How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Squarespace Products API

The Squarespace Products API allows developers to manage the product catalog of a Squarespace merchant site. It supports physical products, service products, gift cards, and digital downloads, along with their images and variants.

This API exposes 25 operations across 17 paths, and defines 67 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.squarespace.com, https://api.squarespace.com/1.0.

25 operations 17 paths 67 schemas 5 DELETE5 GET15 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Servers
https://api.squarespace.com
https://api.squarespace.com/1.0
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Squarespace Products API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (Authorization). It accepts HTTP bearer tokens (bearerAuth).

  • bearerAuth — Authenticate using an API key or OAuth access token. Include the token in the Authorization header as "Bearer YOURTOKEN".

Paths & Operations 25

Across 17 paths, the API surfaces 25 operations — 5 DELETE, 5 GET, 15 POST. Each is listed below with its method, path, parameters, and response codes.

Products 25
GET
/v2/commerce/products
List products
getProducts 7 params → 200400
POST
/v2/commerce/products
Create product
createProduct 2 params body → 201400405409429
GET
/v2/commerce/products/{productIdCsvs}
Get products
getSpecificProducts 3 params → 200400404
DELETE
/v2/commerce/products/{productId}
Delete specified product
deleteProduct 3 params → 204404405
POST
/v2/commerce/products/{productId}
Update product
updateProduct 3 params body → 200400404405409
POST
/v2/commerce/products/{productId}/images
Upload product image
uploadProductImage 3 params body → 202400404409
DELETE
/v2/commerce/products/{productId}/images/{imageId}
Delete one product image
deleteProductImage 4 params → 204404
POST
/v2/commerce/products/{productId}/images/{imageId}
Update product image
updateProductImage 4 params body → 200400404
POST
/v2/commerce/products/{productId}/images/{imageId}/order
Update product image order
updateProductImageOrder 4 params body → 204400404405
GET
/v2/commerce/products/{productId}/images/{imageId}/status
Get image processing status
getProductImageProcessingStatus 4 params → 200404
POST
/v2/commerce/products/{productId}/variants
Create product variant
createProductVariant 3 params body → 201400404405409
DELETE
/v2/commerce/products/{productId}/variants/{variantId}
Delete one product variant
deleteProductVariant 4 params → 204404405409429
POST
/v2/commerce/products/{productId}/variants/{variantId}
Update product variant
updateProductVariant 4 params body → 200400404405409429
POST
/v2/commerce/products/{productId}/variants/{variantId}/image
Associate variant image
associateProductVariantImage 4 params body → 204400404405429
GET
/commerce/products
Retrieve All Products
listProducts 2 params → 200401403429
POST
/commerce/products
Create a Product
createProduct body → 200400401403429
GET
/commerce/products/{productIds}
Retrieve Specific Products
getProducts 1 param → 200400401403404429
POST
/commerce/products/{productIds}
Update a Product
updateProduct 1 param body → 200400401403404429
DELETE
/commerce/products/{productIds}
Delete a Product
deleteProduct 1 param → 204401403404429
POST
/commerce/products/{productId}/variants
Create a Product Variant
createProductVariant 1 param body → 200400401403404429
POST
/commerce/products/{productId}/variants/{variantId}
Update a Product Variant
updateProductVariant 2 params body → 200400401403404429
POST
/commerce/products/{productId}/images
Upload a Product Image
uploadProductImage 1 param body → 200400401403404429
POST
/commerce/products/{productId}/images/{imageId}
Update a Product Image
updateProductImage 2 params body → 200400401403404429
DELETE
/commerce/products/{productId}/images/{imageId}
Delete a Product Image
deleteProductImage 2 params → 204401403404429
POST
/commerce/products/{productId}/images/reorder
Reorder Product Images
reorderProductImages 1 param body → 200400401403404429

Schemas 67

The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are DigitalProduct (15 properties), ServiceProduct (15 properties), PhysicalProduct (15 properties), GiftCardProduct (14 properties). Each schema is shown below with its type and property counts.

UpdateProductMeasurements
object
2 properties
ProductStock
object
Available stock for the variant. Present for PHYSICAL products only.
2 properties
ProductListResponseV2
object
1 property
ChangeProductDimensions
object
2 properties
ChangeSeoOptions
object
Options for search engine optimization.
2 properties
ProductDimensions
object
Physical dimensions of the variant.
4 properties
CreatePhysicalProductVariantRequest
object
7 properties
ProductVariantV2
object
A product variant. The shape depends on the product type.
3 properties
DigitalGood
object
Present for DIGITAL products only.
2 properties
UpdateProductRequest
object
8 properties
ChangeMapStringString
object
Specifies attribute-value pairs for the variant. Supported for PHYSICAL products only.
2 properties
ServiceProductVariant
object
A variant of a SERVICE product.
6 properties
UploadProductImageResponse
object
1 property
CreatePhysicalProductRequest
object
Request payload to create a PHYSICAL product.
9 properties
PaginatedProductListResponseV2
object
2 properties
PhysicalProduct
object
A PHYSICAL product.
15 properties 5 required
ChangeBoolean
object
2 properties
ProductWeightUnit
string
Unit of measurement. Supported values: KILOGRAM, POUND.
ServiceProduct
object
A SERVICE product.
15 properties 5 required
ChangeMonetaryAmount
object
2 properties
UpdateProductPricing
object
3 properties
ProductTypeV2
string
SeoOptions
object
Options for search engine optimization.
2 properties
UpdateProductImageRequest
object
1 property
ChangeUpdateProductMeasurements
object
Measurements of the variant when it's shipped. Supported for PHYSICAL products only.
2 properties
StandardErrorPayload
object
5 properties
PhysicalProductVariant
object
A variant of a PHYSICAL product.
9 properties
UpdateVariantRequestV2
object
6 properties
MonetaryAmount
object
A monetary amount with currency code and decimal value.
2 properties
ChangeListString
object
Optional; list of event topics that trigger a webhook notification. Possible values include: extension.uninstall, order.create, order.update.
2 properties
CreateServiceProductVariantRequest
object
4 properties
ProductPricing
object
Present for DIGITAL products only. Digital products don't have variants, so pricing is at the product level.
3 properties
ProductMeasurements
object
Measurements of the variant when it's shipped. Present for PHYSICAL products only.
2 properties
CreateGiftCardProductVariantRequest
object
2 properties
ChangeUpdateProductPricing
object
Pricing data for the product.
2 properties
GiftCardProductVariant
object
A variant of a GIFTCARD product.
4 properties
ChangeProductWeight
object
2 properties
ChangeString
object
Optional; HTTPS URL to receive webhook notifications.
2 properties
UpdateProductImageOrderRequest
object
1 property
ProductImageProcessingStatus
object
2 properties
ProductV2
object
13 properties 5 required
DigitalProduct
object
A DIGITAL product.
15 properties 5 required
GiftCardProduct
object
A GIFTCARD product.
14 properties 5 required
SimpleProductPricing
object
1 property
CreateServiceProductRequest
object
Request payload to create a SERVICE product.
9 properties
CreateVariantRequestV2
object
7 properties 2 required
FullProductPricing
object
3 properties
ImageProcessingStatus
string
ProductWeight
object
Weight of the variant.
2 properties
ProductDimensionsUnit
string
Unit of measurement. Supported values: INCH, CENTIMETER.
AssociateProductImageToVariantRequest
object
1 property 1 required
ProductImage
object
Product image assigned to the variant.
6 properties
CreateGiftCardProductRequest
object
Request payload to create a GIFTCARD product.
8 properties
VariantPricing
object
Pricing information for a product variant
3 properties
Pagination
object
Pagination metadata included with list responses
3 properties
UpdateImageRequest
object
Request body for updating product image metadata
1 property
ProductVariant
object
A specific variant of a product with its own price, SKU, and stock
5 properties
UpdateProductRequest_2
object
Request body for updating an existing product (supports partial updates)
5 properties
CreateProductRequest
object
Request body for creating a new product
7 properties 3 required
UpdateVariantRequest
object
Request body for updating a product variant (supports partial updates)
4 properties
VariantStock
object
Stock tracking configuration for a product variant
3 properties
Error
object
Standard error response returned by the Squarespace API
4 properties
CreateVariantRequest
object
Request body for creating a product variant
4 properties 2 required
UploadImageRequest
object
Request body for uploading a product image from a URL
2 properties 1 required
Money
object
A monetary value with currency
2 properties
ProductImage_2
object
An image associated with a product
5 properties
Product
object
A product in the Squarespace merchant catalog
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

squarespace-products-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of Squarespace Products API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.