WIwithflex
Products

Update Product

Changed on

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}

Request

  • Base URL
    https://api.withflex.com
  • URL
    https://api.withflex.com/v1/products/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required
Example:fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Request body

Example request

{
  "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"
      }
    ]
  }
}

Response

An envelope wrapping a single product object.

Example response

{
  "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"
  }
}

Changes

  • eec642897a22Revision changes
    • warning

      added the new adaptiveShoesDependent enum value to the ///// response property for the response status

    • warning

      added the new automatedCleaner enum value to the ///// response property for the response status

    • warning

      added the new babyMonitorSplit enum value to the ///// response property for the response status

    • warning

      added the new babySleepApp enum value to the ///// response property for the response status

    • warning

      added the new bodyPillow enum value to the ///// response property for the response status

    • warning

      added the new breathWorkDependent enum value to the ///// response property for the response status

    • warning

      added the new coolingSleepwear enum value to the ///// response property for the response status

    • warning

      added the new meneralsNootropicPouch enum value to the ///// response property for the response status

    • warning

      added the new nonenalOdor enum value to the ///// response property for the response status

    • warning

      added the new nursingChairs enum value to the ///// response property for the response status

    • warning

      added the new speechHealthDependent enum value to the ///// response property for the response status

    • warning

      added the new uvClothing enum value to the ///// response property for the response status

    • warning

      added the new uvGlasses enum value to the ///// response property for the response status

    • info

      added the new optional request property /