Introduction

Manage e-commerce products with dynamic catalogs, filtering, and search.

🎯 What does this module do?

The Products module (Catalog) is a standalone module that lets you create, retrieve, filter, and manage products in your online store or multimedia collections. It provides very flexible tools for creating product catalogs or multimedia galleries with powerful search, filters, and organization features.

The Catalog enables creating, uploading, editing, and filtering catalogs through an intuitive interface. Beyond e-commerce, it supports alternative applications like multimedia galleries, demonstrating its versatility as a content management tool.

Think of it as your digital warehouse - you manage your product inventory in OneEntry admin panel (Catalog > Products), and your app fetches products dynamically with powerful search, filters, and sorting.

📖 Simple Explanation

Imagine you're building an online store selling:

👟 Sneakers - with sizes, colors, prices
📱 Electronics - with specs, images, reviews
👕 Clothing - with sizes, materials, variants
📚 Books - with authors, prices, descriptions

✅ Instead of hardcoding each product, you:

Add products in OneEntry admin panel (with all details)
Fetch products dynamically using this module
Filter by category, price range, availability
Search products by name or description
Sort by price, date, popularity
Update prices/stock without redeploying

Real-world example:

❌ Without Products Module (hardcoded):
- Add new product → Change code → Deploy
- Change price → Code change → Deploy
- 1000 products = massive code file

✅ With Products Module (dynamic):
- Add new product → Update in admin → Live instantly
- Change price → Update in admin → Live instantly
- 10,000 products = simple API calls

✨ Key Concepts

What is a Product?

A product is an item you sell, containing:

Basic info - Name, description, SKU, price
Images - Product photos, gallery
Variants - Sizes, colors, options (e.g., "Red T-shirt Size M")
Inventory - Stock quantity, availability
Custom attributes - Any fields you define (brand, material, weight, etc.)
SEO - Meta title, description, keywords
Status - Active, draft, out of stock
Localization - Multi-language support

Product Structure

Products can have different structures:

Type	Description	Example
Simple Product	Single item, no variants	Book, Poster
Product with Variants	Multiple options (size, color)	T-shirt (S/M/L, Red/Blue)
Digital Product	Downloadable items	E-book, Software
Bundle	Group of products	Starter Pack, Gift Set

Product Organization

Products are organized through several key features:

Categories - Organize into sections (Categories are pages of the Catalog type created in Pages module)
Product Statuses - Create additional filtering conditions beyond existing attribute filters
Product Links - Establish connections between products based on attribute criteria
Product Filters - Quick searching using specified filter criteria
Custom attributes - Brand, Size, Color, Material, etc.

Example hierarchy:

📁 Electronics
  ├─ 📱 Smartphones
  │   ├─ iPhone 15 Pro
  │   └─ Samsung Galaxy S24
  └─ 💻 Laptops
      ├─ MacBook Pro
      └─ Dell XPS

📁 Clothing
  ├─ 👕 T-Shirts
  └─ 👖 Jeans

📋 What You Need to Know

Catalog Architecture

Important: Categories of the catalog are pages of the Catalog type created through the Pages module. You need to create catalog categories first before adding products.

Catalog features:

Products Tab - Main workspace for creating and managing catalog items
Product Filters - Quick searching using specified criteria
Product Links - Connect products based on attribute criteria (e.g., all black phones)
Product Statuses - Additional filtering conditions for organization
Catalog Upload - Bulk importing catalog data
Settings - Configuration options with numeric input fields

Ways to Get Products

Method	When to Use	Example
getProducts()	List products with filters/search	Shop catalog page
getProductsByPageId()	Products from specific category (by ID)	Category page
getProductsByPageUrl()	Products from specific category (by URL)	Category page by URL
getProductById()	Get single product by ID	Product detail page
getRelatedProductsById()	Get related/similar products	"You may also like" section
searchProduct()	Search products by query	Search functionality

When you have 1000 products, you don't load all at once:

Offset formula: offset = (pageNumber - 1) * limit

Sorting Options

Sort products by different fields:

sortKey	What It Does	Example Use
price	Sort by price	Show cheapest first
date	Sort by creation date	Show newest products
title	Sort alphabetically	A-Z product list
position	Custom order (default)	Hand-picked order from admin
id	Sort by ID	Technical sorting

Sort order:

ASC (Ascending) - Low to high (A→Z, 0→9, cheap→expensive)
DESC (Descending) - High to low (Z→A, 9→0, expensive→cheap)

Filtering Products

Use filters to narrow down results:

Condition markers:

Marker	Meaning	Example
eq	Equal (exact match)	Price = $50
neq	Not equal	Status ≠ "sold out"
in	Contains (one of)	Color in ["red", "blue"]
nin	Not contains	Category not in ["archived"]
mth	Greater than	Price > $100
lth	Less than	Price < $50
exs	Exists (has value)	Has discount
nexs	Does not exist (empty)	No discount

Product Status and Links

Product Statuses create additional filtering conditions beyond existing attribute filters for more sophisticated product organization.

Product Links allow establishing connections between products based on attribute criteria. For example, you can link all products with the same color attribute (e.g., all black phones together).

📊 Quick Reference Table - Common Methods

