inventory

Get an inventory item

Returns a single inventory item belonging to the studio the API key is issued for.

GET

/v1/inventory/{id}

curl --request GET \
  --url https://api.beamdynamics.io/v1/inventory/{id} \
  --header 'beam-api-key: <api-key>'

{
  "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

Response

The inventory item

inventoryobjectrequired

Show child attributes

Still need help? Ask the team