Version 2.0 (March 2017)

Usage

Reference


Usage

Signup

You must sign up for a Lennox Residential Webservices key that will allow you to make requests to the API.

A Lennox Residential Webservices key will be generated for you and displayed on the screen.

The Webservices key is how the Lennox Residential Product API will authenticate you. You must use your key for each request you make from the API.

Develop an Application

The Lennox Residential Product API requires the development of code on the user's end that does two things:

  1. REQUEST information from the API
  2. Handle the RESPONSE from the API

API Reference

Requests

How to make a request

All requests from the Lennox Residential Product API are made through standard HTTP requests. The responses to these requests will be in the form of valid JSON.

There are three different requests that may be made of the Lennox Residential Product API:

  1. List of Product Categories
  2. List of Products in a Specific Category
  3. Individual Product Overview

Note: Requests made to the API require your unique Lennox Residential Webservices Key.

List of Product Categories

URL: https://lennox.com/api/v2/<WEBSERVICESKEY>/public/categories
Arguments:

Webservices Key - Your unique Lennox Product Webservices Key

List of Products in a Specific Category

URL: https://lennox.com/api/v2/<WEBSERVICESKEY>/public/category/<category ID>
Arguments:

Webservices Key - Your unique Lennox Product Webservices Key
Category ID - The numeric ID of the category you wish to display. Is referenced as an attribute of the category in the "List of Product Categories" response.

Individual Product Overview

URL: https://lennox.com/api/v2/<WEBSERVICESKEY>/public/product/<product ID>
Arguments:

Webservices Key - Your unique Lennox Webservices Key
Product ID - The numeric ID of the product you wish to display, e.g. XC21 or PCO. Is referenced as an attribute of the product node in the "List of Products" response.

 

Responses

List of Product Categories

Example JSON:

{
  "responseCode": 1,
  "error": "sample string 2",
  "categories": [
    {
      "id": 1,
      "name": "sample string 2",
      "description": "sample string 3",
      "image": {
        "default": {
          "src": "sample string 1",
          "alt": "sample string 2"
        },
        "x-sm": {
          "src": "sample string 1",
          "alt": "sample string 2"
        },
        "sm": {
          "src": "sample string 1",
          "alt": "sample string 2"
        },
        "md": {
          "src": "sample string 1",
          "alt": "sample string 2"
        },
        "lg": {
          "src": "sample string 1",
          "alt": "sample string 2"
        },
        "x-lg": {
          "src": "sample string 1",
          "alt": "sample string 2"
        }
      },
      "products": [],
      "subcategories": [
        {
          "id": 1,
          "name": "sample string 2",
          "description": "sample string 3",
          "image": {
            "default": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "x-sm": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "sm": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "md": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "lg": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "x-lg": {
              "src": "sample string 1",
              "alt": "sample string 2"
            }
          },
          "products": [
            {
              "id": 1,
              "modelNumber": "sample string 2",
              "formattedModelNumber": "sample string 3",
              "modelName": "sample string 4",
              "description": "sample string 5",
              "thumbnailImage": {
                "default": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "x-sm": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "sm": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "md": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "lg": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "x-lg": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                }
              }
            },
            {
              "id": 1,
              "modelNumber": "sample string 2",
              "formattedModelNumber": "sample string 3",
              "modelName": "sample string 4",
              "description": "sample string 5",
              "thumbnailImage": {
                "default": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "x-sm": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "sm": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "md": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "lg": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "x-lg": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                }
              }
            },
            {
              "id": 1,
              "modelNumber": "sample string 2",
              "formattedModelNumber": "sample string 3",
              "modelName": "sample string 4",
              "description": "sample string 5",
              "thumbnailImage": {
                "default": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "x-sm": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "sm": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "md": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "lg": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "x-lg": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                }
              }
            }
          ]
        },
        {
          "id": 1,
          "name": "sample string 2",
          "description": "sample string 3",
          "image": {
            "default": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "x-sm": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "sm": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "md": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "lg": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "x-lg": {
              "src": "sample string 1",
              "alt": "sample string 2"
            }
          },
         ]
        ,
        {
          "id": 2,
          "name": "sample string 2",
          "description": "sample string 3",
          "image": {
            "default": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "x-sm": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "sm": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "md": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "lg": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "x-lg": {
              "src": "sample string 1",
              "alt": "sample string 2"
            }
          },
          "products": [
            {
              "id": 1,
              "modelNumber": "sample string 2",
              "formattedModelNumber": "sample string 3",
              "modelName": "sample string 4",
              "description": "sample string 5",
              "thumbnailImage": {
                "default": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "x-sm": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "sm": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "md": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "lg": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "x-lg": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                }
              }
            },
            {
              "id": 1,
              "modelNumber": "sample string 2",
              "formattedModelNumber": "sample string 3",
              "modelName": "sample string 4",
              "description": "sample string 5",
              "thumbnailImage": {
                "default": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "x-sm": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "sm": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "md": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "lg": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "x-lg": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                }
              }
            },
            {
              "id": 1,
              "modelNumber": "sample string 2",
              "formattedModelNumber": "sample string 3",
              "modelName": "sample string 4",
              "description": "sample string 5",
              "thumbnailImage": {
                "default": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "x-sm": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "sm": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "md": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "lg": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "x-lg": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                }
              }
            }
          ]
        }
      ]
    },
    {
      "id": 3,
      "name": "sample string 3",
      "description": "sample string 3",
      "image": {
        "default": {
          "src": "sample string 1",
          "alt": "sample string 2"
        },
        "x-sm": {
          "src": "sample string 1",
          "alt": "sample string 2"
        },
        "sm": {
          "src": "sample string 1",
          "alt": "sample string 2"
        },
        "md": {
          "src": "sample string 1",
          "alt": "sample string 2"
        },
        "lg": {
          "src": "sample string 1",
          "alt": "sample string 2"
        },
        "x-lg": {
          "src": "sample string 1",
          "alt": "sample string 2"
        }
      },
      "products": [
        {
          "id": 1,
          "modelNumber": "sample string 2",
          "formattedModelNumber": "sample string 3",
          "modelName": "sample string 4",
          "description": "sample string 5",
          "thumbnailImage": {
            "default": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "x-sm": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "sm": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "md": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "lg": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "x-lg": {
              "src": "sample string 1",
              "alt": "sample string 2"
            }
          }
        },
        {
          "id": 1,
          "modelNumber": "sample string 2",
          "formattedModelNumber": "sample string 3",
          "modelName": "sample string 4",
          "description": "sample string 5",
          "thumbnailImage": {
            "default": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "x-sm": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "sm": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "md": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "lg": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "x-lg": {
              "src": "sample string 1",
              "alt": "sample string 2"
            }
          }
        },
        {
          "id": 1,
          "modelNumber": "sample string 2",
          "formattedModelNumber": "sample string 3",
          "modelName": "sample string 4",
          "description": "sample string 5",
          "thumbnailImage": {
            "default": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "x-sm": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "sm": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "md": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "lg": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "x-lg": {
              "src": "sample string 1",
              "alt": "sample string 2"
            }
          }
        }
      ]
    }
  ]
}

                            

