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
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/{id}Request
curl https://api.thesweetspot.com/v1/product-variants/id_123 \
-H "Content-Type: application/json"Response
{
"createdAt": "2026-02-04T02:26:36.771Z",
"description": "string",
"id": null,
"isWaitlisted": false,
"name": "string",
"options": null,
"price": null,
"productImages": [
null
],
"sku": "string",
"status": null,
"stripeId": "string",
"updatedAt": "2026-02-04T02:26:36.771Z",
"pricing": null,
"productId": "string"
}