Create Product - Flex Documentation

Create Product

cURL

curl --request POST \
  --url https://api.withflex.com/v1/products \
  --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",
    "client_reference_id": "example_value",
    "metadata": {
      "order_id": "8842",
      "channel": "shopify"
    },
    "image_urls": [
      "https://example.com/image.png"
    ]
  }
}
'

Python

import requests

url = "https://api.withflex.com/v1/products"

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",
        "client_reference_id": "example_value",
        "metadata": {
            "order_id": "8842",
            "channel": "shopify"
        },
        "image_urls": ["https://example.com/image.png"]
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

JavaScript (Fetch)

const options = {
  method: 'POST',
  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',
      client_reference_id: 'example_value',
      metadata: {order_id: '8842', channel: 'shopify'},
      image_urls: ['https://example.com/image.png']
    }
  })
};

fetch('https://api.withflex.com/v1/products', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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',
        'client_reference_id' => 'example_value',
        'metadata' => [
                'order_id' => '8842',
                'channel' => 'shopify'
        ],
        'image_urls' => [
                'https://example.com/image.png'
        ]
    ]
  ]),
  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;
}

Go

package main

import (
    "fmt"
    "strings"
    "net/http"
    "io"
)

func main() {

url := "https://api.withflex.com/v1/products"

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    \"client_reference_id\": \"example_value\",\n    \"metadata\": {\n      \"order_id\": \"8842\",\n      \"channel\": \"shopify\"\n    },\n    \"image_urls\": [\n      \"https://example.com/image.png\"\n    ]\n  }\n}")

req, _ := http.NewRequest("POST", 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))
}

Java (Unirest)

HttpResponse<String> response = Unirest.post("https://api.withflex.com/v1/products")
  .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    \"client_reference_id\": \"example_value\",\n    \"metadata\": {\n      \"order_id\": \"8842\",\n      \"channel\": \"shopify\",\n    },\n    \"image_urls\": [\n      \"https://example.com/image.png\"\n    ]\n  }\n}")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://api.withflex.com/v1/products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.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    \"client_reference_id\": \"example_value\",\n    \"metadata\": {\n      \"order_id\": \"8842\",\n      \"channel\": \"shopify\"\n    },\n    \"image_urls\": [\n      \"https://example.com/image.png\"\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

HTTP Status Codes

Sample Success Response

{
  "product": {
    "product_id": "fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "owner_partner_id": "facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "name": "Example",
    "description": "Premium SPF 50 mineral sunscreen",
    "created_at": "2026-06-15T14:30:00Z",
    "visit_type": "cbtSleep",
    "active": false,
    "hsa_fsa_eligibility": "not_eligible",
    "test_mode": false,
    "metadata": {
      "order_id": "8842",
      "channel": "shopify"
    },
    "url": "https://example.com",
    "client_reference_id": "obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
  }
}

Sample Error Response

{
  "code": "string",
  "detail": "string"
}