Skip to main content
GET
/
v1
/
products
/
{productId}
Get a product
curl --request GET \
  --url https://api-eu.flexportal.io/v1/products/{productId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Tenant-ID: <tenant-id>'
{
  "productId": "<string>",
  "tenantId": "<string>",
  "productSku": "<string>",
  "name": "<string>",
  "specification": "<string>",
  "category": "<string>",
  "brand": "<string>",
  "status": "active",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "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
    }
  ]
}

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
variants
object[]