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
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | Required | Product ID to retrieve |
Response Data
Fields returned in the response
| Name | Type | Required | Description |
|---|---|---|---|
createdAt | string (date-time) | Required | Timestamp when the product was created |
description | string | Required | Description of the product |
discountPercentage | number (double) | Required | Discount percentage applied to this product |
externalId | string | Optional | External ID from integrated systems (Shopify, etc.) |
hasCustomLeaseTerms | boolean | Required | Whether this product has custom lease terms (vs. organization defaults) |
id | ProductPubId | Required | Public-facing unique identifier for the product |
ignoreUpstreamUpdates | boolean | Required | Whether to ignore updates from upstream sources (Shopify, etc.) |
isActive | boolean | Required | Whether this product is currently active |
isWaitlisted | boolean | Required | Whether this product is currently waitlisted |
mainProductImage | string | Optional | URL to the main product image |
name | string | Required | Name of the product |
options | Required | Product options/variants configuration | |
organizationId | OrganizationId | Required | Organization that owns this product |
price | number (double) | Required | Base price of the product |
productCategoryId | ProductCategoryId | Required | Category this product belongs to |
productSource | Required | Source of the product (TSS or Shopify) | |
productType | Required | Type of product (leasable or add-on) | |
sku | string | Optional | Stock keeping unit (SKU) identifier |
stripeId | string | Required | Stripe product ID for payment processing |
updatedAt | string (date-time) | Required | Timestamp when the product was last updated |
GET
/v1/products/{id}Request
curl https://api.thesweetspot.com/v1/products/id_123 \
-H "Content-Type: application/json"Response
{
"createdAt": "2025-12-10T18:00:53.194Z",
"description": "string",
"discountPercentage": 0,
"hasCustomLeaseTerms": false,
"id": null,
"ignoreUpstreamUpdates": false,
"isActive": false,
"isWaitlisted": false,
"name": "string",
"options": [
null
],
"organizationId": "string",
"price": 0,
"productCategoryId": "string",
"productSource": null,
"productType": null,
"stripeId": "string",
"updatedAt": "2025-12-10T18:00:53.195Z"
}