> ## 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. # Single BOM > Get detailed information about a specific BOM by its ID ## OpenAPI ````yaml /api-reference/build.yaml get /boms/{bomId} 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: /boms/{bomId}: get: tags: - BOMs summary: Single BOM description: | Get detailed information about a specific BOM by its ID operationId: getBomById parameters: - in: path name: bomId required: true schema: type: integer description: BOM ID responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: object properties: id: type: integer description: Unique identifier for the BOM name: type: string description: BOM name items: type: array description: BOM items (components/products) items: type: object properties: id: type: integer description: Unique identifier for the BOM item bom_id: type: integer description: ID of the BOM this item belongs to product_id: type: integer description: ID of the product/component product: type: object nullable: true description: Product information (when loaded) properties: id: type: integer name: type: string sku: type: string description: type: string nullable: true quantity: type: number format: float description: Quantity required for this item base_quantity: type: number format: float description: >- Base quantity (converted to base unit of measure) note: type: string nullable: true description: Optional note for this item uom_id: type: integer nullable: true description: Unit of measure ID unit_of_measure: type: object nullable: true description: Unit of measure information (when loaded) properties: id: type: integer name: type: string order: type: integer nullable: true description: Display order for this item consumption_basis: type: string enum: - planned - actual description: >- Determines how much of this component an assembly/work order consumes. `planned` consumes the BOM-defined quantity; `actual` consumes the quantity actually reported during production. Defaults to `planned`. created_at: type: string format: date-time description: Timestamp when the item was created updated_at: type: string format: date-time description: Timestamp when the item was last updated required: - id - bom_id - product_id - quantity extra_costs: type: array description: Additional costs associated with the BOM items: type: object properties: id: type: integer description: Unique identifier for the extra cost name: type: string description: Name/description of the extra cost quantity: type: number format: float description: Quantity for this cost item unit_price: type: number format: float description: Unit price for this cost item line_total: type: number format: float description: >- Total cost (quantity × unit_price), calculated automatically on the backend. This field is read-only and should not be provided when creating or updating extra costs. created_at: type: string format: date-time description: Timestamp when the extra cost was created updated_at: type: string format: date-time description: Timestamp when the extra cost was last updated required: - id - name - quantity - unit_price - line_total created_at: type: string format: date-time description: Timestamp when the BOM was created updated_at: type: string format: date-time description: Timestamp when the BOM was last updated required: - id - name '401': description: Unauthorized content: application/json: schema: type: object properties: message: type: string '404': description: BOM not found 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. ````