Skip to content

Create an asset unit

Assets module

POST/asset-unitsassetUnits.create

An individual asset tracked by serial or asset tag (unit grain), with a nine-value lifecycle. Creates an asset unit. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requires the capability assets.asset.write.
  • OAuth scopes: assets.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: AssetUnitCreate

assetUnits.create: AssetUnitCreate
FieldTypeRequiredDescription
asset_class_idstring (uuid)YesIdentifier of the asset class.
asset_tagstringYesAsset tag (a code that is ours).Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
condition_enum_idstring | nullNoCondition: a row of the canon Asset Condition enumeration.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
home_venue_idstring (uuid) | nullNoIdentifier of the venue the unit returns to.
{
  "asset_class_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "asset_tag": "NWL-TR-0042",
  "condition_enum_id": "ENM-017",
  "home_venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Response 201: AssetUnit

assetUnits.create: AssetUnit
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the asset unit.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
asset_class_idstring (uuid)YesIdentifier of the asset class.
asset_tagstringYesAsset tag (a code that is ours).Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
asset_state"Proposed" | "Received" | "Available" | "Reserved" | "Deployed" | "In Maintenance" | "Damaged" | "Lost" | "Retired"YesAsset lifecycle state.
condition_enum_idstring | nullYesCondition: a row of the canon Asset Condition enumeration.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
home_venue_idstring (uuid) | nullYesIdentifier of the venue the unit returns to.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "asset_class_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "asset_tag": "NWL-TR-0042",
  "asset_state": "Available",
  "condition_enum_id": "ENM-017",
  "home_venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

curl -X POST "$XOS_BASE_URL/asset-units" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"asset_class_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","asset_tag":"NWL-TR-0042","condition_enum_id":"ENM-017","home_venue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'
const { data } = await xos.assetUnits.create({
    "asset_class_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "asset_tag": "NWL-TR-0042",
    "condition_enum_id": "ENM-017",
    "home_venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });
response = xos.asset_units.create({"asset_class_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "asset_tag": "NWL-TR-0042", "condition_enum_id": "ENM-017", "home_venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})
xos asset-units create --data '{"asset_class_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","asset_tag":"NWL-TR-0042","condition_enum_id":"ENM-017","home_venue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'