Catálogo e inventario

Artículo

El artículo, tal como lo devuelve la API.

Esquemas: ItemDto, ItemDetailDto

{
  "id": "id_8f2a1c",
  "name": "Example",
  "sku": "string",
  "description": "string",
  "orderInfo": "string",
  "ean": "string",
  "itemType": "fixed",
  "stockCalculationMethod": "bulk",
  "collectionId": "string",
  "collectionName": "Example",
  "images": [
    "string"
  ],
  "salePrice": "1234.50",
  "depositValue": "1234.50",
  "minStock": 1,
  "serializedItemsCount": 1,
  "pricingSettings": {
    "type": "periodPrice",
    "price": "1234.50",
    "period": "hour"
  },
  "insuranceEnabled": true,
  "discountEnabled": true,
  "bufferBefore": 1,
  "bufferBeforeUnit": "hour",
  "bufferAfter": 1,
  "bufferAfterUnit": "hour",
  "physicalProperties": {
    "weight": 1,
    "width": 1,
    "height": 1,
    "length": 1,
    "volume": 1,
    "current": 1,
    "power": 1
  },
  "variants": [
    {
      "variantId": "string",
      "variantName": "Example",
      "variantPrice": "1234.50",
      "salePrice": "1234.50",
      "ean": "string"
    }
  ],
  "tags": [
    {
      "id": "id_8f2a1c",
      "name": "Example"
    }
  ],
  "customFields": {
    "key": "string"
  },
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z",
  "replacementValue": "1234.50",
  "accessoryIds": [
    "string"
  ],
  "alternativeIds": [
    "string"
  ]
}

Generado a partir del esquema

Un equipo del catálogo, con su SKU, precios, márgenes, variantes, propiedades físicas y la colección a la que pertenece. Cada artículo puede tener unidades serializadas físicas. Los artículos están acotados a la suscripción que posee la clave. El SKU es opcional al crear: el servidor asigna el siguiente disponible. La lectura de detalle, GET /api/v1/items/{itemId}, añade el valor de reposición y los identificadores de los accesorios y alternativas.

Atributos

idstring

Identificador único del artículo.

namestring

Nombre del artículo.

skustring | null

Referencia SKU del artículo; null si no consta.

descriptionstring | null

Descripción del artículo; null si no consta.

orderInfostring | null

Información adicional del pedido (notas de preparación y entrega); null si no consta.

eanstring | null

EAN/código de barras; null si no consta.

itemTypestring

Tipo de artículo: fixed (artículo simple) o variant (artículo con variantes).

Opciones disponibles: fixed, variant

stockCalculationMethodstring

Método de cálculo del stock: bulk (a granel, por cantidad) o serialized (por artículos serializados).

Opciones disponibles: bulk, serialized

collectionIdstring | null

Identificador de la colección a la que pertenece; null si no está en ninguna.

collectionNamestring | null

Nombre de la colección a la que pertenece; null si no está en ninguna.

imagesstring[]

URLs de las imágenes del artículo.

salePricestring | null

Precio de venta como cadena decimal "1234.50" (ROUND_HALF_UP); null si no tiene.

Límites: patrón ^-?\d+\.\d{2}$

depositValuestring | null

Importe de la fianza como cadena decimal "1234.50" (ROUND_HALF_UP); null si no tiene.

Límites: patrón ^-?\d+\.\d{2}$

minStocknumber | null

Stock mínimo configurado para las alertas; null si no está configurado.

serializedItemsCountnumber

Número de unidades serializadas registradas del artículo.

pricingSettingsobject | null

Configuración de precios de alquiler; null si no está configurada.

Mostrar atributos hijos

pricingSettings.typestring | null

Modo de precio: periodPrice (precio por periodo), fixedPrice (precio fijo) o pricingStructure (estructura de precios); null si el artículo no tiene ninguno configurado.

Opciones disponibles: periodPrice, fixedPrice, pricingStructure

pricingSettings.pricestring | null

Precio base de alquiler como cadena decimal "1234.50" (ROUND_HALF_UP); null si no aplica.

Límites: patrón ^-?\d+\.\d{2}$

pricingSettings.periodstring | null

Unidad de periodo del precio: hour, day, week o month; null si el artículo no tiene ninguna configurada.

Opciones disponibles: hour, day, week, month

insuranceEnabledboolean

Si el artículo admite seguro.

discountEnabledboolean

Si el artículo admite descuentos.

bufferBeforenumber | null

Tiempo de margen reservado antes del alquiler; null si no aplica.

bufferBeforeUnitstring | null

Unidad del margen previo: hora o día; null si no aplica.

Opciones disponibles: hour, day

bufferAfternumber | null

Tiempo de margen reservado después del alquiler; null si no aplica.

bufferAfterUnitstring | null

Unidad del margen posterior: hour o day; null si no aplica.

Opciones disponibles: hour, day

physicalPropertiesobject | null

Propiedades físicas (peso y dimensiones); null si no se han registrado.

Mostrar atributos hijos

physicalProperties.weightnumber | null

Peso del artículo en kilogramos; null si no está registrado.

physicalProperties.widthnumber | null

Ancho del artículo en centímetros; null si no está registrado.

physicalProperties.heightnumber | null

Altura del artículo en centímetros; null si no consta.

physicalProperties.lengthnumber | null

Longitud del artículo en centímetros; null si no consta.

physicalProperties.volumenumber | null

Volumen del artículo en metros cúbicos (m³); null si no está registrado.

physicalProperties.currentnumber | null

Consumo de corriente en amperios; null si no consta.

physicalProperties.powernumber | null

Potencia en vatios; null si no se ha registrado.

variantsobject[]

Variantes del artículo (vacío si el artículo es de tipo fixed).

Mostrar atributos hijos

variants.variantIdstring

Identificador único de la variante.

variants.variantNamestring

Nombre de la variante.

variants.variantPricestring

Precio de alquiler de la variante como cadena decimal "1234.50" (ROUND_HALF_UP).

Límites: patrón ^-?\d+\.\d{2}$

variants.salePricestring | null

Precio de venta de la variante como cadena decimal "1234.50" (ROUND_HALF_UP); null si no tiene.

Límites: patrón ^-?\d+\.\d{2}$

variants.eanstring | null

EAN/código de barras de la variante; null si no consta.

tagsobject[]

Etiquetas asociadas al artículo.

Mostrar atributos hijos

tags.idstring

Identificador único de la etiqueta.

tags.namestring

Nombre de la etiqueta.

customFieldsobject<string, any>

Valores de los campos personalizados por identificador de campo personalizado; las definiciones están en /api/v1/custom-fields.

createdAtstring<date-time>

Fecha de creación en ISO 8601 con desplazamiento.

updatedAtstring<date-time>

Fecha de la última actualización en ISO 8601 con desplazamiento.

replacementValuestring | nullsolo en el detalle

Valor de reposición del artículo como cadena decimal "1234.50" (ROUND_HALF_UP); null si no consta.

Límites: patrón ^-?\d+\.\d{2}$

accessoryIdsstring[]solo en el detalle

Identificadores de los artículos configurados como accesorios de este.

alternativeIdsstring[]solo en el detalle

Identificadores de los artículos configurados como alternativas de este.

Valores

itemType: fixed, variant
stockCalculationMethod: bulk, serialized
bufferBeforeUnit: hour, day
bufferAfterUnit: hour, day

Lo devuelven

GET /api/v1/items — Listar artículos
GET /api/v1/items/{itemId} — Obtener un artículo

Lo modifican

POST /api/v1/items — Crear un artículo
PATCH /api/v1/items/{itemId} — Actualizar un artículo
PATCH /api/v1/items/{itemId}/physical-properties — Actualizar peso y dimensiones
PATCH /api/v1/items/{itemId}/pricing — Actualizar los precios de un artículo
PUT /api/v1/items/{itemId}/accessories — Actualizar los accesorios de un artículo
PUT /api/v1/items/{itemId}/alternatives — Actualizar las alternativas de un artículo
PATCH /api/v1/items/{itemId}/variants/{variantId} — Actualizar una variante de un artículo

¿Te ha resultado útil esta página?

Ejemplo

Atributos

Valores

Lo devuelven

Lo modifican