ITADSHIPMENT: ITAD Shipment
Collection and secure transport of IT assets for disposition processing, tracking chain of custody and compliance.
Default definition. This article describes the default
ITADSHIPMENT definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches ITADSHIPMENT.Entity properties
| Property | Value |
|---|---|
| Entity code | ITADSHIPMENT |
| Display name | ITAD Shipment |
| Plural | ITAD Shipments |
| Level | 50650 |
Use cases
ITADSHIPMENT tracks the physical movement of assets from collection site to processing facility. Each shipment belongs to an ITADORDER via comboKey SUB|ITADORDER. The status workflow is scheduled → collected → in-transit → delivered → confirmed.
Fields
Shipment Details
| Field | Type | Required | Notes |
|---|---|---|---|
ref | text | Ref. | |
name | text | Yes | Shipment Reference. |
project | reference → ITADORDER | Yes | Disposition Order. |
status | enum | Yes | Valid ids: scheduled (Scheduled), collected (Collected), inTransit (In Transit), delivered (Delivered), confirmed (Confirmed). |
collectionDate | date | Collection Date. | |
deliveryDate | date | Delivery Date. | |
collectionSite | reference → SITE | Collection Site. | |
deliverySite | text | Processing facility name and address | |
carrier | text | Carrier. | |
vehicleRef | text | Vehicle Registration. | |
trackingRef | text | Tracking Reference. |
Contents
| Field | Type | Required | Notes |
|---|---|---|---|
assetCount | number | Asset Count. | |
totalWeightKg | number | Total Weight (kg). | |
palletCount | number | Pallet Count. | |
containerCount | number | Container Count. | |
manifestRef | text | Packing list or manifest document reference | |
sealNumber | text | Tamper-evident seal number for chain of custody | |
notes | text (multi-line) | Notes. |
Security
| Field | Type | Required | Notes |
|---|---|---|---|
secureContainer | enum | Valid ids: yes (Yes), no (No). | |
gpsTracked | enum | Valid ids: yes (Yes), no (No). | |
securityClearedPersonnel | enum | Valid ids: yes (Yes), no (No), na (N/A). |
Hazardous Goods
| Field | Type | Required | Notes |
|---|---|---|---|
hazardousGoods | enum | Valid ids: yes (Yes), no (No). | |
hazardousDescription | text (multi-line) | Hazardous Description. | |
adrCompliant | enum | Valid ids: yes (Yes), no (No), exempt (Exempt (small quantities)). | |
wasteTransferNote | text | Consignment note reference for hazardous waste |
Relationships
- Lookups:
projectpoints at aITADORDERrecord;collectionSitepoints at aSITErecord.
Creating a ITAD Shipment via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "ITADSHIPMENT",
"level": 50650,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example",
"project": "",
"status": "scheduled",
"ref": "..."
}
Listing ITAD Shipments
# All records in your tenant
GET /v1/entities/ITADSHIPMENT/SUB:<your-sub-id>