The BOM Explosion Item object

Attributes

id string

Unique identifier for the object.

idx integer
bom_id string required
item_code string
item_name string
source_warehouse string
operation string
description string
image string
image_view string
stock_qty number
rate number
qty_consumed_per_unit number
stock_uom string
amount number
include_item_in_manufacturing boolean

Default: false

sourced_by_supplier boolean

Default: false

is_sub_assembly_item boolean

Default: false

The BOM Explosion Item object 
{
  "id": "b-o-m-explosion-item_abc123",
  "idx": 1,
  "bom_id": "bom_id_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "source_warehouse": "source_warehouse_example",
  "operation": "operation_example",
  "description": "description_example",
  "image": "image_example",
  "image_view": "image_view_example",
  "stock_qty": 0,
  "rate": 0,
  "qty_consumed_per_unit": 0,
  "stock_uom": "stock_uom_example",
  "amount": 0,
  "include_item_in_manufacturing": false,
  "sourced_by_supplier": false,
  "is_sub_assembly_item": false
}
GET /api/manufacturing/b-o-m-explosion-item?parent_id={id}

List bom explosion items by parent

Returns all bom explosion items belonging to the specified parent.

Query parameters

parent_id string required

The ID of the parent to list children for.

Returns

A list of bom explosion item objects belonging to the parent.

GET /api/manufacturing/b-o-m-explosion-item?parent_id={id} 
curl https://api.overplane.dev/api/manufacturing/b-o-m-explosion-item?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "b-o-m-explosion-item_abc123",
      "idx": 1,
      "bom_id": "bom_id_example",
      "item_code": "item_code_example",
      "item_name": "item_name_example",
      "source_warehouse": "source_warehouse_example",
      "operation": "operation_example",
      "description": "description_example",
      "image": "image_example",
      "image_view": "image_view_example",
      "stock_qty": 0,
      "rate": 0,
      "qty_consumed_per_unit": 0,
      "stock_uom": "stock_uom_example",
      "amount": 0,
      "include_item_in_manufacturing": false,
      "sourced_by_supplier": false,
      "is_sub_assembly_item": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/manufacturing/b-o-m-explosion-item

Create a bom explosion item

Creates a new bom explosion item object.

Body parameters

idx integer
bom_id string required
item_code string
item_name string
source_warehouse string
operation string
description string
image string
image_view string
stock_qty number
rate number
qty_consumed_per_unit number
stock_uom string
amount number
include_item_in_manufacturing boolean

Default: false

sourced_by_supplier boolean

Default: false

is_sub_assembly_item boolean

Default: false

Returns

Returns the newly created bom explosion item object if the call succeeded.

POST /api/manufacturing/b-o-m-explosion-item 
curl https://api.overplane.dev/api/manufacturing/b-o-m-explosion-item \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"bom_id":"bom_id_example"}'
Response 
{
  "id": "b-o-m-explosion-item_abc123",
  "idx": 1,
  "bom_id": "bom_id_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "source_warehouse": "source_warehouse_example",
  "operation": "operation_example",
  "description": "description_example",
  "image": "image_example",
  "image_view": "image_view_example",
  "stock_qty": 0,
  "rate": 0,
  "qty_consumed_per_unit": 0,
  "stock_uom": "stock_uom_example",
  "amount": 0,
  "include_item_in_manufacturing": false,
  "sourced_by_supplier": false,
  "is_sub_assembly_item": false
}
PATCH /api/manufacturing/b-o-m-explosion-item/{id}

Update a bom explosion item

Updates the specified bom explosion item by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the bom explosion item to update.

Body parameters

idx integer
bom_id string
item_code string
item_name string
source_warehouse string
operation string
description string
image string
image_view string
stock_qty number
rate number
qty_consumed_per_unit number
stock_uom string
amount number
include_item_in_manufacturing boolean

Default: false

sourced_by_supplier boolean

Default: false

is_sub_assembly_item boolean

Default: false

Returns

Returns the updated bom explosion item object.

PATCH /api/manufacturing/b-o-m-explosion-item/{id} 
curl https://api.overplane.dev/api/manufacturing/b-o-m-explosion-item/b-o-m-explosion-item_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"idx":1,"bom_id":"bom_id_example"}'
Response 
{
  "id": "b-o-m-explosion-item_abc123",
  "idx": 1,
  "bom_id": "bom_id_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "source_warehouse": "source_warehouse_example",
  "operation": "operation_example",
  "description": "description_example",
  "image": "image_example",
  "image_view": "image_view_example",
  "stock_qty": 0,
  "rate": 0,
  "qty_consumed_per_unit": 0,
  "stock_uom": "stock_uom_example",
  "amount": 0,
  "include_item_in_manufacturing": false,
  "sourced_by_supplier": false,
  "is_sub_assembly_item": false
}
DELETE /api/manufacturing/b-o-m-explosion-item/{id}

Delete a bom explosion item

Permanently deletes a bom explosion item. This cannot be undone.

Path parameters

id string required

The identifier of the bom explosion item to delete.

Returns

Returns a confirmation that the bom explosion item has been deleted.

DELETE /api/manufacturing/b-o-m-explosion-item/{id} 
curl https://api.overplane.dev/api/manufacturing/b-o-m-explosion-item/b-o-m-explosion-item_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "b-o-m-explosion-item_abc123",
  "deleted": true
}
POST /api/manufacturing/b-o-m-explosion-item/reorder

Reorder bom explosion items

Updates the sort order of bom explosion items within their parent by setting new index values.

Returns

Returns the reordered list.

POST /api/manufacturing/b-o-m-explosion-item/reorder 
curl https://api.overplane.dev/api/manufacturing/b-o-m-explosion-item/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "b-o-m-explosion-item_abc123",
  "idx": 1,
  "bom_id": "bom_id_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "source_warehouse": "source_warehouse_example",
  "operation": "operation_example",
  "description": "description_example",
  "image": "image_example",
  "image_view": "image_view_example",
  "stock_qty": 0,
  "rate": 0,
  "qty_consumed_per_unit": 0,
  "stock_uom": "stock_uom_example",
  "amount": 0,
  "include_item_in_manufacturing": false,
  "sourced_by_supplier": false,
  "is_sub_assembly_item": false
}