Material Subcategories

Get material subcategories

get

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

Authorizations

PublicApiKey

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

429

Returned when the rate limit is exceeded

get/api/v1/public/material-categories/{id}/subcategories

HTTPcURLJavaScriptPython

GET /api/v1/public/material-categories/{id}/subcategories HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": "b86fa12a-76fc-46f5-8a3e-bf39e7be4c4e",
      "name": "Organic Cotton",
      "created_at": "2023-12-01T10:30:00.000Z",
      "updated_at": "2023-12-15T14:45:30.000Z",
      "material_category_id": "a75eb02c-65dc-35e4-9b2f-ce28d6ad3d3c"
    }
  ],
  "meta": {
    "total": 1,
    "lastPage": 1,
    "currentPage": 1,
    "perPage": 1,
    "prev": 1,
    "next": 1
  }
}

Create material subcategory

post

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

Authorizations

PublicApiKey

x-api-keystringRequired

Path parameters

idstringRequired

Material category id

Header parameters

x-tenant-idstring · uuidOptional

Tenant id (uuid v4)

Body

application/json

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

429

Returned when the rate limit is exceeded

post/api/v1/public/material-categories/{id}/subcategories

HTTPcURLJavaScriptPython

POST /api/v1/public/material-categories/{id}/subcategories HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "name": "Organic Cotton"
}

{
  "id": "b86fa12a-76fc-46f5-8a3e-bf39e7be4c4e",
  "name": "Organic Cotton",
  "created_at": "2023-12-01T10:30:00.000Z",
  "updated_at": "2023-12-15T14:45:30.000Z",
  "material_category_id": "a75eb02c-65dc-35e4-9b2f-ce28d6ad3d3c"
}

Delete material subcategory

delete

The API gives the ability to delete subcategory.

Authorizations

PublicApiKey

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

429

Returned when the rate limit is exceeded

delete/api/v1/public/material-categories/{id}/subcategories/{subcategory_id}

HTTPcURLJavaScriptPython

DELETE /api/v1/public/material-categories/{id}/subcategories/{subcategory_id} HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "message": "The operation was done successfully"
}

Update material subcategory

patch

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

Authorizations

PublicApiKey

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

application/json

namestringRequired

Subcategory name

Example: Organic Cotton

Responses

200Success

application/json

messagestringRequired

Message returned from API confirming the operation

Example: The operation was done successfully

429

Returned when the rate limit is exceeded

patch/api/v1/public/material-categories/{id}/subcategories/{subcategory_id}

HTTPcURLJavaScriptPython

PATCH /api/v1/public/material-categories/{id}/subcategories/{subcategory_id} HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "name": "Organic Cotton"
}

{
  "message": "The operation was done successfully"
}