Product Models

ProductDTO

Represents a product in the catalog with its available sizes. Products are identified by a unique ID and belong to a specific brand.

Fields

string

required

Unique identifier for the product

brandId

string

required

Identifier of the brand this product belongs to

sizes

string[]

required

List of available sizes for this product (e.g., [“S”, “M”, “L”, “XL”])

Example

{
  "id": "PROD-001",
  "brandId": "BRAND-A",
  "sizes": ["S", "M", "L", "XL"]
}

ProductItemDTO

Represents a specific product item with a particular size and quantity. Used in stock inventories, demand lists, and stock assignments.

Fields

UUID

required

Unique identifier for the product item

productId

string

required

Reference to the parent product ID

size

string

required

Specific size of this product item (e.g., “M”, “L”)

quantity

integer

required

Quantity of units available or demanded

Example

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "productId": "PROD-001",
  "size": "M",
  "quantity": 150
}

Usage Context

ProductItem objects are used in:

Warehouse stock inventories - tracking available units
Store demand lists - representing requested quantities
Stock assignments - linking specific product items to fulfillment operations

GET /api/products - Returns list of ProductDTO objects
POST /api/products - Create new product with sizes
GET /api/warehouses/ - Returns warehouse with stock ProductItems
GET /api/stores/ - Returns store with demand ProductItems

Overview

Endpoints

Models

ProductDTO

Fields

Example

ProductItemDTO

Fields

Example

Usage Context

Build docs developers (and LLMs) love

Overview

Endpoints

Models

​ProductDTO

​Fields

​Example

​ProductItemDTO

​Fields

​Example

​Usage Context

​Related Endpoints

Build docs developers (and LLMs) love

ProductDTO

Fields

Example

ProductItemDTO

Fields

Example

Usage Context

Related Endpoints