The Stock API provides read access to the current stock ledger (Documentation Index
Fetch the complete documentation index at: https://mintlify.com/CodexaCP/DG_BACK/llms.txt
Use this file to discover all available pages before exploring further.
CurrentStock table) for a given tenant. Two endpoints are available — a minimal projection and an enriched projection that joins item, bin, and location metadata into every row.
GET /api/stock
Returns a paginated list of raw stock records for the authenticated company. Each record includes item ID, bin ID, and stock quantity. UseGET /api/stock/enriched when you need human-readable item numbers and location codes.
Authentication: Authorization: Bearer <token> (required).
Tenant company ID. Resolved from the JWT claims if omitted.
1-based page number. Defaults to
1.Records per page. Defaults to
20.Paginated list of stock rows.
Current page number.
Requested page size.
Total number of stock records for the company.
Total number of pages.
GET /api/stock/enriched
Returns a paginated list of stock records enriched with item attributes (number, description, UOM, type, tracking flags, weight, volume) and bin/location attributes (bin code, description, type, location code, picking/putaway flags). Supports free-text search. Authentication:Authorization: Bearer <token> (required).
Tenant company ID. Resolved from JWT if omitted.
Free-text filter matched against item number, item description, bin code, and location code.
1-based page number. Defaults to
1.Records per page. Defaults to
20.Paginated enriched stock rows.
Current page.
Page size.
Total matching records.
Total pages.