Skip to main content
PUT
/
v1
/
products
/
{productId}
Update a product
curl --request PUT \
  --url https://api-eu.flexportal.io/v1/products/{productId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Tenant-ID: <tenant-id>' \
  --data '
{
  "productSku": "<string>",
  "name": "<string>",
  "specification": "<string>",
  "category": "<string>",
  "brand": "<string>",
  "variants": [
    {
      "variantSku": "<string>",
      "variantName": "<string>",
      "grade": "<string>",
      "pricing": [
        {
          "contractLength": 2,
          "monthlyPrice": 1,
          "setupFee": 1,
          "discount": {
            "type": "percentage",
            "value": 1,
            "description": "<string>"
          }
        }
      ],
      "colorName": "<string>",
      "rrp": 1
    }
  ]
}
'
{
  "success": true,
  "message": "<string>",
  "productId": "<string>",
  "productSku": "<string>",
  "operation": "created",
  "variantResults": [
    {
      "variantSku": "<string>",
      "operation": "create"
    }
  ]
}

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

Body

application/json
productSku
string
required
Minimum string length: 1
name
string
required
Minimum string length: 1
specification
string
required
Minimum string length: 1
category
string
required
Minimum string length: 1
brand
string
required
Minimum string length: 1
variants
object[]
required
Minimum array length: 1

Response

Product updated

success
enum<boolean>
required
Available options:
true,
false
message
string
required
productId
string
required
productSku
string
required
operation
enum<string>
required
Available options:
created,
updated
variantResults
object[]
required