inventory

Update an inventory item

Updates a single non-bulk inventory item.

PATCH

/v1/inventory/{id}

curl --request PATCH \
  --url https://api.beamdynamics.io/v1/inventory/{id} \
  --header 'beam-api-key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attributes": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "barcode": "<string>",
  "customFields": [
    {
      "content": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "equipmentStatusId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "extendedWarrantyPurchased": true,
  "importedManufacturerName": "<string>",
  "importedModel": "<string>",
  "importedName": "<string>",
  "installDate": "2023-11-07T05:31:56Z",
  "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "purchasedDate": "2023-11-07T05:31:56Z",
  "purchasedPrice": 123,
  "serial": "<string>",
  "statusComment": "<string>",
  "tagsId": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor": "<string>"
}
'

{
  "inventory": {
    "attributes": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "autoStatus": "overstock",
    "barcode": "<string>",
    "checkedInAt": "2023-11-07T05:31:56Z",
    "checkedInBy": "<string>",
    "checkedInNote": "<string>",
    "companies": [
      {
        "category": {
          "color": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>"
        },
        "description": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "logo": "<string>",
        "name": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "equipmentStatus": [
      {
        "category": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ],
    "equipmentStatusId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "fields": {},
    "firmwareId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "identificationStatus": "inventory",
    "importedManufacturerName": "<string>",
    "importedModel": "<string>",
    "importedName": "<string>",
    "installDate": "2023-11-07T05:31:56Z",
    "isActive": true,
    "isCheckedIn": true,
    "locations": [
      {
        "color": "<string>",
        "icon": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "nestedLevel": 123
      }
    ],
    "manufacturer": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "imageUrl": "<string>",
        "name": "<string>",
        "status": "<string>"
      }
    ],
    "productDimension": [
      {
        "depth": 123,
        "dimensionType": "<string>",
        "dimensionUnitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dimensionUnitName": "<string>",
        "dimensionUnitSymbol": "<string>",
        "height": 123,
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "note": "<string>",
        "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "weight": 123,
        "weightUnitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "weightUnitName": "<string>",
        "weightUnitSymbol": "<string>",
        "width": 123
      }
    ],
    "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "products": [
      {

Authorizations

beam-api-keystringheaderrequired

Path Parameters

idstringrequired

Body

attributesstring[] | null

barcodestring | null

customFieldsobject[]

Show child attributes

equipmentStatusIdstring

extendedWarrantyPurchasedboolean

importedManufacturerNamestring | null

importedModelstring | null

importedNamestring | null

installDatestring | null

productIdstring

purchasedDatestring | null

purchasedPricenumber | null

serialstring | null

statusCommentstring | null

tagsIdstring[]

userIdstring | null

vendorstring | null

Response

The updated inventory item

inventoryobjectrequired

Show child attributes

Still need help? Ask the team