boms

List BOMs

Returns a paginated list of BOMs for the authenticated business

get/boms

Query parameters

pageinteger

Page number

page_sizeinteger

Items per page

business_node_idsstring

Filter by business nodes (comma-separated UUIDs). Omit for all nodes

searchstring

Filter by BOM name (substring) or BOM id. With has_source_file, also matches the archived file's name

has_source_fileboolean

Only BOMs whose original upload was archived and can be downloaded

statusstring

Filter by status. Omit for active BOMs (excludes archived); pass 'archived' for archived BOMs

item_idstring

Only BOMs that USE this item. Puts the ones it is the finished good of first, and sets item_context on every row

Response

OK

object required

Changes

Changed in 2 of the 7 revisions of this API.3

    • added the new optional query request parameter has_source_file

      new-optional-request-parameter

    • added the new optional query request parameter item_id

      new-optional-request-parameter

    • added the non-success response with the status 400

      response-non-success-status-added