Retrieves a product variant by its public ID (pub_id) alo...

GET/v1/product-variants/{id}

Retrieves a product variant by its public ID (pub_id) along with computed pricing for all available lease terms. The response includes an `id` field containing the variant's public identifier (pub_id). Use this endpoint to fetch detailed variant information including pricing calculations. Returns the variant with pricing data showing monthly payments, deposits, and total costs for each lease term option. Requires ProductVariantRead permission on the variant's product organization. Note: This endpoint requires a public ID (format: 'pvar_xxxxx'), not an internal numeric ID.

Parameters

Request parameters for this endpoint

Name	Location	Type	Required	Description
id	path	string	Required	Product variant public ID (pub_id) to retrieve, e.g., 'pvar_3c07c56b-f379-4'. Must be a public ID, not an internal numeric 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/product-variants/{id}

Request

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

Response

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