Broadlume

Broadlume Customer API

The Customer API from Broadlume — 26 operation(s) for customer.

GitHub OpenAPI
Business capability
Customer Data Management BC-420.10

Operations 39

GET /{alias}/customers Customer List #
GET /{alias}/customer Customer info #
POST /{alias}/customer Customer info #
PATCH /{alias}/customer Customer info #
GET /{alias}/customersearchbyphone Customer Search #
GET /{alias}/customersearch Customer Search #
GET /{alias}/customerproperties Customer Properties #
GET /{alias}/customerpropertymanagers Customer Property Managers #
GET /{alias}/customerinvoices Customer Invoices #
GET /{alias}/customer5year Customer 5 Year Sales #
GET /{alias}/customerARcontacts Customer AR Contacts #
POST /{alias}/customercontact Creates Customer Contact #
PATCH /{alias}/customercontact Updates Existing Customer Contact #
GET /{alias}/customerARnotes Customer AR Contact Notes #
POST /{alias}/ customerARnotes Create Customer AR Contact Notes #
PATCH /{alias}/ customerARnotes Update Customer AR Contact Notes #
GET /{alias}/ ContactNotesbyID All Customer Contact Notes #
GET /{alias}/customersaleslist Customer Sales #
GET /{alias}/roleList Get Contact Role List #
GET /{alias}/shipto Ship To Information #
GET /{alias}/customershiptos Customer Ship To Codes #
GET /{alias}/payhist Payment History #
GET /{alias}/aropenitem AR Open Items #
GET /{alias}/shiptocodes Ship To Code List #
GET /{alias}/nationalpropertymanagers Get list of national property manager relationships #
POST /{alias}/customernotes Creates a Customer Note #
PATCH /{alias}/customernotes Edits a Customer Note #
GET /{alias}/customernotes Reads a Customer Note #
DELETE /{alias}/customernotes Erases a Customer Note #
POST /{alias}/salesnotes Creates a Sales Note #
PATCH /{alias}/salesnotes Edits a Sales Note #
GET /{alias}/salesnotes Reads a Sales Note #
DELETE /{alias}/salesnotes Erases a Sales Note #
POST /{alias}/shiptonotes Creates a Customer Note by ShipTo Code - Inactive until 2102 Release #
PATCH /{alias}/shiptonotes Updates a Customer Note by ShipTo Code - Inactive until 2102 Release #
GET /{alias}/shiptonotes Gets all Customer Note by ShipTo Code - Inactive until 2102 Release #
DELETE /{alias}/shiptonotes Erases a Customer Note by ShipTo Code - Inactive until 2102 Release #
GET /{alias}/customersearchbyemail Customer Search #
GET /{alias}/customercreditstats Get List of possible customer credit status codes #

Documentation

📖
Documentation
https://developer.broadlume.com/bms
📖
APIReference
https://developer.broadlume.com/bms
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/broadlume/refs/heads/main/authentication/broadlume-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/broadlume/refs/heads/main/openapi/broadlume-customer-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/broadlume/refs/heads/main/conventions/broadlume-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/broadlume/refs/heads/main/errors/broadlume-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/broadlume/refs/heads/main/data-model/broadlume-data-model.yml
🔗
Console
https://developer.broadlume.com/api-runner/broadlume/bms

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/broadlume-customer-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

broadlume-customer-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Broadlume BMS Customer API
  version: v1
  summary: Business management API for Broadlume BMS, the flooring ERP formerly known as RollMaster.
  description: REST API for Broadlume BMS (formerly RollMaster), Broadlume's business management system for flooring retailers.
  contact:
    name: Broadlume Developer Portal
    url: https://developer.broadlume.com/bms
servers:
- url: https://api.rmaster.com/api
  description: Production
security:
- apiKeyAuth: []
  sessionToken: []
tags:


# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/broadlume/refs/heads/main/openapi/broadlume-customer-api-openapi.yml