> ## Documentation Index > Fetch the complete documentation index at: https://docs.joinluminous.com/llms.txt > Use this file to discover all available pages before exploring further. # Stock snapshot (JSON, CSV, or Excel) > Point-in-time stock snapshot with optional product filters. Product filters use the shared bracket-operator syntax, for example `sku[in]=SKU-1,SKU-2`, `id[in]=1,2`, `name[contains]=shirt`, or `sku_prefix=STYLE-RED-`. These let integrations pull a targeted snapshot without paginating an entire warehouse. JSON responses are paginated with `page` and `per_page`. When `export=csv` or `export=excel` is supplied, pagination is ignored and the filtered result set is streamed back as a file download. Returns **202 Accepted** with `Retry-After` when snapshot data is still being prepared. ## OpenAPI ````yaml /api-reference/build.yaml get /stock-snapshot openapi: 3.0.0 info: title: Luminous API version: 1.0.0 description: API documentation for Luminous servers: - url: https://{companyName}.api.joinluminous.com/external/api/v1 variables: companyName: default: companyName description: Your company-specific subdomain security: [] tags: - name: Products description: Get and manage products - name: Pricing description: Manage price schedules, levels, and customizations - name: BOMs description: Manage Bills of Materials (BOMs) - name: Labels description: Label rendering via Labelary ZPL service - name: Companies description: Manage business accounts and their associated data - name: Contacts description: Manage contact information for individuals - name: Suppliers description: Manage suppliers (factories) — vendors used on purchase orders - name: Supplier SKUs description: Manage per-supplier SKU and unit-cost overrides for products - name: Locations description: Manage warehouses and locations - name: Inventory description: Get and adjust product stock levels - name: Lots description: Create, update, and delete product lots (batches) - name: Transfer Orders description: Manage transfer orders - name: Fulfillment Orders description: Manage fulfillment orders and picklists - name: Purchase Orders description: Get and modify purchase orders - name: Receiving Reports description: Manage receiving reports - name: Payment Obligations description: Manage payment obligations for purchase orders - name: Sales Orders description: Manage sales orders and sales order shipments - name: Purgatory description: >- Inspect and resolve non-posted sales orders in the purgatory staging workflow - name: PickFlow Shipping description: >- Provider-agnostic shipping rates, services, packages, and label purchase for PickFlow - name: Cycle Counts description: >- Create, drive, and post PickFlow cycle counts — batches, per-warehouse sessions, and CSV import/export - name: Print Stations description: List paired print stations and enqueue print jobs to them - name: Invoices description: Get and manage invoices - name: Work Orders description: >- Manage work orders — production lifecycle, steps, materials, links, shipments, and comments - name: Production Batches description: Group and manage work orders as production batches - name: Bills description: >- Accounts payable bill management, payments, attachments, allocations, and variance - name: Prepayments description: Manage vendor prepayments and applications - name: Vendor Credits description: Manage vendor credits and applications - name: Vendor Returns description: Manage vendor returns and credit generation - name: Customer Returns description: Manage customer returns (sales returns), receiving, and restock behavior - name: Stock Snapshot description: Point-in-time stock snapshots with export support - name: Consumption description: Consumption reports and exports - name: Inventory Aging description: Cost-layer-based inventory aging reports - name: Bills Reports description: Accounts payable bills aging reports - name: Forecast description: Materialized forecast data - name: Reports description: Close the books, inventory discrepancy, transaction COGS, and EDI reports - name: Tags description: Add/remove tags across various resources - name: Custom Fields description: Get and set custom fields across various resources - name: Currency description: Currency configuration, exchange rates, and conversion - name: Integration Mappings description: Manage integration mappings for external systems - name: Integration Field Mappings description: Manage field-level mappings between Luminous and external systems paths: /stock-snapshot: get: tags: - Stock Snapshot summary: Stock snapshot (JSON, CSV, or Excel) description: > Point-in-time stock snapshot with optional product filters. Product filters use the shared bracket-operator syntax, for example `sku[in]=SKU-1,SKU-2`, `id[in]=1,2`, `name[contains]=shirt`, or `sku_prefix=STYLE-RED-`. These let integrations pull a targeted snapshot without paginating an entire warehouse. JSON responses are paginated with `page` and `per_page`. When `export=csv` or `export=excel` is supplied, pagination is ignored and the filtered result set is streamed back as a file download. Returns **202 Accepted** with `Retry-After` when snapshot data is still being prepared. operationId: getStockSnapshot parameters: - in: query name: start_date required: true schema: type: string example: '2025-01-01 00:00:00' description: Start date in Y-m-d H:i:s format - in: query name: end_date required: true schema: type: string example: '2025-01-31 23:59:59' description: End date in Y-m-d H:i:s format, must be >= start_date - in: query name: warehouse_id schema: type: integer description: > Optional warehouse scope. Products with no stock in that warehouse are excluded. - in: query name: sku schema: type: string description: > Filter by product SKU. Supports bracket operators such as `sku[eq]=ABC` and comma-separated `sku[in]=ABC,DEF`. - in: query name: sku_prefix schema: type: string description: > Internal SKU starts-with filter, for example `sku_prefix=STYLE-RED-`. Useful for pulling a style/size family without substring matches. - in: query name: id schema: type: integer description: > Filter by product ID. Supports bracket operators such as `id[in]=1,2,3`. - in: query name: name schema: type: string description: > Filter by product name. Supports bracket operators such as `name[contains]=shirt`. - in: query name: category.id schema: type: integer description: Filter by product category ID. - in: query name: sub_category.id schema: type: integer description: Filter by product subcategory ID. - in: query name: per_page schema: type: integer default: 10 maximum: 100 description: Number of items per page (max 100) - in: query name: page schema: type: integer default: 1 minimum: 1 description: Page number for pagination - in: query name: dateBasis schema: type: string enum: - order_date - received_date default: order_date description: > Which date the received quantities and values are bucketed by: the purchase order's `order_date` (default) or the receiving report's `received_date`. - in: query name: export schema: type: string enum: - excel - csv description: When set to excel or csv, returns a file download instead of JSON. - in: query name: columns schema: type: string description: JSON string of export column configuration (when exporting). responses: '200': description: > Paginated snapshot rows (JSON), or a CSV / Excel file download when `export=csv` or `export=excel` is supplied. content: application/json: schema: type: object properties: data: type: array items: type: object additionalProperties: true meta: type: object properties: current_page: type: integer description: The current page number example: 1 from: type: integer description: The starting index of the paginated results example: 1 last_page: type: integer description: The last page number example: 5 per_page: type: integer description: Number of items per page example: 10 to: type: integer description: The ending index of the paginated results example: 10 total: type: integer description: Total number of items across all pages example: 50 text/csv: schema: type: string format: binary application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: schema: type: string format: binary '202': description: >- Snapshot build in progress; retry after the specified number of seconds. headers: Retry-After: schema: type: integer content: application/json: schema: type: object properties: status: type: string example: processing message: type: string retry_after: type: integer description: Suggested delay in seconds before retrying '400': description: Validation or business rule error content: application/json: schema: type: object properties: message: type: string '401': description: Unauthorized content: application/json: schema: type: object properties: message: type: string security: - BearerAuth: [] components: securitySchemes: BearerAuth: type: http scheme: bearer description: >- Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token. ````