Download OpenAPI specification:Download
API for managing asset part unit storage operations
Retrieve a list of all asset part unit storage records with optional filtering and pagination
| limit | integer [ 1 .. 100 ] Default: 50 Maximum number of records to return |
| offset | integer >= 0 Default: 0 Number of records to skip for pagination |
| sort | string Field to sort by |
| order | string Default: "desc" Enum: "asc" "desc" Sort order (asc or desc) |
| filter | string Filter conditions in JSON format |
| search | string Search term for text fields |
{- "success": true,
- "data": [
- {
- "_id": "60f7b1b3e4b0e8b3f8b3f8b3",
- "storageNumber": "STR-2023-001",
- "assetPartUnit": "60f7b1b3e4b0e8b3f8b3f8b4",
- "serialNumber": "SN-EP001-2023-001",
- "storageType": "inventory",
- "storageReason": "New inventory received",
- "storedBy": "60f7b1b3e4b0e8b3f8b3f8b5",
- "authorizedBy": "60f7b1b3e4b0e8b3f8b3f8b6",
- "storageDate": "2023-01-15T10:00:00Z",
- "expectedRetrievalDate": "2023-06-15T10:00:00Z",
- "location": {
- "warehouse": "string",
- "section": "string",
- "shelf": "string",
- "position": "string",
- "bin": "string",
- "coordinates": {
- "x": 0,
- "y": 0,
- "z": 0
}
}, - "status": "stored",
- "condition": "new",
- "storageEnvironment": {
- "temperature": {
- "min": 0,
- "max": 0,
- "unit": "celsius"
}, - "humidity": {
- "min": 0,
- "max": 0
}, - "specialRequirements": [
- "dry"
]
}, - "preservationMethod": "none",
- "lastInspectionDate": "2019-08-24T14:15:22Z",
- "nextInspectionDate": "2019-08-24T14:15:22Z",
- "reservedFor": {
- "workOrder": "string",
- "asset": "string",
- "project": "string",
- "reservationDate": "2019-08-24T14:15:22Z",
- "reservedBy": "string"
}, - "tags": [
- "string"
], - "barcode": "string",
- "qrCode": "string",
- "weight": 0,
- "dimensions": {
- "length": 0,
- "width": 0,
- "height": 0,
- "unit": "mm"
}, - "storageHistory": [
- {
- "date": "2019-08-24T14:15:22Z",
- "action": "stored",
- "performedBy": "string",
- "fromLocation": "string",
- "toLocation": "string",
- "notes": "string"
}
], - "notes": "string",
- "metadata": { },
- "createdAt": "2023-01-15T08:00:00Z",
- "updatedAt": "2023-01-15T10:30:00Z"
}
], - "total": 0
}Create a new asset part unit storage record with the provided data
| storageNumber required | string Unique storage number |
| assetPartUnit required | string Asset part unit ID being stored |
| serialNumber | string Serial number of the part unit |
| storageType required | string Enum: "inventory" "spare" "buffer" "quarantine" "maintenance" Type of storage |
| storageReason | string Reason for storage |
| storedBy required | string User who stored the part |
| authorizedBy | string User who authorized the storage |
| storageDate | string <date-time> Date when the part was stored |
| expectedRetrievalDate | string <date-time> Expected retrieval date |
required | object |
| status | string Default: "stored" Enum: "stored" "reserved" "allocated" "picked" "expired" Current storage status |
| condition | string Enum: "new" "good" "fair" "poor" "damaged" Condition when stored |
object | |
| preservationMethod | string Default: "none" Enum: "none" "plastic-wrap" "desiccant" "vacuum-seal" "oil-coating" Preservation method used |
| lastInspectionDate | string <date-time> Last inspection date |
| nextInspectionDate | string <date-time> Next scheduled inspection date |
object | |
| tags | Array of strings Storage tags for categorization |
| barcode | string Storage barcode |
| qrCode | string Storage QR code |
| weight | number <double> >= 0 Weight of the stored item |
object | |
| notes | string Additional notes |
object Additional metadata |
{- "storageNumber": "STR-2023-001",
- "assetPartUnit": "60f7b1b3e4b0e8b3f8b3f8b4",
- "serialNumber": "SN-EP001-2023-001",
- "storageType": "inventory",
- "storageReason": "New inventory received",
- "storedBy": "60f7b1b3e4b0e8b3f8b3f8b5",
- "authorizedBy": "60f7b1b3e4b0e8b3f8b3f8b6",
- "storageDate": "2023-01-15T10:00:00Z",
- "expectedRetrievalDate": "2023-06-15T10:00:00Z",
- "location": {
- "warehouse": "string",
- "section": "string",
- "shelf": "string",
- "position": "string",
- "bin": "string",
- "coordinates": {
- "x": 0,
- "y": 0,
- "z": 0
}
}, - "status": "stored",
- "condition": "new",
- "storageEnvironment": {
- "temperature": {
- "min": 0,
- "max": 0,
- "unit": "celsius"
}, - "humidity": {
- "min": 0,
- "max": 0
}, - "specialRequirements": [
- "dry"
]
}, - "preservationMethod": "none",
- "lastInspectionDate": "2019-08-24T14:15:22Z",
- "nextInspectionDate": "2019-08-24T14:15:22Z",
- "reservedFor": {
- "workOrder": "string",
- "asset": "string",
- "project": "string",
- "reservationDate": "2019-08-24T14:15:22Z",
- "reservedBy": "string"
}, - "tags": [
- "string"
], - "barcode": "string",
- "qrCode": "string",
- "weight": 0,
- "dimensions": {
- "length": 0,
- "width": 0,
- "height": 0,
- "unit": "mm"
}, - "notes": "string",
- "metadata": { }
}{- "success": true,
- "data": {
- "_id": "60f7b1b3e4b0e8b3f8b3f8b3",
- "storageNumber": "STR-2023-001",
- "assetPartUnit": "60f7b1b3e4b0e8b3f8b3f8b4",
- "serialNumber": "SN-EP001-2023-001",
- "storageType": "inventory",
- "storageReason": "New inventory received",
- "storedBy": "60f7b1b3e4b0e8b3f8b3f8b5",
- "authorizedBy": "60f7b1b3e4b0e8b3f8b3f8b6",
- "storageDate": "2023-01-15T10:00:00Z",
- "expectedRetrievalDate": "2023-06-15T10:00:00Z",
- "location": {
- "warehouse": "string",
- "section": "string",
- "shelf": "string",
- "position": "string",
- "bin": "string",
- "coordinates": {
- "x": 0,
- "y": 0,
- "z": 0
}
}, - "status": "stored",
- "condition": "new",
- "storageEnvironment": {
- "temperature": {
- "min": 0,
- "max": 0,
- "unit": "celsius"
}, - "humidity": {
- "min": 0,
- "max": 0
}, - "specialRequirements": [
- "dry"
]
}, - "preservationMethod": "none",
- "lastInspectionDate": "2019-08-24T14:15:22Z",
- "nextInspectionDate": "2019-08-24T14:15:22Z",
- "reservedFor": {
- "workOrder": "string",
- "asset": "string",
- "project": "string",
- "reservationDate": "2019-08-24T14:15:22Z",
- "reservedBy": "string"
}, - "tags": [
- "string"
], - "barcode": "string",
- "qrCode": "string",
- "weight": 0,
- "dimensions": {
- "length": 0,
- "width": 0,
- "height": 0,
- "unit": "mm"
}, - "storageHistory": [
- {
- "date": "2019-08-24T14:15:22Z",
- "action": "stored",
- "performedBy": "string",
- "fromLocation": "string",
- "toLocation": "string",
- "notes": "string"
}
], - "notes": "string",
- "metadata": { },
- "createdAt": "2023-01-15T08:00:00Z",
- "updatedAt": "2023-01-15T10:30:00Z"
}
}Retrieve a specific asset part unit storage record by its ID
| id required | string Asset part unit storage record ID |
{- "success": true,
- "data": {
- "_id": "60f7b1b3e4b0e8b3f8b3f8b3",
- "storageNumber": "STR-2023-001",
- "assetPartUnit": "60f7b1b3e4b0e8b3f8b3f8b4",
- "serialNumber": "SN-EP001-2023-001",
- "storageType": "inventory",
- "storageReason": "New inventory received",
- "storedBy": "60f7b1b3e4b0e8b3f8b3f8b5",
- "authorizedBy": "60f7b1b3e4b0e8b3f8b3f8b6",
- "storageDate": "2023-01-15T10:00:00Z",
- "expectedRetrievalDate": "2023-06-15T10:00:00Z",
- "location": {
- "warehouse": "string",
- "section": "string",
- "shelf": "string",
- "position": "string",
- "bin": "string",
- "coordinates": {
- "x": 0,
- "y": 0,
- "z": 0
}
}, - "status": "stored",
- "condition": "new",
- "storageEnvironment": {
- "temperature": {
- "min": 0,
- "max": 0,
- "unit": "celsius"
}, - "humidity": {
- "min": 0,
- "max": 0
}, - "specialRequirements": [
- "dry"
]
}, - "preservationMethod": "none",
- "lastInspectionDate": "2019-08-24T14:15:22Z",
- "nextInspectionDate": "2019-08-24T14:15:22Z",
- "reservedFor": {
- "workOrder": "string",
- "asset": "string",
- "project": "string",
- "reservationDate": "2019-08-24T14:15:22Z",
- "reservedBy": "string"
}, - "tags": [
- "string"
], - "barcode": "string",
- "qrCode": "string",
- "weight": 0,
- "dimensions": {
- "length": 0,
- "width": 0,
- "height": 0,
- "unit": "mm"
}, - "storageHistory": [
- {
- "date": "2019-08-24T14:15:22Z",
- "action": "stored",
- "performedBy": "string",
- "fromLocation": "string",
- "toLocation": "string",
- "notes": "string"
}
], - "notes": "string",
- "metadata": { },
- "createdAt": "2023-01-15T08:00:00Z",
- "updatedAt": "2023-01-15T10:30:00Z"
}
}Update an existing asset part unit storage record with new data
| id required | string Asset part unit storage record ID |
| storageNumber required | string Unique storage number |
| assetPartUnit required | string Asset part unit ID being stored |
| serialNumber | string Serial number of the part unit |
| storageType required | string Enum: "inventory" "spare" "buffer" "quarantine" "maintenance" Type of storage |
| storageReason | string Reason for storage |
| storedBy required | string User who stored the part |
| authorizedBy | string User who authorized the storage |
| storageDate | string <date-time> Date when the part was stored |
| expectedRetrievalDate | string <date-time> Expected retrieval date |
required | object |
| status | string Default: "stored" Enum: "stored" "reserved" "allocated" "picked" "expired" Current storage status |
| condition | string Enum: "new" "good" "fair" "poor" "damaged" Condition when stored |
object | |
| preservationMethod | string Default: "none" Enum: "none" "plastic-wrap" "desiccant" "vacuum-seal" "oil-coating" Preservation method used |
| lastInspectionDate | string <date-time> Last inspection date |
| nextInspectionDate | string <date-time> Next scheduled inspection date |
object | |
| tags | Array of strings Storage tags for categorization |
| barcode | string Storage barcode |
| qrCode | string Storage QR code |
| weight | number <double> >= 0 Weight of the stored item |
object | |
| notes | string Additional notes |
object Additional metadata |
{- "storageNumber": "STR-2023-001",
- "assetPartUnit": "60f7b1b3e4b0e8b3f8b3f8b4",
- "serialNumber": "SN-EP001-2023-001",
- "storageType": "inventory",
- "storageReason": "New inventory received",
- "storedBy": "60f7b1b3e4b0e8b3f8b3f8b5",
- "authorizedBy": "60f7b1b3e4b0e8b3f8b3f8b6",
- "storageDate": "2023-01-15T10:00:00Z",
- "expectedRetrievalDate": "2023-06-15T10:00:00Z",
- "location": {
- "warehouse": "string",
- "section": "string",
- "shelf": "string",
- "position": "string",
- "bin": "string",
- "coordinates": {
- "x": 0,
- "y": 0,
- "z": 0
}
}, - "status": "stored",
- "condition": "new",
- "storageEnvironment": {
- "temperature": {
- "min": 0,
- "max": 0,
- "unit": "celsius"
}, - "humidity": {
- "min": 0,
- "max": 0
}, - "specialRequirements": [
- "dry"
]
}, - "preservationMethod": "none",
- "lastInspectionDate": "2019-08-24T14:15:22Z",
- "nextInspectionDate": "2019-08-24T14:15:22Z",
- "reservedFor": {
- "workOrder": "string",
- "asset": "string",
- "project": "string",
- "reservationDate": "2019-08-24T14:15:22Z",
- "reservedBy": "string"
}, - "tags": [
- "string"
], - "barcode": "string",
- "qrCode": "string",
- "weight": 0,
- "dimensions": {
- "length": 0,
- "width": 0,
- "height": 0,
- "unit": "mm"
}, - "notes": "string",
- "metadata": { }
}{- "success": true,
- "data": {
- "_id": "60f7b1b3e4b0e8b3f8b3f8b3",
- "storageNumber": "STR-2023-001",
- "assetPartUnit": "60f7b1b3e4b0e8b3f8b3f8b4",
- "serialNumber": "SN-EP001-2023-001",
- "storageType": "inventory",
- "storageReason": "New inventory received",
- "storedBy": "60f7b1b3e4b0e8b3f8b3f8b5",
- "authorizedBy": "60f7b1b3e4b0e8b3f8b3f8b6",
- "storageDate": "2023-01-15T10:00:00Z",
- "expectedRetrievalDate": "2023-06-15T10:00:00Z",
- "location": {
- "warehouse": "string",
- "section": "string",
- "shelf": "string",
- "position": "string",
- "bin": "string",
- "coordinates": {
- "x": 0,
- "y": 0,
- "z": 0
}
}, - "status": "stored",
- "condition": "new",
- "storageEnvironment": {
- "temperature": {
- "min": 0,
- "max": 0,
- "unit": "celsius"
}, - "humidity": {
- "min": 0,
- "max": 0
}, - "specialRequirements": [
- "dry"
]
}, - "preservationMethod": "none",
- "lastInspectionDate": "2019-08-24T14:15:22Z",
- "nextInspectionDate": "2019-08-24T14:15:22Z",
- "reservedFor": {
- "workOrder": "string",
- "asset": "string",
- "project": "string",
- "reservationDate": "2019-08-24T14:15:22Z",
- "reservedBy": "string"
}, - "tags": [
- "string"
], - "barcode": "string",
- "qrCode": "string",
- "weight": 0,
- "dimensions": {
- "length": 0,
- "width": 0,
- "height": 0,
- "unit": "mm"
}, - "storageHistory": [
- {
- "date": "2019-08-24T14:15:22Z",
- "action": "stored",
- "performedBy": "string",
- "fromLocation": "string",
- "toLocation": "string",
- "notes": "string"
}
], - "notes": "string",
- "metadata": { },
- "createdAt": "2023-01-15T08:00:00Z",
- "updatedAt": "2023-01-15T10:30:00Z"
}
}Delete an existing asset part unit storage record
| id required | string Asset part unit storage record ID |
{- "success": true,
- "message": "Asset part unit storage record deleted successfully"
}