Broadlume

Broadlume Inventory API

The Inventory API from Broadlume — 5 operation(s) for inventory.

GitHub OpenAPI
Business capability
Inventory Management BC-530

Operations 7

GET /{alias}/lowstock Get Catalog Items below Safety Stock Limit #
GET /{alias}/received Assigned Inventory Received #
GET /{alias}/inventorypointers Get Inventory Point records #
GET /{alias}/inventorybyauditdate Get Inventory File Records #
GET /{alias}/assignedinventory Get Inventory Assigned on Job #
PATCH /{alias}/assignedinventory Unassign Inventory on Job #
POST /{alias}/assignedinventory Assign Inventory to Job #

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-inventory-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-inventory-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-inventory-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Broadlume BMS Inventory 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:
- name: Inventory
paths:
  /{alias}/lowstock:
    get:
      operationId: getCatalogItemsBelowSafetyStockLimit
      summary: Get Catalog Items below Safety Stock Limit
      tags:
      - Inventory
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          type: string
        description: The clientid for the API call.
      - name: company
        in: query
        required: true
        schema:
          type: string
          maxLength: 2
        description: RollMaster company.
      - name: page
        in: query
        required: false
        schema:
          type: number
          maxLength: 4
          default: '1'
        description: Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page.
      - name: pagelimit
        in: query
        required: false
        schema:
          type: number
          maxLength: 4
          default: '1000'
        description: Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  '0':
                    type: array
                    items:
                      type: string
  /{alias}/received:
    get:
      operationId: assignedInventoryReceived
      summary: Assigned Inventory Received
      tags:
      - Inventory
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          type: string
        description: The clientid for the API call.
      - name: company
        in: query
        required: true
        schema:
          type: string
          maxLength: 2
        description: RollMaster company.
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          maxLength: 8
        description: Format - YYYYMMDD
      - name: enddate
        in: query
        required: true
        schema:
          type: string
          maxLength: 8
        description: Format - YYYYMMDD
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  '0':
                    type: array
                    items:
                      type: string
  /{alias}/inventorypointers:
    get:
      operationId: getInventoryPointRecords
      summary: Get Inventory Point records
      tags:
      - Inventory
      description: Get all inventory point records for open POs with open PO lines
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          type: string
        description: The clientid for the API call.
      - name: company
        in: query
        required: true
        schema:
          type: string
          maxLength: 2
        description: RollMaster company.
      - name: branch
        in: query
        required: false
        schema:
          type: string
          maxLength: 2
        description: Optional
      - name: order
        in: query
        required: false
        schema:
          type: string
          maxLength: 6
        description: Optional
      - name: startdate
        in: query
        required: false
        schema:
          type: string
          maxLength: 8
        description: Optional - Format - YYYYMMDD - Use to return records with an audit within specific date range
      - name: enddate
        in: query
        required: false
        schema:
          type: string
          maxLength: 8
        description: Optional - Format - YYYYMMDD - Use to return records with an audit within specific date range
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  COMMENT:
                    type: array
                    items:
                      type: array
                      items:
                        type: string
  /{alias}/inventorybyauditdate:
    get:
      operationId: getInventoryFileRecords
      summary: Get Inventory File Records
      tags:
      - Inventory
      description: Returns all inventory file records by company, branch, and/or audit date
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          type: string
        description: The clientid for the API call.
      - name: company
        in: query
        required: true
        schema:
          type: string
          maxLength: 2
        description: RollMaster company.
      - name: branch
        in: query
        required: false
        schema:
          type: string
          maxLength: 2
        description: Optional
      - name: catseq
        in: query
        required: false
        schema:
          type: string
          maxLength: 13
        description: Optional
      - name: startdate
        in: query
        required: false
        schema:
          type: string
          maxLength: 8
        description: Format - YYYYMMDD - Looks Audit Date in Range.
      - name: enddate
        in: query
        required: false
        schema:
          type: string
          maxLength: 8
        description: Format - YYYYMMDD - - Looks Audit Date in Range.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  COMMENT:
                    type: array
                    items:
                      type: array
                      items:
                        type: string
  /{alias}/assignedinventory:
    get:
      operationId: getInventoryAssignedOnJob
      summary: Get Inventory Assigned on Job
      tags:
      - Inventory
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          type: string
        description: The clientid for the API call.
      - name: company
        in: query
        required: true
        schema:
          type: string
          maxLength: 2
        description: RollMaster company.
      - name: branch
        in: query
        required: true
        schema:
          type: string
          maxLength: 2
        description: RollMaster branch.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                job:
                  type: string
                  maxLength: 6
              required:
              - job
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  '0':
                    type: array
                    items:
                      type: string
    patch:
      operationId: unassignInventoryOnJob
      summary: Unassign Inventory on Job
      tags:
      - Inventory
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          type: string
        description: The clientid for the API call.
      - name: company
        in: query
        required: true
        schema:
          type: string
          maxLength: 2
        description: RollMaster company.
      - name: branch
        in: query
        required: true
        schema:
          type: string
          maxLength: 2
        description: RollMaster branch.
      - name: job
        in: query
        required: true
        schema:
          type: string
          maxLength: 6
      - name: lnnum
        in: query
        required: true
        schema:
          type: string
          maxLength: 3
      - name: invpoint
        in: query
        required: true
        schema:
          type: string
          maxLength: 36
        description: Full inventory pointer key
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  '0':
                    type: array
                    items:
                      type: string
    post:
      operationId: assignInventoryToJob
      summary: Assign Inventory to Job
      tags:
      - Inventory
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          type: string
        description: The clientid for the API call.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                company:
                  type: string
                  maxLength: 2
                  description: RollMaster company.
                branch:
                  type: string
                  maxLength: 2
                  description: RollMaster branch.
                job:
                  type: string
                  maxLength: 6
                lnnum:
                  type: string
                  maxLength: 3
                barcode:
                  type: string
                  maxLength: 36
                  description: Item barcode / Inventory Serialnumber.
                box:
                  type: string
                  maxLength: 1
                  description: Required when by box.
                quantity:
                  type: string
                  maxLength: 15
                  description: Used when specifying a quantity other than full quantity available.
              required:
              - company
              - branch
              - job
              - lnnum
              - barcode
              - box
              - quantity
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  '0':
                    type: array
                    items:
                      type: string
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key issued by Broadlume, required on every request.
    sessionToken:
      type: apiKey
      in: header
      name: token
      description: User session token obtained from POST /{alias}/token. Sessions expire after a server-specified idle timeout (default 5 minutes); refresh with the keepalive endpoint.
externalDocs:
  description: Broadlume BMS developer portal
  url: https://developer.broadlume.com/bms