Dictionary:

Category

  • Attributes
  • name - string
  • description - string
  • image - string, absolute link to category highlight image, e.g. https://lennox.com/images/cat_ac.jpg
  • products - container, products in this category
  • subcategories - container, container for subcategories to this category

Product Lists by Category

Example JSON:

{
  "responseCode": 1,
  "error": "sample string 2",
  "categories": [
    {
      "id": 1,
      "name": "sample string 2",
      "description": "sample string 3",
      "image": {
        "default": {
          "src": "sample string 1",
          "alt": "sample string 2"
        },
        "x-sm": {
          "src": "sample string 1",
          "alt": "sample string 2"
        },
        "sm": {
          "src": "sample string 1",
          "alt": "sample string 2"
        },
        "md": {
          "src": "sample string 1",
          "alt": "sample string 2"
        },
        "lg": {
          "src": "sample string 1",
          "alt": "sample string 2"
        },
        "x-lg": {
          "src": "sample string 1",
          "alt": "sample string 2"
        }
      },
      "products": [],
      "subcategories": [
        {
          "id": 1,
          "name": "sample string 2",
          "description": "sample string 3",
          "image": {
            "default": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "x-sm": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "sm": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "md": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "lg": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "x-lg": {
              "src": "sample string 1",
              "alt": "sample string 2"
            }
          },
          "products": [
            {
              "id": 1,
              "modelNumber": "sample string 2",
              "formattedModelNumber": "sample string 3",
              "modelName": "sample string 4",
              "description": "sample string 5",
              "thumbnailImage": {
                "default": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "x-sm": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "sm": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "md": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "lg": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "x-lg": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                }
              }
            },
            {
              "id": 1,
              "modelNumber": "sample string 2",
              "formattedModelNumber": "sample string 3",
              "modelName": "sample string 4",
              "description": "sample string 5",
              "thumbnailImage": {
                "default": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "x-sm": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "sm": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "md": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "lg": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "x-lg": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                }
              }
            },
            {
              "id": 1,
              "modelNumber": "sample string 2",
              "formattedModelNumber": "sample string 3",
              "modelName": "sample string 4",
              "description": "sample string 5",
              "thumbnailImage": {
                "default": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "x-sm": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "sm": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "md": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "lg": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                },
                "x-lg": {
                  "src": "sample string 1",
                  "alt": "sample string 2"
                }
              }
            }
          ]
        },
        {
          "id": 1,
          "name": "sample string 2",
          "description": "sample string 3",
          "image": {
            "default": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "x-sm": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "sm": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "md": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "lg": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "x-lg": {
              "src": "sample string 1",
              "alt": "sample string 2"
            }
          },
         ]
        ,
        {
          "id": 2,
          "name": "sample string 2",
          "description": "sample string 3",
          "image": {
            "default": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "x-sm": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "sm": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "md": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "lg": {
              "src": "sample string 1",
              "alt": "sample string 2"
            },
            "x-lg": {
              "src": "sample string 1",
              "alt": "sample string 2"
            }
          }
        }
      ]
    }
  ]
}
                            

