Update Product
curl --request PATCH \
--url https://api.withflex.com/v1/products/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"product": {
"name": "Example",
"description": "Premium SPF 50 mineral sunscreen",
"upc_code": "example_value",
"gtin": "example_value",
"reference_gtin": "example_value",
"url": "https://example.com",
"active": false,
"metadata": {
"order_id": "8842",
"channel": "shopify"
},
"categories": [
"string"
],
"component_items": [
{
"component_id": "fcomp_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
}
]
}
}
'import requests
url = "https://api.withflex.com/v1/products/{id}"
payload = { "product": {
"name": "Example",
"description": "Premium SPF 50 mineral sunscreen",
"upc_code": "example_value",
"gtin": "example_value",
"reference_gtin": "example_value",
"url": "https://example.com",
"active": False,
"metadata": {
"order_id": "8842",
"channel": "shopify"
},
"categories": ["string"],
"component_items": [{ "component_id": "fcomp_01J9XR8M3K7VZ8N2YB4WJ6T0RA" }]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
product: {
name: 'Example',
description: 'Premium SPF 50 mineral sunscreen',
upc_code: 'example_value',
gtin: 'example_value',
reference_gtin: 'example_value',
url: 'https://example.com',
active: false,
metadata: {order_id: '8842', channel: 'shopify'},
categories: ['string'],
component_items: [{component_id: 'fcomp_01J9XR8M3K7VZ8N2YB4WJ6T0RA'}]
}
})
};
fetch('https://api.withflex.com/v1/products/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.withflex.com/v1/products/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'product' => [
'name' => 'Example',
'description' => 'Premium SPF 50 mineral sunscreen',
'upc_code' => 'example_value',
'gtin' => 'example_value',
'reference_gtin' => 'example_value',
'url' => 'https://example.com',
'active' => false,
'metadata' => [
'order_id' => '8842',
'channel' => 'shopify'
],
'categories' => [
'string'
],
'component_items' => [
[
'component_id' => 'fcomp_01J9XR8M3K7VZ8N2YB4WJ6T0RA'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.withflex.com/v1/products/{id}"
payload := strings.NewReader("{\n \"product\": {\n \"name\": \"Example\",\n \"description\": \"Premium SPF 50 mineral sunscreen\",\n \"upc_code\": \"example_value\",\n \"gtin\": \"example_value\",\n \"reference_gtin\": \"example_value\",\n \"url\": \"https://example.com\",\n \"active\": false,\n \"metadata\": {\n \"order_id\": \"8842\",\n \"channel\": \"shopify\"\n },\n \"categories\": [\n \"string\"\n ],\n \"component_items\": [\n {\n \"component_id\": \"fcomp_01J9XR8M3K7VZ8N2YB4WJ6T0RA\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.withflex.com/v1/products/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"product\": {\n \"name\": \"Example\",\n \"description\": \"Premium SPF 50 mineral sunscreen\",\n \"upc_code\": \"example_value\",\n \"gtin\": \"example_value\",\n \"reference_gtin\": \"example_value\",\n \"url\": \"https://example.com\",\n \"active\": false,\n \"metadata\": {\n \"order_id\": \"8842\",\n \"channel\": \"shopify\"\n },\n \"categories\": [\n \"string\"\n ],\n \"component_items\": [\n {\n \"component_id\": \"fcomp_01J9XR8M3K7VZ8N2YB4WJ6T0RA\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withflex.com/v1/products/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"product\": {\n \"name\": \"Example\",\n \"description\": \"Premium SPF 50 mineral sunscreen\",\n \"upc_code\": \"example_value\",\n \"gtin\": \"example_value\",\n \"reference_gtin\": \"example_value\",\n \"url\": \"https://example.com\",\n \"active\": false,\n \"metadata\": {\n \"order_id\": \"8842\",\n \"channel\": \"shopify\"\n },\n \"categories\": [\n \"string\"\n ],\n \"component_items\": [\n {\n \"component_id\": \"fcomp_01J9XR8M3K7VZ8N2YB4WJ6T0RA\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"product": {
"product_id": "fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"owner_partner_id": "facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"name": "Example",
"description": "Premium SPF 50 mineral sunscreen",
"document_description": "string",
"receipt_description": "string",
"created_at": "2026-06-15T14:30:00Z",
"visit_type": "cbtSleep",
"active": false,
"upc_code": "string",
"gtin": "string",
"reference_gtin": "string",
"hsa_fsa_eligibility": "not_eligible",
"test_mode": false,
"metadata": {
"order_id": "8842",
"channel": "shopify"
},
"url": "https://example.com",
"client_reference_id": "obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
}
}{
"code": "string",
"detail": "string"
}{
"code": "string",
"detail": "string"
}{
"code": "string",
"detail": "string"
}{
"code": "string",
"detail": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}{
"code": "string",
"detail": "string"
}Update Product
Updates the specified product by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Updates never re-run HSA/FSA eligibility determination — eligibility is set when the product is created and only changes through review, so correcting a product’s ingredients cannot silently flip its eligibility. Passing categories replaces the product’s existing categories, and passing component_items replaces its components (an empty array removes them all). A product.updated event is sent to your configured webhook endpoints on success.
PATCH
/
v1
/
products
/
{id}
Update Product
curl --request PATCH \
--url https://api.withflex.com/v1/products/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"product": {
"name": "Example",
"description": "Premium SPF 50 mineral sunscreen",
"upc_code": "example_value",
"gtin": "example_value",
"reference_gtin": "example_value",
"url": "https://example.com",
"active": false,
"metadata": {
"order_id": "8842",
"channel": "shopify"
},
"categories": [
"string"
],
"component_items": [
{
"component_id": "fcomp_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
}
]
}
}
'import requests
url = "https://api.withflex.com/v1/products/{id}"
payload = { "product": {
"name": "Example",
"description": "Premium SPF 50 mineral sunscreen",
"upc_code": "example_value",
"gtin": "example_value",
"reference_gtin": "example_value",
"url": "https://example.com",
"active": False,
"metadata": {
"order_id": "8842",
"channel": "shopify"
},
"categories": ["string"],
"component_items": [{ "component_id": "fcomp_01J9XR8M3K7VZ8N2YB4WJ6T0RA" }]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
product: {
name: 'Example',
description: 'Premium SPF 50 mineral sunscreen',
upc_code: 'example_value',
gtin: 'example_value',
reference_gtin: 'example_value',
url: 'https://example.com',
active: false,
metadata: {order_id: '8842', channel: 'shopify'},
categories: ['string'],
component_items: [{component_id: 'fcomp_01J9XR8M3K7VZ8N2YB4WJ6T0RA'}]
}
})
};
fetch('https://api.withflex.com/v1/products/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.withflex.com/v1/products/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'product' => [
'name' => 'Example',
'description' => 'Premium SPF 50 mineral sunscreen',
'upc_code' => 'example_value',
'gtin' => 'example_value',
'reference_gtin' => 'example_value',
'url' => 'https://example.com',
'active' => false,
'metadata' => [
'order_id' => '8842',
'channel' => 'shopify'
],
'categories' => [
'string'
],
'component_items' => [
[
'component_id' => 'fcomp_01J9XR8M3K7VZ8N2YB4WJ6T0RA'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.withflex.com/v1/products/{id}"
payload := strings.NewReader("{\n \"product\": {\n \"name\": \"Example\",\n \"description\": \"Premium SPF 50 mineral sunscreen\",\n \"upc_code\": \"example_value\",\n \"gtin\": \"example_value\",\n \"reference_gtin\": \"example_value\",\n \"url\": \"https://example.com\",\n \"active\": false,\n \"metadata\": {\n \"order_id\": \"8842\",\n \"channel\": \"shopify\"\n },\n \"categories\": [\n \"string\"\n ],\n \"component_items\": [\n {\n \"component_id\": \"fcomp_01J9XR8M3K7VZ8N2YB4WJ6T0RA\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.withflex.com/v1/products/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"product\": {\n \"name\": \"Example\",\n \"description\": \"Premium SPF 50 mineral sunscreen\",\n \"upc_code\": \"example_value\",\n \"gtin\": \"example_value\",\n \"reference_gtin\": \"example_value\",\n \"url\": \"https://example.com\",\n \"active\": false,\n \"metadata\": {\n \"order_id\": \"8842\",\n \"channel\": \"shopify\"\n },\n \"categories\": [\n \"string\"\n ],\n \"component_items\": [\n {\n \"component_id\": \"fcomp_01J9XR8M3K7VZ8N2YB4WJ6T0RA\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withflex.com/v1/products/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"product\": {\n \"name\": \"Example\",\n \"description\": \"Premium SPF 50 mineral sunscreen\",\n \"upc_code\": \"example_value\",\n \"gtin\": \"example_value\",\n \"reference_gtin\": \"example_value\",\n \"url\": \"https://example.com\",\n \"active\": false,\n \"metadata\": {\n \"order_id\": \"8842\",\n \"channel\": \"shopify\"\n },\n \"categories\": [\n \"string\"\n ],\n \"component_items\": [\n {\n \"component_id\": \"fcomp_01J9XR8M3K7VZ8N2YB4WJ6T0RA\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"product": {
"product_id": "fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"owner_partner_id": "facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"name": "Example",
"description": "Premium SPF 50 mineral sunscreen",
"document_description": "string",
"receipt_description": "string",
"created_at": "2026-06-15T14:30:00Z",
"visit_type": "cbtSleep",
"active": false,
"upc_code": "string",
"gtin": "string",
"reference_gtin": "string",
"hsa_fsa_eligibility": "not_eligible",
"test_mode": false,
"metadata": {
"order_id": "8842",
"channel": "shopify"
},
"url": "https://example.com",
"client_reference_id": "obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
}
}{
"code": "string",
"detail": "string"
}{
"code": "string",
"detail": "string"
}{
"code": "string",
"detail": "string"
}{
"code": "string",
"detail": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}{
"code": "string",
"detail": "string"
}Authorizations
Use a Bearer token to access this API.
Path Parameters
Example:
"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
Body
application/json
An envelope wrapping a single product object.
An envelope wrapping a single product object.
The product object.
Show child attributes
Show child attributes
Example:
{ "name": "Example", "description": "Premium SPF 50 mineral sunscreen", "upc_code": "example_value", "gtin": "example_value", "reference_gtin": "example_value", "url": "https://example.com", "active": false, "metadata": { "order_id": "8842", "channel": "shopify" }, "categories": ["string"], "component_items": [ { "component_id": "fcomp_01J9XR8M3K7VZ8N2YB4WJ6T0RA" } ] }
Response
An envelope wrapping a single product object.
An envelope wrapping a single product object.
The product object.
Show child attributes
Show child attributes
Example:
{ "product_id": "fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA", "owner_partner_id": "facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA", "name": "Example", "description": "Premium SPF 50 mineral sunscreen", "document_description": "string", "receipt_description": "string", "created_at": "2026-06-15T14:30:00Z", "visit_type": "cbtSleep", "active": false, "upc_code": "string", "gtin": "string", "reference_gtin": "string", "hsa_fsa_eligibility": "not_eligible", "test_mode": false, "metadata": { "order_id": "8842", "channel": "shopify" }, "url": "https://example.com", "client_reference_id": "obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA" }