Edge API Endpoint

The edge api endpoint is used to manage edges in the system. The following operations are supported:

Data Structures

Edge Record

{

    "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": null,
    "handling_cost": null,
    "area_handling_cost": null,
    "application_cost": null,
    "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
    }
}

Field	Type	Description
`id`	ID	Unique identifier
`brand_id`	ID	Identifier of the brand
`material_type_id`	ID	Identifier of the material type
`item_code`	string	Code specific to the edge
`name`	string	Name of the edge
`image`	string	Image of the edge
`finish`	string	Edge's Finish
`thickness`	decimal	Edge's Thickness
`door_filter`	string	Door filter to which the edge belongs
`length_cost`	boolean	Length cost for the edge
`handling_cost`	boolean	Handling cost for the edge
`area_handling_cost`	decimal	Area handling cost for the edge
`application_cost`	decimal	Application cost of the edge
`is_hidden`	boolean	Hidden status of the edge
`brand`	`Brand`	Edge's brand information
`material_type`	`MaterialType`	Material type information
`defaults`	`EdgeDefaults`	Admin Defaults for the pricing

Brand Record

{
    "id": 1,
    "name": "Laminex"
}

Field	Type	Description
`id`	ID	Unique identifier
`name`	string	Brand name

MaterialType Record

{
    "id": 2,
    "name": "Melamine",
    "is_vinyl": false
}

Field	Type	Description
`id`	ID	Unique identifier
`name`	string	Material type name
`is_vinyl`	boolean	Is the material type vinyl

EdgeDefaults Record

{
    "handling_cost": 0.5,
    "length_cost": 1.21,
    "area_handling_cost": 1.5,
    "application_cost": 0.9
}

Field	Type	Description
`handling_cost`	decimal	Handling cost for the edge
`length_cost`	decimal	Length cost for the edge
`area_handling_cost`	decimal	Area Handling cost for the edge
`application_cost`	decimal	Application cost for the edge

Requests

The request endpoints are as follows:

Edge Listing

GET /api/product/edges

The edge listing api endpoint is used to list all edges in the system. The response will be a paginated list of edges. See search criteria for more information on how to paginate and filter records.

Edge View

GET /api/product/edges/{id}

The edge view api endpoint is used to view a single edge in the system. The response will be a single edge. The id parameter is the id of the edge to view.

Edge Update

PUT /api/product/edges/{id}

The edge update api endpoint is used to update a single edge in the system. The id parameter is the id of the edge to update. The request body should contain the updated edge.

Edge Delete

DELETE /api/product/materials/{id}

The edge delete api endpoint is used to delete a single edge in the system. The id parameter is the id of the edge to delete.