Products API

The Products API handles all product-related operations including categories, brands, products, variants, orders, and payments.

Overview

The Products API provides endpoints for:

• Categories: Product category management
• Attributes: Product attribute definitions
• Brands: Brand management
• Products: Base product management
• Product Variants: Product variants with multi-language support
• Product Images: Image management for variants
• Currency: Currency management
• Basket: Shopping cart operations
• Wishlist: Wishlist management
• Orders: Order management and status updates
• Payments: Payment processing and callbacks

Base Path

/v1/products/

Authentication

Most endpoints require authentication. Public endpoints are marked accordingly.

Endpoints

Categories

• Get All Categories
• Get Category By ID
• Create Category
• Update Category
• Delete Category

Attributes

• Get Attributes By Category
• Get All Attributes
• Get Attribute By ID
• Create Attribute
• Update Attribute
• Delete Attribute

Brands

• Get All Brands
• Get Brand By ID
• Create Brand
• Update Brand
• Delete Brand

Products

• Get All Products
• Get All Variants (All Products) - Get all variants across all store products
• Get Product By ID
• Create Product
• Update Product
• Delete Product
• Get Store Dashboard - Store statistics

Product Variants

• Get All Variants
• Get Variant By ID
• Create Variant
• Update Variant
• Delete Variant

Product Images

• Get Images By Variant
• Create Images
• Update Images

Product Variants (Admin)

• Get All Variants (Admin)
• Get Variant By ID (Admin)
• Delete Variant (Admin)
• Get Images By Variant (Admin)
• Update Images (Admin)

Site Products (Public)

• Get All Site Products
• Get Site Product By ID
• Search Products By Store
• Get All Stores (Site) - Get all stores with featured products
• Filter Products - Advanced product filtering

Elasticsearch Search (Public)

• Search Products - Intelligent, multilingual, typo-tolerant search powered by Elasticsearch
• Sync Products to Elasticsearch - Manually sync all products to Elasticsearch (Admin only)

Currency

• Get All Currencies - Requires authentication
• Get All Currencies (Site) - Public endpoint
• Get Currency By ID
• Create Currency
• Update Currency
• Delete Currency

Basket

• Get Basket
• Add To Basket
• Add To Basket (Login)
• Remove From Basket
• Clear Basket

Wishlist

• Get Wishlist
• Toggle Wishlist

Orders

• Get User Orders
• Get Store Orders
• Get Admin Orders
• Update Order Status (Store)
• Update Order Status (Admin)

Payments

• Create Payment Request
• Payment Callback
• Get Admin Payments
• Get Store Payments

Audit (Admin Only)

• Get Audit Settings
• Update Audit Settings
• Get Audit Overview
• Get Payout Report
• Get Tax Report
• Get Store Analytics