Skip to main content

Catalog

The Catalog is where you showcase your brands to the public. It plays a pivotal role in product promotion, fostering engagement with your products, and enhancing market value. Within the catalog, the API will display brand, category, and product information.


List All Brands

The API allows users to retrieve a list of brands available in the store, providing insight into the brands offered.


Parameters


No parameter required.



Attributes


id number

The id of the brand.


name string

The name of the brand.


slug string

The slug in the existing url.


image string

The URL source of the brands’ images.

GET /api/public/brand
curl --location 'https://appliance-api.com/api/public/brand' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id'
{
"code": "200",
"message": "Success",
"data": [
{
"id": 1,
"name": "AGA",
"slug": "aga",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/192843-aga.png"
},
{
"id": 2,
"name": "Amana",
"slug": "amana",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/813600-amana.png"
},
{
"id": 3,
"name": "Azure",
"slug": "azure",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/701476-azure.png"
},
{
"id": 4,
"name": "Bertazzoni",
"slug": "bertazzoni",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/587259-bertazzoni.png"
},
{
"id": 5,
"name": "Blazegrills",
"slug": "blazegrills",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/792935-blazegrills.png"
},
{
"id": 6,
"name": "Bosch",
"slug": "bosch",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/854831-bosch.png"
},
{
"id": 7,
"name": "Broan",
"slug": "broan",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/595173-broan.png"
},
{
"id": 8,
"name": "Cafe",
"slug": "cafe",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/258872-cafe.png"
},
{
"id": 9,
"name": "Chef's Design",
"slug": "chefs-design",
"image": "https://ik.imagekit.io/3afupmxoz"
},
{
"id": 10,
"name": "Coyote",
"slug": "coyote",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/466790-coyote.png"
},
{
"id": 57,
"name": "Crossover 2.0",
"slug": "crossover-2-0",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/crossover-2-0.png"
},
{
"id": 11,
"name": "Danby",
"slug": "danby",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/216518-danby.png"
},
{
"id": 13,
"name": "Electrolux",
"slug": "electrolux",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/415104-electrolux.png"
},
{
"id": 72,
"name": "Element Appliance",
"slug": "element-appliance",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/element-appliance.png"
},
{
"id": 58,
"name": "Elica",
"slug": "elica",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/525944-elica.png"
},
{
"id": 14,
"name": "Frigidaire",
"slug": "frigidaire",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/878017-frigidaire.png"
},
{
"id": 15,
"name": "Frigidaire Gallery",
"slug": "frigidaire-gallery",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/452315-frigidaire-gallery.png"
},
{
"id": 16,
"name": "Frigidaire Professional",
"slug": "frigidaire-professional",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/313844-frigidaire-professional.png"
},
{
"id": 68,
"name": "Galanz",
"slug": "galanz",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/315759-galanz.png"
},
{
"id": 17,
"name": "GE",
"slug": "ge",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/502614-ge.png"
},
{
"id": 49,
"name": "GE Profile",
"slug": "ge-profile",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/737688-profile.png"
},
{
"id": 52,
"name": "Gladiator",
"slug": "gladiator",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/426999-gladiator.jpg"
},
{
"id": 50,
"name": "Haier",
"slug": "haier",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/317333-haier.png"
},
{
"id": 59,
"name": "Hestan",
"slug": "hestan",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/481721-hestan.png"
},
{
"id": 61,
"name": "Hoshizaki",
"slug": "hoshizaki",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/hoshizaki.png"
},
{
"id": 19,
"name": "Hotpoint",
"slug": "hotpoint",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/901994-hotpoint.png"
},
{
"id": 53,
"name": "ILVE",
"slug": "ilve",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/489209-ilve.png"
},
{
"id": 20,
"name": "JennAir",
"slug": "jennair",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/293105-jennair.png"
},
{
"id": 73,
"name": "Kelvinator",
"slug": "kelvinator",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/235018-kelvinator.png"
},
{
"id": 69,
"name": "Keystone",
"slug": "keystone",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/270864-keystone.png"
},
{
"id": 21,
"name": "KitchenAid",
"slug": "kitchenaid",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/945200-kitchenaid.jpg"
},
{
"id": 22,
"name": "LG",
"slug": "lg",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/617342-LG.png"
},
{
"id": 23,
"name": "LG Signature",
"slug": "lg-signature",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/898375-lg-signature.png"
},
{
"id": 24,
"name": "LG Studio",
"slug": "lg-studio",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/543090-lg-studio.png"
},
{
"id": 25,
"name": "Magic Chef",
"slug": "magic-chef",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/891296-magic-chef.png"
},
{
"id": 26,
"name": "Marvel",
"slug": "marvel",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/403137-marvel.png"
},
{
"id": 27,
"name": "Maytag",
"slug": "maytag",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/311766-maytag.jpg"
},
{
"id": 48,
"name": "Midea",
"slug": "midea",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/604836-midea.png"
},
{
"id": 71,
"name": "Miele",
"slug": "miele",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/805664-miele.png"
},
{
"id": 28,
"name": "Moen",
"slug": "moen",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/596531-moen.png"
},
{
"id": 29,
"name": "Monogram",
"slug": "monogram",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/854912-monogram.png"
},
{
"id": 55,
"name": "NXR",
"slug": "nxr",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/nxr.png"
},
{
"id": 31,
"name": "Panasonic",
"slug": "panasonic",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/966068-panasonic.png"
},
{
"id": 32,
"name": "Premier",
"slug": "premier",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/923635-premier.png"
},
{
"id": 33,
"name": "Samsung",
"slug": "samsung",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/273325-samsung.png"
},
{
"id": 34,
"name": "Scotsman",
"slug": "scotsman",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/206376-scotsman.png"
},
{
"id": 35,
"name": "Sharp",
"slug": "sharp",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/628493-sharp.png"
},
{
"id": 36,
"name": "Silhouette",
"slug": "silhouette",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/735537-silhouette.png"
},
{
"id": 39,
"name": "Speed Queen",
"slug": "speed-queen",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/741172-speedqueen.png"
},
{
"id": 40,
"name": "Summit",
"slug": "summit",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/383514-summit.png"
},
{
"id": 41,
"name": "Thermador",
"slug": "thermador",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/922400-thermador.png"
},
{
"id": 54,
"name": "True Residential",
"slug": "true-residential",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/397022-true-residential.png"
},
{
"id": 42,
"name": "U-Line",
"slug": "u-line",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/870108-u-line.png"
},
{
"id": 43,
"name": "Verona",
"slug": "verona",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/172197-verona.png"
},
{
"id": 44,
"name": "Viking",
"slug": "viking",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/187818-viking.png"
},
{
"id": 45,
"name": "Waste King",
"slug": "wasteking",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/592420-wasteking.png"
},
{
"id": 46,
"name": "Whirlpool",
"slug": "whirlpool",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/211742-whirlpool.jpg"
},
{
"id": 47,
"name": "Zephyr",
"slug": "zephyr",
"image": "https://ik.imagekit.io/3afupmxoz/storage/images/brand/327423-zephyr.png"
}
],
"meta": null,
"errors": null
}

