README

🚧 UNDER DEVELOPMENT 🚧

Simple & reliable inventory management package for Laravel

Installation

You can install the package via composer:

composer require visanduma/laravel-inventory

You can publish and run the migrations with:

php artisan vendor:publish --tag="inventory-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="inventory-config"

This is the contents of the published config file:

return [
	 'table_name_prefix' => 'la'
];

Usage

Stock Management

Reducing Stock

You can reduce stock in several ways:

Using the Stock model directly:

// Get a stock instance
$stock = $productVariant->stock();

// Reduce stock by 10 units
$stock->reduce(10, 'Order #123');

Using the ProductVariant model:

// Reduce stock by 5 units from the default batch
$productVariant->reduce(5, 'Order #123');

// Reduce stock from a specific batch
$productVariant->reduce(5, 'Order #123', 'batch-name');

Using the LaravelInventory facade:

use Visanduma\LaravelInventory\Facades\LaravelInventory;

// Reduce stock for a product variant
LaravelInventory::reduceStock($productVariant, 10, 'Order #123');

// Reduce stock from a specific batch
LaravelInventory::reduceStock($productVariant, 10, 'Order #123', 'batch-name');

Each method creates a stock movement record and updates the stock quantity.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

visanduma / laravel-inventory

Maintainers

Details