Stock exports and reporting
Export the warehouse stock catalog
/a/Stock_exportAll
Download a non-deleted stock catalog with warehouse quantities and metadata.
When to use this endpoint
Use for catalog/warehouse reconciliation; use the Summary report for separate customer/job/dispatch quantity columns.
Authentication and permissions
Authenticate with a signed API-key request or a logged-in CRM session. Requires Stock view (pageStocks_view) and table export (pageMain_exportTableData) permissions through the shared export guard; denial returns permission denied.
Client administrators and the all permission satisfy the checks. Legacy users with no role use the helper’s allow fallback when no explicit permission list is loaded. This is not merely the CRM1 export-button bit check.
Queries use the authenticated tenant. No department/owner restriction or stock-tracking feature gate is added by these handlers. CRM2 features2.stockTracking changes the export choices offered, not server authorization. Session CSRF and API signing still apply.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
stockIDsFilter | Comma-separated string | No | A string such as 1042,1088, not a JSON or native array. Omitted or blank/whitespace means no selection restriction. Tokens must be positive decimal IDs; whitespace is trimmed and duplicates are removed. Malformed, zero/negative or non-string lists return invalid parameter: stockIDsFilter. |
name | Strings | No | Non-empty values add lower-case contains filters on the respective stock columns. SQL LIKE wildcards remain active. |
code | Strings | No | Non-empty values add lower-case contains filters on the respective stock columns. SQL LIKE wildcards remain active. |
description | Strings | No | Non-empty values add lower-case contains filters on the respective stock columns. SQL LIKE wildcards remain active. |
archived | Integer-compatible string | No | Only omission disables this filter. When present, integer-converts and matches is_archived, including blank/0 as unarchived; this is not a deleted-record filter. |
category_id | Integer-compatible string | No | Non-zero values search the stock category_ids JSON text for a quoted integer ID. It does not use the category membership CSV used to render category names. |
stock_id | Integer-compatible string | No | Truthy value adds an exact integer-converted stock ID filter. |
location_tags | String | No | Non-empty value adds a contains expression on meta.location_tags using a safely encoded SQL literal. SQL LIKE wildcards remain active. |
search | String | No | Non-empty value searches its own text against lower-case stock name OR code. Combines with other supplied filters using AND; SQL LIKE wildcards remain active. |
triggered | Integer-compatible string | No | Non-zero enables the trigger comparison described below. Omitted/0 does not filter. |
Example request
$csv = FM_api('Stock_exportAll', ['stockIDsFilter'=>'1042']);Example response
ID,Name,Code,Description,Supplier,Cost,Price,Amount,"Trigger Level",Notes,"Location Tags",Locations,Vehicles,Users,"Nominal Code","Tax Rate",Category,"Total Cost",Status,"Price Bands",Manufacturer,EAN/Barcode,"Manufacturer Part No","Supplier Part No"
1042,"Filter cartridge",FLT-01,"Replacement cartridge","Parts supplier",1.11,1.1200,7,,,,0,0,0,,,,7.77,Active,,,,,Success is raw CSV, not JSON: retain the response body instead of JSON-decoding it. The response uses text/csv and the final download filename stock-export.csv. Column positions and blank cells are meaningful.
Errors and unusual responses
| Response | Condition |
|---|---|
{"error":"not logged in"} | No authenticated tenant context is available. Invalid signed credentials can be rejected by the dispatcher before the handler runs. |
{"error":"permission denied"} | Either required export permission is denied. |
Header-only CSV or interrupted output | Most database reads are not checked for failure. A blank export is not proof that the database contained no matching rows; malformed stored JSON can interrupt legacy reports. |
{"error":"invalid parameter: stockIDsFilter"} | A supplied selected-ID list is not a string of positive decimal IDs. |
{"error":"invalid parameter: search"} | A supplied stock/date filter is an array or other non-scalar value; the error names that parameter. |
Legacy application errors may be returned with HTTP 200. Check the decoded response for error, not only the HTTP status.
Behaviour and edge cases
- Always excludes deleted stock. Archived stock is included unless archived is supplied. triggered applies warehouse in_stock<=amt_trigger, not individual container thresholds.
- Amount is warehouse in_stock; Locations/Vehicles/Users are summed container types 3/2/1 with fractional quantities preserved. Total Cost is warehouse quantity × average cost, not total valuation including allocations.
- Supplier labels exclude deleted suppliers. Categories come from active stock_category membership CSV, not category_ids; price-band labels are looked up by saved ID without a deletion filter, with ID fallback.
- Structured JSON note arrays are flattened by content/scalar entries with ; separators. Invalid/non-array note JSON is output unchanged. Price-band pairs become name:value, with raw saved text retained when it cannot decode to a non-empty array.
- Location Tags preserves stored text and joins retained native string arrays with newline separators.
- No pagination or result limit is implemented. The entire result is exported; a header-only CSV is a valid empty result.
- No stock quantity, audit, edit timestamp, notification or event is changed. Reads across multiple queries are not a transactionally frozen snapshot.
- No direct caller for this exact endpoint was found in the current app JavaScript or
m/wwwintermediary; these are office reporting/source-selection calls, not the app download protocol. - The shared guard rejects non-scalar supplied stock/date filters and validates any supplied stockIDsFilter even on reports that do not use it for selection.
Side effects
- Streams CSV directly to the response, closes the output stream and exits.
See it in Fieldmotion
CRM1
Open Stock, choose Warehouse in Export Stock and submit; filter Network for Stock_exportAll. The form sends archive/category/name/code/search/description/trigger controls.
CRM2
Open Stocks, choose Export, select the matching report and submit. Filter Network for Stock_exportAll (the posted form uses php/api.php with extra=/Stock_exportAll). CRM2 supplies yes=really and a comma-separated stockIDsFilter for the selected export scope.
Related endpoints
Stock_exportSummaryprovides the CSV destination-type summary.Stock_getCostsprovides single-item costing defaults.Stock_getNamesresolves catalog labels.