Returns a list of materials.
This endpoint supports search criteria.
The following fields are searchable, using one of the filter conditions documented.
| Field | Description |
|---|---|
| id | The material identifier |
| prefix_id | The associated prefix identifier |
| brand_id | The associated brand identifier |
| type_id | The associated type identifier |
| item_code | The associated item code |
| name | The material name |
| finish | The associated finish |
| substrate | The associated substrate |
| thickness | The associated thickness |
| prefix_name | The associated prefix name |
| door_filter | The associated door filter |
| is_hidden | Is the material hidden |
This returns a paginated response containing a list of Material records.
Request
curl -X GET 'https://cabinetry.online/api/product/materials?current_page=1&page_size=10' -H 'X-GC-API-KEY: xxxxxxxxxxxx'
Successful Response
{
"items": [
{
"id": 145,
"prefix_id": 2,
"brand_id": 3,
"type_id": 2,
"item_code": null,
"name": "Artisan Oak",
"image": "Polytec/Artisan Oak.jpg",
"finish": "TimberPrintMatt",
"substrate": "MR MDF",
"thickness": 16.5,
"prefix_name": "PT",
"door_filter": "Flat Panel",
"is_grained": true,
"is_double_sided": false,
"double_sided_cost": 0,
"handling_cost": 1.45,
"area_cost": 64.152,
"area_assembly_cost": 3.15,
"min_job_area": 2.88,
"length": 2400,
"width": 1200,
"minimum_usage_rollover": 1,
"expected_yield_factor": 100,
"prefix": {
"id": 2,
"name": "PT",
"description": "Texture"
},
"brand": {
"id": 3,
"name": "Polytec"
},
"type": {
"id": 2,
"name": "Melamine",
"is_vinyl": false
},
"horizontal_grain_surcharge": null,
"is_hidden": false,
"defaults": {
"handling_cost": 1.45,
"double_sided_cost": 0,
"area_assembly_cost": 3.15,
"area_cost": 53.02,
"min_job_area": 2.88,
"minimum_usage_rollover": 1,
"expected_yield_factor": 100,
"width": 1200,
"length": 2400
}
},
{
"id": 147,
"prefix_id": 2,
"brand_id": 3,
"type_id": 2,
"item_code": null,
"name": "Belgian Oak",
"image": "Polytec/Belgian Oak.jpg",
"finish": "TimberPrintMatt",
"substrate": "MR MDF",
"thickness": 16.5,
"prefix_name": "PT",
"door_filter": "Flat Panel",
"is_grained": true,
"is_double_sided": false,
"double_sided_cost": 0,
"handling_cost": 1.45,
"area_cost": 64.152,
"area_assembly_cost": 3.15,
"min_job_area": null,
"length": null,
"width": null,
"minimum_usage_rollover": null,
"expected_yield_factor": null,
"prefix": {
"id": 2,
"name": "PT",
"description": "Texture"
},
"brand": {
"id": 3,
"name": "Polytec"
},
"type": {
"id": 2,
"name": "Melamine",
"is_vinyl": false
},
"horizontal_grain_surcharge": null,
"is_hidden": false,
"defaults": {
"handling_cost": 1.45,
"double_sided_cost": 0,
"area_assembly_cost": 3.15,
"area_cost": 53.02,
"min_job_area": 2.88,
"minimum_usage_rollover": 1,
"expected_yield_factor": 100,
"width": 1200,
"length": 2400
}
}
],
"pagination": {
"current_page": 1,
"page_count": 5,
"page_size": 2,
"total_count": 10
},
"group_count": 2,
"success": 1
}