Skip to main content
The Products API provides comprehensive endpoints for managing furniture products in your inventory. Products represent individual items available for sale, including their details, pricing, and categorization.

Resource Structure

A product contains the following information:
id
integer
Unique identifier for the product
name
string
The name of the product
description
string
Detailed description of the product
sku
string
Stock Keeping Unit - unique identifier for inventory management
category_id
integer
ID of the category this product belongs to
price
number
Selling price of the product
cost_price
number
Cost price of the product (for margin calculation)
weight_kg
number
Weight of the product in kilograms
is_active
boolean
Whether the product is currently active and available for sale
created_at
string
Timestamp when the product was created (ISO 8601 format)
product_dimension_id
integer
ID of the associated product dimensions record
product_inventory_id
integer
ID of the associated inventory record
image_ids
array
List of image IDs associated with this product

Available Endpoints

CRUD Operations

Search Operations

Pagination

List endpoints support pagination using the following query parameters:
page
integer
default:"0"
Page number (zero-based)
pageSize
integer
default:"10"
Number of items per page

Build docs developers (and LLMs) love