Saltar al contenido

Create an asset identifier

Módulo Assets

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.

  • Requiere la capacidad assets.asset.write.
  • Alcances de OAuth: assets.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: AssetIdentifierCreate

assetIdentifiers.create: AssetIdentifierCreate
CampoTipoObligatorioDescripción
asset_unit_idstring (uuid)SíIdentifier of the asset unit.
valuestringSíIdentifier value.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
schemestringSíScheme, such as serial, gtin14 or mpn.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
{
  "asset_unit_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "value": "00012345678905",
  "scheme": "serial"
}

Respuesta 201: AssetIdentifier

assetIdentifiers.create: AssetIdentifier
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the asset identifier.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
asset_unit_idstring (uuid)SíIdentifier of the asset unit.
identifier_classstringSíIdentifier class.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
valuestringSíIdentifier value.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
schemestringSíScheme, such as serial, gtin14 or mpn.Restricciones: 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"
}

Ejemplos de código

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"}'