List All Categories

The category specifies the grouping of products. The API will retrieve data for each product, including its subcategory, category details, and product description.


Parameters


No parameter required.



Attributes


id number

The id of the categories.


name string

The name of the category.


slug string

The slug in the existing url.

GET /api/public/category
curl --location 'https://appliance-api.com/api/public/category' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id'
{
"code": "200",
"message": "Success",
"data": [
{
"id": 1,
"name": "Air Conditioners",
"slug": "air-conditioners"
},
{
"id": 2,
"name": "Cooking",
"slug": "cooking"
},
{
"id": 3,
"name": "Dishwashers",
"slug": "dishwashers"
},
{
"id": 4,
"name": "Laundry",
"slug": "laundry"
},
{
"id": 12,
"name": "Other",
"slug": "other"
},
{
"id": 5,
"name": "Outdoor",
"slug": "outdoor"
},
{
"id": 6,
"name": "Refrigeration",
"slug": "refrigeration"
}
],
"meta": null,
"errors": null
}

List All Subcategories

Each category includes specific subcategories to classify products. The API will retrieve data for each product, including its subcategory, category details, and product description.


Parameters


category_id number

The param determines the id of category.



Attributes


id number

The special id number of the subcategories.


name string

The name of the main appliance type.


slug string

The slug of the main appliance type.

