Updates product variant details including name, price, SK...

PUT/v1/product-variants/{id}

Updates product variant details including name, price, SKU, description, images, options, and status flags. Use this endpoint to modify variant information such as pricing or availability. All fields are optional - only provided fields will be updated. Requires ProductVariantWrite permission on the variant's product organization.

Parameters

Request parameters for this endpoint

Name	Location	Type	Required	Description
id	path	string	Required	Product variant ID

Request Body

Fields in the request body

Name	Type	Required	Description
description	string	Optional	Description of the variant
discountPercentage	number	Optional	Discount percentage applied to this variant
isActive	boolean	Optional	Whether this variant is currently active
isWaitlisted	boolean	Optional	Whether this variant is currently waitlisted
mainProductImage	string	Optional	URL to the main product image for this variant
name	string	Optional	Name of the product variant
options		Optional	-
price	number	Optional	Price of the variant
sku	string	Optional	Stock keeping unit (SKU) identifier

Response Data

Fields returned in the response

Name	Type	Required	Description
createdAt	string (date-time)	Required	Timestamp when the variant was created
description	string	Required	Description of the variant
discountPercentage	number (double)	Required	Discount percentage applied to this variant
externalId	string	Optional	External ID from integrated systems (Shopify, etc.)
id	ProductVariantPubId	Required	Public-facing unique identifier for the product variant
inventoryQuantity	integer (int32)	Required	Current inventory quantity
isActive	boolean	Required	Whether this variant is currently active
isWaitlisted	boolean	Required	Whether this variant is currently waitlisted
name	string	Required	Name of the variant
options		Required	Variant options (size, color, etc.)
price	number (double)	Required	Price of this variant
productImages	array<string>	Required	URLs to product images for this variant
sku	string	Required	Stock keeping unit (SKU) identifier
stripeId	string	Required	Stripe product variant ID for payment processing
updatedAt	string (date-time)	Required	Timestamp when the variant was last updated

PUT/v1/product-variants/{id}

Request

curl https://api.thesweetspot.com/v1/product-variants/id_123 \
  -X PUT \
  -H "Content-Type: application/json" \
  -d '{
  "description": null,
  "discountPercentage": null,
  "isActive": null,
  "isWaitlisted": null,
  "mainProductImage": null,
  "name": null,
  "options": null,
  "price": null,
  "sku": null
}'

Response

{
  "createdAt": "2025-12-10T18:00:54.247Z",
  "description": "string",
  "discountPercentage": 0,
  "externalId": null,
  "id": "string",
  "inventoryQuantity": 0,
  "isActive": false,
  "isWaitlisted": false,
  "name": "string",
  "options": [
    null
  ],
  "price": 0,
  "productImages": [
    "string"
  ],
  "sku": "string",
  "stripeId": "string",
  "updatedAt": "2025-12-10T18:00:54.247Z"
}