Bills of Materials (BOMs)

Bill of materials for manufacturing. Describes the components needed to produce a finished product.

Endpoints

• GET /obapi/v1/boms -- list
• GET /obapi/v1/boms/{id} -- single with lines

Parameters

page, per_page, status, product_ref, sort

Status values

Response (list)

{
    "items": [
        {
            "id": "8",
            "ref": "BOM2405-0002",
            "label": "Assembled widget v2",
            "product_ref": "WIDGET-V2",
            "quantity": "1.00",
            "status": "validated"
        }
    ],
    "pagination": { "..." }
}

Response (single)

{
    "bom": {
        "id": "8",
        "ref": "BOM2405-0002",
        "label": "Assembled widget v2",
        "bom_type": "manufacturing",
        "description": "Assembly instructions for Widget V2",
        "product_ref": "WIDGET-V2",
        "product_label": "Assembled Widget V2",
        "quantity": "1.00",
        "duration": "3600",
        "efficiency": "0.95",
        "warehouse": "Production warehouse",
        "created_at": "2024-03-10T09:00:00Z",
        "validated_at": "2024-03-15T10:00:00Z",
        "updated_at": "2024-03-15T10:00:00Z",
        "status": "validated",
        "public_note": "",
        "lines": [
            {
                "id": "20",
                "position": 1,
                "product_ref": "COMP-A1",
                "product_label": "Component A1",
                "description": "Main circuit board",
                "quantity": "1.00",
                "quantity_frozen": false,
                "disable_stock_change": false,
                "efficiency": "1.00",
                "child_bom_ref": ""
            },
            {
                "id": "21",
                "position": 2,
                "product_ref": "COMP-B2",
                "product_label": "Component B2",
                "description": "Mounting bracket",
                "quantity": "4.00",
                "quantity_frozen": false,
                "disable_stock_change": false,
                "efficiency": "0.98",
                "child_bom_ref": ""
            },
            {
                "id": "22",
                "position": 3,
                "product_ref": "ENCL-01",
                "product_label": "Enclosure standard",
                "description": "Outer casing",
                "quantity": "1.00",
                "quantity_frozen": true,
                "disable_stock_change": false,
                "efficiency": "1.00",
                "child_bom_ref": "BOM2404-0005"
            }
        ]
    }
}

BOM types