انتقل إلى المحتوى الرئيسي

Items API Documentation

Overview​

This folder contains comprehensive API documentation for all item-related endpoints in the Inventory Management System.

Available Documentation​

Core Item Management​

  • Items API - Complete item master data management
    • Item CRUD operations
    • Stockable behavior management
    • Advanced filtering and search
    • Pagination support
    • Archive and restore operations

Common Operations​

Create Stockable Item:

POST /api/items
{
  "itemNumber": "WIDGET-001",
  "name": "Premium Widget",
  "allowNegativeStock": false,
  "trackByLocation": true
}

Search Items:

GET /api/items?searchTerm=widget&isStockable=true&pageSize=50

Update Item:

PATCH /api/items/{id}
{
  "name": "Updated Widget Name",
  "allowNegativeStock": true
}

Integration Guides​

Frontend Integration​

For frontend developers implementing item management:

  1. Start with Items API
  2. Understand Composition Pattern
  3. Review Item Domain for business rules

Backend Integration​

For backend developers:

  1. Review Item Aggregate
  2. Understand repository patterns
  3. Implement event handlers if needed

Last Updated: 2025-10-24 | API Version: 1.0