Skip to main content
POST
/
v1
/
products
Create Product
curl --request POST \
  --url https://api.withflex.com/v1/products \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product": {
    "name": "Example",
    "description": "string",
    "upc_code": "string",
    "gtin": "string",
    "reference_gtin": "string",
    "url": "https://example.com",
    "client_reference_id": "string",
    "metadata": {},
    "image_urls": [
      "https://example.com/image.png"
    ],
    "categories": [
      "string"
    ],
    "components": [
      "string"
    ]
  }
}
'
{
  "product": {
    "product_id": "obj_01EXAMPLE00000000000000000",
    "name": "Example",
    "description": "string",
    "document_description": "string",
    "receipt_description": "string",
    "created_at": "2024-01-01T00:00:00Z",
    "visit_type": "cbtSleep",
    "active": false,
    "upc_code": "string",
    "gtin": "string",
    "reference_gtin": "string",
    "hsa_fsa_eligibility": "not_eligible",
    "test_mode": false,
    "metadata": {},
    "url": "https://example.com",
    "client_reference_id": "obj_01EXAMPLE00000000000000000"
  }
}

Authorizations

​
Authorization
string
header
required

Use a Bearer token to access this API.

Body

application/json
​
product
object
required
Example:
{
  "name": "Example",
  "description": "string",
  "upc_code": "string",
  "gtin": "string",
  "reference_gtin": "string",
  "url": "https://example.com",
  "client_reference_id": "string",
  "metadata": {},
  "image_urls": ["https://example.com/image.png"],
  "categories": ["string"],
  "components": ["string"]
}

Response

Success

​
product
object
required

A Product defines what you sell. Flex creates the The product can either be not eligible, elegible via auto-substantiation or elegible via letter of medical necessity.

Example:
{
  "product_id": "obj_01EXAMPLE00000000000000000",
  "name": "Example",
  "description": "string",
  "document_description": "string",
  "receipt_description": "string",
  "created_at": "2024-01-01T00:00:00Z",
  "visit_type": "cbtSleep",
  "active": false,
  "upc_code": "string",
  "gtin": "string",
  "reference_gtin": "string",
  "hsa_fsa_eligibility": "not_eligible",
  "test_mode": false,
  "metadata": {},
  "url": "https://example.com",
  "client_reference_id": "obj_01EXAMPLE00000000000000000"
}