Brands
To retrieve brands, three options are available: all brands, only popular brands, or details of specific brands.
To implement Appliance.io’s API, the GET method must be used for fetching brand components.
The objects retrieved vary for each section.
Retrieve All Brands
The brand names need to be displayed for the purpose of promoting and showcasing the products' brands.
Parameters
No parameter required.
Attributes
name
stringThe name of the brand.
slug
stringThe slug in the existing url.
image
stringThe URL source of the brands’ images.
GET /api/v2/brandcurl --location 'https://appliance-api.com/api/v2/brand' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id'
{
"code": "200",
"message": "Success",
"data": [
{
"name": "Hotpoint",
"slug": "hotpoint",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/901994-hotpoint.png"
},
{
"name": "JennAir",
"slug": "jennair",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/293105-jennair.png"
},
{
"name": "Amana",
"slug": "amana",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/813600-amana.png"
},
{
"name": "Whirlpool",
"slug": "whirlpool",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/211742-whirlpool.jpg"
},
{
"name": "KitchenAid",
"slug": "kitchenaid",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/945200-kitchenaid.jpg"
},
{
"name": "Zephyr",
"slug": "zephyr",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/327423-zephyr.png"
},
{
"name": "Magic Chef",
"slug": "magic-chef",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/891296-magic-chef.png"
},
{
"name": "Maytag",
"slug": "maytag",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/311766-maytag.jpg"
},
{
"name": "Bosch",
"slug": "bosch",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/854831-bosch.png"
},
{
"name": "Marvel",
"slug": "marvel",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/403137-marvel.png"
},
{
"name": "Moen",
"slug": "moen",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/596531-moen.png"
},
{
"name": "Broan",
"slug": "broan",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/595173-broan.png"
},
{
"name": "Coyote",
"slug": "coyote",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/466790-coyote.png"
},
{
"name": "Danby",
"slug": "danby",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/216518-danby.png"
},
{
"name": "Frigidaire",
"slug": "frigidaire",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/878017-frigidaire.png"
},
{
"name": "Frigidaire Gallery",
"slug": "frigidaire-gallery",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/452315-frigidaire-gallery.png"
},
{
"name": "Frigidaire Professional",
"slug": "frigidaire-professional",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/313844-frigidaire-professional.png"
},
{
"name": "Electrolux",
"slug": "electrolux",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/415104-electrolux.png"
},
{
"name": "Samsung",
"slug": "samsung",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/273325-samsung.png"
},
{
"name": "Silhouette",
"slug": "silhouette",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/735537-silhouette.png"
},
{
"name": "Speed Queen",
"slug": "speed-queen",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/741172-speedqueen.png"
},
{
"name": "Summit",
"slug": "summit",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/383514-summit.png"
},
{
"name": "Thermador",
"slug": "thermador",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/922400-thermador.png"
},
{
"name": "LG",
"slug": "lg",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/617342-LG.png"
},
{
"name": "LG Signature",
"slug": "lg-signature",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/898375-lg-signature.png"
},
{
"name": "Azure",
"slug": "azure",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/701476-azure.png"
},
{
"name": "Sharp",
"slug": "sharp",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/628493-sharp.png"
},
{
"name": "GE",
"slug": "ge",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/502614-ge.png"
},
{
"name": "Cafe",
"slug": "cafe",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/258872-cafe.png"
},
{
"name": "Monogram",
"slug": "monogram",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/854912-monogram.png"
},
{
"name": "GE Profile",
"slug": "ge-profile",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/737688-profile.png"
},
{
"name": "Midea",
"slug": "midea",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/604836-midea.png"
},
{
"name": "Haier",
"slug": "haier",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/317333-haier.png"
},
{
"name": "Bertazzoni",
"slug": "bertazzoni",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/587259-bertazzoni.png"
},
{
"name": "Waste King",
"slug": "wasteking",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/592420-wasteking.png"
},
{
"name": "Viking",
"slug": "viking",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/187818-viking.png"
},
{
"name": "LG Studio",
"slug": "lg-studio",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/543090-lg-studio.png"
},
{
"name": "U-Line",
"slug": "u-line",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/870108-u-line.png"
},
{
"name": "Gladiator",
"slug": "gladiator",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/426999-gladiator.jpg"
},
{
"name": "Blazegrills",
"slug": "blazegrills",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/792935-blazegrills.png"
},
{
"name": "True Residential",
"slug": "true-residential",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/397022-true-residential.png"
},
{
"name": "Hestan",
"slug": "hestan",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/481721-hestan.png"
},
{
"name": "Panasonic",
"slug": "panasonic",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/966068-panasonic.png"
},
{
"name": "Scotsman",
"slug": "scotsman",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/206376-scotsman.png"
},
{
"name": "AGA",
"slug": "aga",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/192843-aga.png"
},
{
"name": "Verona",
"slug": "verona",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/172197-verona.png"
},
{
"name": "ILVE",
"slug": "ilve",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/489209-ilve.png"
},
{
"name": "Miele",
"slug": "miele",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/805664-miele.png"
},
{
"name": "Elica",
"slug": "elica",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/525944-elica.png"
},
{
"name": "Crossover 2.0",
"slug": "crossover-2-0",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/crossover-2-0.png"
},
{
"name": "Premier",
"slug": "premier",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/923635-premier.png"
},
{
"name": "NXR",
"slug": "nxr",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/nxr.png"
},
{
"name": "Chef's Design",
"slug": "chefs-design",
"image": "https://ik.imagekit.io/3afupmxoz"
},
{
"name": "Hoshizaki",
"slug": "hoshizaki",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/hoshizaki.png"
},
{
"name": "Galanz",
"slug": "galanz",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/315759-galanz.png"
},
{
"name": "Keystone",
"slug": "keystone",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/270864-keystone.png"
},
{
"name": "Element Appliance",
"slug": "element-appliance",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/element-appliance.png"
},
{
"name": "Kelvinator",
"slug": "kelvinator",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/235018-kelvinator.png"
}
],
"meta": null,
"errors": null
}
Retrieve Popular Brands
To specify the request, you can simply request popular brands. Popular brands include certain brands that meet the criteria of being the most desired.
Parameters
is_popular
boolean *Filter brand to popular brand only.
Attributes
name
stringThe name of the popular brand.
slug
stringThe slug in the existing url of a popular brand.
image
stringThe URL source of the popular brands’ images.
GET /api/v2/brandcurl --location 'https://appliance-api.com/api/v2/brand?is_popular=true' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id'
{
"code": "200",
"message": "Success",
"data": [
{
"name": "Thermador",
"slug": "thermador",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/922400-thermador.png"
},
{
"name": "JennAir",
"slug": "jennair",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/293105-jennair.png"
},
{
"name": "True Residential",
"slug": "true-residential",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/397022-true-residential.png"
},
{
"name": "GE",
"slug": "ge",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/502614-ge.png"
},
{
"name": "KitchenAid",
"slug": "kitchenaid",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/945200-kitchenaid.jpg"
},
{
"name": "LG",
"slug": "lg",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/617342-LG.png"
},
{
"name": "Cafe",
"slug": "cafe",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/258872-cafe.png"
},
{
"name": "Whirlpool",
"slug": "whirlpool",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/211742-whirlpool.jpg"
},
{
"name": "Monogram",
"slug": "monogram",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/854912-monogram.png"
},
{
"name": "Bosch",
"slug": "bosch",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/854831-bosch.png"
},
{
"name": "Maytag",
"slug": "maytag",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/311766-maytag.jpg"
}
],
"meta": null,
"errors": null
}
Retrieve Brand Details
Accessing brand details is crucial for customers as it provides essential information. These details become more specific, including subcategories within each category.
Parameters
super_classes
string *The param determines the name of the brand.
Attributes
logo
stringThe url of the brand’s logo as the main category.
brand_name
stringThe name of the brand.
background
stringThe URL source of the popular brands’ background images.
subcategory
array of objectsAfter choosing the brand, subcategory can be specified based on the needed appliance type.
name
stringName of the category.
slug
stringThe slug of the category.
detail_category
array of objectsInside the detail_category, there are more details of the category type based on the specific type of product.
id
integerThe id number of the specific category.
name
stringName of the more specific category.
slug
stringThe slug of the specific category.
logo_url
nullIt is optional, if the logo exists, it will be filled with the URL of the brand or product’s logo.
slug
stringThe slug of the brand.
url
stringIt is optional.
text_content
array of objectsThe content inside which explains about the brand (description).
Description
array of objectsThe description of the brand.
description
stringThe description of the brand inside the Description array, using paragraph <p><p/> and <i><i/>.
GET /api/v2/category/menucurl --location 'https://appliance-api.com/api/v2/category/menu?super_classes=jennair' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id'
{
"code": "200",
"message": "Success",
"data": {
"logo": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/293105-jennair.png",
"brand_name": "JennAir",
"background": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/jennair-background.jpg",
"subcategory": [
{
"name": "Refrigerators",
"slug": "refrigerators",
"detail_category": [
{
"id": 89,
"name": "French Door Refrigerators",
"slug": "french-door-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
}
]
},
{
"name": "Freezers",
"slug": "freezers",
"detail_category": [
{
"id": 99,
"name": "Built-in Freezers",
"slug": "built-in-freezers",
"logo_url": null
}
]
},
{
"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": 119,
"name": "Drawer Refrigerators",
"slug": "drawer-refrigerators",
"logo_url": null
}
]
},
{
"name": "Cooktops",
"slug": "cooktops",
"detail_category": [
{
"id": 11,
"name": "Gas Cooktops",
"slug": "gas-cooktops",
"logo_url": null
},
{
"id": 12,
"name": "Electric Cooktops",
"slug": "electric-cooktops",
"logo_url": null
},
{
"id": 13,
"name": "Induction Cooktops",
"slug": "induction-cooktops",
"logo_url": null
},
{
"id": 14,
"name": "Rangetops",
"slug": "rangetops",
"logo_url": null
}
]
},
{
"name": "Microwaves",
"slug": "microwaves",
"detail_category": [
{
"id": 16,
"name": "Built-in Microwaves",
"slug": "built-in-microwaves",
"logo_url": null
},
{
"id": 17,
"name": "Countertop Microwaves",
"slug": "countertop-microwaves",
"logo_url": null
},
{
"id": 18,
"name": "Over-the-Range Microwaves",
"slug": "over-the-range-microwaves",
"logo_url": null
},
{
"id": 20,
"name": "Microwave Drawers",
"slug": "microwave-drawers",
"logo_url": null
}
]
},
{
"name": "Ovens",
"slug": "ovens",
"detail_category": [
{
"id": 23,
"name": "Single Wall Ovens",
"slug": "single-wall-ovens",
"logo_url": null
},
{
"id": 24,
"name": "Double Wall Ovens",
"slug": "double-wall-ovens",
"logo_url": null
},
{
"id": 25,
"name": "Microwave Oven Combinations",
"slug": "microwave-Oven-combinations",
"logo_url": null
},
{
"id": 26,
"name": "Warming Drawers",
"slug": "warming-drawers",
"logo_url": null
}
]
},
{
"name": "Ranges",
"slug": "ranges",
"detail_category": [
{
"id": 122,
"name": "Professional",
"slug": "professional",
"logo_url": null
},
{
"id": 123,
"name": "Slide-In",
"slug": "slide-in",
"logo_url": null
}
]
},
{
"name": "Vent Hoods",
"slug": "vent-hoods",
"detail_category": [
{
"id": 37,
"name": "Wall & Chimney Hoods",
"slug": "wall-chimney-hoods",
"logo_url": null
},
{
"id": 38,
"name": "Under Cabinet Hoods",
"slug": "under-cabinet-hoods",
"logo_url": null
},
{
"id": 39,
"name": "Downdraft Hoods",
"slug": "downdraft-hoods",
"logo_url": null
}
]
},
{
"name": "Dishwashers",
"slug": "dishwashers",
"detail_category": [
{
"id": 46,
"name": "Built-In Dishwashers",
"slug": "built-in-dishwashers",
"logo_url": null
}
]
},
{
"name": "Disposal",
"slug": "disposal",
"detail_category": [
{
"id": 118,
"name": "Trash Compactors",
"slug": "trash-compactors",
"logo_url": null
}
]
},
{
"name": "Coffee Systems",
"slug": "coffee-systems",
"detail_category": [
{
"id": 43,
"name": "Built-In Coffeemakers",
"slug": "built-in-coffeemakers",
"logo_url": null
}
]
}
],
"slug": "jennair",
"url": null,
"text_content": {
"Description": [
{
"description": "<p>With a full lineup of JennAir refrigerators, microwaves, ovens, and <i>more</i>, our Example family elevates your kitchen’s aesthetic with a consistent look across all of your appliances. As the premier local JennAir dealer, our always up-to-date selection features the latest sizes and styles, tailored to your unique home. All the while, we proudly support next-day deliveries throughout St. Louis for our JennAir appliance collection. Upgrade your luxury kitchen <i>today</i> at Example.</p>"
}
]
}
},
"meta": null,
"errors": null
}