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.

Herramienta
filmo_orders_lines_list
Acceso: Lectura
  • orders:read
  • 120/min
  • Anotación del servidor: Solo lectura
  • Anotación del servidor: Idempotente

Resultado

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_orders_lines_list",
    "arguments": {
      "orderId": "orde_8f2a1c",
      "limit": 20
    }
  }
}

generado desde el 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.

Argumentos

orderIdstringObligatorio

Identificador del pedido.

Límites: longitud mín. 1

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.

Resultado

En un éxito el resultado lleva structuredContent con data y meta. Estos son los atributos de data.

Ver los atributos de data
idstring

Identificador único de la línea.

orderIdstring

Identificador del pedido al que pertenece la línea.

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

transactionTypestring

Naturaleza de la línea: rental o sale.

Opciones disponibles: rental, sale

statusstring

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

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

positioninteger

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

addedDuringDeliveryboolean

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

itemIdstring | null

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

itemNamestring | null

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

variantIdstring | null

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

spaceIdstring | null

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

quantitynumber

Unidades de la línea.

serialsobject[]

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

Mostrar atributos hijos
serials.idstring

Identificador único de la unidad serializada.

serials.codestring | null

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

serials.serialNumberstring | null

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

startDatestring<date-time> | null

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

endDatestring<date-time> | null

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

rentalDaysnumber | null

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

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

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

freeboolean

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

notesstring | null

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

Un error es un resultado con isError: true y el problema en content[0].text; no hay structuredContent. Consulta Errores.

La misma operación por REST

Esta herramienta ejecuta GET /api/v1/orders/{orderId}/lines.

  • 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.

  • Guías

    Escrituras seguras

    Un asistente que puede escribir también puede escribir lo equivocado. Decide qué herramientas necesitan a una persona, reintenta sin duplicar y sabe qué pone en marcha una escritura.

  • Guías

    Errores

    Un error de herramienta es un resultado con isError: true y el problema en el primer bloque de texto. Ramifica por su code.

¿Te ha resultado útil esta página?