Method	Description	Use Case
getProducts()	Get all products with filtering/sorting	Main catalog page
getProductById()	Get single product by ID	Product detail page
getProductsByPageId()	Get products from category by page ID	Category page
getProductsByPageUrl()	Get products from category by page URL	Category page by URL
getRelatedProductsById()	Get related/similar products	"You may also like" section
searchProduct()	Search products by query	Search functionality
getProductsCount()	Get total products count	Pagination info
getProductsCountByPageId()	Get products count by category ID	Category pagination
getProductsCountByPageUrl()	Get products count by category URL	Category pagination
getProductBlockById()	Get product block by ID	Product content blocks
getProductsEmptyPage()	Get products empty page structure	Empty state handling
getProductsPriceByPageUrl()	Get product prices by page URL	Price filtering

❓ Common Questions (FAQ)

Can I filter by multiple criteria at once?

Yes! Combine multiple filters in array.

How do I handle product variants (sizes, colors)?

Product variants are stored in attributeValues.

How do I implement "Load More" button?

Use offset to load more products.

Can I show products from multiple categories?

Yes, use category in condition marker.

How do I implement "New Arrivals" section?

Sort by creation date or use parent category for manually sorting.

💡 Important Notes

Catalog Categories Setup

Important: Before adding products, you must create catalog categories through the Pages module. Categories of the catalog are pages of the Catalog type.

Workflow:

Go to Pages module in admin panel
Create pages with "Catalog" type
These pages become your product categories
Add products to these categories via Catalog > Products

Catalog Features

The Catalog module provides comprehensive tools:

Products Tab - Main workspace for creating/managing catalog items
Product Filters - Enable quick searching using specified criteria
Product Links - Connect related products based on attributes
Product Statuses - Create custom filtering conditions
Catalog Upload - Bulk import products
Settings - Configure catalog behavior

Beyond E-commerce

The Catalog isn't limited to products - it can be used for:

Multimedia Galleries - Photos, videos, artwork collections
Portfolio Items - Design work, case studies
Document Libraries - Resources, downloads
Event Catalogs - Conferences, webinars
Recipe Collections - Food, drinks, cooking

Performance Optimization

Cache frequently accessed products to reduce API calls and improve load times.

Always Filter Active Products

In production, always show only active products by filtering with statusId: 1.

Handle Missing Images

Provide fallback images for products without images to maintain consistent UI.

🎓 Best Practices

Always use pagination (limit + offset)
Filter by statusId: 1 in production
Cache product lists to reduce API calls
Handle "out of stock" gracefully
Provide fallback images
Use markers for featured products (not IDs)
Implement search with debouncing
Add loading states in UI

More information about the Catalog in the OneEntry admin panel: https://doc.oneentry.cloudhttps://doc.oneentry.cloud/docs/category/catalog

Definition of the Products module


const { Products } = defineOneEntry(
  "your-project-url", {
    "token": "your-app-token"
  }
);

This module accepts a set of user parameters called userQuery. If the parameters are not passed to the method, the default value will be applied. Some methods accept the body as a parameter for filtering. If you don't want to set up sorting, pass an empty array or don't pass anything.

Parameters:


const userQuery = {
    offset: 0,
    limit: 30,
    sortOrder: 'DESC',
    sortKey: 'id',
}

Schema

offset: number
Pagination parameter. Default 0
example: 0

limit: number
pagination parameter. Default 30
example: 30

sortKey: string
Field for sorting (default not set - sorting by position, possible values: id, title, date, price, position)
Available values: id, position, title, date, price

sortOrder: string
sorting order DESC | ASC (default DESC)
example: "DESC"

By default, you can retrieve 10 objects. This is due to the record limit in the module's permissions settings.
For pagination to work correctly, you need to configure Module permissions according to your needs in the corresponding section.

"conditionMarker" by which values are filtered (not set by default), possible values:

'in' - Contains,
'nin' - Does not contain,
'eq' - Equal,
'neq' - Not equal,
'mth' - Greater than,
'lth' - Less than,
'exs' - Exists,
'nexs' - Does not exist

OneEntry Admin Panel - Catalog - Official admin panel documentation
Pages Module - Create catalog categories (Catalog type pages)
AttributesSets Module - Custom product fields and attributes
Templates Module - Product display templates
Blocks Module - Reusable product content blocks
Orders Module - Handle product orders

Introduction

🎯 What does this module do?​

📖 Simple Explanation​

✨ Key Concepts​

What is a Product?​

Product Structure​

Product Organization​

📋 What You Need to Know​

Catalog Architecture​

Ways to Get Products​

Pagination Explained Simply​

Sorting Options​

Filtering Products​

Product Status and Links​

📊 Quick Reference Table - Common Methods​

❓ Common Questions (FAQ)​

Can I filter by multiple criteria at once?​

How do I handle product variants (sizes, colors)?​

How do I implement "Load More" button?​

Can I show products from multiple categories?​

How do I implement "New Arrivals" section?​

💡 Important Notes​

Catalog Categories Setup​

Catalog Features​

Beyond E-commerce​

Performance Optimization​

Always Filter Active Products​

Handle Missing Images​

🎓 Best Practices​

Definition of the Products module​

🔗 Related Documentation​