Fishbowl
Fishbowl Advanced REST API Documentation

Inventory

This is an object representing the inventory associated with a Fishbowl part.

Related guide: Inventory

ENDPOINTS
GET /api/parts/inventory
POST /api/parts/:id/inventory/add
POST /api/parts/:id/inventory/cycle
POST /api/parts/:id/inventory/move
POST /api/parts/:id/inventory/scrap
Search for inventory

Searches for inventory.

Parameters
  • pageNumber integer
    The current page of the results.
  • pageSize integer
    The number of returned results per page. (Default 100)
  • number string
    The part number.
  • description string
    The part description.
  • locationId integer
    The unique identifier for the location.
  • locationGroupId integer
    The unique identifier for the location group.
  • abc string: 'A' | 'B' | 'C'
    The ABC code for the part.
  • includeZeroQuantities boolean
    Indicates whether to include parts with no on hand inventory.
  • active boolean
    Indicates whether to only include active parts.
Attributes
  • customFields list
    A list of the part's custom fields.
  • trackingItems list
    A list of the tracking items associated with a part.
GET /api/parts/inventory 
curl --location \
--request GET '<YOUR SERVER>/api/parts/inventory' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>'
RESPONSE
{
  "totalCount": 4,
  "totalPages": 1,
  "pageNumber": 1,
  "pageSize": 100,
  "results": [
    {
      "id": 28,
      "partNumber": "B201",
      "quantity": "242",
      "partDescription": "Premium Brake Cables",
      "uom": {
        "id": 1,
        "name": "Each",
        "abbreviation": "ea"
      }
    },
    {
      "id": 36,
      "partNumber": "C201",
      "quantity": "46",
      "partDescription": "Single Speed Chain",
      "uom": {
        "id": 1,
        "name": "Each",
        "abbreviation": "ea"
      }
    },
    {
      "id": 40,
      "partNumber": "F201",
      "quantity": "50",
      "partDescription": "Road Fury Frame",
      "uom": {
        "id": 1,
        "name": "Each",
        "abbreviation": "ea"
      }
    },
    {
      "id": 72,
      "partNumber": "RF201",
      "quantity": "56",
      "partDescription": "Various Reflectors",
      "uom": {
        "id": 1,
        "name": "Each",
        "abbreviation": "ea"
      }
    }
  ]
}
Add Inventory

Adds inventory.

Attributes
  • location reference object optional
    The location for the inventory.
  • quantity quantity
    The quantity of the part to add to inventory.
  • uom reference object optional
    The part unit of measure.
  • unitCost money optional
    The unit cost for the inventory to be added. If blank, the current part cost will be used.
  • note string optional
    A note about the inventory adjustment.
  • customer reference object optional
    The customer associated with the inventory adjustment.
  • class reference object optional
    The class category for the inventory adjustment.
  • date date optional
    The date for the inventory adjustment. If blank, the current date will be used.
  • trackingItems list optional
    A list of the tracking items for the inventory. Only used if the part tracks inventory.
POST /api/parts/:id/inventory/add 
curl --location \
--request POST '<YOUR SERVER>/api/parts/:id/inventory/add' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>' \
--data-raw '<INVENTORY JSON>'
RESPONSE
{}
Cycle Inventory

Cycles inventory.

Attributes
  • location reference object optional
    The location for the inventory.
  • quantity quantity
    The quantity of the part to cycle at the location.
  • uom reference object optional
    The part unit of measure.
  • note string optional
    A note about the inventory adjustment.
  • customer reference object optional
    The customer associated with the inventory adjustment.
  • class reference object optional
    The class category for the inventory adjustment.
  • date date optional
    The date for the inventory adjustment. If blank, the current date will be used.
  • trackingItems list optional
    A list of the tracking items for the inventory. Only used if the part tracks inventory.
POST /api/parts/:id/inventory/cycle 
curl --location \
--request POST '<YOUR SERVER>/api/parts/:id/inventory/cycle' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>' \
--data-raw '<INVENTORY JSON>'
RESPONSE
{}
Move Inventory

Moves inventory from one location to another.

Attributes
  • sourceLocation reference object optional
    The source location where the inventory will be moved from.
  • location reference object optional
    The end location where the inventory will be moved to.
  • quantity quantity
    The quantity of the part to move to a different location.
  • uom reference object optional
    The part unit of measure.
  • note string optional
    A note about the inventory adjustment.
  • customer reference object optional
    The customer associated with the inventory adjustment.
  • class reference object optional
    The class category for the inventory adjustment.
  • date date optional
    The date for the inventory adjustment. If blank, the current date will be used.
  • trackingItems list optional
    A list of the tracking items for the inventory. Only used if the part tracks inventory.
POST /api/parts/:id/inventory/move 
curl --location \
--request POST '<YOUR SERVER>/api/parts/:id/inventory/move' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>' \
--data-raw '<INVENTORY JSON>'
RESPONSE
{}
Scrap Inventory

Scraps inventory. Parts that have tracking only require the primary tracking value.

Attributes
  • location reference object optional
    The location for the inventory.
  • quantity quantity
    The quantity of the part to scrap from inventory.
  • uom reference object optional
    The part unit of measure.
  • note string optional
    A note about the inventory adjustment.
  • customer reference object optional
    The customer associated with the inventory adjustment.
  • class reference object optional
    The class category for the inventory adjustment.
  • date date optional
    The date for the inventory adjustment. If blank, the current date will be used.
  • trackingItems list optional
    A list of the tracking items for the inventory. Only used if the part tracks inventory.
POST /api/parts/:id/inventory/scrap 
curl --location \
--request POST '<YOUR SERVER>/api/parts/:id/inventory/scrap' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>' \
--data-raw '<INVENTORY JSON>'
RESPONSE
{}