How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Broadlume BMS API

REST API for Broadlume BMS, the flooring business management system formerly known as RollMaster. 256 documented operations across 28 resource groups covering orders, quotes, leads, customers, products and catalog, inventory, purchase orders, invoicing, accounts receivable, general ledger, installation scheduling, e-documents, handheld/barcode operations, dashboards and reporting. Authentication is a Broadlume-issued x-api-key header plus a per-user session token obtained from the token endpoint.

Broadlume BMS API is published by Broadlume on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ERP, Order Management, Inventory, Accounting, and Point-of-Sale. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 256 operations across 199 paths, organized into 28 resource areas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://api.rmaster.com/api.

256 operations 199 paths 0 schemas 10 DELETE186 GET25 PATCH35 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://api.rmaster.com/api
Authentication
API Key, API Key
Resource Areas
28

Authentication & Security 2

Broadlume BMS API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (apiKeyAuth). An API key is passed in the header as token (sessionToken). By default, every request must be authenticated.

  • apiKeyAuth — API key issued by Broadlume, required on every request.
  • sessionToken — User session token obtained from POST /{alias}/token. Sessions expire after a server-specified idle timeout (default 5 minutes); refresh with the keepalive end…

Paths & Operations 256

Across 199 paths, the API surfaces 256 operations — 10 DELETE, 186 GET, 25 PATCH, 35 POST. They span 28 resource areas, including Version, Authentication, Order, Customer, Company, Product, Retail Pricing, Edocs, and 20 more. Each is listed below with its method, path, parameters, and response codes.

