Door Object

Defines the structure of the Door object, which is used in the quote request API.

Overview

The Door object contains the information for the door frame and leaf.

Field Name

Type

Description

id

string

The unique identifier for the door.

name

string

The name of the door.

width

number

The width of the door, in inches.

height

number

The height of the door, in inches.

hand

string

The hand type for the door. Possible values:

  • doorHand.LEFT- single door with handle on left

  • doorHand.RIGHT- single door with handle on right

  • doorHand.PAIR- for a pair of doors

swing

string

The swing type for the door. Possible values:

  • doorSwing.OUT

  • doorSwing.IN

  • doorSwing.DOUBLE_ACTING

quantity

number

The quantity needed of this door configuration.

unit_cost

number

The cost for a single quantity of this door configuration.

total_cost

number

The total cost for all quantities of this door configuration. This is equal to the quantity times unit_cost.

frame

object

An object representing the door frame.

frame.name

name

The name of the door frame.

frame.components

array

The component objects making up the door frame.

frame.components.name

string

The name of the frame component.

frame.components.type

string

The type of the frame component. TODO LINK

frame.components.order_code

string

This is field not yet supported, but in the future will contain the supplier's order code for the component

leaf

object

An object representing the door leaf.

leaf.name

string

The name of the door leaf.

leaf.components

array

The component objects making up the door leaf.

leaf.components.name

string

The name of the leaf component.

leaf.components.type

string

The type of the leaf component.

leaf.components.order_code

string

This is field not yet supported, but in the future will contain the supplier's order code for the component

Example

{
    id: “407f191e810c19729de860aa”,
    name: “Door 101”,
    width: 72,  # inches
    height: 84,  # inches
    hand: “doorHand.LEFT”,
    swing: “doorSwing.OUT”,
    quantity: 2,
    unit_cost: 500.00,
    total_cost: 1000.00,
    frame: {
        name: “FL500 for 9/16" Transom Glass”,
        components: [{
            name: “FL501 Transom Head”,
            type: “Transom Frame Head”,
            order_code: null  # Not yet supported
        }, {
            name: "FL504 Door Transom Mullion (Left Side)",
            type: "FL504 Door Transom Mullion (Left Side)",
            order_code: null
        }]
    },
    leaf: {
        name: “Impact Resistant Doors”,
        components: [{
            name: “D102 (4") Top Rail”,
            type: “Top Rail”,
            order_code: null  # Not yet supported
        }, {
            name: "",
            type: "",
            order_code: null
        }]
    }
}

Last updated

Was this helpful?