Dictionary:

Category - string, name of category, e.g. Air Conditioners

  • Attributes
  • name - string
  • description - string
  • image - string, absolute link to category highlight image, e.g. https://lennox.com/images/cat_ac.jpg
  • products - container, products in this category
  • subcategories - container, container for subcategories to this category

Product Overview Information

Example JSON:

{
  "responseCode": 1,
  "error": "sample string 2",
  "product": {
    "id": 1,
    "modelName": "sample string 2",
    "modelNumber": "sample string 3",
    "formattedModelNumber": "sample string 4",
    "category": "sample string 5",
    "description": {
      "short": "sample string 1",
      "long": "sample string 2"
    },
    "series": "sample string 6",
    "priceGuide": "sample string 7",
    "energyStarQualified": true,
    "energyStarSouthQualified": true,
    "warrantyBlurb": "sample string 10",
    "efficiencies": [
      {
        "type": "sample string 1",
        "rating": "sample string 2",
        "upToLabel": "sample string 3"
      },
      {
        "type": "sample string 1",
        "rating": "sample string 2",
        "upToLabel": "sample string 3"
      },
      {
        "type": "sample string 1",
        "rating": "sample string 2",
        "upToLabel": "sample string 3"
      }
    ],
    "image": {
      "default": {
        "src": "sample string 1",
        "alt": "sample string 2"
      },
      "x-sm": {
        "src": "sample string 1",
        "alt": "sample string 2"
      },
      "sm": {
        "src": "sample string 1",
        "alt": "sample string 2"
      },
      "md": {
        "src": "sample string 1",
        "alt": "sample string 2"
      },
      "lg": {
        "src": "sample string 1",
        "alt": "sample string 2"
      },
      "x-lg": {
        "src": "sample string 1",
        "alt": "sample string 2"
      }
    },
    "supportImage": {
      "default": {
        "src": "sample string 1",
        "alt": "sample string 2"
      },
      "x-sm": {
        "src": "sample string 1",
        "alt": "sample string 2"
      },
      "sm": {
        "src": "sample string 1",
        "alt": "sample string 2"
      },
      "md": {
        "src": "sample string 1",
        "alt": "sample string 2"
      },
      "lg": {
        "src": "sample string 1",
        "alt": "sample string 2"
      },
      "x-lg": {
        "src": "sample string 1",
        "alt": "sample string 2"
      }
    },
    "literature": [
      {
        "title": "sample string 1",
        "url": "sample string 2",
        "type": "sample string 3"
      },
      {
        "title": "sample string 1",
        "url": "sample string 2",
        "type": "sample string 3"
      },
      {
        "title": "sample string 1",
        "url": "sample string 2",
        "type": "sample string 3"
      }
    ],
    "warrantyEligible": true,
    "taxCreditQualifying": true,
    "disclaimers": [
      {
        "id": 1,
        "body": "sample string 2"
      },
      {
        "id": 1,
        "body": "sample string 2"
      },
      {
        "id": 1,
        "body": "sample string 2"
      }
    ],
    "isLimitedAvailability": true,
    "limitedAvailabilityLinkText": "sample string 14",
    "limitedAvailabilityContent": "sample string 15",
    "solarReady": true
  }
}

                            

Dictionary:

Product - container

  • modelName - string
  • modelNumber - string, model number, e.g. XC21
  • formattedModelNumber - string, model number, e.g. XC21
  • category - string, category name
  • description - string, description of product
  • series - string, series description, e.g. Merit, Elite, Dave Lennox Signature Collection
  • priceGuide - string, relative cost as indicated by dollar signs. $ to $$$
  • energyStarQualified - string, indicates EnergyStar qualification
    • Options:
      • Y - Yes
      • N - No
  • energyStarSouthQualified - string, indicates EnergyStar qualification
    • Options:
      • Y - Yes
      • N - No
  • warrantyBlurb - string for product warranty
  • efficiencies - container includes type, rating, upToLabel fields
  • image - container for image sizes
  • supportImage - container for image sizes
  • literature - container for documents with title, url and type
  • warrantyEligible - string, indicates whether product is warranty eligible
    • Options:
      • Y - Yes
      • N - No
  • taxCreditQualifying - string, indicates whether product qualifies for a tax credit
    • Options:
      • Y - Yes
      • N - No
  • disclaimers - string, product disclaimer, usually referenced in Features & Benefits copy. Should be displayed as footer.
  • limitedAvailability - string, indicates whether product limited
    • Options:
      • Y - Yes
      • N - No
  • limitedAvailabilityLinkText - string
  • limitedAvailabilityContent - string
  • solarReady - string, indicates whether product is solar ready
    • Options:
      • Y - Yes
      • N - No