Product
The product API can display detailed information about products.
Users can utilize the objects to retrieve, search, filter, and display various types of products.
Additionally, special characteristics such as popular and most viewed products can also be retrieved.
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
stringIt mentions the stock keeping unit, to differentiate one product with another.
brand_id
stringIt is used to search the product based on id.
category
stringIt specifies the main category of the product.
subcategory
stringIt specifies the second category of the product.
detail_category
stringIt specifies the detail category of the product.
page
numberIt makes the search result page appear.
paginate
numberIt specifies the number of results per page.
Attributes
id
numberThe id number of the product.
sku
stringThe stock keeping unit id of each product.
color
stringThe color of the product.
name
stringThe name of the specific product.
content
stringThe id of each product which has different patterns.
brand_id
numberThe brand id of the product.
brand_name
stringThe name of the appliance brand.
category
stringThe category of the product.
subcategory
stringThe subcategory of the product.
detail_category
stringThe detail category of the product.
product_images
array of objectsThe list of product image object.
product_images: id
numberThe id of the product image.
product_images: image
stringThe url of the product image, retrieved from the brand’s website.
product_images: role
nullproduct_documents
array of objectsThe list of product image object.
product_documents: id
numberThe id of the product document.
product_documents: pdf
stringThe url of the product document, retrieved from the brand’s website.
product_documents: role
stringThe name of the document.
product_feature
array of objectsThe list of product image object.
product_feature: value
stringThe value name of the product feature.
product_spec
array of objectsThe list of product's specification; dimensions, exterior, and details.
meta
array of objectsIt includes some details of the backend’s fetch data and path.
meta: current_page
numberThe page number of the current search result.
meta: first_page_url
stringThe url of the backend API for the product’s first page result.
meta: from
numberThe starting number of the product's page search.
meta: last_page
numberThe last number of the product’s page search.
meta: last_page_url
stringThe url of the backend API for the product’s last page result.
meta: next_page_url
nullIt is optional to use.
meta: path
stringThe url of the backend API for the whole product details.
meta: per_page
numberMaximum number of page availability to be shown.
meta: prev_page_url
nullIt is optional to input this.
meta: to
numbermeta: total
numbermeta: errors
nullIt is optional to include this.
GET /api/v2/productcurl --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
}