Artículos
Actualizar un artículo
Actualiza los metadatos de catálogo de un artículo (envía solo los campos que cambian).
Ejemplos de petición
curl https://app.filmo.io/api/v1/items/item_8f2a1c \
--request PATCH \
--header "Authorization: Bearer $FILMO_API_KEY" \
--header "Idempotency-Key: $(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)" \
--header 'Content-Type: application/json' \
--data '{
"name": "Sony FX6 (cuerpo)",
"description": "Cámara de cine digital full-frame, montura E.",
"synonyms": [
"FX6",
"Sony cine full frame"
],
"tags": [
"Cámaras",
"Cine"
]
}'Generado a partir del esquema
synonyms y tags reemplazan la lista completa. El método de stock y el tipo de artículo NO se pueden cambiar aquí: son destructivos una vez que hay stock o variantes, y se fijan al crear. Devuelve el artículo actualizado en detalle.
Autorizaciones
Clave de API como Bearer, con el permiso de abajo. items:write
Cabeceras
Identificador único de la petición, elegido por el cliente (sirve un UUID). Entre 1 y 255 caracteres: una cabecera vacía se rechaza con 400 validation_error, porque el cliente se creería protegido. Repetir la misma clave con el MISMO cuerpo en 24 h devuelve la respuesta guardada sin volver a ejecutar, con la cabecera Idempotent-Replay: true. Con un cuerpo DISTINTO devuelve 422. Es la forma segura de reintentar tras un tiempo de espera de red.
Límites: longitud mín. 1, longitud máx. 255
Ejemplo:"9f1c2f4e-3a5b-4f6d-8e7a-0b1c2d3e4f5a"
Bloqueo optimista: el ETag que leíste del recurso (o *). Si el recurso ha cambiado desde entonces, la escritura se rechaza con 412 precondition_failed antes de hacer nada; léelo de nuevo y reintenta. Sin la cabecera, la escritura siempre se realiza.
Ejemplo:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""
Parámetros de ruta
Identificador del artículo.
Límites: longitud mín. 1
Cuerpo
Esquema del cuerpo: ItemUpdateBody
Nombre del artículo.
Límites: longitud mín. 1
Descripción del artículo; null la borra.
Referencia SKU. Única dentro de la cuenta; null la borra.
Límites: longitud mín. 1
Colección a la que pertenece; null lo saca de cualquier colección.
Límites: longitud mín. 1
Información del pedido: notas de preparación o entrega que sí llegan al cliente; null la borra.
Sinónimos con los que el artículo debe encontrarse en la búsqueda. Reemplaza la lista completa.
Respuesta
Respuesta correcta.
Esquema de la respuesta: ItemDetailDto
Sobre: ItemDetailResponse. meta. solo aparece cuando la operación está obsoleta.
Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag · Idempotent-Replay
El artículo completo, tal como lo devuelve la API.
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.
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}$
Identificadores de los artículos configurados como accesorios de este.
Identificadores de los artículos configurados como alternativas de este.
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 · Idempotent-Replay
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 · Idempotent-Replay
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 · Idempotent-Replay
Recurso no encontrado (not_found): no existe o está fuera del alcance de la clave de API.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Idempotent-Replay
Conflicto (conflict): el estado actual del recurso impide la operación, ya hay en curso una petición con esa Idempotency-Key, o otra escritura condicional (If-Match) retuvo el recurso durante más de cinco segundos. errors[0]. indica cuál: in_progress y lock_timeout se resuelven reintentando; invalid_state no, porque el estado del recurso prohíbe la operación.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Idempotent-Replay
Precondición fallida (precondition_failed): la etiqueta de entidad If-Match no coincide con la representación actual. Lee el recurso de nuevo y reintenta.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Idempotent-Replay
Idempotency-Key reutilizada (idempotency_key_reused): la misma clave se usó antes con un cuerpo distinto. Cambia la clave.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Idempotent-Replay
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 · Idempotent-Replay
Error interno (internal_error).
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Idempotent-Replay
Errores
| Estado | Códigos | Significado |
|---|---|---|
| 400 | validation_error | Consulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable. |
| 404 | not_found | No existe o queda fuera del alcance de la clave de API. |
| 409 | conflict | El estado actual del recurso impide la operación, ya hay en curso una petición con esa Idempotency-Key, u otra escritura condicional (If-Match) retuvo el recurso durante más de cinco segundos. errors[0]. indica cuál: in_progress y lock_timeout se resuelven reintentando; invalid_state no, porque el estado del recurso prohíbe la operación. |
| 412 | precondition_failed | La etiqueta de entidad If-Match no coincide con la representación actual. Vuelve a leer el recurso y reintenta. |
| 422 | idempotency_key_reused | La misma clave se usó antes con un cuerpo distinto. Cambia la clave. |
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
Relacionado
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?