Skip to main content

Get Hardware in Storage

Retrieves a list of all hardware items currently in storage for a specific company.

Authentication

This endpoint requires authentication. See Authentication for details.

Filters

PropertyTypeRequiredDescription
companyCodestringYesCompany code for one of your managed companies
countryCodestringNoFilter hardware by country in ISO 3166-1 alpha-2 format

Request

Production URL: https://orchestrator.tecspal.com/
Sandbox URL: https://tecspal-orchestrator.sandbox.lexartlabs.uy/
Endpoint: GET /hardwares/storages

Example Request

{
"filters": {
"companyCode": "DM1",
"countryCode": "UY"
},
"request": "hardwares/storages",
"vendor": "tecspal",
"verb": "GET"
}

Response Schema

PropertyTypeDescription
statusCodenumberHTTP status code of the response
messagestringDescription of the response status
enveloparrayArray containing the list of hardware items in storage

Hardware Properties

PropertyTypeDescription
idstringUnique identifier of the hardware item
descriptionstringDescription of the hardware item
serialNumberstringSerial number of the hardware item
brandstringBrand of the hardware item
namestringName of the device (e.g., MacBook Pro)
ramstringRAM size (if applicable, e.g., laptops)
diskSpacestringDisk space (if applicable)
displaySizestringDisplay size (if applicable)
processorstringProcessor info (if applicable)
imagestringURL of the hardware image
dateBoughtstringDate when the hardware was purchased (ISO 8601 format)
countryCodestringISO 3166-1 alpha-2 country code (e.g., "UY")
statusstringStatus of the hardware: "EMPLOYEE" or "STORAGE"
newHardwarebooleanIndicates if the hardware is new or used
externalReferencestring | nullExternal reference identifier (if any)
factoryResetbooleanIndicates if the device has been factory reset
damagedbooleanIndicates if the hardware is damaged
costnumber | nullCost of the hardware
costCurrencystringCurrency code (e.g., "USD")
companyNamestringName of the company that owns the hardware
hardwareNotearrayNotes associated with the hardware item

hardwareNote Properties

PropertyTypeDescription
contentstringNote content
createdAtstringDate and time when the note was created
userobjectInformation about the user who made the note

user (inside hardwareNote) Properties

PropertyTypeDescription
emailstringEmail of the note creator

Example Response

{
"envelop": [
{
"id": "37ada72c-8daa-4c93-b704-b21433cbb2db",
"createdAt": "2024-10-24T16:20:49.460Z",
"updatedAt": "2024-10-24T16:20:49.460Z",
"brand": null,
"serialNumber": "1247102",
"description": "Good headphones",
"dateBought": "2024-10-24T16:20:49.460Z",
"countryCode": "UY",
"status": "STORAGE",
"companyId": "10ff1eb4-0d6d-4d9f-a2bf-ec0cab7bb793",
"newHardware": false,
"externalReference": null,
"createdThrough": null,
"createdOrderId": null,
"createdUserId": null,
"company": {
"id": "10ff1eb4-0d6d-4d9f-a2bf-ec0cab7bb793",
"name": "Larian Studios"
},
"commonModel": {
"name": "MacBook Pro",
"ram": "16GB",
"displaySize": "16 inch",
"diskSpace": "512GB",
"processor": "M1 Pro",
"image": "https://a-us.storyblok.com/f/1001855/789x500/82ee51ba4d/macbook-pro-16.png"
},
"hardwareType": {
"name": "HEADPHONES",
"image": "https://a-us.storyblok.com/f/1001855/800x800/eacb7e6f4f/headphones.png"
},
"hardwareNote": [
{
"content": "This device was received in excellent condition. No visible marks or scratches.",
"createdAt": "2024-10-24T16:20:49.475Z",
"user": {
"email": "larian@tecspal.com"
}
},
{
"content": "The device was returned once by an employee due to connectivity issues. After a thorough check, no problems were found. It might be an issue on the user's end.",
"createdAt": "2024-10-24T16:20:49.475Z",
"user": {
"email": "superadmin@tecspal.com"
}
}
],
"inMovement": false
},
{
"id": "d8825603-fc99-4313-bdb9-7c78ff44cf36",
"createdAt": "2024-10-24T20:21:58.934Z",
"updatedAt": "2024-10-24T20:21:58.934Z",
"brand": null,
"serialNumber": "",
"description": null,
"dateBought": "2024-10-24T00:00:00.000Z",
"countryCode": "UY",
"status": "STORAGE",
"companyId": "10ff1eb4-0d6d-4d9f-a2bf-ec0cab7bb793",
"newHardware": true,
"externalReference": null,
"createdThrough": "ORDER",
"createdOrderId": "505f0501-5a41-499e-a284-162965b6c0d4",
"createdUserId": null,
"company": {
"id": "10ff1eb4-0d6d-4d9f-a2bf-ec0cab7bb793",
"name": "Larian Studios"
},
"commonModel": null,
"hardwareType": {
"name": "HEADPHONES",
"image": "https://a-us.storyblok.com/f/1001855/800x800/eacb7e6f4f/headphones.png"
},
"hardwareNote": [],
"inMovement": false
}
],
"message": "Request successful",
"statusCode": 200
}

Error Responses

Bad Request (400)

{
"error": "Bad Request",
"message": "Missing required filter: companyCode",
"statusCode": 400
}

Unauthorized (401)

{
"error": "Unauthorized",
"message": "Unauthorized access",
"statusCode": 401
}

Notes

  • This endpoint only returns hardware items with status "STORAGE"
  • New hardware items from orders may have empty serial numbers until they are updated
  • The hardwareNote array contains historical notes about the hardware item
  • Hardware items created through orders will have the createdThrough field set to "ORDER"
  • The inMovement flag indicates if the hardware is currently part of an active movement request