Locations API Documentation

Overview

This folder contains comprehensive API documentation for warehouse location management endpoints.

Available Documentation

Location Management

• Locations API - Complete location hierarchy management
  • Location CRUD operations
  • Hierarchical tree queries
  • Operational status management
  • Physical address management
  • Move and reorganization operations

Quick Links

Common Operations

Create Root Location (Warehouse):

POST /api/locations
{
  "code": "WH-MAIN",
  "name": "Main Distribution Center",
  "locationTypeId": 1,
  "locationPurposeId": 1,
  "physicalAddress": { /* ... */ }
}

Get Location Tree:

GET /api/locations/tree?operationalOnly=true&maxDepth=4

Create Child Location:

POST /api/locations
{
  "code": "ZONE-A",
  "name": "Storage Zone A",
  "locationTypeId": 2,
  "locationPurposeId": 1,
  "parentLocationId": "warehouse-id"
}

Mark Non-Operational:

PATCH /api/locations/{id}/operational-flags
{
  "isOperational": false
}

Related APIs

• Transactions API - For transactions using locations
• Inventory API - For inventory tracked by location

Integration Guides

UI Components

Location Tree Picker:

• Use GET /api/locations/tree for hierarchical picker
• Set maxDepth for performance optimization
• Use operationalOnly=true for transaction pickers

Location Breadcrumbs:

• Use fullPath property from location DTOs
• Display as: "Warehouse / Zone A / Aisle 1"

Backend Integration

For backend developers:

1. Review Location Aggregate
2. Understand hierarchy validation (LocationHierarchyService)
3. Implement location-based queries

---

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