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

Delete a product variant

DELETE https://api.squarespace.com/{api-version}/commerce/products/{productId}/variants/{variantId}

Deletes a variant of a physical product. Requests that try to delete a product with one variant will fail since a product must always have at least one variant.

Note: This endpoint does not delete any image assigned to the variant since images always belong to the product.

A successful request deletes a ProductVariant that belongs to the parent Product. Read the Overview to learn more about these resources.

Parameters

If needed, see the "Related endpoints" section to learn how to retrieve resource ids.

{api-version} string
required

See the Products API Overview page for the current API version.

{productId} string
required

Specifies the parent Product of the ProductVariant.

{variantId} string
required

Specifies the ProductVariant to delete.

Request example

Read the Making requests guide to learn why specific headers are necessary, and why some are omitted. Every request should also abide by Squarespace rate limits.

curl "https://api.squarespace.com/{api-version}/commerce/products/123/variants/456" \
 -i \
 -H "Authorization: Bearer YOUR_API_KEY_OR_OAUTH_TOKEN" \
 -H "User-Agent: YOUR_CUSTOM_APP_DESCRIPTION" \
 -X DELETE

Response example

A response to a successful request will not contain any data.

Status codes and error conditions

204 NO CONTENT

The ProductVariant was deleted successfully.

404 NOT FOUND

Type: INVALID_REQUEST_ERROR

Subtype: INVALID_ARGUMENT
Either the Product or the ProductVariant was not found.

405 METHOD NOT ALLOWED

Type: METHOD_NOT_ALLOWED

Subtype: OPERATION_NOT_ALLOWED_FOR_PRODUCT_TYPE
The Product requested is not a physical Product.

Related endpoints

To retrieve ids for Products and their ProductVariants, use these suggested endpoints: