Artículos

El endpoint de Artículos gestiona su catálogo de partes — la lista maestra de todo lo que almacena, rastrea o vende. Los artículos se identifican por un shortID (su SKU o cadena de número de parte) y un partNo interno (entero auto-asignado).

El Objeto Artículo

{
  "partNo": 42,
  "shortID": "BOLT-M8-30",
  "description": "Hex Bolt M8x30mm",
  "category": 5,
  "subCategory": 12,
  "uOM": "EA",
  "putUp": "Box/100",
  "units": 1.0,
  "dfltOwner": 0,
  "created": "2024-03-15T10:30:00Z",
  "modified": "2025-01-20T14:22:00Z",
  "discontinued": false
}

Endpoints

Listar Artículos

GET /Item?page=1&pageSize=25

Devuelve artículos activos (no descontinuados), ordenados por ShortID.

Parámetros

Aplican los parámetros de paginación estándar.

Respuesta

{
  "value": [
    {
      "partNo": 42,
      "shortID": "BOLT-M8-30",
      "description": "Hex Bolt M8x30mm",
      "category": 5,
      "subCategory": 12,
      "uOM": "EA",
      "putUp": "Box/100",
      "units": 1.0,
      "dfltOwner": 0,
      "created": "2024-03-15T10:30:00Z",
      "modified": "2025-01-20T14:22:00Z",
      "discontinued": false
    }
  ],
  "totalCount": 2340,
  "page": 1,
  "pageSize": 25,
  "pageCount": 94,
  "hasMore": true
}

Cada artículo en value contiene los campos documentados en El Objeto Artículo anterior.

Listar Todos los Articulos (Incluyendo Descontinuados)

GET /Item/All?page=1&pageSize=25

Igual que la lista estándar, pero incluye artículos descontinuados. Use esto cuando necesite una exportaci\u00f3n completa del catálogo.

Obtener Articulo por ShortID

GET /Item?key=BOLT-M8-30&type=id

Devuelve el registro completo del artículo para el ShortID dado. Devuelve 404 si no se encuentra.

Obtener Articulo por Alias

GET /Item?key=ALT-BOLT-M8&type=alias

Busca un artículo usando un alias (número de parte alternativo). Devuelve el artículo al que apunta el alias. Devuelve 404 si el alias no existe.

Obtener Articulos por Categoria

GET /Item?Category=5

Devuelve todos los artículos en la categoría dada. Este endpoint devuelve un arreglo plano (sin paginaci\u00f3n).

Crear un Articulo

POST /Item

Cuerpo de la Solicitud

{
  "shortID": "BOLT-M8-30",
  "description": "Hex Bolt M8x30mm",
  "uOM": "EA",
  "category": 5,
  "putUp": "Box/100"
}

El cuerpo de la solicitud acepta los mismos campos que el Objeto Artículo. Solo shortID es obligatorio — incluya los demás campos que desee establecer.

Campos Obligatorios

Campos Opcionales

Respuesta

{
  "shortID": "BOLT-M8-30",
  "status": "created"
}

Casos de Error

Actualizar un Articulo

PUT /Item

Actualiza un artículo existente. Solo los campos que incluye en el cuerpo de la solicitud se modifican — los campos omitidos permanecen sin cambios.

Cuerpo de la Solicitud

{
  "shortID": "BOLT-M8-30",
  "description": "Hex Bolt M8x30mm Zinc Plated"
}

shortID es obligatorio para identificar que artículo actualizar. El ShortID en si no puede cambiarse.

Campos Inmutables

Estos campos se preservan sin importar lo que envíe:

• partNo — ID interno, nunca cambia
• shortID — identifica el artículo, no puede renombrarse
• created / createdBy — auditoría de creaci\u00f3n original

Respuesta

{
  "shortID": "BOLT-M8-30",
  "status": "updated"
}

Casos de Error

Descontinuar un Articulo

DELETE /Item/BOLT-M8-30

Marca el artículo como descontinuado. El artículo permanece en el sistema (para datos históricos) pero no aparecerá en la lista predeterminada de artículos activos.

Esto no elimina registros de inventario — es una eliminaci\u00f3n lógica.

Respuesta

{
  "shortID": "BOLT-M8-30",
  "status": "discontinued"
}

Casos de Error

Permisos