Edge Listing Endpoint

Returns a list of edges.

Features

This endpoint supports search criteria.

Search Criteria

The following fields are searchable, using one of the filter conditions documented.

Field Description
id The edge identifier
brand_id The associated brand identifier
material_type_id The associated material type identifier
item_code The associated item code
name The edge name
finish The associated finish
door_filter The associated door filter
is_hidden Is the edge hidden

Response

This returns a paginated response containing a list of Edge records.

Examples

Request

curl -X GET 'https://cabinetry.online/api/product/edges?current_page=1&page_size=10' -H 'X-GC-API-KEY: xxxxxxxxxxxx'

Successful Response

{
    "items": [
        {
            "id": 723,
            "brand_id": 1,
            "material_type_id": 2,
            "item_code": null,
            "name": "Alabaster",
            "image": "Laminex/Alabaster.jpg",
            "finish": "Flint Solid Colour",
            "thickness": 2,
            "door_filter": "Flat Panel",
            "length_cost": 1.21,
            "handling_cost": 0.5,
            "area_handling_cost": 1.15,
            "application_cost": 0.9,
            "brand": {
                "id": 1,
                "name": "Laminex"
            },
            "material_type": {
                "id": 2,
                "name": "Melamine",
                "is_vinyl": false
            },
            "is_hidden": false,
            "defaults": {
                "handling_cost": 0.5,
                "length_cost": 1.21,
                "area_handling_cost": 1.5,
                "application_cost": 0.9
            }
        },
        {
            "id": 725,
            "brand_id": 1,
            "material_type_id": 2,
            "item_code": null,
            "name": "Alpaca",
            "image": "Laminex/Alpaca.jpg",
            "finish": "Flint Solid Colour",
            "thickness": 2,
            "door_filter": "Flat Panel",
            "length_cost": 1.21,
            "handling_cost": 0.5,
            "area_handling_cost": 1.25,
            "application_cost": 0.9,
            "brand": {
                "id": 1,
                "name": "Laminex"
            },
            "material_type": {
                "id": 2,
                "name": "Melamine",
                "is_vinyl": false
            },
            "is_hidden": false,
            "defaults": {
                "handling_cost": 0.5,
                "length_cost": 1.21,
                "area_handling_cost": 1.5,
                "application_cost": 0.9
            }
        }
    ],
    "pagination": {
        "current_page": 1,
        "page_count": 10,
        "page_size": 2,
        "total_count": 20
    },
    "group_count": 10,
    "success": 1
}