Products

Overview

Products represent goods or services that can be sold. Products can have multiple price points (per currency), variations, and belong to Product Categories. Products are referenced as line items on Deals, Quotes, Orders, and Invoices.

Model: VentureDrake\LaravelCrm\Models\Product Table: {prefix}products (default: crm_products)

Attributes

Attribute	Type	Description
`external_id`	`string`	UUID used in URLs (auto-generated)
`name`	`string`	Product name
`code`	`string`	Product code/SKU
`description`	`text`	Description
`unit`	`string`	Unit of measure
`active`	`boolean`	Whether the product is active
`tax_rate_id`	`integer`	Default tax rate
`product_category_id`	`integer`	Category
`user_owner_id`	`integer`	Owner user

Relationships

Method	Type	Related Model	Description
`productPrices()`	`hasMany`	`ProductPrice`	Prices per currency
`productVariations()`	`hasMany`	`ProductVariation`	Product variations
`productCategory()`	`belongsTo`	`ProductCategory`	Category
`taxRate()`	`belongsTo`	`TaxRate`	Default tax rate
`ownerUser()`	`belongsTo`	`User`	Owner

Helper Methods

getDefaultPrice()

Returns the default price for the configured system currency.

$price = $product->getDefaultPrice();

Scopes

active

Filters to only active products.

$products = Product::active()->get();

Creating a Product

use VentureDrake\LaravelCrm\Models\Product;

$product = Product::create([
    'name' => 'Web Design Package',
    'code' => 'WDP-001',
    'description' => 'Full website design package',
    'unit' => 'each',
    'active' => true,
    'user_owner_id' => auth()->id(),
]);

// Add a price
$product->productPrices()->create([
    'unit_price' => 5000, // in cents
    'currency' => 'USD',
]);

Deleting a Product

Deleting a product soft-deletes it. The distinction matters because a product is referenced by every quote, order, invoice, purchase order, delivery and deal line ever raised against it:

It stays readable on the documents that already reference it. The line-item relations resolve withTrashed(), so the historic line description still renders on the show views, in all 14 PDF templates and in the Xero sync.
It stays out of the product pickers. Those query Product:: directly, so a deleted product cannot be chosen on a new document.

Readable on the documents that already reference it, not choosable on new ones. Before 2.4.1 deleting a product made every document that referenced it permanently unviewable — the foreign-key column was still populated but the relation resolved to null, so reading the product's name fatalled on a quote or invoice that had been fine for months.

Searching & Filtering

Searchable by name. Filterable by user_owner_id and labels.id.

Traits

Trait	Description
`SoftDeletes`	Soft delete support
`BelongsToTeams`	Multi-tenant team scoping
`HasCrmFields`	Custom field support
`SearchFilters`	Search and filter capabilities

Reference

#Products

#Overview

#Attributes

#Relationships

#Helper Methods

#getDefaultPrice()

#Scopes

#active

#Creating a Product

#Deleting a Product

#Searching & Filtering

#Traits