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.

GET
/api/v1/orders/{orderId}/lines

Ejemplos de petición

curl https://app.filmo.io/api/v1/orders/orde_8f2a1c/lines \
  --header "Authorization: Bearer $FILMO_API_KEY"
{
  "data": [
    {
      "id": "order_line_9f3a2b",
      "orderId": "order_9f3a2b",
      "resourceType": "item",
      "transactionType": "rental",
      "status": "draft",
      "position": 1,
      "addedDuringDelivery": true,
      "itemId": "item_9f3a2b",
      "itemName": "Example item name",
      "variantId": "variant_9f3a2b",
      "spaceId": "space_9f3a2b",
      "quantity": 1,
      "serials": [
        {
          "id": "serial_9f3a2b",
          "code": "Example code",
          "serialNumber": "2026-0001"
        }
      ],
      "startDate": "2026-09-01T08:00:00.000Z",
      "endDate": "2026-09-01T08:00:00.000Z",
      "rentalDays": 1,
      "unitPrice": "120.00",
      "linePrice": "120.00",
      "free": true,
      "notes": "Example text."
    }
  ],
  "pagination": {
    "nextCursor": "eyJvIjoyMH0",
    "hasMore": true,
    "total": 1
  }
}

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

orderIdstringObligatorio

Identificador del pedido.

Límites: longitud mín. 1

Parámetros de consulta

limitintegerpredeterminado:50

Tamaño de página (1-500). Por defecto es 50.

Límites: mín. 1, máx. 500

cursorstring

Cursor opaco de la página que se devuelve. Pasa el valor de pagination.nextCursor de la respuesta anterior; trátalo como opaco.

Límites: longitud máx. 200

sortstring

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

resourceTypestring

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

transactionTypestring

Filtra por naturaleza de la línea: rental o sale.

Opciones disponibles: rental, sale

includeDeliverybooleanpredeterminado:false

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.

includeTotalbooleanpredeterminado:false

Ponlo en true para incluir pagination.total, el número de resultados que coinciden con los filtros en todas las páginas. Desactivado por defecto.

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: OrderLineDto

Sobre: OrderLineList. meta.warnings solo aparece cuando la operación está obsoleta.

Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset

dataobject[]

Mostrar atributos hijos
data.idstring

Identificador único de la línea.

data.orderIdstring

Identificador del pedido al que pertenece la línea.

data.resourceTypestring

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

data.transactionTypestring

Naturaleza de la línea: rental o sale.

Opciones disponibles: rental, sale

data.statusstring

Estado de la línea dentro del flujo del pedido.

Opciones disponibles: draft, reserved, prepared, picked_up, sold, returned, checked_in, cancelled, lost

data.positioninteger

Posición de visualización de la línea dentro del pedido, empezando en 0.

data.addedDuringDeliveryboolean

true si la línea se añadió durante el proceso de entrega y no en el pedido original.

data.itemIdstring | null

Identificador del artículo del catálogo; null si la línea no es de tipo artículo.

data.itemNamestring | null

Nombre del artículo, espacio, servicio o elemento personalizado de la línea.

data.variantIdstring | null

Identificador de la variante del artículo; null si no aplica.

data.spaceIdstring | null

Identificador del espacio; null si la línea no es de tipo espacio.

data.quantitynumber

Unidades de la línea.

data.serialsobject[]

Unidades físicas concretas asignadas. Vacío para artículos no serializados o cuando aún no se han asignado.

Mostrar atributos hijos
data.serials.idstring

Identificador único de la unidad serializada.

data.serials.codestring | null

Código interno de la unidad; null si no tiene.

data.serials.serialNumberstring | null

Número de serie del fabricante; null si no está registrado.

data.startDatestring<date-time> | null

Inicio del periodo de la línea en ISO 8601 UTC; null si hereda el periodo del pedido.

data.endDatestring<date-time> | null

Fin del periodo de la línea en ISO 8601 UTC; null si hereda el periodo del pedido.

data.rentalDaysnumber | null

Días de alquiler facturables de la línea; null si no se ha calculado.

data.unitPricestring | null

Precio unitario neto como cadena decimal "1234.50"; null si la línea no tiene precio propio.

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

data.linePricestring | null

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}$

data.freeboolean

true si la línea se factura explícitamente a cero.

data.notesstring | null

Notas de la línea; null si no hay.

paginationobject

Metadatos de paginación por cursor opaco.

Mostrar atributos hijos
pagination.nextCursorstring | null

Cursor opaco de la página siguiente; null cuando no hay más resultados. Pásalo como cursor en la siguiente petición.

pagination.hasMoreboolean

Si existen más resultados después de esta página.

pagination.totalinteger

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

metaobject

Información adicional sobre la respuesta.

Mostrar atributos hijos
meta.warningsobject[]

Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.

Mostrar atributos hijos
meta.warnings.codestring

Código de aviso estable.

Opciones disponibles: deprecated

meta.warnings.messagestring

Para personas: qué está obsoleto, hasta cuándo y qué usar.

meta.warnings.sunsetstring

Día (YYYY-MM-DD) en que la operación deja de estar disponible.

meta.warnings.replacementstring | null

operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.

Errores

EstadoCódigosSignificado
400validation_errorConsulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable.
404not_foundNo 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

  • Alquileres

    Línea de pedido

    Línea de pedido: qué recurso incluye, cuánto, cuándo y a qué precio de venta.