The below list includes all possible Asset Statuses you can find in the Firstbase Platform. Each asset in your Asset Management page will have one of these possible statuses.
In our API, asset status is available on the Inventory endpoint via the deployStatus field. When additional context is needed, the API also returns a deployReason field. deployReason is typically null for AVAILABLE and AWAITING_ARRIVAL items.
| Archived | A terminal state for when an inventory item reaches end of life or when it will never be returned. See list of possible reasons under the "Archived reasons" table. |
|---|---|
| Available | Automatically and manually assigned to items when they’re assigned to a warehouse or an office location |
| Deployed | Automatically and manually assigned to items when they’re assigned to a person. See list of possible reasons under the "Deployed reasons" table. |
| Unavailable | Manually assigned to items that are unavailable for redeployment for several reasons. See list of possible reasons under the "Unavailable reasons" table. |
| On Hold | Automatically assigned to computers when the machine retention feature is enabled for a given category. See list of possible reasons under the "On Hold reasons" table. |
| Awaiting Arrival | Automatically assigned to items when an inventory item is created, but the item has not yet arrived at a given warehouse to be made available to order. |
Some deployReason values can appear with more than one deployStatus. The tables below list every customer-facing reason and the API value returned for each.
Archived Reasons
When deployStatus is ARCHIVED, the API returns a deployReason code explaining why the item was archived.
Possible reasons for a device being "Archived" include:
| Reason | API value (deployReason) | Description |
|---|---|---|
| Bought Out | BOUGHT_OUT | The asset was bought out by the person assigned to it. |
| Decommissioned by Employer | DECOMMISSIONED_BY_EMPLOYER | The asset is no longer deployable as determined by the employer. |
| Decommissioned by Firstbase | DECOMMISSIONED_BY_FIRSTBASE | Firstbase determined the asset is no longer deployable. |
| End of Useful Life - Destroyed | END_OF_USEFUL_LIFE_DESTROYED | The asset has been destroyed or recycled. |
| End of Useful Life - Donated | END_OF_USEFUL_LIFE_DONATED | The asset has been donated. |
| Gifted by Employer | GIFTED_BY_EMPLOYER | The asset was gifted by the employer to the person assigned to it. |
| Gifted by Firstbase | GIFTED_BY_FIRSTBASE | The asset was gifted by Firstbase to the person assigned to it. |
| Lost by Firstbase | LOST_BY_FIRSTBASE | The asset was lost and marked as not returned. |
| Lost by Worker | LOST_BY_WORKER | The asset was lost by the employee or worker. |
| Lost in Transit | LOST_IN_TRANSIT | The asset was lost during shipping. |
| Never Received by Worker | NEVER_RECEIVED_BY_WORKER | The asset was assigned to a person who reports they never received it. |
| Never Returned by Worker | NEVER_RETURNED_BY_WORKER | The asset was expected to be returned, but was never returned by the person assigned to it. |
| Other | OTHER | Catch-all for archived outcomes not covered by another reason. |
| Out for Destruction | OUT_FOR_DESTRUCTION | The asset has left the warehouse and is on its way to the destruction facility. Also valid when deployStatus is UNAVAILABLE. |
| Personal Device | PERSONAL_DEVICE | The asset is treated as a personal device. |
| Stolen | STOLEN | The asset was reported stolen. |
| Unresponsive Worker | UNRESPONSIVE_WORKER | The asset is being returned and is assigned to a person who fails to respond within 30 days of initiating the return order. |
| Unsupported Region | UNSUPPORTED_REGION | The asset is assigned to a person who resides in a region that is not supported by Firstbase. |
Unavailable reasons:
When deployStatus is UNAVAILABLE, the API returns a deployReason code explaining why the item is unavailable.
Possible reasons for a device being "Unavailable" include:
| Reason | API value (deployReason) | Description |
|---|---|---|
| Awaiting Information | AWAITING_INFORMATION | The asset requires more information before proceeding to the next steps. |
| Data Hold | DATA_HOLD | The asset needs to be put on a data hold upon arriving at the warehouse. |
| In Transit | IN_TRANSIT | The asset is in transit (for example, after order fulfillment and before warehouse receipt). |
| Locked - Apple Activation | LOCKED_APPLE_ACTIVATION | The asset has an Apple Activation lock. |
| Locked - FMD Reported Lost/Stolen | LOCKED_FMD_REPORTED_LOST_STOLEN | The asset was reported lost or stolen and has an FMD lock. |
| Locked - MDM | LOCKED_MDM | The asset has an MDM (Mobile Device Management) lock. |
| Locked - PIN | LOCKED_PIN | The asset has a PIN lock. |
| Marked for Destruction | MARKED_FOR_DESTRUCTION | The asset is in the warehouse, pending transfer to the destruction facility. |
| Out for Destruction | OUT_FOR_DESTRUCTION | The asset has left the warehouse and is on its way to the destruction facility. Also valid when deployStatus is ARCHIVED. |
| Out for Repair | OUT_FOR_REPAIR | The asset is currently being repaired. |
| Pending Fulfillment | PENDING_FULFILLMENT | An order was created for this item but has not yet been fulfilled. |
| Pending Hold Release | PENDING_HOLD_RELEASE | A data hold has expired and the item is awaiting warehouse processing. |
| Recycling Requested | RECYCLING_REQUESTED | The asset is in the warehouse and has been marked for recycling. |
| Requires Cleaning | REQUIRES_CLEANING | The asset needs to be cleaned before redeployment. |
| Requires Repair | REQUIRES_REPAIR | The asset needs to be repaired. |
Deployed reasons:
When deployStatus is DEPLOYED, the API may return a deployReason code. The table below lists reasons specific to the Deployed status.
| Reason | API value (deployReason) | Description |
|---|---|---|
| Return in Progress | RETURN_IN_PROGRESS | Automatically assigned to an item when a return order is created for it. Also valid when deployStatus is ON_HOLD. |
| Pending Buy Out | PENDING_BUY_OUT | The assigned person initiated a buyout but has not completed the purchase. |
On Hold reasons:
When deployStatus is ON_HOLD, the API may return a deployReason code.
| Reason | API value (deployReason) | Description |
|---|---|---|
| Return in Progress | RETURN_IN_PROGRESS | A return is in progress while the item is on hold. Also valid when deployStatus is DEPLOYED. |
Comments
0 comments
Please sign in to leave a comment.