Update product family

patch

https://{domain_prefix}.retail.lightspeed.app/api/2026-10/product_families/{product_family_id}

Partially updates an existing product family. Only fields present in the request body are updated.
Fields set to null will be cleared where applicable.

🔒 Requires: products:write scope

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

product_family_id

string

required

A product family ID

Body Params

All fields are optional. Only fields present in the request body are updated.

brand_id

string | null

ID of the brand. Set to null to clear.

category_id

string | null

ID of the category. Set to null to clear.

composite_components

array of objects | null

Array of composite components (bill of materials). Set to null to clear.

composite_components

customizations

array of objects | null

Array of customization fields. Replaces all existing customizations.

customizations

description

string | null

Description of the product family. Set to null to clear.

name

string | null

Name of the product family. Set to null to clear.

tag_ids

array of strings | null

Array of tag IDs. Set to null to clear.

tag_ids

tax_category

string

Avalara tax code (non-negative integer as string). Applied to all products in the family. Omit to leave unchanged. Set to empty string or "0" to clear. Null is not allowed.

track_inventory

boolean

Whether to track inventory for this family.

variant_attribute_ids

array of strings | null

Array of variant attribute IDs. Set to null to clear.

variant_attribute_ids

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK