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.
orders:readorders:read- 120/min
- Anotación del servidor: Solo lectura
- Anotación del servidor: Idempotente
Resultado
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
Identificador del pedido.
Límites: longitud mín. 1
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.
Resultado
En un éxito el resultado lleva structuredContent con data y meta. Estos son los atributos de data.
Ver los atributos de data
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.
Un error es un resultado con isError: true y el problema en content[0].; no hay structuredContent. Consulta Errores.
La misma operación por REST
Esta herramienta ejecuta GET /api/v1/orders/{orderId}/lines.
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasPedidos
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: truey el problema en el primer bloque de texto. Ramifica por sucode.
¿Te ha resultado útil esta página?