Door API Endpoint

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

Data Structures

Door Record

{
    "id": 33,
    "image_id": 3053,
    "suffix_id": null,
    "name": "Non Supply",
    "item_code": null,
    "filter_name": "Non Supply",
    "suffix_name": "",
    "handling_cost": null,
    "area_handling_cost": null,
    "machining_cost": null,
    "area_machining_cost": null,
    "unit_cost": null,
    "assembly_cost": null,
    "area_assembly_cost": null,
    "is_outsourced": false,
    "is_advanced": false,
    "is_default_edge_type": false,
    "is_default_edge_type_locked": false,
    "default_brand_id": null,
    "default_material_id": null,
    "default_finish": null,
    "minimum_width": null,
    "maximum_width": null,
    "minimum_height": null,
    "maximum_height": null,
    "minimum_drawer_height": null,
    "minimum_border_width_top": null,
    "minimum_border_width_bottom": null,
    "minimum_border_width_left": null,
    "minimum_border_width_right": null,
    "default_border_width_top": null,
    "default_border_width_bottom": null,
    "default_border_width_left": null,
    "default_border_width_right": null,
    "minimum_distance_top_bottom": null,
    "minimum_distance_left_right": null,
    "minimum_rails_horizontal_height": null,
    "maximum_rails_horizontal_height": null,
    "minimum_rails_vertical_width": null,
    "maximum_rails_vertical_width": null,
    "default_rails_horizontal_height": null,
    "default_rails_vertical_width": null,
    "default_edge_finish_top": "1",
    "default_edge_finish_bottom": "1",
    "default_edge_finish_left": "1",
    "default_edge_finish_right": "1",
    "default_edge_finish_join": "1",
    "is_default_edge_finish": "1",
    "is_locked_edge_finish": "0",
    "image": {
        "id": 3053,
        "name": "Flat Panel.jpg"
    },
    "is_hidden": false,
    "defaults": {
        "area_handling_cost": 0,
        "handling_cost": 0,
        "machining_cost": 0,
        "area_machining_cost": 0,
        "assembly_cost": 0,
        "area_assembly_cost": 0,
        "unit_cost": 0
    }
}

Field	Type	Description
`id`	ID	Unique identifier
`image_id`	ID	Identifier of the image
`suffix_id`	ID	Identifier of the suffix
`name`	string	Name of the door
`item_code`	string	Code specific to the door
`filter_name`	string	Door's filter name
`suffix_name`	string	Door's suffix name
`handling_cost`	decimal	Handling cost of the door
`area_handling_cost`	decimal	Area handling cost of the door
`machining_cost`	decimal	Machining cost of the material
`area_machining_cost`	decimal	Area machining cost for the material
`unit_cost`	decimal	Unit cost for the material
`assembly_cost`	decimal	Assembly cost for the material
`area_assembly_cost`	decimal	Area assembly cost for the material
`is_outsourced`	boolean	Is the door outsourced
`is_advanced`	boolean	Is the door advanced
`is_default_edge_type`	boolean	Is door having a default edge type
`is_default_edge_type_locked`	boolean	Is door having a default edge type locked
`default_brand_id`	ID	Identifier of the brand
`default_material_id`	ID	Identifier of the material
`default_finish`	string	Default finish for the door
`minimum_width`	number	Minimum width required for the door
`maximum_width`	number	Maximum width required for the door
`minimum_height`	number	Minimum height required for the door
`maximum_height`	number	Maximum height required for the door
`minimum_drawer_height`	number	Minimum drawer height required for the door
`minimum_border_width_top`	number	Minimum border width top required for the door
`minimum_border_width_bottom`	number	Minimum border width bottom required for the door
`minimum_border_width_left`	number	Minimum border width left required for the door
`minimum_border_width_right`	number	Minimum border width right required for the door
`default_border_width_top`	number	Default border width top for the door
`default_border_width_bottom`	number	Default border width bottom for the door
`default_border_width_left`	number	Default border width left for the door
`default_border_width_right`	number	Default border width right for the door
`minimum_distance_top_bottom`	number	Minimum distance between top and bottom edge of the door
`minimum_distance_left_right`	number	Minimum distance between left and right edge of the door
`minimum_rails_horizontal_height`	number	Minimum horizontal height for the rails
`maximum_rails_horizontal_height`	number	Maximum horizontal height for the rails
`minimum_rails_vertical_width`	number	Minimum vertical width for the rails
`maximum_rails_vertical_width`	number	Maximum vertical width for the rails
`default_rails_horizontal_height`	number	Default horizontal height for the rails
`default_rails_vertical_width`	number	Default vertical width for the rails
`default_edge_finish_top`	ID	Identifier for the edge profile
`default_edge_finish_bottom`	ID	Identifier for the edge profile
`default_edge_finish_left`	ID	Identifier for the edge profile
`default_edge_finish_right`	ID	Identifier for the edge profile
`default_edge_finish_join`	ID	Identifier for the edge profile
`is_default_edge_finish`	boolean	Is the edge profile default
`is_locked_edge_finish`	boolean	Is the edge profile locked
`is_hidden`	boolean	Is the door hidden
`image`	`Image`	Door image details
`defaults`	`DoorDefaults`	Default pricing set by admin

Image Record

{
    "id": 3053,
    "name": "Flat Panel.jpg"
}

Field	Type	Description
`id`	ID	Unique identifier
`name`	string	Name of the image file

DoorDefaults Record

{
    "area_handling_cost": 5,
    "handling_cost": 8,
    "machining_cost": 15,
    "area_machining_cost": 8,
    "assembly_cost": 3.2,
    "area_assembly_cost": 6.5,
    "unit_cost": 1
}

Field	Type	Description
`area_handling_cost`	decimal	Area handling cost of the door
`handling_cost`	decimal	Handling cost for the door
`machining_cost`	decimal	Machining cost for the door
`area_machining_cost`	decimal	Area Machining cost for the door
`assembly_cost`	decimal	Machining cost for the door
`area_assembly_cost`	decimal	Area assembly cost for the door
`unit_cost`	decimal	Unit cost for the door

Requests

The request endpoints are as follows:

Door Listing

GET /api/product/doors

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

Door View

GET /api/product/doors/{id}

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

Door Update

PUT /api/product/doors/{id}

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

Door Delete

DELETE /api/product/doors/{id}

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