Family Endpoints
GET /api/families
Returns a list of families
for a shop.
Accepts a page
and limit
query parameter for pagination.
Returns 10
records at a time.
GET /api/families/{id}
Returns the family with id={id}
.
POST /api/families
Creates a new family record.
Accepted Parameters:
typescript
{
family: {
name: string,
slug?: string,
description?: string,
parent_id?: number,
child_index?: number
}
}
PUT /api/families/{id}
Updates the family with id={id}
.
Accepted Parameters:
typescript
{
family: {
name: string,
slug?: string,
description?: string,
parent_id?: number
},
color: {
id: number,
position?: number
},
rule: {
id: number
},
rule_setting: {
value: string
}
}
DELETE /api/families/{id}
Removes the family and all dependent records.