Sweet Spot API

Command Palette

Search for a command to run...

GET/v1/products/{id}

Retrieves a single product by its ID. Use this endpoint to fetch detailed product information for display or editing. The response includes an `id` field containing the product identifier. Returns complete product data including options, images, and configuration. Requires ProductRead permission on the product's organization.

Parameters
Request parameters for this endpoint
NameLocationTypeRequiredDescription
idpathstringRequiredProduct ID to retrieve
Response Data
Fields returned in the response
NameTypeRequiredDescription
createdAt
string (date-time)
RequiredTimestamp when the product was created
description
string
RequiredDescription of the product
discountPercentage
number (double)
RequiredDiscount percentage applied to this product
externalId
string
OptionalExternal ID from integrated systems (Shopify, etc.)
hasCustomLeaseTerms
boolean
RequiredWhether this product has custom lease terms (vs. organization defaults)
id
ProductPubId
RequiredPublic-facing unique identifier for the product
ignoreUpstreamUpdates
boolean
RequiredWhether to ignore updates from upstream sources (Shopify, etc.)
isActive
boolean
RequiredWhether this product is currently active
isWaitlisted
boolean
RequiredWhether this product is currently waitlisted
mainProductImage
string
OptionalURL to the main product image
name
string
RequiredName of the product
options
RequiredProduct options/variants configuration
organizationId
OrganizationId
RequiredOrganization that owns this product
price
number (double)
RequiredBase price of the product
productCategoryId
ProductCategoryId
RequiredCategory this product belongs to
productSource
RequiredSource of the product (TSS or Shopify)
productType
RequiredType of product (leasable or add-on)
sku
string
OptionalStock keeping unit (SKU) identifier
stripeId
string
RequiredStripe product ID for payment processing
updatedAt
string (date-time)
RequiredTimestamp when the product was last updated