Category
Appliances are categorized based on their specifications and users' needs.
For example, refrigerator products have more specific categories due to different purposes within each subcategory.
This API provides instructions on how to retrieve the list of products based on these categories.
Retrieve Menu
The category serves as the menu, with numerous categories and explanations due to each category having its own specialties.
The API is responsible for retrieving data for each product, including the subcategory, category details, and product description.
Parameters
super_classes
string *The param determines the name of the brand.
Attributes
slug
stringThe slug of the main category.
subcategory
array of objectsIt includes some details of the category, including the specific type of appliances.
id
numberThe special id number of the subcategories.
name
stringThe name of the subcategories.
slug
stringThe slug of the subcategories.
detail_category
array of objectsIt includes more specific appliance types, such as id, name, slug, and logo.
id
numberThe id number of the specific appliance type.
name
stringThe name of the specific appliance type.
slug
stringThe slug of the specific appliance type.
logo_url
nullIt is optional, if the logo's url exists, it will be filled with the URL of the brand or product’s logo.
description
array of objectsIt includes more descriptions of the specific appliance types, such as titles and body descriptions.
title
stringThe name of the product.
body
stringIt is optional.
child
array of objectsIt includes the details of product id, category, title, and description of the product.
id
numberThe special number for the product.
category_id
numberThe id number of the category.
parent_id
numberThe id number of the main category.
title
stringThe title of the appliance description.
body
stringThe detailed description of the appliance product.
created_at
string | nullIt is optional, if the creation date exists, it will be filled with the date.
updated_at
string | nullIt is optional, if the update date exists, it will be filled with the date.
GET /api/v2/category/menucurl --location 'https://appliance-api.com/api/v2/category/menu?super_classes=refrigeration' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id'
{
"code": "200",
"message": "Success",
"data": [
{
"slug": "refrigeration",
"subcategory": [
{
"id": 15,
"name": "Refrigerators",
"slug": "refrigerators",
"detail_category": [
{
"id": 89,
"name": "French Door Refrigerators",
"slug": "french-door-refrigerators",
"logo_url": null
},
{
"id": 90,
"name": "Top Freezer Refrigerators",
"slug": "top-freezer-refrigerators",
"logo_url": null
},
{
"id": 91,
"name": "Side-by-Side Refrigerators",
"slug": "side-by-side-refrigerators",
"logo_url": null
},
{
"id": 92,
"name": "Bottom Freezer Refrigerators",
"slug": "bottom-freezer-refrigerators",
"logo_url": null
},
{
"id": 96,
"name": "Refrigerator Only",
"slug": "refrigerator-only",
"logo_url": null
}
]
},
{
"id": 16,
"name": "Freezers",
"slug": "freezers",
"detail_category": [
{
"id": 99,
"name": "Built-in Freezers",
"slug": "built-in-freezers",
"logo_url": null
},
{
"id": 103,
"name": "Chest Freezers",
"slug": "chest-freezers",
"logo_url": null
},
{
"id": 104,
"name": "Upright Freezers",
"slug": "upright-freezers",
"logo_url": null
}
]
},
{
"id": 17,
"name": "Specialty Refrigeration",
"slug": "specialty-refrigeration",
"detail_category": [
{
"id": 94,
"name": "Mini Refrigerators",
"slug": "mini-refrigerators",
"logo_url": null
},
{
"id": 107,
"name": "Wine Coolers",
"slug": "wine-coolers",
"logo_url": null
},
{
"id": 108,
"name": "Ice Machines",
"slug": "ice-machines",
"logo_url": null
},
{
"id": 109,
"name": "Beverage Centers",
"slug": "beverage-centers",
"logo_url": null
},
{
"id": 110,
"name": "Beer Dispensers & Coolers",
"slug": "beer-dispensers-coolers",
"logo_url": null
},
{
"id": 111,
"name": "Other Specialty Refrigerators",
"slug": "other-specialty-refrigerators",
"logo_url": null
},
{
"id": 119,
"name": "Drawer Refrigerators",
"slug": "drawer-refrigerators",
"logo_url": null
}
]
}
],
"description": [
{
"title": "Refrigeration",
"body": "",
"child": [
{
"id": 91,
"category_id": 6,
"parent_id": 90,
"type": "2",
"title": "Quality Freezer and Refrigeration Appliances",
"body": "Choose Your Perfect Refrigerator and Freezer From Our Wide Variety of Styles and Brands.",
"created_at": null,
"updated_at": null
},
{
"id": 92,
"category_id": 6,
"parent_id": 90,
"type": "2",
"title": "Love Your Refrigeration",
"body": "Your refrigerator is an appliance that you rely on every day to keep your food fresh. Invest in a quality refrigerator with an extended warranty for great peace of mind and value for money. <br><br> [Shop Here] ",
"created_at": null,
"updated_at": null
},
{
"id": 93,
"category_id": 6,
"parent_id": 90,
"type": "2",
"title": "Every Style of Refrigeration",
"body": "Choose from french door refrigerators, top freezer refrigerators, side-by-side refrigerators, bottom freezer refrigerators, built-in Freezers, chest freezers, and upright freezers – you'll find your perfect match.",
"created_at": null,
"updated_at": null
},
{
"id": 94,
"category_id": 6,
"parent_id": 90,
"type": "2",
"title": "5 Star Rated",
"body": "Example Company have been supplying the highest quality appliances for your home and business since 1965. We help our customers find the appliances best suited to their lifestyle. [Check out our reviews] ",
"created_at": null,
"updated_at": null
},
{
"id": 95,
"category_id": 6,
"parent_id": 90,
"type": "2",
"title": "Order Your New Refrigerator Today",
"body": "Stop by our showroom in St. Louis, order online, or call 636-223-5555 and get your new refrigeration appliance delivered to your door in no time. We offer competitive pricing and great deals on all our refrigerators and freezers from top brands. Enjoy great value for money and extended warranties. [Order Now] ",
"created_at": null,
"updated_at": null
}
]
}
]
}
],
"meta": null,
"errors": null
}