The BOM Item object

Attributes

id string

Unique identifier for the object.

idx integer

bom_id string required

item_code string required

item_name string

operation string

bom_no string

source_warehouse string

description string

image string

image_view string

qty number required

uom string required

stock_qty number

stock_uom string

conversion_factor number

rate number required

base_rate number

amount number

base_amount number

qty_consumed_per_unit number

allow_alternative_item boolean

Default: false

include_item_in_manufacturing boolean

Default: false

original_item string

has_variants boolean

Default: false

sourced_by_supplier boolean

Default: false

do_not_explode boolean

Default: false

is_stock_item boolean

Default: false

operation_row_id integer

is_sub_assembly_item boolean

Default: false

is_phantom_item boolean

Default: false

The BOM Item object

{
  "id": "b-o-m-item_abc123",
  "idx": 1,
  "bom_id": "bom_id_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "operation": "operation_example",
  "bom_no": "bom_no_example",
  "source_warehouse": "source_warehouse_example",
  "description": "description_example",
  "image": "image_example",
  "image_view": "image_view_example",
  "qty": 0,
  "uom": "uom_example",
  "stock_qty": 0,
  "stock_uom": "stock_uom_example",
  "conversion_factor": 0,
  "rate": 0,
  "base_rate": 0,
  "amount": 0,
  "base_amount": 0,
  "qty_consumed_per_unit": 0,
  "allow_alternative_item": false,
  "include_item_in_manufacturing": false,
  "original_item": "original_item_example",
  "has_variants": false,
  "sourced_by_supplier": false,
  "do_not_explode": false,
  "is_stock_item": false,
  "operation_row_id": 0,
  "is_sub_assembly_item": false,
  "is_phantom_item": false
}

GET /api/manufacturing/b-o-m-item?parent_id={id}

List bom items by parent

Returns all bom 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 item objects belonging to the parent.

GET /api/manufacturing/b-o-m-item?parent_id={id}

curl https://api.overplane.dev/api/manufacturing/b-o-m-item?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "data": [
    {
      "id": "b-o-m-item_abc123",
      "idx": 1,
      "bom_id": "bom_id_example",
      "item_code": "item_code_example",
      "item_name": "item_name_example",
      "operation": "operation_example",
      "bom_no": "bom_no_example",
      "source_warehouse": "source_warehouse_example",
      "description": "description_example",
      "image": "image_example",
      "image_view": "image_view_example",
      "qty": 0,
      "uom": "uom_example",
      "stock_qty": 0,
      "stock_uom": "stock_uom_example",
      "conversion_factor": 0,
      "rate": 0,
      "base_rate": 0,
      "amount": 0,
      "base_amount": 0,
      "qty_consumed_per_unit": 0,
      "allow_alternative_item": false,
      "include_item_in_manufacturing": false,
      "original_item": "original_item_example",
      "has_variants": false,
      "sourced_by_supplier": false,
      "do_not_explode": false,
      "is_stock_item": false,
      "operation_row_id": 0,
      "is_sub_assembly_item": false,
      "is_phantom_item": false
    }
  ],
  "has_more": false,
  "total": 1
}

POST /api/manufacturing/b-o-m-item

Create a bom item

Creates a new bom item object.

Body parameters

idx integer

bom_id string required

item_code string required

item_name string

operation string

bom_no string

source_warehouse string

description string

image string

image_view string

qty number required

uom string required

stock_qty number

stock_uom string

conversion_factor number

rate number required

base_rate number

amount number

base_amount number

qty_consumed_per_unit number

allow_alternative_item boolean

Default: false

include_item_in_manufacturing boolean

Default: false

original_item string

has_variants boolean

Default: false

sourced_by_supplier boolean

Default: false

do_not_explode boolean

Default: false

is_stock_item boolean

Default: false

operation_row_id integer

is_sub_assembly_item boolean

Default: false

is_phantom_item boolean

Default: false

Returns

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

POST /api/manufacturing/b-o-m-item

curl https://api.overplane.dev/api/manufacturing/b-o-m-item \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"bom_id":"bom_id_example","item_code":"item_code_example","qty":0,"uom":"uom_example","rate":0}'

Response