Version 1
GET
/{alias}/version
API Version
apiVersion 1 param → 200
Authentication 6
POST
/{alias}/token
Authenticate User / Create Session
authenticateUserCreateSession 1 param body → 200
GET
/{alias}/token
Session Keepalive
sessionKeepalive 1 param → 200
DELETE
/{alias}/token
Remove Session
removeSession 1 param body → 200
GET
/{alias}/sessioncount
Session Count
sessionCount 1 param → 200
GET
/{alias}/permissions
User permissions
userPermissions 2 params → 200
POST
/{alias}/changebranch
Change Branches
changeBranches 1 param body → 200
Order 26
POST
/{alias}/order
Create Order
createOrder 1 param body → 200
PATCH
/{alias}/order
Update Order
updateOrder 23 params body → 200
GET
/{alias}/order
Get Order
getOrder 4 params → 200
PATCH
/{alias}/orderlineinstaller
Update Order Line Installer (Single Date Only)
updateOrderLineInstallerSingleDateOnly 7 params → 200
GET
/{alias}/orderline
Get Order Lines - Inactive until 2102 Release
getOrderLinesInactiveUntil2102Release 7 params → 200
POST
/{alias}/orderline
Create Order Line
createOrderLine 1 param body → 200
GET
/{alias}/salesreps
Sales Reps
salesReps 2 params → 200
GET
/{alias}/ordertype
Order Type List
orderTypeList 2 params → 200
GET
/{alias}/accumcode
Accumulator Code List
accumulatorCodeList 2 params → 200
GET
/{alias}/ordertimeslots
Order Time Slot List
orderTimeSlotList 2 params → 200
GET
/{alias}/orders
Orders by date range
ordersByDateRange 8 params → 200
GET
/{alias}/invoicedue
Aging Invoices
agingInvoices 3 params → 200
POST
/{alias}/linecomments
Create Order Line Comment
createOrderLineComment 1 param body → 200
PATCH
/{alias}/linecomments
Update Order Line Comment
updateOrderLineComment 7 params → 200
GET
/{alias}/linecomments
Get order line commments
getOrderLineCommments 5 params → 200
DELETE
/{alias}/linecomments
Delete order line commment
deleteOrderLineCommment 6 params → 200
POST
/{alias}/jobnote
Creates a Job Note
createsAJobNote 1 param body → 200
PATCH
/{alias}/jobnote
Edits a Job Note
editsAJobNote 7 params → 200
GET
/{alias}/jobnote
Reads a Job Note
readsAJobNote 5 params → 200
DELETE
/{alias}/jobnote
Erases a Job Note
erasesAJobNote 5 params → 200
GET
/{alias}/initials
List of Initials
listOfInitials 3 params → 200
GET
/{alias}/jobstats
Job Status List
jobStatusList 4 params → 200
GET
/{alias}/regiontax
Get Region Tax Codes
getRegionTaxCodes 3 params → 200
GET
/{alias}/commissiondetails
Get Sales Rep Commission Details
getSalesRepCommissionDetails 6 params → 200
GET
/{alias}/taxcode
Tax Code Details
taxCodeDetails 7 params → 200
GET
/{alias}/orderlinesub
Get ORDLSUB Records
getOrdlsubRecords 9 params → 200
Customer 39
GET
/{alias}/customers
Customer List
customerList 11 params → 200
GET
/{alias}/customer
Customer info
customerInfo 4 params → 200
POST
/{alias}/customer
Customer info
customerInfo1 1 param body → 200
PATCH
/{alias}/customer
Customer info
customerInfo2 1 param body → 200
GET
/{alias}/customersearchbyphone
Customer Search
customerSearch 5 params → 200
GET
/{alias}/customersearch
Customer Search
customerSearch1 7 params → 200
GET
/{alias}/customerproperties
Customer Properties
customerProperties 3 params → 200
GET
/{alias}/customerpropertymanagers
Customer Property Managers
customerPropertyManagers 2 params → 200
GET
/{alias}/customerinvoices
Customer Invoices
customerInvoices 7 params → 200
GET
/{alias}/customer5year
Customer 5 Year Sales
customer5YearSales 4 params → 200
GET
/{alias}/customerARcontacts
Customer AR Contacts
customerArContacts 3 params → 200
POST
/{alias}/customercontact
Creates Customer Contact
createsCustomerContact 1 param body → 200
PATCH
/{alias}/customercontact
Updates Existing Customer Contact
updatesExistingCustomerContact 12 params → 200
GET
/{alias}/customerARnotes
Customer AR Contact Notes
customerArContactNotes 3 params body → 200
POST
/{alias}/ customerARnotes
Create Customer AR Contact Notes
createCustomerArContactNotes 1 param body → 200
PATCH
/{alias}/ customerARnotes
Update Customer AR Contact Notes
updateCustomerArContactNotes 1 param body → 200
GET
/{alias}/ ContactNotesbyID
All Customer Contact Notes
allCustomerContactNotes 3 params → 200
GET
/{alias}/customersaleslist
Customer Sales
customerSales 3 params → 200
GET
/{alias}/roleList
Get Contact Role List
getContactRoleList 2 params → 200
GET
/{alias}/shipto
Ship To Information
shipToInformation 5 params → 200
GET
/{alias}/customershiptos
Customer Ship To Codes
customerShipToCodes 5 params → 200
GET
/{alias}/payhist
Payment History
paymentHistory 5 params → 200
GET
/{alias}/aropenitem
AR Open Items
arOpenItems 5 params → 200
GET
/{alias}/shiptocodes
Ship To Code List
shipToCodeList 4 params → 200
GET
/{alias}/nationalpropertymanagers
Get list of national property manager relationships
getListOfNationalPropertyManagerRelationships 2 params → 200
POST
/{alias}/customernotes
Creates a Customer Note
createsACustomerNote 1 param body → 200
PATCH
/{alias}/customernotes
Edits a Customer Note
editsACustomerNote 6 params → 200
GET
/{alias}/customernotes
Reads a Customer Note
readsACustomerNote 3 params → 200
DELETE
/{alias}/customernotes
Erases a Customer Note
erasesACustomerNote 5 params → 200
POST
/{alias}/salesnotes
Creates a Sales Note
createsASalesNote 1 param body → 200
PATCH
/{alias}/salesnotes
Edits a Sales Note
editsASalesNote 4 params → 200
GET
/{alias}/salesnotes
Reads a Sales Note
readsASalesNote 3 params → 200
DELETE
/{alias}/salesnotes
Erases a Sales Note
erasesASalesNote 3 params → 200
POST
/{alias}/shiptonotes
Creates a Customer Note by ShipTo Code - Inactive until 2102 Release
createsACustomerNoteByShiptoCodeInactiveUntil2102Release 1 param body → 200
PATCH
/{alias}/shiptonotes
Updates a Customer Note by ShipTo Code - Inactive until 2102 Release
updatesACustomerNoteByShiptoCodeInactiveUntil2102Release 6 params body → 200
GET
/{alias}/shiptonotes
Gets all Customer Note by ShipTo Code - Inactive until 2102 Release
getsAllCustomerNoteByShiptoCodeInactiveUntil2102Release 3 params body → 200
DELETE
/{alias}/shiptonotes
Erases a Customer Note by ShipTo Code - Inactive until 2102 Release
erasesACustomerNoteByShiptoCodeInactiveUntil2102Release 5 params body → 200
GET
/{alias}/customersearchbyemail
Customer Search
customerSearch2 5 params → 200
GET
/{alias}/customercreditstats
Get List of possible customer credit status codes
getListOfPossibleCustomerCreditStatusCodes 2 params → 200
Company 7
GET
/{alias}/company
Company Info
companyInfo 2 params → 200
GET
/{alias}/branch
Branch info
branchInfo 3 params → 200
GET
/{alias}/branches
Branches list
branchesList 2 params → 200
GET
/{alias}/systeminfo
System Information
systemInformation 1 param → 200
GET
/{alias}/globalsettings
Global settings
globalSettings 1 param → 200
GET
/{alias}/companysettings
Settings specific to a company
settingsSpecificToACompany 2 params → 200
GET
/{alias}/territorycodes
Territory Codes List
territoryCodesList 2 params → 200
Product 22
GET
/{alias}/producttypes
Product types
productTypes 2 params → 200
GET
/{alias}/productcodes
Product codes
productCodes 3 params → 200
GET
/{alias}/productstyles
Product styles
productStyles 4 params → 200
GET
/{alias}/productstylessearch
Product styles
productStyles1 8 params → 200
GET
/{alias}/productcolors
Product colors
productColors 5 params → 200
GET
/{alias}/productstock
Product stock
productStock 4 params → 200
GET
/{alias}/productprice
Product price
productPrice 8 params → 200
GET
/{alias}/catalogattributes
Product Attributes
productAttributes 3 params → 200
GET
/{alias}/attributelabels
Attributes Labels
attributesLabels 3 params → 200
GET
/{alias}/webproducts
Web Products
webProducts 7 params → 200
GET
/{alias}/catalogdetails
Product details
productDetails 4 params → 200
GET
/{alias}/associatedproducts
Get Associated Products
getAssociatedProducts 3 params → 200
GET
/{alias}/catalogitems
Catalog Items
catalogItems 7 params → 200
GET
/{alias}/getcatatrcollection
Get Catalog Attribute Collections
getCatalogAttributeCollections 3 params → 200
GET
/{alias}/getcatatrbrands
Get Catalog Attribute Brands
getCatalogAttributeBrands 3 params → 200
GET
/{alias}/getcatatrsalesrep
Get Catalog Attribute Sales Rep
getCatalogAttributeSalesRep 4 params → 200
GET
/{alias}/getcatatrinventory
Get Catalog Attribute Inventory Types
getCatalogAttributeInventoryTypes 4 params → 200
GET
/{alias}/getcatatrcustomer
Get Catalog Attribute Customer
getCatalogAttributeCustomer 4 params → 200
GET
/{alias}/getcatatrdate
Get Catalog Attribute Dates
getCatalogAttributeDates 4 params → 200
GET
/{alias}/getcatatrselinv
Get Selected Inventory Catalog Attribute
getSelectedInventoryCatalogAttribute 3 params → 200
GET
/{alias}/getcatatrsel2
Get Selected Catalog Attribute File 2
getSelectedCatalogAttributeFile2 3 params → 200
GET
/{alias}/getcatatrsel3
Get Selected Catalog Attribute File 3
getSelectedCatalogAttributeFile3 3 params → 200
Retail Pricing 1
GET
/{alias}/productpagedetails
Sample Pricing Data
samplePricingData 4 params → 200
Edocs 4
GET
/{alias}/edocs
Edocs List
edocsList 14 params → 200
POST
/{alias}/edoc
Edoc upload
edocUpload 1 param body → 200
GET
/{alias}/edoc
Edoc download
edocDownload 15 params → 200
GET
/{alias}/edoctypes
Get Edoc types for user
getEdocTypesForUser 3 params → 200
Install 9
GET
/{alias}/installers
Installers list
installersList 3 params → 200
GET
/{alias}/installer
Installer info
installerInfo 4 params → 200
GET
/{alias}/installerlist
Installer List
installerList 2 params → 200
GET
/{alias}/installdetail
Install List by date
installListByDate 8 params → 200
GET
/{alias}/installerinvoice
Generate Installer Invoice PDF
generateInstallerInvoicePdf 8 params → 200
GET
/{alias}/getinstallations
Installations By Date
installationsByDate 14 params → 200
POST
/{alias}/install
Create Installation Record
createInstallationRecord 1 param body → 200
GET
/{alias}/installs
Get Installation Records
getInstallationRecords 6 params → 200
GET
/{alias}/installcapacity
Installation limits and capacities
installationLimitsAndCapacities 4 params → 200
Dashboard 6
GET
/{alias}/dashboardsales
Sales Quicklist
salesQuicklist 5 params → 200
GET
/{alias}/dashboardar
AR Quicklist
arQuicklist 3 params → 200
GET
/{alias}/dashboardap
AP Quicklist
apQuicklist 2 params → 200
GET
/{alias}/dashboardinventory
Inventory Valuation Quicklist
inventoryValuationQuicklist 2 params → 200
GET
/{alias}/dashboardworkinprocess
Work in Process quicklist
workInProcessQuicklist 3 params → 200
GET
/{alias}/dashboardfiscal
Fiscal Year Quicklist
fiscalYearQuicklist 2 params → 200
Pivot 6
GET
/{alias}/accountspayablebuckets
AP Bucket Definitions
apBucketDefinitions 2 params → 200
GET
/{alias}/accountspayable
AP by Bucket
apByBucket 4 params → 200
GET
/{alias}/accountsreceivablebuckets
AR Bucket Definitions
arBucketDefinitions 2 params → 200
GET
/{alias}/accountsreceivable
AR By Bucket
arByBucket 5 params → 200
GET
/{alias}/salesvolume
Sales Volume by Date
salesVolumeByDate 4 params → 200
GET
/{alias}/inventoryvaluation
Inventory Valuation
inventoryValuation 2 params → 200
Lead 33
GET
/{alias}/leadtimeslots
Lead Time Slots
leadTimeSlots 2 params → 200
GET
/{alias}/leadsbydate
Leads list
leadsList 13 params → 200
POST
/{alias}/lead
Creates Lead
createsLead 3 params body → 200
PATCH
/{alias}/lead
Update lead
updateLead 4 params body → 200
GET
/{alias}/lead
Lead detail
leadDetail 4 params → 200
POST
/{alias}/leadnotes
Updates Lead Notes
updatesLeadNotes 1 param body → 200
POST
/{alias}/leadquicknote
Updates Lead Quick Note
updatesLeadQuickNote 1 param body → 200
POST
/{alias}/leaddispoqty
Updates Lead Disp Style/Quantity Notes
updatesLeadDispStyleQuantityNotes 1 param body → 200
POST
/{alias}/leaddispo
Updates Lead Dispo Notes
updatesLeadDispoNotes 1 param body → 200
GET
/{alias}/leadnonq
Lead Nonqualified Categories
leadNonqualifiedCategories 4 params → 200
PATCH
/{alias}/leadnonq
Updates Nonqualifiers on a Lead. Sending existing description will remove from a lead.
updatesNonqualifiersOnALeadSendingExistingDescriptionWillRemoveFromALead 3 params body → 200
GET
/{alias}/leadzone
Lead Zone Categories
leadZoneCategories 3 params → 200
GET
/{alias}/terrsub
Subterritory Categories
subterritoryCategories 3 params → 200
GET
/{alias}/leadexceptions
Lead Exception Categories
leadExceptionCategories 7 params → 200
GET
/{alias}/leadofficenotes
Lead Office Notes Categories
leadOfficeNotesCategories 5 params → 200
POST
/{alias}/leadofficenotes
Create Lead Office Notes
createLeadOfficeNotes 1 param body → 200
PATCH
/{alias}/leadofficenotes
Update Lead Office Notes
updateLeadOfficeNotes 4 params body → 200
GET
/{alias}/leadsched
Lead Scheduling Categories
leadSchedulingCategories 6 params → 200
GET
/{alias}/nonqualified
Nonqualified Categories
nonqualifiedCategories 2 params → 200
GET
/{alias}/leadmattype
Lead Mat Type Categories
leadMatTypeCategories 2 params → 200
GET
/{alias}/leadappt
Lead Appointments
leadAppointments 8 params → 200
POST
/{alias}/leadproductnotes
Create Lead Product Notes
createLeadProductNotes 1 param body → 200
PATCH
/{alias}/leadproductnotes
Updates Lead Product Notes
updatesLeadProductNotes 9 params → 200
GET
/{alias}/leadproductnotes
Gets Lead Product Notes
getsLeadProductNotes 4 params → 200
DELETE
/{alias}/leadproductnotes
Deletes Lead Product Notes
deletesLeadProductNotes 5 params → 200
GET
/{alias}/leadroom
Get Lead Room
getLeadRoom 2 params body → 200
POST
/{alias}/leadroom
Create Lead Room
createLeadRoom 1 param body → 200
PATCH
/{alias}/leadroom
Update Lead Room
updateLeadRoom 4 params body → 200
DELETE
/{alias}/leadroom
Remove Lead Room
removeLeadRoom 3 params body → 200
GET
/{alias}/roomfile
Room File
roomFile 2 params body → 200
GET
/{alias}/allavailability
Get All Availability
getAllAvailability 7 params → 200
GET
/{alias}/leadspecials
Get Lead Specials
getLeadSpecials 2 params → 200
POST
/{alias}/convertleadtoquote
Converts an existing lead into a quote
convertsAnExistingLeadIntoAQuote 1 param body → 200
Bundle 3
POST
/{alias}/bundle
Create Bundle(Job/Quote) Record
createBundleJobQuoteRecord 5 params body → 200
PATCH
/{alias}/bundle
Update Bundle(Job/Quote) Name by sequence
updateBundleJobQuoteNameBySequence 6 params body → 200
GET
/{alias}/bundle
Return Bundle(Job/Quote) Name by sequence
returnBundleJobQuoteNameBySequence 5 params body → 200
Quote 13
GET
/{alias}/quotes
Quotes by follow up date range
quotesByFollowUpDateRange 9 params → 200
POST
/{alias}/quote
Create Quote
createQuote 1 param body → 200
PATCH
/{alias}/quote
Update Quote
updateQuote 23 params → 200
GET
/{alias}/quote
Get Quote
getQuote 4 params → 200
POST
/{alias}/quoteline
Create Quote Line
createQuoteLine 1 param body → 200
GET
/{alias}/quoteline
Get quote lines
getQuoteLines 5 params → 200
PATCH
/{alias}/quoteline
Update Quote Line
updateQuoteLine 10 params → 200
DELETE
/{alias}/quoteline
Delete Quote Line
deleteQuoteLine 5 params → 200
POST
/{alias}/quotelinecomments
Create Quote Line Comment
createQuoteLineComment 1 param body → 200
PATCH
/{alias}/quotelinecomments
Update Quote Line Comment
updateQuoteLineComment 7 params → 200
GET
/{alias}/quotelinecomments
Get Quote line commments
getQuoteLineCommments 5 params → 200
GET
/{alias}/quotenote
Reads a Quote Note
readsAQuoteNote 5 params → 200
GET
/{alias}/quotelinesub
Get QRDLSUB Records
getQrdlsubRecords 9 params → 200
Inventory 7
GET
/{alias}/lowstock
Get Catalog Items below Safety Stock Limit
getCatalogItemsBelowSafetyStockLimit 4 params → 200
GET
/{alias}/received
Assigned Inventory Received
assignedInventoryReceived 4 params → 200
GET
/{alias}/inventorypointers
Get Inventory Point records
getInventoryPointRecords 6 params → 200
GET
/{alias}/inventorybyauditdate
Get Inventory File Records
getInventoryFileRecords 6 params → 200
GET
/{alias}/assignedinventory
Get Inventory Assigned on Job
getInventoryAssignedOnJob 3 params body → 200
PATCH
/{alias}/assignedinventory
Unassign Inventory on Job
unassignInventoryOnJob 6 params → 200
POST
/{alias}/assignedinventory
Assign Inventory to Job
assignInventoryToJob 1 param body → 200
Invoice 5
GET
/{alias}/invoice
Invoice Header
invoiceHeader 6 params → 200
GET
/{alias}/invoicelines
Get Invoice Lines
getInvoiceLines 4 params → 200
GET
/{alias}/salesinvoice
Invoice download
invoiceDownload 4 params → 200
GET
/{alias}/invoicecommission
Get Invoice Commission Info
getInvoiceCommissionInfo 6 params → 200
GET
/{alias}/jobcost
Get Job Cost Info
getJobCostInfo 8 params → 200
Accounts Receivable 4
GET
/{alias}/ARNotes
AR Notes by Bucket
arNotesByBucket 4 params → 200
GET
/{alias}/paytypecodes
Payment Type Codes
paymentTypeCodes 2 params body → 200
GET
/{alias}/arcustomerregister
AR Customer Register
arCustomerRegister 4 params → 200
GET
/{alias}/arcustomerregisterhistory
AR Customer Register History
arCustomerRegisterHistory 4 params → 200
Reports 3
GET
/{alias}/salesreport
Get pre-built sales report
getPreBuiltSalesReport 5 params → 200
GET
/{alias}/writtenbusiness
Get written business report
getWrittenBusinessReport 5 params → 200
GET
/{alias}/writtenbusinessdetail
Get written business report detail
getWrittenBusinessReportDetail 5 params → 200
Audit 2
GET
/{alias}/orderauditbydate
Audit create record for order
auditCreateRecordForOrder 5 params → 200
GET
/{alias}/quoteauditbydate
Audit create record for quote
auditCreateRecordForQuote 5 params → 200
General Ledger 4
GET
/{alias}/glchartofaccounts
Get GL Chart of Accounts
getGlChartOfAccounts 2 params → 200
GET
/{alias}/glreportformatlist
Get GL Report Format List
getGlReportFormatList 2 params → 200
GET
/{alias}/gldetailbyperiod
Get GL Detail By Period
getGlDetailByPeriod 3 params → 200
GET
/{alias}/glperiodtable
Get GL Detail By Period
getGlDetailByPeriod1 2 params → 200
Handheld 21
GET
/{alias}/hhgetinvpointers
Inventory from barcode scan
inventoryFromBarcodeScan 4 params → 200
GET
/{alias}/hhgetinvbylocation
Inventory by location
inventoryByLocation 3 params → 200
GET
/{alias}/hhgetpricing
View A-J pricing
viewAJPricing 5 params → 200
GET
/{alias}/getposbybarcode
Find PO's by barcode
findPoSByBarcode 7 params → 200
GET
/{alias}/getposbyvendor
Find PO's by vendor that can have additional material added
findPoSByVendorThatCanHaveAdditionalMaterialAdded 4 params → 200
POST
/{alias}/po
Create PO
createPo 1 param body → 200
POST
/{alias}/poline
Create PO Line
createPoLine 1 param body → 200
GET
/{alias}/poline
Get PO lines
getPoLines 4 params → 200
PATCH
/{alias}/poline
Update PO Line
updatePoLine 24 params → 200
GET
/{alias}/wolines
Read WO lines from barcode
readWoLinesFromBarcode 3 params → 200
GET
/{alias}/wo
Read WO header from barcode
readWoHeaderFromBarcode 3 params → 200
PATCH
/{alias}/assign
Unassign Inventory
unassignInventory 7 params → 200
POST
/{alias}/assign
Assign Inventory
assignInventory 1 param body → 200
POST
/{alias}/ship
Ships Work Order
shipsWorkOrder 1 param body → 200
GET
/{alias}/hhgetlocations
Inventory Locations from barcode scan
inventoryLocationsFromBarcodeScan 3 params → 200
GET
/{alias}/unpicked
Get unpicked inventory
getUnpickedInventory 4 params → 200
GET
/{alias}/inventorycomments
Get inventory comments
getInventoryComments 2 params → 200
GET
/{alias}/tempbarcode
Find temporary inventory barcode.
findTemporaryInventoryBarcode 3 params → 200
GET
/{alias}/barcodesettings
Get user barcode settings.
getUserBarcodeSettings 2 params → 200
GET
/{alias}/stagedrevisions
Get staged revisions list
getStagedRevisionsList 4 params → 200
GET
/{alias}/convertinvqty
Convert Inventory Quantity
convertInventoryQuantity 5 params → 200
Purchase Order 16
PATCH
/{alias}/po
Update PO
updatePo 24 params → 200
GET
/{alias}/purchaseorderlines
Read purchase order lines that are open
readPurchaseOrderLinesThatAreOpen 2 params body → 200
GET
/{alias}/purchaseorderheader
Purchase order detail
purchaseOrderDetail 4 params → 200
GET
/{alias}/purchaseorderheaders
List of purchase orders by date
listOfPurchaseOrdersByDate 7 params → 200
GET
/{alias}/shipvia
PO Shipvia
poShipvia 2 params → 200
GET
/{alias}/freightterms
PO Freight Terms
poFreightTerms 2 params → 200
GET
/{alias}/smop
PO Shipment Method of Payment
poShipmentMethodOfPayment 2 params → 200
GET
/{alias}/vendortypes
Vendor Type List
vendorTypeList 2 params → 200
GET
/{alias}/customertype
Customer Type List
customerTypeList 2 params → 200
POST
/{alias}/ponote
Creates a PO Note
createsAPoNote 1 param body → 200
PATCH
/{alias}/ponote
Edits a PO Note
editsAPoNote 7 params → 200
GET
/{alias}/ponote
Reads PO Notes
readsPoNotes 6 params → 200
POST
/{alias}/polinecomments
Create PO Line Comment
createPoLineComment 1 param body → 200
GET
/{alias}/polinecomments
Get PO line commments
getPoLineCommments 5 params → 200
GET
/{alias}/popointers
Get PO Pointers
getPoPointers 5 params → 200
GET
/{alias}/pos
Get Purchase Order File Data - SQL Format
getPurchaseOrderFileDataSqlFormat 5 params → 200
ChargeItPro 1
GET
/{alias}/cip_summary
ChargeItPro summary
chargeitproSummary 2 params → 200
Vendor 2
GET
/{alias}/vendors
Vendor Details
vendorDetails 6 params → 200
GET
/{alias}/vendorcontacts
Get Vendor Contacts
getVendorContacts 3 params → 200
Committed 1
GET
/{alias}/committed
Committed Inventory
committedInventory 2 params → 200
General 7
GET
/{alias}/searchbyphone
Get records from the customer, customer address, customer contacts, leads, and vendor records based on phone number.
getRecordsFromTheCustomerCustomerAddressCustomerContactsLeadsAndVendorRecordsBasedOnPhoneNumber 3 params → 200
GET
/{alias}/contactcreation
Get records for contacts created on or after date sent.
getRecordsForContactsCreatedOnOrAfterDateSent 3 params → 200
GET
/{alias}/webstorages
Get web storage objects per user
getWebStorageObjectsPerUser 3 params → 200
GET
/{alias}/webstorage
Get web storage objects per user
getWebStorageObjectsPerUser1 4 params → 200
POST
/{alias}/webstorage
Create webstorage object
createWebstorageObject 1 param body → 200
PATCH
/{alias}/webstorage
Update webstorage object
updateWebstorageObject 5 params → 200
DELETE
/{alias}/webstorage
Update webstorage object
updateWebstorageObject1 4 params → 200
Build Order 4
GET
/{alias}/buildorders
Get BM File
getBmFile 5 params → 200
GET
/{alias}/buildorderlines
Get Build Order Lines File
getBuildOrderLinesFile 5 params → 200
GET
/{alias}/buildorderpoint
Get Build Order Point File
getBuildOrderPointFile 5 params → 200
GET
/{alias}/orderrelatedbolines
Get Order-Related Build Order Lines
getOrderRelatedBuildOrderLines 7 params → 200
Logo 3
GET
/{alias}/installerlogo
Get Installer Logo
getInstallerLogo 4 params → 200
GET
/{alias}/getlogo
Get Logo
getLogo 4 params → 200
GET
/{alias}/logosettings
Get Logo settings bu document type
getLogoSettingsBuDocumentType 4 params → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

broadlume-bms-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of Broadlume BMS API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.