Skip to main content
GET
List products

Overview

Retrieve a paginated list of products in your catalog. Products are the parent items that contain variants—each variant represents a specific configuration (e.g., color, storage size, grade) with its own SKU and pricing.

Product vs Variant

Understanding the product hierarchy is key: A product can have multiple variants, and orders reference variants by SKU.

Common Use Cases

Product Catalog

Display your product catalog in e-commerce or customer-facing applications

Inventory Check

Verify products exist before creating orders or importing inventory

Admin Dashboard

Build product management interfaces for your operations team

Sync Systems

Keep product data synchronized with external systems

Filtering Products

Response Fields

Key fields in each product object:
Product list responses include variant counts but not full variant details. Use Get Product to retrieve a product with all its variants, or List Variants to query variants directly.

Pagination

Results are paginated using cursor-based pagination. See Pagination for details.

Authorizations

Authorization
string
header
required

API key obtained from FlexPortal dashboard

Headers

Tenant-ID
string
required

Your tenant identifier

Query Parameters

limit
string

Items per page (default: 50, max: 100)

startAfter
string

Cursor for pagination

status
string

Filter by status (active, discontinued)

category
string

Filter by category

brand
string

Filter by brand

Response

200 - application/json

List of products

products
object[]
required
count
number
required
limit
number
required
hasMore
boolean
required
nextCursor
string | null
required