GET /api/public/subcategory
curl --location 'https://appliance-api.com/api/public/subcategory?category_id=1' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id'
{
"code": "200",
"message": "Success",
"data": [
{
"id": 1,
"name": "Air Conditioners",
"slug": "air-conditioners"
},
{
"id": 2,
"name": "Dehumidifiers",
"slug": "dehumidifiers"
}
],
"meta": null,
"errors": null
}

List Detail Categories

Each subcategory contains more detailed classifications for products. The API will retrieve data for each product, including its subcategory, category details, and product description.


Parameters


subcategory_id number

The param determines the id of subcategory.



Attributes


id number

The special id number of the detail categories.


name string

The name of the main appliance type.


slug string

The slug of the main appliance type.

GET /api/public/detail-category
curl --location 'https://appliance-api.com/api/public/detail-category?subcategory_id=1' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id'
{
"code": "200",
"message": "Success",
"data": [
{
"id": 3,
"name": "Portable Air Conditioners",
"slug": "portable-air-conditioners"
},
{
"id": 2,
"name": "Wall Mount Air Conditioners",
"slug": "wall-mount-air-conditioners"
},
{
"id": 1,
"name": "Window Mount Air Conditioners",
"slug": "window-mount-air-conditioners"
}
],
"meta": null,
"errors": null
}

List All Products

Displaying the product is necessary for promotions and can only be retrieved from the database. The data includes category details, sorting format, brand, and applied filters. Furthermore, the price range can be displayed using the GET method, while product ratings and stock availability can also be checked.


Parameters


sku string

It mentions the stock keeping unit, to differentiate one product with another.


brand_id string

It is used to search the product based on id.


category string

It specifies the main category of the product.


subcategory string

It specifies the second category of the product.


detail_category string

It specifies the detail category of the product.


page number

It makes the search result page appear.


paginate number

It specifies the number of results per page.



Attributes


id number

The id number of the product.


sku string

The stock keeping unit id of each product.


color string

The color of the product.


name string

The name of the specific product.


content string

The id of each product which has different patterns.


brand_id number

The brand id of the product.


brand_name string

The name of the appliance brand.


category string

The category of the product.


subcategory string

The subcategory of the product.


detail_category string

The detail category of the product.


product_images array of objects

The list of product image object.


product_images: id number

The id of the product image.


product_images: image string

The url of the product image, retrieved from the brand’s website.


product_images: role null

product_documents array of objects

The list of product image object.


product_documents: id number

The id of the product document.


product_documents: pdf string

The url of the product document, retrieved from the brand’s website.


product_documents: role string

The name of the document.


product_feature array of objects

The list of product image object.


product_feature: value string

The value name of the product feature.


product_spec array of objects

The list of product's specification; dimensions, exterior, and details.


meta array of objects

It includes some details of the backend’s fetch data and path.


meta: current_page number

The page number of the current search result.


meta: first_page_url string

The url of the backend API for the product’s first page result.


meta: from number

The starting number of the product's page search.


meta: last_page number

The last number of the product’s page search.


meta: last_page_url string

The url of the backend API for the product’s last page result.


meta: next_page_url null

It is optional to use.


meta: path string

The url of the backend API for the whole product details.


meta: per_page number

Maximum number of page availability to be shown.


meta: prev_page_url null

It is optional to input this.


meta: to number

meta: total number

meta: errors null

It is optional to include this.

