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.
Operations 25
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“How do I list all products of one type with the v2 products API?”
“Can I search v2 products by keyword or by when they were last modified?”
Tell an agent
List v2 products of type {type}.
Search v2 products for {query}.
Ask an LLM
“How do I add a new product to my store with the v2 products API?”
“Does v2 product creation set up the right subresources for each product type?”
Tell an agent
Create a new product through the v2 products endpoint.
Create a v2 product, sending user agent {user_agent}.
Ask an LLM
“How do I fetch a handful of products, with variants and images, by ID on v2?”
“How many products can one v2 by-ID request return?”
Tell an agent
Get v2 products {productIdCsvs}.
Show variants and images for v2 products {productIdCsvs}.
Ask an LLM
“How do I delete a product with the v2 products API?”
“Can I remove a discontinued product from the v2 catalog by its ID?”
Tell an agent destructive · confirm first
Delete v2 product {productId}.
Remove product {productId} from the catalog via v2.
Ask an LLM
“How do I hide a product from my storefront with the v2 API?”
“Can I change a product's URL slug or SEO data on v2 without resending everything?”
Tell an agent
Rename v2 product {productId} to {name}.
Set v2 product {productId} visibility to {isVisible}.
Ask an LLM
“How do I upload a photo for a product with the v2 API?”
“Does uploading a v2 product image make it the featured image?”
Tell an agent
Upload an image to v2 product {productId}.
Add a new photo file to product {productId} using v2.
DELETE
/v2/commerce/products/{productId}/images/{imageId}
Delete a product image (v2) · Delete one product image
#
Ask an LLM
“How do I delete one image from a product with the v2 API?”
“Can I remove an outdated photo from a v2 product listing?”
Tell an agent destructive · confirm first
Delete image {imageId} from v2 product {productId}.
Remove photo {imageId} on product {productId} using v2.
POST
/v2/commerce/products/{productId}/images/{imageId}
Update a product image's alt text (v2) · Update product image
#
Ask an LLM
“How do I change the alt text on a product image with v2?”
“What can I edit on an existing v2 product image besides alt text?”
Tell an agent
Set the alt text of image {imageId} on v2 product {productId} to {altText}.
Update v2 image {imageId} of product {productId} with alt text {altText}.
POST
/v2/commerce/products/{productId}/images/{imageId}/order
Move one product image after another (v2) · Update product image order
#
Ask an LLM
“How do I move a single product image to sit after another image on v2?”
“Can I change where one image appears on the product details page?”
Tell an agent
Move image {imageId} of v2 product {productId} to after image {afterImageId}.
Reposition v2 image {imageId} on product {productId} behind {afterImageId}.
GET
/v2/commerce/products/{productId}/images/{imageId}/status
Check an uploaded image's processing status · Get image processing status
#
Ask an LLM
“Is my uploaded product image still processing, ready, or in error?”
“How do I know when a newly uploaded product image is ready to use?”
Tell an agent
Check the processing status of image {imageId} on product {productId}.
Tell me whether upload {imageId} for product {productId} finished processing.
POST
/v2/commerce/products/{productId}/variants
Add a variant to a product (v2) · Create product variant
#
Ask an LLM
“How do I add a new size or color variant to a product with v2?”
“Can I set a GTIN or MPN when creating a v2 variant?”
Tell an agent
Add a v2 variant with SKU {sku} and pricing {pricing} to product {productId}.
Create v2 variant {sku} on product {productId} priced {pricing} with attributes {attributes} and GTIN {gtin}.
DELETE
/v2/commerce/products/{productId}/variants/{variantId}
Delete a product variant · Delete one product variant
#
Ask an LLM
“How do I remove a variant I no longer sell from a product?”
“Can I delete one variant without deleting the whole product?”
Tell an agent destructive · confirm first
Delete variant {variantId} from product {productId}.
Remove the variant {variantId} of product {productId}.
POST
/v2/commerce/products/{productId}/variants/{variantId}
Update a product variant (v2) · Update product variant
#
Ask an LLM
“How do I change the price of one variant with the v2 API?”
“Can I update a v2 variant's shipping measurements?”
Tell an agent
Set pricing of v2 variant {variantId} on product {productId} to {pricing}.
Change the SKU of v2 variant {variantId} of product {productId} to {sku}.
POST
/v2/commerce/products/{productId}/variants/{variantId}/image
Assign an image to a variant · Associate variant image
#
Ask an LLM
“How do I show a specific photo when a shopper picks a variant?”
“Can I clear the image linked to a variant?”
Tell an agent
Assign image {imageId} to variant {variantId} of product {productId}.
Link variant {variantId} on product {productId} to photo {imageId}.
Ask an LLM
“What products are in my catalog, via the unversioned products path?”
“Can the unversioned product listing be filtered by product type?”
Tell an agent
Retrieve unversioned products of type {type}.
Continue the unversioned product listing from cursor {cursor}.
Ask an LLM
“Can I create a gift card or digital download product via the unversioned path?”
“What must an unversioned product creation request include besides the name?”
Tell an agent
Create an unversioned {type} product named {name} with variants {variants}.
Add product {name} of type {type} with variants {variants} and visibility {isVisible}.
GET
/commerce/products/{productIds}
Get specific products by ID (unversioned) · Retrieve Specific Products
#
Ask an LLM
“How do I retrieve up to 50 products by ID without the v2 prefix?”
“Can I get full variant and image data for specific products via the unversioned path?”
Tell an agent
Retrieve unversioned products {productIds}.
Pull full product data for IDs {productIds} from the unversioned endpoint.
Ask an LLM
“How do I change a product's tags via the unversioned path?”
“Can I update just the description of a product without the v2 prefix?”
Tell an agent
Set the tags on unversioned product {productIds} to {tags}.
Update the description of product {productIds} to {description} via the unversioned endpoint.
DELETE
/commerce/products/{productIds}
Permanently delete a product (unversioned) · Delete a Product
#
Ask an LLM
“Does deleting a product through the unversioned path also remove its variants and images?”
“Can I undo a product deletion made without the v2 prefix?”
Tell an agent destructive · confirm first
Permanently delete unversioned product {productIds}.
Delete product {productIds} with all its variants and images using the unversioned endpoint.
POST
/commerce/products/{productId}/variants
Add a variant (unversioned) · Create a Product Variant
#
Ask an LLM
“How do I add a variant with its own stock tracking via the unversioned path?”
“Can I create a variant without the v2 prefix?”
Tell an agent
Add an unversioned variant {sku} priced {pricing} to product {productId}.
Create variant {sku} on product {productId} at {pricing} with stock settings {stock}, unversioned.
POST
/commerce/products/{productId}/variants/{variantId}
Update a variant's price, SKU or stock (unversioned) · Update a Product Variant
#
Ask an LLM
“How do I change a variant's stock tracking settings via the unversioned path?”
“Can I edit a variant's option values without the v2 prefix?”
Tell an agent
Update stock settings of unversioned variant {variantId} on product {productId} to {stock}.
Change option values of variant {variantId} on product {productId} to {attributes}, unversioned.
POST
/commerce/products/{productId}/images
Add a product image from a URL (unversioned) · Upload a Product Image
#
Ask an LLM
“Can I add a product image by pointing at a public image URL?”
“How do I set alt text while uploading an image via the unversioned path?”
Tell an agent
Upload the image at {url} to product {productId}.
Add image {url} to product {productId} with alt text {altText}, unversioned.
POST
/commerce/products/{productId}/images/{imageId}
Edit a product image's alt text (unversioned) · Update a Product Image
#
Ask an LLM
“How do I fix the accessibility alt text on a product image via the unversioned path?”
“Can I replace the actual image file of an existing product image?”
Tell an agent
Change unversioned image {imageId} on product {productId} to alt text {altText}.
Edit the alt text of product {productId} image {imageId} to read {altText} without the v2 prefix.
DELETE
/commerce/products/{productId}/images/{imageId}
Permanently remove a product image (unversioned) · Delete a Product Image
#
Ask an LLM
“How do I permanently remove an image from a product via the unversioned path?”
“Is deleting a product image without the v2 prefix reversible?”
Tell an agent destructive · confirm first
Permanently remove unversioned image {imageId} from product {productId}.
Delete product {productId}'s image {imageId} via the unversioned endpoint.
POST
/commerce/products/{productId}/images/reorder
Set the full display order of product images · Reorder Product Images
#
Ask an LLM
“How do I reorder all of a product's images in one request?”
“Which image becomes the primary product image when I set a new order?”
Tell an agent
Reorder the images of product {productId} as {imageIds}.
Make product {productId}'s image order {imageIds}, first one as primary.