API Endpoints

API Documentation Details

API Endpoints Details

GET /categories Examples

Example 1: Basic Request

GET /categories

Fetches all unique product categories and subcategories.

GET /products Examples

Example 1: Basic Request

GET /products

Fetches the first 10 products (default pagination) without any filters.

Example 2: Filter by Category & Sort by Price Ascending

GET /products?category=Home%20Appliances&sort=price_asc

Returns products in the "Home Appliances" category sorted by price in ascending order.

Example 3: Paginated Request

GET /products?page=2&limit=5

Fetches the second page of products, displaying 5 products per page.

Example 4: Select Specific Fields

GET /products?fields=id,name,price,category

Returns only the id, name, price, and category fields for each product.

Product Fields Details

Query Builder

Format:

Click any product field below to add or remove it from your query.

id

A unique identifier for the product.

name

The name of the product.

description

A detailed description of the product, including features and specifications.

brand

The manufacturer or brand of the product.

category

The category to which the product belongs.

subcategory

The subcategory of the product.

tags

Keywords or tags associated with the product.

sku

Stock Keeping Unit, a unique product code.

upc

Universal Product Code.

ean

European Article Number.

isbn

International Standard Book Number (if applicable).

price

The price of the product.

sale_price

The discounted sale price.

currency

Currency in which the price is denominated (e.g., USD).

availability

Product availability status (e.g., in_stock, out_of_stock).

stock_quantity

Number of items available in stock.

min_order_quantity

Minimum number of items per order.

max_order_quantity

Maximum number of items allowed per order.

images

Array of image objects for the product.

original

URL of the original image.

thumbnail

URL of the thumbnail image.

medium

URL of the medium-sized image.

large

URL of the large-sized image.

custom_sizes

Custom image sizes.

1280x720

URL for the 1280x720 image.

1920x1080

URL for the 1920x1080 image.

video_urls

Array of URLs for product videos.

manual_url

URL to the product's manual or documentation.

color

The color of the product.

size

Size specifications of the product.

weight

The weight of the product.

dimensions

Physical dimensions of the product.

length

The length of the product.

width

The width of the product.

height

The height of the product.

material

Material composition of the product.

warranty

Warranty information for the product.

features

Key features of the product.

shipping_weight

Weight used for shipping calculations.

shipping_dimensions

Dimensions of the package used for shipping.

length

The length of the shipping package.

width

The width of the shipping package.

height

The height of the shipping package.

ships_from

The origin location from which the product is shipped.

estimated_delivery_time

Estimated delivery time for the product.

shipping_methods

Available shipping methods.

average_rating

Average customer rating of the product.

review_count

Total number of reviews for the product.

reviews

Customer reviews for the product.

reviewer_name

Name of the reviewer.

rating

Rating given by the reviewer.

comment

Review comment.

created_at

Date the review was created.

qa

Questions and answers about the product.

question

A question about the product.

answer

Answer to the question.

answered_at

Date when the question was answered.

seller_id

Unique identifier for the seller.

seller_name

Name of the seller.

seller_rating

Rating of the seller.

fulfilled_by

Indicates who fulfills the product shipment (e.g., seller, third-party).

certifications

Certifications or quality standards the product meets.

safety_warnings

Safety warnings or precautions for the product.

age_restriction

Minimum age requirement to purchase the product (if applicable).

eco_friendly

Indicates if the product is eco-friendly.

created_at

Date when the product was created.

updated_at

Date when the product was last updated.

Sample Product JSON 

{
  "id": "1",
  "name": "Sample Microwaves 1",
  "description": "A high-quality Microwaves from Home Appliances.",
  "brand": "BrandA",
  "category": "Home Appliances",
  "subcategory": "Microwaves",
  "tags": [
    "microwaves",
    "home appliances",
    "bestseller"
  ],
  "sku": "SKU-1",
  "upc": "4152620810",
  "ean": "7106510497572",
  "isbn": "978-682-833158-7",
  "price": 382.34,
  "sale_price": 22.94,
  "currency": "USD",
  "availability": "in_stock",
  "stock_quantity": 99,
  "min_order_quantity": 1,
  "max_order_quantity": 4,
  "images": [
    {
      "original": "https://via.assets.so/img.jpg?w=800&h=600&tc=white&bg=gray",
      "thumbnail": "https://via.assets.so/img.jpg?w=150&h=150&tc=white&bg=gray",
      "medium": "https://via.assets.so/img.jpg?w=400&h=300&tc=white&bg=gray",
      "large": "https://via.assets.so/img.jpg?w=1024&h=768&tc=white&bg=gray",
      "custom_sizes": {
        "1280x720": "https://via.assets.so/img.jpg?w=1280&h=720&tc=white&bg=gray",
        "1920x1080": "https://via.assets.so/img.jpg?w=1920&h=1080&tc=white&bg=gray"
      }
    }
  ],
  "featured_image": {
    "original": "https://via.assets.so/img.jpg?w=800&h=600&tc=white&bg=gray",
    "thumbnail": "https://via.assets.so/img.jpg?w=150&h=150&tc=white&bg=gray"
  },
  "video_urls": [
    "https://example.com/videos/sample.mp4"
  ],
  "manual_url": "https://example.com/manuals/sample.pdf",
  "color": "Black",
  "size": "Large",
  "weight": 2.88,
  "dimensions": {
    "length": 7.45,
    "width": 5.59,
    "height": 17.86
  },
  "material": "Glass",
  "warranty": "3 Year",
  "features": [
    "Eco-friendly",
    "Shockproof",
    "Lightweight"
  ],
  "shipping_weight": 8.74,
  "shipping_dimensions": {
    "length": 10.36,
    "width": 21.77,
    "height": 13.68
  },
  "ships_from": "USA",
  "estimated_delivery_time": "3-5 days",
  "shipping_methods": [
    "Express",
    "Standard"
  ],
  "average_rating": 3.57,
  "review_count": 19,
  "reviews": [
    {
      "reviewer_name": "John Doe",
      "rating": 1.21,
      "comment": "Great product! Highly recommend.",
      "created_at": "2024-12-17T01:13:48.309308"
    }
  ],
  "qa": [
    {
      "question": "Is this product waterproof?",
      "answer": "Yes, it is waterproof.",
      "answered_at": "2024-10-29T01:13:48.309308"
    }
  ],
  "seller_id": "seller-1",
  "seller_name": "Seller 2",
  "seller_rating": 2.33,
  "fulfilled_by": "Third-party",
  "certifications": [
    "ISO9001",
    "Energy Star"
  ],
  "safety_warnings": [
    "Handle with care"
  ],
  "age_restriction": 13,
  "eco_friendly": false,
  "created_at": "2025-02-05T01:13:48.309308",
  "updated_at": "2025-02-05T01:13:48.309308"
}

Terminal output / API Response preview here...

Request Preview

Request Preview

/products