Retrieves all product variants for a product along with c...

GET/v1/products/{id}/variants

Retrieves all product variants for a product along with computed pricing for each available lease term. Use this endpoint to display product options (e.g., sizes, colors) with their pricing. Returns variants with pricing calculations including monthly payments, deposits, and total costs. Requires ProductRead permission on the product's organization.

Parameters

Request parameters for this endpoint

Name	Location	Type	Required	Description
id	path	string	Required	Product ID

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
pricing	HashMap	Required	Pricing calculations for all available lease terms (keyed by term in months)
productId	ProductPubId	Required	Public ID of the parent product

GET/v1/products/{id}/variants

Request

curl https://api.thesweetspot.com/v1/products/id_123/variants \
  -H "Content-Type: application/json"

Response

[
  {
    "pricing": null,
    "productId": null
  }
]