Skip to main content
GET
Get a product

Overview

Retrieve a single product by ID, including all its variants. Use this endpoint when you need complete product details including pricing for all configurations.

Common Use Cases

  • Product Detail Page: Display full product information with all available variants
  • Variant Selection: Show customers all available configurations and their pricing
  • Order Validation: Verify a variant exists and is active before creating an order
  • Pricing Display: Show subscription pricing for different contract lengths

Understanding Variants

Each variant represents a specific product configuration:

Variant Fields Explained

Pricing by Contract Length

The pricing object maps contract lengths (in months) to monthly subscription prices:
Longer contracts typically have lower monthly prices. Configure your pricing tiers based on your cost recovery targets.

Grade Classification

Products are classified by condition:

Example: Building a Variant Selector

Authorizations

Authorization
string
header
required

API key obtained from FlexPortal dashboard

Headers

Tenant-ID
string
required

Your tenant identifier

Path Parameters

productId
string
required

The product ID

Response

Product details

productId
string
required
tenantId
string
required
productSku
string
required
name
string
required
specification
string
required
category
string
required
brand
string
required
status
enum<string>
required
Available options:
active,
discontinued
createdAt
string
required
updatedAt
string
required
description
string
images
string[]
_sync
object
variants
object[]