Retrieves product variants for multiple products in bulk....

GET/v1/product-variants/bulk

Retrieves product variants for multiple products in bulk. Pass a comma-separated list of product public IDs in the productIds query parameter. Returns all variants with computed pricing for each product. Requires ProductVariantRead permission on each product's organization.

Parameters

Request parameters for this endpoint

Name	Location	Type	Required	Description
productIds	query	string	Required	Comma-separated list of product public IDs (e.g., "prod_abc123,prod_def456")

Response Data

Fields returned in the response

Always Present

Name	Type	Description
createdAt	string (date-time)	Timestamp when the variant was created
description	string	Description of the variant
id	ProductVariantPubId	Public-facing unique identifier for the product variant
isWaitlisted	boolean	Whether this variant is currently waitlisted
name	string	Name of the variant
options		Variant options (size, color, etc.)
price		Price of this variant
productImages	array<string>	URLs to product images for this variant
sku	string	Stock keeping unit (SKU) identifier
status		Status of the variant (active, inactive, or archived)
stripeId	string	Stripe product variant ID for payment processing
updatedAt	string (date-time)	Timestamp when the variant was last updated
pricing	HashMap	Pricing calculations for all available lease terms (keyed by term in months). The keys are lease term durations in months (e.g., "12", "24", "36").
productId	ProductPubId	Public ID of the parent product

Optional

Name	Type	Description
discountPercentage		-
externalId	string	External ID from integrated systems (Shopify, etc.)
inventoryQuantity	integer	Current inventory quantity (None means inventory tracking is disabled)
productYear	integer	Product model year (e.g., 2024, 2025)

GET/v1/product-variants/bulk

Request

curl https://api.thesweetspot.com/v1/product-variants/bulk \
  -H "Content-Type: application/json" \
  -G -d "productIds=id_123"

Response

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