Products
List products
Retrieves information for products; products can be filtered within a date range and by product type. The response contains product information in a Product, up to 50 Products ordered by their modification date (modifiedOn), and supports dynamic cursors for pagination.
query Parameters
modifiedAftermodifiedBeforecursorquerytypeHeaders
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
List products › Responses
A paginated list of products.
Create product
Creates a product with appropriate subresources based on product type.
Headers
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Create product › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object | |
| type = object |
descriptionisVisiblenamestorePageIdtagstypeurlSlugCreate product › Responses
The product was created successfully.
createdOnidmodifiedOnstorePageIdtypedescriptionisVisiblenameOptions for search engine optimization.
tagsurlurlSlugGet products
Retrieves information for specific products, including information for any variants or images. Up to 50 products can be retrieved per request.
path Parameters
productIdCsvsHeaders
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Get products › Responses
The requested products.
Update product
Updates information for a product. The endpoint supports partial updates.
path Parameters
productIdHeaders
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Update product › Request Body
Optional; HTTPS URL to receive webhook notifications.
Optional; HTTPS URL to receive webhook notifications.
Pricing data for the product.
Optional; list of event topics that trigger a webhook notification. Possible values include: extension.uninstall, order.create, order.update.
Options for search engine optimization.
Optional; list of event topics that trigger a webhook notification. Possible values include: extension.uninstall, order.create, order.update.
Optional; HTTPS URL to receive webhook notifications.
Update product › Responses
Return the updated Product
createdOnidmodifiedOnstorePageIdtypedescriptionisVisiblenameOptions for search engine optimization.
tagsurlurlSlugDelete specified product
Delete specified product
path Parameters
productIdHeaders
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Delete specified product › Responses
The Product was deleted successfully.
Upload product image
Uploads an image for a product. Uploading an image doesn't set the product's featured image. A successful request creates a ProductImage subresource of the Product.
path Parameters
productIdHeaders
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Upload product image › Responses
The request was accepted and the uploaded image is being processed.
imageIdUnique ProductImage id.
Update product image
Updates information for a product image. Currently, the endpoint only supports updates to the alt text for an image.
path Parameters
productIdimageIdHeaders
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Update product image › Responses
Return the updated ProductImage
altTextAlt text for the image; impacts SEO and appears in search results.
availableFormatsAvailable image sizes. Use with images.url and a format query parameter to retrieve the image at a particular width.
idUnique ProductImage id.
orderIndexPosition of the image in the product's image list.
originalSizeImage size when first uploaded.
urlAbsolute URL of the image hosted on Squarespace.
Delete one product image
Delete one product image
path Parameters
productIdimageIdHeaders
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Delete one product image › Responses
The ProductImage was deleted successfully.
Update product image order
Updates the ordering of a product image on the product details page.
path Parameters
productIdimageIdHeaders
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Update product image order › Responses
The request was successful.
Get image processing status
Retrieves the processing status for an uploaded product image. A successful request indicates that a ProductImage is processing, ready, or in an error state.
path Parameters
productIdimageIdHeaders
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Get image processing status › Responses
Return the processing status for the ProductImage
idstatusCreate product variant
Creates a variant of a product. Creating a variant for a physical or service product requires that the product already has at least one attribute.
path Parameters
productIdHeaders
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Create product variant › Request Body
Present for DIGITAL products only. Digital products don't have variants, so pricing is at the product level.
skuMerchant-defined code that identifies the product variant. Value must be unique among variants. Leading and trailing whitespace is removed.
Specifies attribute-value pairs for the variant. 100 char limit per key and per value with no more than six key-value pairs. Supported for PHYSICAL products only.
gtinGlobal Trade Item Number (GTIN). Optional. Must be 8, 12, 13, or 14 numeric digits. Whitespace, hyphens, and underscores are stripped before validation. Supported for PHYSICAL products only.
mpnManufacturer Part Number (MPN). Optional. Must be alphanumeric and 70 characters or fewer. Whitespace, hyphens, and underscores are stripped before validation. Supported for PHYSICAL products only.
Measurements of the variant when it's shipped. Present for PHYSICAL products only.
Available stock for the variant. Present for PHYSICAL products only.
Create product variant › Responses
The ProductVariant was created successfully.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object | |
| type = object |
gtinidProduct image assigned to the variant.
mpnMeasurements of the variant when it's shipped. Present for PHYSICAL products only.
skuAvailable stock for the variant. Present for PHYSICAL products only.
Update product variant
Updates a variant of a product. The endpoint supports partial updates.
path Parameters
productIdvariantIdHeaders
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Update product variant › Request Body
Specifies attribute-value pairs for the variant. Supported for PHYSICAL products only.
Optional; HTTPS URL to receive webhook notifications.
Optional; HTTPS URL to receive webhook notifications.
Pricing data for the product.
Measurements of the variant when it's shipped. Supported for PHYSICAL products only.
Optional; HTTPS URL to receive webhook notifications.
Update product variant › Responses
Return the updated ProductVariant
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object | |
| type = object |
gtinidProduct image assigned to the variant.
mpnMeasurements of the variant when it's shipped. Present for PHYSICAL products only.
skuAvailable stock for the variant. Present for PHYSICAL products only.
Delete one product variant
Delete one product variant
path Parameters
productIdvariantIdHeaders
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Delete one product variant › Responses
The ProductVariant was deleted successfully.
Associate variant image
Assigns a product image to a product variant. Specifying imageId of null will delete the association.
path Parameters
productIdvariantIdHeaders
AuthorizationAPI key or OAuth access token
User-AgentUser Agent
Associate variant image › Request Body
Optional; HTTPS URL to receive webhook notifications.
Associate variant image › Responses
The request was successful.