{
  "id": "b-o-m-item_abc123",
  "idx": 1,
  "bom_id": "bom_id_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "operation": "operation_example",
  "bom_no": "bom_no_example",
  "source_warehouse": "source_warehouse_example",
  "description": "description_example",
  "image": "image_example",
  "image_view": "image_view_example",
  "qty": 0,
  "uom": "uom_example",
  "stock_qty": 0,
  "stock_uom": "stock_uom_example",
  "conversion_factor": 0,
  "rate": 0,
  "base_rate": 0,
  "amount": 0,
  "base_amount": 0,
  "qty_consumed_per_unit": 0,
  "allow_alternative_item": false,
  "include_item_in_manufacturing": false,
  "original_item": "original_item_example",
  "has_variants": false,
  "sourced_by_supplier": false,
  "do_not_explode": false,
  "is_stock_item": false,
  "operation_row_id": 0,
  "is_sub_assembly_item": false,
  "is_phantom_item": false
}

PATCH /api/manufacturing/b-o-m-item/{id}

Update a bom item

Updates the specified bom 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 item to update.

Body parameters

idx integer

bom_id string

item_code string

item_name string

operation string

bom_no string

source_warehouse string

description string

image string

image_view string

qty number

uom string

stock_qty number

stock_uom string

conversion_factor number

rate number

base_rate number

amount number

base_amount number

qty_consumed_per_unit number

allow_alternative_item boolean

Default: false

include_item_in_manufacturing boolean

Default: false

original_item string

has_variants boolean

Default: false

sourced_by_supplier boolean

Default: false

do_not_explode boolean

Default: false

is_stock_item boolean

Default: false

operation_row_id integer

is_sub_assembly_item boolean

Default: false

is_phantom_item boolean

Default: false

Returns

Returns the updated bom item object.

PATCH /api/manufacturing/b-o-m-item/{id}

curl https://api.overplane.dev/api/manufacturing/b-o-m-item/b-o-m-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-item_abc123",
  "idx": 1,
  "bom_id": "bom_id_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "operation": "operation_example",
  "bom_no": "bom_no_example",
  "source_warehouse": "source_warehouse_example",
  "description": "description_example",
  "image": "image_example",
  "image_view": "image_view_example",
  "qty": 0,
  "uom": "uom_example",
  "stock_qty": 0,
  "stock_uom": "stock_uom_example",
  "conversion_factor": 0,
  "rate": 0,
  "base_rate": 0,
  "amount": 0,
  "base_amount": 0,
  "qty_consumed_per_unit": 0,
  "allow_alternative_item": false,
  "include_item_in_manufacturing": false,
  "original_item": "original_item_example",
  "has_variants": false,
  "sourced_by_supplier": false,
  "do_not_explode": false,
  "is_stock_item": false,
  "operation_row_id": 0,
  "is_sub_assembly_item": false,
  "is_phantom_item": false
}

DELETE /api/manufacturing/b-o-m-item/{id}

Delete a bom item

Permanently deletes a bom item. This cannot be undone.

Path parameters

id string required

The identifier of the bom item to delete.

Returns

Returns a confirmation that the bom item has been deleted.

DELETE /api/manufacturing/b-o-m-item/{id}

curl https://api.overplane.dev/api/manufacturing/b-o-m-item/b-o-m-item_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE

Response

{
  "id": "b-o-m-item_abc123",
  "deleted": true
}

POST /api/manufacturing/b-o-m-item/reorder

Reorder bom items

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

Returns

Returns the reordered list.

POST /api/manufacturing/b-o-m-item/reorder

curl https://api.overplane.dev/api/manufacturing/b-o-m-item/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST

Response

{
  "id": "b-o-m-item_abc123",
  "idx": 1,
  "bom_id": "bom_id_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "operation": "operation_example",
  "bom_no": "bom_no_example",
  "source_warehouse": "source_warehouse_example",
  "description": "description_example",
  "image": "image_example",
  "image_view": "image_view_example",
  "qty": 0,
  "uom": "uom_example",
  "stock_qty": 0,
  "stock_uom": "stock_uom_example",
  "conversion_factor": 0,
  "rate": 0,
  "base_rate": 0,
  "amount": 0,
  "base_amount": 0,
  "qty_consumed_per_unit": 0,
  "allow_alternative_item": false,
  "include_item_in_manufacturing": false,
  "original_item": "original_item_example",
  "has_variants": false,
  "sourced_by_supplier": false,
  "do_not_explode": false,
  "is_stock_item": false,
  "operation_row_id": 0,
  "is_sub_assembly_item": false,
  "is_phantom_item": false
}

The BOM Item object

Attributes

List bom items by parent

Query parameters

Returns

Create a bom item

Body parameters

Returns

Update a bom item

Path parameters

Body parameters

Returns

Delete a bom item

Path parameters

Returns

Reorder bom items

Returns

Coming Soon