Create product family

post

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

Creates a new product family.

🔒 Requires: products:write scope

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

brand_id

string | null

ID of the brand

category_id

string | null

ID of the category

classification

string

enum

required

Product classification type:

STANDARD: A product family with a single member that does not vary
VARIANT: A product family with one or more members that vary by some attributes
COMPOSITE: A standard product built from multiple other products

Allowed:

composite_components

array of objects | null

Array of composite components (for composite products)

composite_components

customizations

array of objects | null

Array of customization fields for this product family

customizations

description

string | null

Description of the product family

images

array of objects | null

Array of images to add

images

name

string

required

Name of the product family

products

array of objects

required

length ≥ 1

Array of products in this family

products*

account_code

object

active

object

codes

array of objects

required

length ≥ 1

Array of product codes

codes*

code

string

required

The actual code value

type

string

enum

required

Type of product code

Allowed:

images

array of objects | null

Array of images

images

measurements

object

outlet_inventories

array of objects | null

Array of product inventory data to override defaults for specific outlets

outlet_inventories

outlet_taxes

array of objects | null

Array of outlet taxes

outlet_taxes

packaging

array of objects | null

Array of packaging

packaging

prices

object

source

object

suppliers

array of objects | null

Array of suppliers

suppliers

tax_id

string | null

Tax ID of the product

variant_attributes

array of strings | null

Array of variant attributes

variant_attributes

tag_ids

array of strings | null

Array of tag IDs

tag_ids

track_inventory

boolean

Whether to track inventory for this family

variant_attribute_ids

array of strings | null

Array of variant attribute IDs

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

201Created