Artículos
Listar artículos
Devuelve el catálogo de artículos de inventario, paginado por cursor.
Ejemplos de petición
curl https://app.filmo.io/api/v1/items \
--header "Authorization: Bearer $FILMO_API_KEY"Generado a partir del esquema
Aislamiento estricto por suscripción.
Autorizaciones
Clave de API como Bearer, con el permiso de abajo. items:read
Parámetros de consulta
Tamaño de página (1-500). Por defecto es 50.
Límites: mín. 1, máx. 500
Cursor opaco de la página que se devuelve. Pasa el valor de pagination. de la respuesta anterior; trátalo como opaco.
Límites: longitud máx. 200
La fecha de creación del recurso cae en esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.
Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
La fecha de creación del recurso es posterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.
Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
La fecha de creación del recurso es anterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.
Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
La fecha de creación del recurso es igual o posterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.
Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
La fecha de creación del recurso es igual o anterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.
Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
La fecha de última actualización del recurso cae en esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.
Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
La fecha de última actualización del recurso es posterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.
Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
La fecha de última actualización del recurso es anterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.
Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
La fecha de última actualización del recurso es igual o posterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.
Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
La fecha de última actualización del recurso es igual o anterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.
Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
Orden: hasta 3 campos separados por comas, cada uno con un "-" inicial para descendente (p. ej. "-updatedAt,name"). Campos ordenables: createdAt, updatedAt, name, sku, salePrice, depositValue, serializedItemsCount, collectionName. Por defecto, "-createdAt". Los empates se resuelven por id, así que el orden es estable entre páginas, y un cursor queda ligado al orden con el que se emitió.
Límites: longitud máx. 200
Búsqueda de texto libre (actualmente ILIKE sobre nombre, SKU, sinónimos y códigos de unidades serializadas). La semántica NO es contractual: puede evolucionar sin previo aviso.
Límites: longitud máx. 200
Filtra por método de cálculo del stock: serialized (por unidades serializadas) o bulk (a granel).
Opciones disponibles: serialized, bulk
Filtra por stockType, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.
Opciones disponibles: serialized, bulk
Límites: mín. 1 elementos, máx. 50 elementos
Filtra por identificador de la colección a la que pertenece el artículo.
Límites: longitud máx. 100
Filtra por collectionId, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.
Límites: mín. 1 elementos, máx. 50 elementos, cada uno: longitud máx. 100
Consulta por lotes mediante identificadores separados por comas (entre 1 y 100), pensada para la sincronización.
Límites: longitud máx. 4000
Ponlo en true para incluir pagination., el número de resultados que coinciden con los filtros en todas las páginas. Desactivado por defecto.
Respuesta
Respuesta correcta.
Esquema de la respuesta: ItemDto
Sobre: ItemList. meta. solo aparece cuando la operación está obsoleta.
Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Mostrar atributos hijosOcultar atributos hijos
Identificador único del artículo.
Nombre del artículo.
Referencia SKU del artículo; null si no consta.
Descripción del artículo; null si no consta.
Información adicional del pedido (notas de preparación y entrega); null si no consta.
EAN/código de barras; null si no consta.
Tipo de artículo: fixed (artículo simple) o variant (artículo con variantes).
Opciones disponibles: fixed, variant
Método de cálculo del stock: bulk (a granel, por cantidad) o serialized (por artículos serializados).
Opciones disponibles: bulk, serialized
Identificador de la colección a la que pertenece; null si no está en ninguna.
Nombre de la colección a la que pertenece; null si no está en ninguna.
URLs de las imágenes del artículo.
Precio de venta como cadena decimal "1234.50" (ROUND_HALF_UP); null si no tiene.
Límites: patrón ^-?\d+\.\d{2}$
Importe de la fianza como cadena decimal "1234.50" (ROUND_HALF_UP); null si no tiene.
Límites: patrón ^-?\d+\.\d{2}$
Stock mínimo configurado para las alertas; null si no está configurado.
Número de unidades serializadas registradas del artículo.
Configuración de precios de alquiler; null si no está configurada.
Mostrar atributos hijosOcultar atributos hijos
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
Precio base de alquiler como cadena decimal "1234.50" (ROUND_HALF_UP); null si no aplica.
Límites: patrón ^-?\d+\.\d{2}$
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
Si el artículo admite seguro.
Si el artículo admite descuentos.
Tiempo de margen reservado antes del alquiler; null si no aplica.
Unidad del margen previo: hora o día; null si no aplica.
Opciones disponibles: hour, day
Tiempo de margen reservado después del alquiler; null si no aplica.
Unidad del margen posterior: hour o day; null si no aplica.
Opciones disponibles: hour, day
Propiedades físicas (peso y dimensiones); null si no se han registrado.
Mostrar atributos hijosOcultar atributos hijos
Peso del artículo en kilogramos; null si no está registrado.
Ancho del artículo en centímetros; null si no está registrado.
Altura del artículo en centímetros; null si no consta.
Longitud del artículo en centímetros; null si no consta.
Volumen del artículo en metros cúbicos (m³); null si no está registrado.
Consumo de corriente en amperios; null si no consta.
Potencia en vatios; null si no se ha registrado.
Variantes del artículo (vacío si el artículo es de tipo fixed).
Mostrar atributos hijosOcultar atributos hijos
Identificador único de la variante.
Nombre de la variante.
Precio de alquiler de la variante como cadena decimal "1234.50" (ROUND_HALF_UP).
Límites: patrón ^-?\d+\.\d{2}$
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}$
EAN/código de barras de la variante; null si no consta.
Valores de los campos personalizados por identificador de campo personalizado; las definiciones están en /api.
Fecha de creación en ISO 8601 con desplazamiento.
Fecha de la última actualización en ISO 8601 con desplazamiento.
Metadatos de paginación por cursor opaco.
Mostrar atributos hijosOcultar atributos hijos
Cursor opaco de la página siguiente; null cuando no hay más resultados. Pásalo como cursor en la siguiente petición.
Si existen más resultados después de esta página.
Número de resultados que coinciden con los filtros en todas las páginas. Solo aparece cuando la petición establece includeTotal=true.
Límites: mín. 0
Información adicional sobre la respuesta.
Mostrar atributos hijosOcultar atributos hijos
Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.
Mostrar atributos hijosOcultar atributos hijos
Código de aviso estable.
Opciones disponibles: deprecated
Para personas: qué está obsoleto, hasta cuándo y qué usar.
Día (YYYY-MM-DD) en que la operación deja de estar disponible.
operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.
Dónde está documentada la deprecación (el changelog).
Petición no válida (validation_error): consulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Fallo de autenticación (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin).
Cabeceras: X-Request-Id · Content-Language
No permitido (insufficient_scope: la clave de API no tiene el scope requerido, indicado en requiredScope; forbidden: el propietario de la clave carece del permiso que exige la operación). insufficient_scope se responde antes de que la petición cuente contra el límite de peticiones, así que no lleva cabeceras RateLimit-*; forbidden sí.
Cabeceras: X-Request-Id · Content-Language
Límite de peticiones superado (rate_limited): reintenta tras Retry-After segundos; RateLimit-* indica qué cuota se ha agotado.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Retry-After
Error interno (internal_error).
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Errores
| Estado | Códigos | Significado |
|---|---|---|
| 400 | validation_error | Consulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable. |
401, 403, 429, 500 los puede devolver cualquier operación. Errores
Obsolescencia
Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada. Política de versiones
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasCatálogo e inventario
Artículo
El artículo, tal como lo devuelve la API.
¿Te ha resultado útil esta página?