Fulcrumpro

Fulcrumpro Inventory API

The Inventory API from Fulcrumpro — 6 operation(s) for inventory.

GitHub OpenAPI
Business capability
Inventory Management BC-530

Operations 6

POST /api/inventory/list Find inventory based on search parameters #
GET /api/inventory/byItem Returns on hand counts by item. #
POST /api/inventory/override Override an inventory's quantity #
POST /api/inventory/pick Pick inventory against a specific item #
GET /api/inventory/availableByItem Returns quantity available by item. #
POST /api/inventory/receive Receive inventory for a specific item #

Documentation

📖
Documentation
https://developers.fulcrumpro.com/docs
📖
APIReference
https://developers.fulcrumpro.com/api-schema
📖
GettingStarted
https://developers.fulcrumpro.com/docs

Specifications

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

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/fulcrumpro:fulcrumpro-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

fulcrumpro-inventory-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Fulcrum Public Inventory API
  version: v1
servers:
- url: https://api.fulcrumpro.com
tags:
- name: Inventory
paths:
  /api/inventory/list:
    post:
      tags:
      - Inventory
      summary: Find inventory based on search parameters
      operationId: ListInventory
      parameters:
      - name: Sort.Field
        in: query
        description: Sort field
        schema:
          minLength: 1
          type: string
      - name: Sort.Dir
        in: query
        description: Sort direction
        schema:
          $ref: '#/components/schemas/CommonEnumSortDirectionEnum'
      - name: Skip
        in: query
        description: 'Number of records to skip. Defaults to 0. Combine with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Take to page

          through a result set larger than one page.'
        schema:
          minimum: 0
          type: integer
          format: int32
      - name: Take
        in: query
        description: 'Number of records to return. Validation accepts 0 through 5000, but `0` is not a

          page size and what an endpoint does with it varies, so send a value from 1 to 5000.


          Two cases differ. A request that supplies paging but leaves this field out takes this

          field''s default of <b>50</b>. A request that supplies no paging at all is

          endpoint-specific — some define their own fallback — so it does not reliably mean any

          particular number of records. Either way the response says nothing about records it

          did not return, so send this explicitly whenever the size of the answer matters.

          Endpoints returning a paged envelope report `totalCount` and `hasNextPage`

          alongside the records; endpoints returning a bare array report neither, so page those

          with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Skip until a page comes back shorter than the value requested.'
        schema:
          maximum: 5000
          minimum: 0
          type: integer
          format: int32
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/InventoryRequestFindParameters'
          application/json:
            schema:
              $ref: '#/components/schemas/InventoryRequestFindParameters'
          text/json:
            schema:
              $ref: '#/components/schemas/InventoryRequestFindParameters'
          application/*+json:
            schema:
              $ref: '#/components/schemas/InventoryRequestFindParameters'
      responses:
        '200':
          description: List of locations matching the filters
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InventoryDto'
            application/problem+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InventoryDto'
      x-c4-exposed: true
      x-c4-required-permissions:
      - ItemsAndInventory-Items-View Inventory
  /api/inventory/byItem:
    get:
      tags:
      - Inventory
      summary: Returns on hand counts by item.
      operationId: OnHandByItem
      parameters:
      - name: includeReserved
        in: query
        description: Whether to included reserved inventory into the counts
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: number
                  format: double
            application/problem+json:
              schema:
                type: object
                additionalProperties:
                  type: number
                  format: double
      x-c4-exposed: true
      x-c4-required-permissions:
      - ItemsAndInventory-Items-View Inventory
  /api/inventory/override:
    post:
      tags:
      - Inventory
      summary: Override an inventory's quantity
      operationId: OverrideInventory
      requestBody:
        description: The parameters for the request
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/InventoryOverrideDto'
          application/json:
            schema:
              $ref: '#/components/schemas/InventoryOverrideDto'
          text/json:
            schema:
              $ref: '#/components/schemas/InventoryOverrideDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/InventoryOverrideDto'
        required: true
      responses:
        '200':
          description: Inventory override was successfully processed
        '400':
          description: Validation issues with the request
        '500':
          description: An unspecified error occurred with the request
      x-c4-exposed: true
      x-c4-mutation: true
      x-c4-required-permissions:
      - ItemsAndInventory-Inventory-Adjust Inventory
  /api/inventory/pick:
    post:
      tags:
      - Inventory
      summary: Pick inventory against a specific item
      operationId: PickInventory
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/InventoryPickDto'
          application/json:
            schema:
              $ref: '#/components/schemas/InventoryPickDto'
          text/json:
            schema:
              $ref: '#/components/schemas/InventoryPickDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/InventoryPickDto'
        required: true
      responses:
        '200':
          description: Inventory transaction processed
        '400':
          description: Validation issues with input
      x-c4-exposed: true
      x-c4-mutation: true
      x-c4-required-permissions:
      - ItemsAndInventory-Inventory-Adjust Inventory
  /api/inventory/availableByItem:
    get:
      tags:
      - Inventory
      summary: Returns quantity available by item.
      operationId: QuantityAvailableByItem
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: number
                  format: double
            application/problem+json:
              schema:
                type: object
                additionalProperties:
                  type: number
                  format: double
      x-c4-exposed: true
      x-c4-required-permissions:
      - ItemsAndInventory-Items-View Inventory
  /api/inventory/receive:
    post:
      tags:
      - Inventory
      summary: Receive inventory for a specific item
      operationId: ReceiveInventory
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/InventoryReceiveDto'
          application/json:
            schema:
              $ref: '#/components/schemas/InventoryReceiveDto'
          text/json:
            schema:
              $ref: '#/components/schemas/InventoryReceiveDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/InventoryReceiveDto'
        required: true
      responses:
        '200':
          description: Inventory transaction processed
        '400':
          description: Validation issues with input
      x-c4-exposed: true
      x-c4-mutation: true
      x-c4-required-permissions:
      - ItemsAndInventory-Inventory-Adjust Inventory
components:
  schemas:
    InventoryPickDto:
      required:
      - itemId
      - quantity
      - secondaryType
      type: object
      properties:
        itemId:
          maxLength: 24
          minLength: 24
          type: string
          description: Item identifier. Please reference /api/items endpoint.
        secondaryType:
          $ref: '#/components/schemas/InventoryPickEventSecondaryType'
        quantity:
          type: number
          description: Quantity of the item to pick.
          format: double
        locationId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: Location id that inventory is picked from. Please reference /api/locations endpoint
        lotId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: Lot identifier for this block of inventory. Please reference /api/inventory-lots endpoint
        note:
          maxLength: 2000
          minLength: 1
          type:
          - string
          - 'null'
          description: Notes associated to this transaction.
      additionalProperties: false
      description: Pick event for item inventory.
    InventoryPickEventSecondaryType:
      enum:
      - pick
      - consume
      - scrap
      - stockAdjustmentDecrease
      - otherDecrease
      type: string
      description: Secondary event type specifically for picking.
    CommonEnumSortDirectionEnum:
      enum:
      - ascending
      - descending
      type: string
      description: Specify sorting direction.
    InventoryReceiveEventSecondaryType:
      enum:
      - receive
      - found
      - stockAdjustmentIncrease
      - otherIncrease
      type: string
      description: Secondary event type specifically for receiving.
    InventoryOverrideDto:
      required:
      - itemId
      - quantity
      type: object
      properties:
        itemId:
          maxLength: 24
          minLength: 24
          type: string
          description: Item identifier.
        quantity:
          type: number
          description: The quantity to set the item's inventory level to.
          format: double
        lotId:
          type:
          - string
          - 'null'
          description: The lot identifier to apply this override to
        locationId:
          type:
          - string
          - 'null'
          description: The location identifier to apply this override to.  ```null``` signifies no location.
        note:
          type:
          - string
          - 'null'
          description: The note to add to the override transaction.
      additionalProperties: false
      description: Override event for item inventory
    InventoryDto:
      required:
      - id
      - itemId
      - itemNumber
      - onHandQuantity
      - quantity
      type: object
      properties:
        id:
          maxLength: 24
          minLength: 24
          type: string
          description: Unique id associated to this entity.
        lotId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: The lot Iid associated to this entity.
        locationId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: The location id associated to this entity.
        quantity:
          minimum: 0
          type: number
          description: The quantity of items in this inventory.
          format: double
        onHandQuantity:
          minimum: 0
          type: number
          description: The on-hand quantity of items in this inventory.
          format: double
        itemId:
          maxLength: 24
          minLength: 24
          type: string
          description: The item id associated to this entity.
        itemNumber:
          maxLength: 200
          minLength: 1
          type: string
          description: The number/sku/short name of the item.
        itemDescription:
          maxLength: 2000
          minLength: 0
          type:
          - string
          - 'null'
          description: The description of the item
      additionalProperties: false
      description: An item inventory record.
    InventoryRequestFindParameters:
      type: object
      properties:
        lotIds:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Filter inventory based on lot ids.
        itemIds:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Filter inventory based on item ids.
        locationIds:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Filter inventory based on location ids.
      additionalProperties: false
      description: Parameters used for searching/finding inventory.
    InventoryReceiveDto:
      required:
      - itemId
      - quantity
      - secondaryType
      type: object
      properties:
        itemId:
          maxLength: 24
          minLength: 24
          type: string
          description: Item identifier. Please reference /api/items endpoint.
        secondaryType:
          $ref: '#/components/schemas/InventoryReceiveEventSecondaryType'
        quantity:
          type: number
          description: Quantity of the item to receive.
          format: double
        locationId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: Location id that inventory is received into. Please reference /api/locations endpoint
        lotId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: Lot identifier for this block of inventory. Please reference /api/inventory-lots endpoint
        lotNumber:
          maxLength: 200
          minLength: 1
          type:
          - string
          - 'null'
          description: Lot name.
        note:
          maxLength: 2000
          minLength: 1
          type:
          - string
          - 'null'
          description: Notes associated to this transaction.
        laborValue:
          minimum: 0
          type:
          - number
          - 'null'
          description: Labor value associated (per unit).
          format: double
        machineValue:
          minimum: 0
          type:
          - number
          - 'null'
          description: Machine value associated (per unit).
          format: double
        outsideProcessingValue:
          minimum: 0
          type:
          - number
          - 'null'
          description: Outside processing value associated (per unit).
          format: double
        materialValue:
          minimum: 0
          type:
          - number
          - 'null'
          description: Material value associated (per unit).
          format: double
      additionalProperties: false
      description: Receive event for item inventory.
  securitySchemes:
    bearer:
      type: http
      description: Your API bearer token generated in System Data > Advanced > Public API Setup
      scheme: bearer
      bearerFormat: JWT
x-tagGroups:
- name: Accounting Code
  tags:
  - Accounting Code
- name: Alert
  tags:
  - Alert
- name: Attachment
  tags:
  - Attachment
  - Attachment Certification
- name: Auth
  tags:
  - Auth
- name: CAPAs
  tags:
  - CAPAs
- name: Change Order
  tags:
  - Change Order
- name: Chart Of Accounts
  tags:
  - Chart Of Accounts
- name: Company Info
  tags:
  - Company Info
- name: Custom Field
  tags:
  - Custom Field
- name: Customer
  tags:
  - Customer
  - Customer Address
  - Customer Contact
- name: Customer Tier
  tags:
  - Customer Tier
- name: Department
  tags:
  - Department
- name: Department Shift
  tags:
  - Department Shift
- name: Equipment
  tags:
  - Equipment
- name: Equipment Downtime
  tags:
  - Equipment Downtime
- name: Gauge Code
  tags:
  - Gauge Code
- name: Grade Code
  tags:
  - Grade Code
- name: InProcessTrackingFieldType
  tags:
  - InProcessTrackingFieldType
- name: Inventory
  tags:
  - Inventory
- name: Inventory Event
  tags:
  - Inventory Event
  - Inventory Event Details
- name: Inventory Lot
  tags:
  - Inventory Lot
- name: Inventory Transactions
  tags:
  - Inventory Transactions
- name: Invoice
  tags:
  - Invoice
  - Invoice Deposit Adjustment Line Item
  - Invoice Deposit Line Item
  - Invoice Discount Line Item
  - Invoice Fee Line Item
  - Invoice Line Item
  - Invoice Note
  - Invoice Part Line Item
  - Invoice Refund Line Item
  - Invoice Shipping Charge Line Item
  - Invoice Tax Line Item
- name: Item
  tags:
  - Item
  - Item Custom Fields
  - Item Customer
  - Item Material Vendor
  - Item PriceBreaks
  - Item Routing
  - Item Vendor
- name: Item Category
  tags:
  - Item Category
- name: Item Class
  tags:
  - Item Class
- name: Item Tag
  tags:
  - Item Tag
- name: Job
  tags:
  - Job
  - Job Custom Fields
  - Job Full Routing
  - Job Part Line Item Full Routing
  - Job Item To Make
  - Job Item To Make Operation
  - Job Message
  - Job Operation
- name: Job Tracking Timers
  tags:
  - Job Tracking Timers
- name: Location
  tags:
  - Location
- name: Material
  tags:
  - Material
  - Material Vendor
- name: Material Code
  tags:
  - Material Code
- name: NCRs
  tags:
  - NCRs
- name: Nesting
  tags:
  - Nesting
- name: Note
  tags:
  - Note
- name: Operation
  tags:
  - Operation
- name: Payment Term
  tags:
  - Payment Term
- name: Purchase Order
  tags:
  - Purchase Order
  - Purchase Order Custom Fields
  - Purchase Order Discount Line Item
  - Purchase Order Fee Line Item
  - Purchase Order Line Item
  - Purchase Order Outside Processing Line Item
  - Purchase Order Part Line Item
  - Purchase Order Tax Line Item
  - Purchase Order Vendor Credit Line Item
- name: Quote
  tags:
  - Quote
  - Quote Custom Fields
  - Quote Discount Line Item
  - Quote Fee Line Item
  - Quote Part Line Item
  - Quote Part Line Item Custom Fields
  - Quote Part Line Item Full Routing
  - Quote Tax Line Item
- name: Receiving
  tags:
  - Receiving Receipt
  - Receiving Receipt Line Item
- name: Refund Reason Code
  tags:
  - Refund Reason Code
- name: Reporting
  tags:
  - Reporting
- name: Sales Order
  tags:
  - Sales Order
  - Sales Order Blanket Line Item
  - Sales Order Custom Fields
  - Sales Order Discount Line Item
  - Sales Order Fee Line Item
  - Sales Order Line Item
  - Sales Order Part Line Item
  - Sales Order Part Line Item Custom Fields
  - Sales Order Part Line Item Full Routing
  - Sales Order Refund Line Item
  - Sales Order Shipping Charge Line Item
  - Sales Order Tax Line Item
- name: ScrapReport
  tags:
  - ScrapReport
- name: Settings
  tags:
  - Settings
- name: Shape Code
  tags:
  - Shape Code
- name: Shipment Line Items (V3)
  tags:
  - Shipment Line Items (V3)
- name: Shipment
  tags:
  - Shipment Custom Fields
- name: Shipments
  tags:
  - Shipments
- name: Shipping Method
  tags:
  - Shipping Method
- name: Tag
  tags:
  - Tag
- name: Task
  tags:
  - Task
- name: Tax Rate
  tags:
  - Tax Rate
- name: Time Clock Timers
  tags:
  - Time Clock Timers
- name: Timer
  tags:
  - Timer
- name: Tool
  tags:
  - Tool
- name: Tool Calibration
  tags:
  - Tool Calibration
- name: User
  tags:
  - User
  - User Status
- name: Vendor
  tags:
  - Vendor
  - Vendor Address
  - Vendor Contact
- name: Work Order
  tags:
  - Work Order
- name: WorkCenter
  tags:
  - WorkCenter
x-provenance:
  method: harvested
  publisher: Fulcrumpro
  source: https://api.fulcrumpro.com/swagger/v1/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)