Skip to main content
GET
/
v1
/
products
/
variants
List all variants
curl --request GET \
  --url https://api-eu.flexportal.io/v1/products/variants \
  --header 'Authorization: Bearer <token>' \
  --header 'Tenant-ID: <tenant-id>'
{
  "variants": [
    {
      "tenantId": "<string>",
      "productId": "<string>",
      "productSku": "<string>",
      "variantSku": "<string>",
      "variantName": "<string>",
      "grade": "<string>",
      "pricing": [
        {
          "contractLength": 2,
          "monthlyPrice": 1,
          "setupFee": 1,
          "discount": {
            "type": "percentage",
            "value": 1,
            "description": "<string>"
          }
        }
      ],
      "status": "active",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "colorName": "<string>",
      "rrp": 123
    }
  ],
  "count": 123,
  "limit": 123,
  "hasMore": true,
  "nextCursor": "<string>"
}

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: 5000, max: 5000)

startAfter
string

Cursor for pagination

status
string

Filter by status (active, inactive)

productSku
string

Filter by product SKU

grade
string

Filter by grade (A, B, C, D, E)

Response

200 - application/json

List of variants

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