Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Prefix the value with "ApiKey" to indicate the custom authorization type

Path Parameters

inventoryId
string<uuid>
required

Body

application/json

Request body for updating inventory details

deployStatus
enum<string>
Available options:
ARCHIVED,
DEPLOYED,
UNAVAILABLE,
AVAILABLE
Example:

"ARCHIVED"

deployReason
enum<string>
Available options:
GIFTED_BY_EMPLOYER,
LOST_BY_WORKER,
BOUGHT_OUT,
PERSONAL_DEVICE,
END_OF_USEFUL_LIFE_DESTROYED,
END_OF_USEFUL_LIFE_DONATED,
DECOMMISSIONED_BY_EMPLOYER,
AWAITING_INFORMATION,
DATA_HOLD,
LOCKED_APPLE_ACTIVATION,
LOCKED_FMD_REPORTED_LOST_STOLEN,
LOCKED_MDM,
LOCKED_PIN,
REQUIRES_REPAIR,
OUT_FOR_REPAIR
Example:

"GIFTED_BY_EMPLOYER"

assignedTo
object

Update the assignment of the inventory

imei
string[] | null

Optional IMEI(s) for cellular/mobile inventory only. Omit this field when updating other attributes (for example renewalDate on laptops). Omit or send null to leave unchanged; send [] to clear all IMEIs. When provided, each value must be a 14- or 15-digit ASCII numeric string (GSMA IMEI).

Pattern: ^\d{14,15}$
condition
enum<string>

Condition of the inventory item.

Available options:
NEW,
USED
Example:

"NEW"

renewalDate
string<date>

Renewal date for the inventory item. Editable when inventory is customer-supplied OR Firstbase-purchased non-subscription.

Example:

"2027-01-15"

serialNumber
string

Serial number. Editable when inventory is customer-supplied OR Firstbase-purchased non-subscription AND assigned to a person/office AND not in return progress. Must be unique within the organization.

Example:

"SN-ABC-123"

description
string

Free-text description. Editable only for generic SKUs (customer-supplied) AND assigned to person/office AND not in return progress.

Example:

"Refurbished MacBook Pro 14\""

vendorCode
string

Vendor code (brand). Must be paired with vendorSku. For customer-supplied inventory this reassigns the item to the SKU identified by the vendorCode/vendorSku pair, which may be a catalog SKU. Not allowed on Firstbase-supplied inventories, inventories assigned to a warehouse, or inventories with a return in progress.

Example:

"APPLE"

vendorSku
string

Vendor SKU (model number). Must be paired with vendorCode. For customer-supplied inventory this reassigns the item to the SKU identified by the vendorCode/vendorSku pair, which may be a catalog SKU. The pair must resolve to an existing SKU that is not ARCHIVED. Not allowed on Firstbase-supplied inventories, inventories assigned to a warehouse, or inventories with a return in progress.

Example:

"MBP14-M3-512"

Response

Inventory updated successfully

A single inventory item (piece of equipment) belonging to the organization

id
string<uuid>
required

Unique identifier for this inventory item

Example:

"ecb7e933-de1e-9830-b180-b25d1d0d296e"

skuId
string<uuid>
required

The SKU (product variant) ID this inventory item is associated with

Example:

"203a5df2-423a-43a9-bb19-1ccaf3434b91"

imei
string[]
required

IMEI(s) for cellular devices. GSMA-allocated 14- or 15-digit numeric strings. Empty array when not applicable.

deployStatus
enum<string>
required

Current lifecycle state of the inventory item. DEPLOYED = assigned to a person; AVAILABLE = in a warehouse ready to ship; ARCHIVED = permanently decommissioned; UNAVAILABLE = in warehouse but not ready to ship; AWAITING_ARRIVAL = in transit to a warehouse.

Available options:
ARCHIVED,
AVAILABLE,
AWAITING_ARRIVAL,
DEPLOYED,
ON_HOLD,
UNAVAILABLE
Example:

"ARCHIVED"

condition
enum<string>
required

Physical condition of the item (NEW or USED)

Available options:
NEW,
USED_LIKE_NEW,
USED_GOOD,
USED_FAIR,
USED,
USED_POOR,
UNUSABLE
Example:

"NEW"

categoryCode
string
required

Category code of the SKU (e.g. COMPUTER, MONITOR, HEADSET)

Example:

"TSHIRT"

categoryNameOfSku
string
required

Human-readable category name for the SKU

Example:

"T-shirt"

skuTitle
string
required

Display title of the SKU (product variant name)

Example:

"T-shirt White - 5XL"

vendorCode
string
required

Vendor/brand code for the SKU

Example:

