Resolve a scanned asset

Assets module

POST/asset-units/scanassetUnits.scan

Resolves a scanned barcode, QR or NFC payload to an asset unit. An unknown code returns a 422 `NO_ANSWER` refusal. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requires the capability assets.asset.read.
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: ScanRequest

assetUnits.scan: ScanRequest
Field	Type	Required	Description
code	string	Yes	Scanned barcode, QR or NFC payload.Constraints: length 1 to any
symbology	string	Yes	Symbology of the scan.Constraints: length 1 to any

{
  "code": "NWL-TR-0042",
  "symbology": "code128"
}

Response 200: AssetUnit

assetUnits.scan: AssetUnit
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the asset unit.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
asset_class_id	string (uuid)	Yes	Identifier of the asset class.
asset_tag	string	Yes	Asset 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"	Yes	Asset lifecycle state.
condition_enum_id	string \| null	Yes	Condition: a row of the canon Asset Condition enumeration.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
home_venue_id	string (uuid) \| null	Yes	Identifier 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/scan" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"code":"NWL-TR-0042","symbology":"code128"}'

const { data } = await xos.assetUnits.scan({
    "code": "NWL-TR-0042",
    "symbology": "code128"
  });

response = xos.asset_units.scan({"code": "NWL-TR-0042", "symbology": "code128"})

xos asset-units scan --data '{"code":"NWL-TR-0042","symbology":"code128"}'