Reporting
Ship By Schedule
Returns ship-by schedule report data showing orders that need to be shipped by specific dates.
Get Inventory Planning Report
Returns a paginated inventory planning report with replenishment data per product. Supports warehouse filtering via filter[warehouse_id], filter[warehouse_id][is], or base64-encoded filter_groups tree.
Get Inventory Planning Summary
Returns summary metrics for the inventory planning report header cards (counts of items at risk, overstocked, out of stock, etc.).
Export Inventory Planning Report
Exports the inventory planning report as CSV or XLSX. Supports column selection and warehouse filtering.
Refresh Velocity Data
Dispatches a tracked background job to recompute product velocity cache and supplier lead time reliability. Returns a tracked_job_log_id for monitoring via the job tray.
Refresh Sales Financials
Dispatches a tracked background job to refresh sales financials data used by the inventory planning report. Returns a tracked_job_log_id for monitoring via the job tray.
Create Draft PO from Planning
Creates a draft purchase order from reorder suggestions in the inventory planning report.
List Scheduled Reports
Returns all scheduled reports for the authenticated user for the inventory_planning report type.
Create Scheduled Report
Creates a new scheduled inventory planning report for the authenticated user.
Delete Scheduled Report
Deletes a scheduled report. Only the owner can delete their own scheduled reports.
Get Profitability Trend
Returns trend data (revenue, cost, profit) grouped by a dimension and time interval. Used for the profitability trend chart.
Get Profitability Cost Breakdown
Returns cost breakdown data with dimension rows and financial line type columns. Used for the profitability cost breakdown table.
Get Profitability Drilldown
Returns paginated order-level drilldown for a specific dimension value, showing revenue, COGS, total cost, profit, and margin per order. Includes financial line type column values when flt_ids[] is provided.
Get Order Breakdown
Returns a full financial breakdown for a single order, including all line items, COGS, allocated costs, and financial line type values.
Get Financial Line Types
Returns all financial line types configured for the current tenant. Used to populate the drilldown column selector.
Get Inventory Valuation
Returns the inventory valuation report summary grouped by warehouse/category.
Export Inventory Valuation
Exports the inventory valuation report as a file download.
Inventory Valuation Drilldown by Category
Returns inventory valuation broken down by category.
Inventory Valuation Drilldown by Source
Returns inventory valuation broken down by source (purchase order, initial inventory, etc.).
Inventory Valuation Drilldown by Transactions
Returns inventory valuation broken down by individual inventory transactions.
Get Realtime Inventory
Returns real-time inventory levels per product per warehouse. Supports both Vue 3 format (filter[search], filter[warehouse_id]) and legacy Vue 2 format (search, warehouse_id) — both are auto-normalized.
Get Realtime Inventory Summary
Returns aggregate summary totals for the realtime inventory report.
Export Realtime Inventory
Exports real-time inventory data as a CSV file. Columns: SKU, Product Name, Warehouse, Available, Allocated, On Hold, In Transit, Total, Inbound, Projected Total.
Financials by Brand
Returns financial summary data grouped by brand.
Financials by SKU
Returns financial summary data grouped by SKU/product.
Financials by Supplier
Returns financial summary data grouped by supplier.
Financials by Sales Channel
Returns financial summary data grouped by sales channel.
Financials by Sub-Sales Channel
Returns financial summary data grouped by sub-sales channel.
Financials by Product Type
Returns financial summary data grouped by product type (standard, blemished, kit).
Get Top Selling Products
Returns the top-selling products by revenue with quantities sold, total revenue, total cost, profit, and number of orders. Supports date range filters.
Get Most Profitable Products
Returns the most profitable products sorted by profit (descending). Supports date range filters.
Get Dashboard Orders
Returns daily order revenue and cost aggregates grouped by date. Used for the dashboard orders trend chart.
Get Dashboard Products
Returns product sales data grouped by the specified field. Used for dashboard analytics.
Get Monthly COGS
Returns monthly COGS (cost of goods sold) data for a specific year.
Get Purchase Summary by Period
Returns a summary of purchases grouped by period (month or year).
Get Accounting COGS
Returns accounting COGS report data including average cost, quantities sold/returned/adjusted, and COGS totals (gross, returned, adjusted, net).
Drilldown Accounting COGS
Underlying movements behind one COGS report row — the individual `accounting_cogs` view rows (sales fulfillments, customer returns, inventory adjustments, FBA movements) that compose the clicked group/SKU aggregate. Paginated, sortable, searchable, with a `totals` block that reconciles to the report row that opened it (same 9 metrics).
Export Accounting COGS
Exports accounting COGS report as a CSV file. group_by[] determines which extra columns appear before the metric columns (Avg Cost, Qty Sold, Qty Returned, Qty Adjusted, Net Qty, Gross COGS, Returned COGS, Adjusted COGS, Net COGS).
Get Accounting Income Statement
Returns an income statement grouped by accounting nominal codes and period. Supports date filtering and period granularity.
Get GINR Report (Prepaid Inventory)
Returns the Goods In Not Received (GINR) / prepaid inventory report — purchase invoices paid but not yet received into inventory.
Get Ship By Schedule
Returns the ship-by schedule report showing which products need to ship by which dates, including quantity coverage status.
Get Sales Channel Coverage (Legacy)
Returns sales channel coverage data (legacy POST endpoint). Prefer the paginated GET endpoint for new implementations.
Get Sales Channel Coverage (Paginated)
Returns paginated sales channel coverage data per product using Spatie QueryBuilder. Shows which products are listed on which sales channels.
Export Sales Channel Coverage (async)
Dispatches an async job (ExportSalesChannelCoverageTrackedJob) that builds the full unpaginated sales channel coverage CSV in the background. Returns immediately with a tracked_job_log_id that the frontend uses to poll progress via the global job tray.
Get Release Schedule
Forward-looking release schedule for held sales orders. Returns held orders (those with a future hold_until_date — a 'do not ship before' release date, used for preorders and scheduled holds) grouped by the application-timezone date on which they become shippable.
Get Supplier Overview
Macro supplier dashboard for the resolved period: headline KPIs (purchase volume, sales volume, profit, active suppliers), the hottest/coldest movers, a 12-month growth heatmap, and the full leaderboard. KPIs and trends are read from monthly supplier metric snapshots.
Get Supplier Leaderboard
Leaderboard rows only — a lightweight endpoint for table page/sort changes on the macro supplier view, without recomputing KPIs, movers, or the heatmap. Rows are computed in-memory from snapshots, then filtered, sorted and sliced; low-volume suppliers are flagged via is_low_volume.
Rebuild Supplier Metric Snapshots
Dispatches the supplier-metric snapshot rebuild as a tracked background job and returns its tracked job log ID for progress polling via the job tray. Rejects a second dispatch with 409 while a rebuild is already queued or running.
Get Scorecard Settings
Returns the tenant-global supplier scorecard configuration: the six dimension weights (sum to 100), the ordered {min, score} threshold bands per dimension, and the minimum in-period PO count required before a supplier is scored. A default row is created on first access if none exists.
Update Scorecard Settings
Updates the tenant-global supplier scorecard configuration. The six weights must each be present and sum to exactly 100; every threshold band needs a numeric min and an integer 1-5 score.
Get Supplier Scorecard Summary
Lightweight scorecard + volume sparklines for the supplier Profile chip. Returns the composite scorecard with its dimension breakdown, a directional composite trend hint (up | down | flat), and trailing-12-month purchase/sales volume sparklines. The period is fixed to YoY.
Get Supplier Analytics
Full per-supplier analytics for the Analytics tab: headline KPIs (purchase volume, sales volume, units purchased/sold, profit, margin %), the composite scorecard, a dual-line current-vs-previous trend chart, and the hottest/coolest products ranked by growth.
Get Supplier Product Breakdown
Paginated, sortable per-product breakdown for one supplier (Analytics-tab product table). Each row carries units, purchase/sales volume, profit, margin %, sell-through %, landed unit cost, the landed-cost trend direction (cost_trend), and period-over-period growth %.
Get Supplier Product Drilldown
Single-product drill-down for one supplier: current vs previous purchase/sales totals, a landed-cost-per-receipt trend, and the list of alternate suppliers carrying the same SKU with their cost, lead time and reliability.
Get Supplier PO History
Recent purchase orders for one supplier — backs the 'Recent Purchase Orders' mini-table on the supplier Analytics tab. Returns up to the 10 most recent non-draft purchase orders ordered by purchase order date (DESC), each with its receipt status and an on-time flag.
Get Supplier Scorecard
Standalone composite scorecard for a supplier over the resolved period — the composite, its band, and the per-dimension breakdown.
Get Product Overview
Macro product dashboard for the resolved period: headline KPIs (sales volume, units sold, profit, active products), the hottest/coldest movers, a 12-month growth heatmap, and the full leaderboard. KPIs and trends are read from monthly product metric snapshots.
Get Product Leaderboard
Server-paginated, sortable product leaderboard for the resolved period — used when the macro dashboard's leaderboard table changes page or sort. Returns the standard Laravel pagination envelope.
Rebuild Product Metric Snapshots
Dispatches the product-metric snapshot rebuild as a tracked background job and returns its tracked job log ID for progress polling via the job tray. The rebuild recomputes per-channel sales snapshots first, then derives the per-product snapshots by summation. Rejects a second dispatch with 409 while a rebuild is already queued or running.
Get Scorecard Settings
Returns the tenant's product scorecard configuration: the six dimension weights (must sum to 100), the threshold bands that map a raw metric value to a 1–5 score, and min_so_count — the minimum sales-order count before a product is scored.
Update Scorecard Settings
Updates the tenant's product scorecard configuration.
Get Product Scorecard Summary
Lightweight scorecard payload for the product Profile-tab performance chip: the composite scorecard, a directional trend hint (up | flat | down) and two short volume sparklines (sales volume and units sold).
Get Product Analytics
Full per-product analytics for the Analytics tab: period KPIs (sales volume, units sold, profit, margin), the computed scorecard, a monthly trend series, the hottest/coolest sales channels, a per-channel growth heatmap and recent orders.
Get Product Channel Breakdown
Server-paginated, sortable per-sales-channel breakdown for one product — the Channels tab table. Each row carries the channel's units, sales volume, profit, order count, average order value, margin, return rate, share of the product's sales and period-over-period growth. Channel-grain data is sales-side only (purchasing is not channel-attributable).
Get Product Channel Drilldown
Single-channel drill-down for one product: the channel's current and previous-period totals, the product's whole-period totals for a share comparison, and recent orders placed on that channel.
Get Product Scorecard
Standalone computed scorecard for one product — the composite, its band and the per-dimension breakdown. Used by the Scorecard Settings live preview.
Aging Report
Aging report bucketed by current / 1-30 / 31-60 / 61-90 / over_90 days. Returns totals and deposit details per bucket.
Summary Stats
Aggregate KPI stats across all deposits (totals by status, available balance, etc.).
Supplier Statement
All deposits for a specific supplier with totals (amount, paid, applied, refunded, available).
Activity Log
Paginated activity log (Spatie Activitylog) for a vendor deposit.