Skip to main content

Product

The product API can display detailed product information. You can utilize the objects to retrieve various types of products. In addition to common or all products, special characteristics of the products can also be retrieved. By leveraging this API, developers can seamlessly integrate detailed product data into their applications, enhancing user experience with rich product insights.

Endpoints
GET
/product# Get Product

Get Product​

Displaying the product is pivotal, and it can only be accessed from the database. The data includes category details, sorting format, brand, and applied filters. Additionally, the price range can be displayed using the GET method. Users can also check product ratings and stock availability.


Parameters​

sku string

Used for searching products by SKU or the unique identifier for the product.


Example: JVW5301SJSS

brand string

Used for searching products by brand.


Example: GE

page number

Used for searching the specific page.


Example: 1

per_page (max 100) number

Used for showing the number of items to display per page, with a maximum limit of 100 items.


Example: 10

category string

Used for searching products by the category to which the product belongs.


Example: Cooking

subcategory string

Used for searching products by subcategory under the main category to which the product belongs.


Example: Vent Hoods

detail_category string

Used for searching products by a more detailed classification within the subcategory for the product.


Example: Wall & Chimney Hoods



Attributes​

id number

The unique identifier for the product.

sku string

The stock keeping unit's ID to identify the product.

upc string

The universal product code, a barcode symbol that identifies the product.

color string

The color of the product.

name string

The name of the product.

image null

The image of the product.

brand array of objects

Objects containing brand information for the product.

brand: brand_id number

The unique identifier for the product's brand.

brand: brand_name string

The name of the product's brand.

brand: brand_slug string

A slug representing the product's brand, typically used in URLs.

brand: brand_image string

The URL of the image representing the product's brand.

status string

The availability status of the product.

price array of objects

Objects containing various price information for the product.

price: map number

The minimum advertised price of the product.

price: map_last_updated string

The last updated date of the product's minimum advertised price.

price: msrp number

The manufacturer's suggested retail price of the product.

price: msrp_last_updated string

The last updated date of the product's manufacturer's suggested retail price.

price: umrp number

The unilateral minimum retail price of the product.

price: umrp_last_updated string

The last update date of the product's unilateral minimum retail price.

price: lowes_price number

The lowest price of the product.

price: lowes_last_updated string

The last update date of the product's lowest price.

price: homedepot_price number

The price of the product at Home Depot.

price: homedepot_last_updated string

The last update date of the product's price at Home Depot.

price: bestbuy_price number

The best buy price of the product.

price: bestbuy_last_updated string

The last update date of the product's best buy price.

category array of objects

Objects containing category information for the product.

category: category_id number

The unique identifier for the product's category.

category: category_name string

The name of the product's category.

category: category_slug string

A slug representing the product's category, typically used in URLs.

category: category_image string

The URL of the image representing the product's category.

subcategory array of objects

Objects containing subcategory information for the product.

subcategory: subcategory_id number

The unique identifier for the product's subcategory.

subcategory: subcategory_name string

The name of the product's subcategory.

subcategory: subcategory_slug string

A slug representing the product's subcategory, typically used in URLs.

subcategory: subcategory_image string

The URL of the image representing the product's subcategory.

detail_category array of objects

Objects containing detailed category information for the product.

detail_category: detail_category_id number

The unique identifier for the product's detailed category.

detail_category: detail_category_name string

The name of the product's detailed category.

detail_category: detail_category_slug string

A slug representing the product's detailed category, typically used in URLs.

detail_category: detail_category_image string

The URL of the image representing the product's detailed category.

product_images array of objects

An array of objects containing image information for the product.

product_images: id number

The unique identifier for each product image.

product_images: url string

The URL of each product image.

product_images: priority number

The priority or order of display for each product image.

product_documents array of objects

An array of objects containing document information for the product.

product_documents: id number

The unique identifier for each product document.

product_documents: url string

The URL of each product document.

product_documents: role string

The role or purpose of each product document (e.g., manual, specifications).

product_documents: priority number

The priority or order of display for each product document.

product_video array of objects

Objects containing video information for the product.

product_video: id number

The unique identifier for the product video.

product_video: url string

The URL of the product video.

product_video: role string

The role or purpose of the product video (e.g., promotional, instructional).

product_video: priority number

The priority or order of display for the product video.

product_feature string

The value representing a specific feature of the product.

product_spec array of objects

Objects containing detailed specifications of the product.

product_asset_360 array of objects

Objects containing 360-degree asset information for the product.

product_asset_360: url string

The URL of the 360-degree asset of the product.

product_asset_360: angle number

The angle representation of the 360-degree asset.

color_relation array of objects

Objects linking the product SKU to its color variants.

color_relation: sku string

The stock keeping unit's ID for the color variant.

color_relation: color string

The color identifier for the color variant.

type_relation array of objects

Objects linking the product SKU to its type variants.

type_relation: sku string

The stock keeping unit's ID for the type variant.

type_relation: type_name string

The name identifier for the type variant.

type_relation: type_value string

The value identifier for the type variant.

filter array of objects

Objects specifying the filter criteria for queries.

sort array of objects

Sorting based on the filter types.

filter: brand array of objects

Objects containing brand filter criteria.

filter: brand: id number

The unique identifier for a brand in the filter criteria.

filter: brand: brand_id number

The unique brand ID used in filter criteria.

filter: brand: name string

The name of the brand used in filter criteria.

filter: brand: total number

The total number of items matching the brand filter criteria.

filter: {condition} array of objects

Objects specifying a particular condition for filtering.

filter: {condition}: field string

The field to which the condition is applied.

filter: {condition}: value string

The value defining the condition.

filter: {condition}: total number

The total number of items matching the condition.

filter: {condition}: default boolean

Indicates if the condition is a default filter setting.

filter: {spec} array of objects

OBjects specifying a particular specification for filtering.

filter: {spec}: field string

The field to which the specification is applied.

filter: {spec}: value string

The value defining the specification.

GET /product
curl --location 'https://api.appliance-data.com/product' \
--header 'Authorization: Bearer Token' \