For the complete documentation index, see llms.txt. This page is also available as Markdown.

Material Subcategories

Get material subcategories

get

The API gives the ability to get all subcategories of material category.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired

Material category id

Query parameters
skipnumberOptional
takenumberOptional
namestringOptional
Header parameters
x-tenant-idstring · uuidOptional

Tenant id (uuid v4)

Responses
200Success
application/json
get/api/v1/public/material-categories/{id}/subcategories

Create material subcategory

post

The API gives the ability to create new subcategory within a category.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired

Material category id

Header parameters
x-tenant-idstring · uuidOptional

Tenant id (uuid v4)

Body
namestringRequired

Subcategory name

Example: Organic Cotton
Responses
201Success
application/json
idstring · uuidRequired

Unique identifier of the subcategory

Example: b86fa12a-76fc-46f5-8a3e-bf39e7be4c4e
namestringRequired

Subcategory name

Example: Organic Cotton
created_atstring · date-timeRequired

Time when the subcategory was created

Example: 2023-12-01T10:30:00.000Z
updated_atobject · nullableOptional

Time when the subcategory was last updated, null if never updated

Example: 2023-12-15T14:45:30.000Z
material_category_idstring · uuidRequired

Identifier of the parent material category this subcategory belongs to

Example: a75eb02c-65dc-35e4-9b2f-ce28d6ad3d3c
post/api/v1/public/material-categories/{id}/subcategories

Delete material subcategory

delete

The API gives the ability to delete subcategory.

Authorizations
x-api-keystringRequired
Path parameters
subcategory_idstringRequired

Material subcategory id

idanyRequired

Material category id

Header parameters
x-tenant-idstring · uuidOptional

Tenant id (uuid v4)

Responses
200Success
application/json
messagestringRequired

Message returned from API confirming the operation

Example: The operation was done successfully
delete/api/v1/public/material-categories/{id}/subcategories/{subcategory_id}

Update material subcategory

patch

The API gives the ability to update an existing subcategory’s name.

Authorizations
x-api-keystringRequired
Path parameters
subcategory_idstringRequired

Material subcategory id

idanyRequired

Material category id

Header parameters
x-tenant-idstring · uuidOptional

Tenant id (uuid v4)

Body
namestringRequired

Subcategory name

Example: Organic Cotton
Responses
200Success
application/json
messagestringRequired

Message returned from API confirming the operation

Example: The operation was done successfully
patch/api/v1/public/material-categories/{id}/subcategories/{subcategory_id}

Last updated