Pedidos
Listar las líneas de un pedido
Devuelve qué recursos lleva el pedido (artículos, espacios, servicios y elementos personalizados) con sus cantidades, sus unidades serializadas concretas, su periodo y su precio de venta.
Ejemplos de petición
curl https://app.filmo.io/api/v1/orders/orde_8f2a1c/lines \
--header "Authorization: Bearer $FILMO_API_KEY"Generado a partir del esquema
Es la consulta habitual tras obtener un pedido. Las líneas añadidas durante la entrega se dejan fuera salvo que se pidan con includeDelivery=true. No emite datos de coste ni de margen. Las líneas pertenecen al pedido y solo se obtienen a través de él: no hay una colección independiente de líneas. Las líneas vienen en el orden del documento.
Autorizaciones
Clave de API como Bearer, con el permiso de abajo. orders:read
Parámetros de ruta
Identificador del pedido.
Límites: longitud mín. 1
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
Orden: hasta 3 campos separados por comas, cada uno con un "-" inicial para descendente (p. ej. "-updatedAt,name"). Campos ordenables: position, itemName, quantity, startDate, endDate, rentalDays, unitPrice, linePrice, status, resourceType, transactionType. Por defecto, "position". 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
Filtra por tipo de recurso de la línea: item, space, service, custom, section o type_group.
Opciones disponibles: item, kit, space, vehicle, personnel, service, custom, section, type_group
Filtra por naturaleza de la línea: rental o sale.
Opciones disponibles: rental, sale
Si es "true", incluye también las líneas añadidas durante el proceso de entrega. Por defecto solo se devuelven las líneas del pedido original.
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: OrderLineDto
Sobre: OrderLineList. 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 de la línea.
Identificador del pedido al que pertenece la línea.
Tipo de recurso de la línea. Las líneas de tipo section y type_group son agrupaciones de presentación sin recurso asociado.
Opciones disponibles: item, kit, space, vehicle, personnel, service, custom, section, type_group
Naturaleza de la línea: rental o sale.
Opciones disponibles: rental, sale
Estado de la línea dentro del flujo del pedido.
Opciones disponibles: draft, reserved, prepared, picked_up, sold, returned, checked_in, cancelled, lost
Posición de visualización de la línea dentro del pedido, empezando en 0.
true si la línea se añadió durante el proceso de entrega y no en el pedido original.
Identificador del artículo del catálogo; null si la línea no es de tipo artículo.
Nombre del artículo, espacio, servicio o elemento personalizado de la línea.
Identificador de la variante del artículo; null si no aplica.
Identificador del espacio; null si la línea no es de tipo espacio.
Unidades de la línea.
Unidades físicas concretas asignadas. Vacío para artículos no serializados o cuando aún no se han asignado.
Mostrar atributos hijosOcultar atributos hijos
Identificador único de la unidad serializada.
Código interno de la unidad; null si no tiene.
Número de serie del fabricante; null si no está registrado.
Inicio del periodo de la línea en ISO 8601 UTC; null si hereda el periodo del pedido.
Fin del periodo de la línea en ISO 8601 UTC; null si hereda el periodo del pedido.
Días de alquiler facturables de la línea; null si no se ha calculado.
Precio unitario neto como cadena decimal "1234.50"; null si la línea no tiene precio propio.
Límites: patrón ^-?\d+\.\d{2}$
Importe neto total de la línea como cadena decimal "1234.50"; null si no se ha calculado.
Límites: patrón ^-?\d+\.\d{2}$
true si la línea se factura explícitamente a cero.
Notas de la línea; null si no hay.
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
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
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. |
| 404 | not_found | No existe o queda fuera del alcance de la clave de API. |
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 relacionadasAlquileres
Línea de pedido
Línea de pedido: qué recurso incluye, cuánto, cuándo y a qué precio de venta.
¿Te ha resultado útil esta página?