GET /api/v2/product
curl --location 'https://appliance-api.com/api/public/product?sku=JES1750FS&brand_id=20&category=Cooking&subcategory=Ranges&detail_category=Slide-In&page=1&paginate=10' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id'
{
"code": "200",
"message": "Success",
"data": [
{
"id": 16,
"sku": "JES1750FS",
"color": "Stainless Steel",
"name": "Euro-Style 30\" Electric Downdraft Range",
"content": "JennAir 30\" Downdraft Electric Range with True Convection and Glide Rack",
"brand_id": 20,
"brand_name": "JennAir",
"category": "Cooking",
"subcategory": "Ranges",
"detail_category": "Slide-In",
"product_images": [
{
"id": 9691157,
"image": "https://kitchenaid-h.assetsadobe.com/is/image/content/dam/global/jennair/cooking/range/images/hero-JES1750FS.tif?wid=900&hei=900",
"role": null
}
],
"product_documents": [
{
"id": 10691435,
"pdf": "https://www.jennair.com/content/dam/global/documents/201606/owners-manual-W10896663-RevA.pdf",
"role": "Owner's Manual"
},
{
"id": 10691436,
"pdf": "https://www.jennair.com/content/dam/global/documents/201809/installation-instruction-w11259377-revA.pdf",
"role": "Installation Instructions"
},
{
"id": 10691437,
"pdf": "https://www.jennair.com/content/dam/global/documents/201705/WarrantyPage-W10896663-W.pdf",
"role": "Warranty"
},
{
"id": 10691438,
"pdf": "https://www.jennair.com/content/dam/global/documents/201906/dimension-guide-jes1750f-dg.pdf",
"role": "Dimension Guide"
},
{
"id": 10691439,
"pdf": "https://whirlpool.com/content/dam/global/documents/201911/specification-sheet-wy190178.pdf",
"role": "Spec"
},
{
"id": 10691440,
"pdf": "https://access.whirlpool.com/mr/getMediaType.do?mediaType=Dimension Guide&sku=JES1750FS&language=EN",
"role": "Energy Guide"
}
],
"product_feature": [
{
"value": "Aqualift® Self-Cleaning Technology"
},
{
"value": "Downdraft Ventilation"
},
{
"value": "Aqualift® Self-Cleaning Technology"
},
{
"value": "Dual Zone Element"
},
{
"value": "True Convection"
},
{
"value": "Telescoping Glide Rack"
},
{
"value": "True Convection"
},
{
"value": "Dual Zone Element"
},
{
"value": "Downdraft Ventilation"
},
{
"value": "Telescoping Glide Rack"
}
],
"product_spec": {
"Dimensions": {
"Depth Closed Including Handles(IN,inches)": [
"28 7/8"
],
"Width": [
"29-7/8 in"
],
"Net Weight(LB,pounds)": [
"220"
],
"Net Weight": [
"220 lbs"
],
"Gross Weight(LB,pounds)": [
"234"
],
"Height(IN,inches)": [
"36"
],
"Capacity": [
"6-2/5"
],
"Width(IN,inches)": [
"29 7/8"
],
"Depth Closed Including Handles (in)": [
"28-7/8"
],
"Capacity(FT3,cubic feet)": [
"6.40"
],
"Height (in)": [
"36.0"
],
"Height": [
"36.0 in"
],
"Width (in)": [
"29-7/8"
]
},
"Exterior": {
"Drawer Type": [
"Access Panel"
],
"Handle Color": [
"Stainless Steel"
],
"Door Type": [
"Glass Window"
],
"Handle Type": [
"Towel Bar"
],
"Handle Material": [
"Metal"
],
"Oven Window Size": [
"Extra Large"
]
},
"Details": {
"Convection Element Type": [
"Fan",
"Fan"
],
"Oven Control Type": [
"Electronic Touch"
],
"Broiler Element Power": [
"4000W"
],
"Number of Oven Racks": [
"3"
],
"Convection Element Power (watts)": [
"3200"
],
"Broiler Location": [
"Top of Oven"
],
"Oven Control Location": [
"Front"
],
"Interior Color": [
"Grey"
],
"Hidden Bake Element": [
"Yes"
],
"Number of Rack Guides": [
"7"
],
"Number of Oven Lights": [
"2"
],
"Oven Cleaning Type": [
"AquaLift® Self Clean"
],
"Cooktop Surface Material": [
"Ceramic Glass"
],
"Bake Element Power": [
"3600W"
],
"Oven Cooking System": [
"Convection"
],
"Convection Functions": [
"Bake,Broil,Roast"
],
"Oven Light Type": [
"Incandescent"
]
},
"Cooktop Details": {
"Left Front Element-Burner Power": [
"3000W"
],
"Left Rear Element-Burner Size": [
"6in.",
"6\"\""
],
"Left Rear Element-Burner Type": [
"Radiant Hyper"
],
"Right Front Element-Burner Size": [
"10in.",
"10\"\""
],
"Right Rear Element-Burner Size": [
"6in.",
"6\"\""
],
"Right Rear Element-Burner Power": [
"1200W"
],
"Left Front Element-Burner Size": [
"12in./6in.",
"12\"\"/6\"\""
],
"Cooktop Control Location": [
"Top Center",
"Top - Center"
],
"Cooktop Control Knob Color": [
"Silver/Chrome"
],
"Right Front Element-Burner Power": [
"3200W"
],
"Left Rear Element-Burner Power": [
"1300W"
],
"Left Front Element-Burner Type": [
"Dual"
],
"Cooktop Surface Color": [
"Black"
],
"Right Rear Element-Burner Type": [
"Radiant"
],
"Right Front Element-Burner Type": [
"Radiant Hyper"
],
"Cooktop Control Type": [
"Knobs"
],
"Cooktop Control Knob Type": [
"Metal"
],
"Cooktop Element Style": [
"Radiant"
],
"Hot Surface Indicator Light": [
"Yes"
],
"Number of Cooking Element-Burners": [
"4"
]
},
"Dimension": {
"Net Weight": [
"220.0"
],
"Depth Closed Including Handles": [
"28 7/8"
],
"Width": [
"29 7/8"
],
"Height": [
"36"
],
"Capacity (Cu Ft)": [
"6.40"
],
"Carton Depth": [
"30 1/2"
],
"Gross Weight": [
"234"
],
"Carton Width": [
"31 1/2"
],
"Carton Height": [
"43 1/2"
]
},
"Electrical": {
"Amps": [
"40"
],
"Power Cord Included": [
"No"
],
"Volts": [
"240"
]
},
"Appearance": {
"Handle Material": [
"Metal"
]
},
"Specifications": {
"Home Delivery": [
"Yes"
],
"Accessory Relationships": [
"Yes"
],
"Will Call": [
"Yes"
]
},
"EndecaProps": {
"ProductOutletCategories": [
"Cooking"
]
},
"Certifications": {
"Prop 65": [
"Yes"
],
"Energy Rating (kWh/year)": [
"639"
],
"ADA Compliant": [
"ADA Height and Operation Compliant"
]
},
"Design Type": {
"Design Expression": [
"Euro-Style"
]
},
"Configuration and Overview": {
"Size (in)": [
"30"
],
"Range Type": [
"Downdraft"
],
"Fuel Type": [
"Electric Radiant"
],
"Size": [
"30 in"
]
},
"Oven Details": {
"Drawer Type": [
"Access Panel"
],
"Oven Control Type": [
"Electronic Touch"
],
"Convection Functions": [
"Bake, Broil, Roast"
],
"Hidden Bake Element": [
"Yes"
],
"Broiler Location": [
"Top of Oven"
],
"Oven Control Location": [
"Front"
],
"Interior Color": [
"Grey"
],
"Oven Cooking System": [
"Convection"
],
"Power On Indicator Light": [
"Yes"
]
},
"Description": {
"Range Type": [
"Downdraft"
],
"Fuel Type": [
"Electric Radiant"
],
"Size (in.)": [
"30"
]
},
"Features": {
"Power On Indicator Light": [
"Yes"
],
"Power Outage Compatible": [
"No"
],
"Hot Surface Indicator Light": [
"Yes"
]
},
"Controls": {
"Electronic Display Type": [
"Digital"
],
"Display Color": [
"Red/ White"
],
"Knob Type": [
"Metal"
]
},
"Configuration": {
"Oven Configuration": [
"Single Oven"
],
"Range Configuration": [
"Slide-In"
]
},
"Refinement": {
"Style": [
"Ranges"
]
}
},
"status": "Active"
}
],
"meta": {
"current_page": 1,
"first_page_url": "example.com/api/api/public",
"from": 1,
"last_page": 1,
"last_page_url": "example.com/api/api/public",
"next_page_url": null,
"path": "example.com/api/api/public",
"per_page": "10",
"prev_page_url": null,
"to": 1,
"total": 1
},
"errors": null
}