Create an asset identifier
Assets module
POST/asset-identifiersassetIdentifiers.create
An external identifier recorded against an asset unit, such as a GTIN or an NFC tag. Creates an asset identifier. 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: AssetIdentifierCreate
| Field | Type | Required | Description |
|---|---|---|---|
| asset_unit_id | string (uuid) | Yes | Identifier of the asset unit. |
| value | string | Yes | Identifier value.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| scheme | string | Yes | Scheme, such as serial, gtin14 or mpn.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
{
"asset_unit_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"value": "00012345678905",
"scheme": "serial"
}Response 201: AssetIdentifier
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the asset identifier. |
| 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_unit_id | string (uuid) | Yes | Identifier of the asset unit. |
| identifier_class | string | Yes | Identifier class.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| value | string | Yes | Identifier value.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| scheme | string | Yes | Scheme, such as serial, gtin14 or mpn.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
{
"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_unit_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"identifier_class": "gtin",
"value": "00012345678905",
"scheme": "serial"
}Code samples
curl -X POST "$XOS_BASE_URL/asset-identifiers" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"asset_unit_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","value":"00012345678905","scheme":"serial"}'const { data } = await xos.assetIdentifiers.create({
"asset_unit_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"value": "00012345678905",
"scheme": "serial"
});response = xos.asset_identifiers.create({"asset_unit_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "value": "00012345678905", "scheme": "serial"})xos asset-identifiers create --data '{"asset_unit_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","value":"00012345678905","scheme":"serial"}'