Fishbowl
Fishbowl Advanced REST API Documentation

Part

This is an object representing a Fishbowl part.

Related guide: Part

ENDPOINTS
GET /api/parts
GET /api/parts/:id/best-cost
DELETE /api/parts/:id
Search for parts

Searches for parts.

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.
  • upc string
    The UPC code for the part.
  • type string: 'Inventory' | 'Service' | 'Labor' | 'Overhead' | 'Non-Inventory' | 'Internal Use' | 'Capital Equipment' | 'Shipping'
    The basic type of the part.
  • abc string
    The ABC code for the part
  • details string
    The part details.
  • hasBom boolean
    Indicates if the part has an associated bill of materials. True returns parts with an associated bill of materials, false does not filter the results.
  • active boolean
    The active status of the UOM.
  • productNumber string
    The associated product number.
  • productDescription string
    The product description.
  • vendorPartNumber string
    The vendor part number.
  • vendorName string
    The name of the associated vendor.
Attributes
  • customFields list
    A list of the part's custom fields.
GET /api/parts 
curl --location \
--request GET '<YOUR SERVER>/api/parts' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>'
RESPONSE
{
  "totalCount": 2,
  "totalPages": 1,
  "pageNumber": 1,
  "pageSize": 100,
  "results": [
    {
      "id": 29,
      "number": "FG2100",
      "description": "Extreme Mountain Bike",
      "type": "Inventory",
      "uom": {
        "id": 1,
        "name": "Each",
        "abbreviation": "ea"
      },
      "upc": "",
      "active": true,
      "hasBom": true,
      "hasTracking": true,
      "tracksSerialNumbers": true
    },
    {
      "id": 31,
      "number": "FG2200",
      "description": "Custom Extreme Mountain Bike",
      "type": "Inventory",
      "uom": {
        "id": 1,
        "name": "Each",
        "abbreviation": "ea"
      },
      "upc": "",
      "active": true,
      "hasBom": true,
      "hasTracking": true,
      "tracksSerialNumbers": true
    }
  ]
}
Get the best cost for the part

Retrieves the best cost for a specific part. The cost will be in the currency of the vendor.

Related guide: Vendor Part Cost

Parameters
  • vendorId integer
    The unique identifier for the vendor associated with the part.
  • quantity quantity
    The part quantity associated with the cost.
  • uomId integer
    The unique identifier for the unit of measure.
Attributes

    No attributes.

GET /api/parts/:id/best-cost 
curl --location \
--request GET '<YOUR SERVER>/api/parts/:id/best-cost' \
--header 'Authorization: Bearer <TOKEN>'
RESPONSE
{
  "totalCost": "5",
  "unitCost": "5",
  "quantity": "1",
  "minimumQuantity": "0",
  "uom": {
    "id": 1,
    "name": "Each",
    "abbreviation": "ea"
  },
  "vendorPartNum": "B201"
}
Delete part

Deletes the part with the specified ID.

Attributes

    No attributes.

DELETE /api/parts/:id 
curl --location \
--request DELETE '<YOUR SERVER>/api/parts/:id' \
--header 'Authorization: Bearer <TOKEN>'
RESPONSE