"AWESOME_MERCHANDISE"

vendorSku
string
required

Vendor-specific SKU or model identifier

Example:

"TSHRT_5XL_WHITE"

createdAt
string<date-time>
required

Timestamp when this inventory item was created in Firstbase

Example:

"2023-02-09T00:00:00"

updatedAt
string<date-time>
required

Timestamp when this inventory item was last updated

Example:

"2023-03-02T17:39:01.650027"

tags
object[]
required

List of key-value tags attached to this inventory item for organization and filtering.

assignedCountryCode
string | null
required

Assigned country/region code (inventory region code, same as Client App Assigned country). Present, including JSON null when unset, only when the organization does not allow regional transfer. Omitted when regional transfer is allowed.

Example:

"DE"

serialNumber
string

Hardware serial number of the device; null for non-serialized items

Example:

"25f2e6ea9a"

deployReason
enum<string>

Reason code explaining why the item is in its current deployStatus. Required when transitioning to UNAVAILABLE or ARCHIVED; null when DEPLOYED or AVAILABLE.

Available options:
ASSIGNED_TO_ADMIN,
AWAITING_INFORMATION,
BOUGHT_OUT,
DATA_HOLD,
DECOMMISSIONED_BY_EMPLOYER,
END_OF_USEFUL_LIFE_DESTROYED,
END_OF_USEFUL_LIFE_DONATED,
PENDING_FULFILLMENT,
GIFTED_BY_EMPLOYER,
GIFTED_BY_FIRSTBASE,
IN_TRANSIT,
LOCKED_APPLE_ACTIVATION,
LOCKED_FMD_REPORTED_LOST_STOLEN,
LOCKED_MDM,
LOCKED_PIN,
LOST_BY_FIRSTBASE,
LOST_IN_TRANSIT,
LOST_BY_WORKER,
MARKED_FOR_DESTRUCTION,
NA,
NEVER_RECEIVED_BY_WORKER,
OTHER,
OUT_FOR_DESTRUCTION,
OUT_FOR_REPAIR,
PENDING_BUY_OUT,
RECYCLING_REQUESTED,
REQUIRES_CLEANING,
REQUIRES_REPAIR,
RETURN_IN_PROGRESS,
SENT_TO_OFFICE,
STOLEN,
UNRESPONSIVE_WORKER,
UNSUPPORTED_REGION,
PERSONAL_DEVICE,
PENDING_HOLD_RELEASE
Example:

"LOST_BY_WORKER"

renewalDate
string<date>

Date when this item is scheduled for renewal or replacement

Example:

"2026-02-09"

renewalDateUpdatedBy
enum<string>

Who or what last set the renewalDate (e.g. organization policy vs. manual override)

Available options:
RENEWAL_DATE_ORGANIZATION_LEVEL,
RENEWAL_DATE_ORGANIZATION_CATEGORY_LEVEL,
RENEWAL_DATE_MANUALLY_UPDATED,
CLEAR_RENEWAL_DATE_MANUALLY_SET
Example:

"RENEWAL_DATE_ORGANIZATION_LEVEL"

billingStartDate
string<date>

Date when billing began for this inventory item

Example:

"2026-02-09"

billingEndDate
string<date>

Date when billing ended or is scheduled to end for this inventory item

Example:

"2028-02-09"

procurementMethod
string

Human-readable label indicating how this item was procured (e.g. via an inventory order ID)

Example:

"Inventory Order - #c853d81c-ba0b-4027-a394-d5586b61608c"

returnOrder
null

Details of the return order associated with this inventory item, if a return has been initiated.

assignedTo
null

Information about the person this inventory item is currently assigned to, if applicable.

pricing
object

Pricing details

description
string

Custom description for the inventory item

Example:

"Custom inventory description"

netsuiteInvoiceId
string

NetSuite invoice ID for Firstbase-supplied inventory

Example:

"INV-123456"

holdStartDate
string<date> | null

Date when the machine retention hold started (set at warehouse receive). Null when no hold is active.

unlockDate
string<date> | null

Date when the machine retention hold expires (holdStartDate + holdPeriodDays). Null when no hold is active.

itadRequested
boolean | null

Whether ITAD was requested for this item. Copied from the return order item at hold-stamp time.

appleBusiness
null

Apple Business Manager assignment for serialized Apple inventory. Omitted for non-Apple or non-serialized items.

hashId
string | null
read-only

Windows hardware hash (Hash ID) captured for this device, used to enroll it into Windows Autopilot. Read-only. Omitted when not captured or not applicable (e.g. non-Windows devices).

Example:

"T0FBQUFBQUFBQUFBQUFB"