Pedidos

Listar pedidos

Devuelve los pedidos de alquiler, paginados por cursor.

Herramienta

filmo_orders_list

Lecturaorders:read

orders:read
120/min
Anotación del servidor: Solo lectura
Anotación del servidor: Idempotente

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

{
  "structuredContent": {
    "data": [
      {
        "id": "id_8f2a1c",
        "orderNumber": "<orderNumber>",
        "externalReference": "<externalReference>",
        "status": "draft",
        "startDate": "2026-09-01T08:00:00Z",
        "endDate": "2026-09-01T08:00:00Z",
        "rentalDays": 1,
        "projectId": "proj_8f2a1c",
        "projectName": "Example",
        "contact": {
          "id": "id_8f2a1c",
          "name": "Example"
        },
        "itemsCount": 1,
        "subTotalPrice": "1234.50",
        "discountTotal": "1234.50",
        "insuranceTotal": "1234.50",
        "depositTotal": "1234.50",
        "taxesPrice": "1234.50",
        "netPrice": "1234.50",
        "grossPrice": "1234.50",
        "tags": [
          {
            "id": "id_8f2a1c",
            "name": "Example"
          }
        ],
        "customFields": {
          "key": "<key>"
        },
        "source": "<source>",
        "createdAt": "2026-09-01T08:00:00Z",
        "updatedAt": "2026-09-01T08:00:00Z"
      }
    ],
    "pagination": {
      "nextCursor": "eyJvIjo1MH0",
      "hasMore": true,
      "total": 1
    },
    "meta": {
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      }
    }
  }
}

generado desde el esquema

El filtro status usa grupos operativos de alto nivel. El listado se limita estrictamente a la suscripción de la clave.

Argumentos

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

qstring

Búsqueda de texto libre en el número de pedido, el nombre o alias del proyecto y la referencia externa.

Límites: longitud mín. 1, 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: createdAt, updatedAt, startDate, endDate, orderNumber, grossPrice, rentalDays, itemsCount. Por defecto, "-createdAt". 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

statusstring

Filtra por grupo de estado operativo (vista de la UI): draft, reserved, prepared (incluye la preparación parcial), in_use (recogido/en uso), returned (incluye la devolución/check-in parcial), completed (con check-in hecho y completado) o cancelled.

Opciones disponibles: draft, reserved, prepared, in_use, returned, completed, cancelled

statusesstring[]

Filtra por status, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.

Opciones disponibles: draft, reserved, prepared, in_use, returned, completed, cancelled

Límites: mín. 1 elementos, máx. 50 elementos

contactIdstring

Filtra por identificador del contacto del pedido.

Límites: longitud mín. 1, longitud máx. 100

contactIdsstring[]

Filtra por contactId, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.

Límites: mín. 1 elementos, máx. 50 elementos, cada uno: longitud mín. 1, cada uno: longitud máx. 100

projectIdstring

Filtra por identificador del proyecto al que pertenece el pedido.

Límites: longitud mín. 1, longitud máx. 100

projectIdsstring[]

Filtra por projectId, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.

Límites: mín. 1 elementos, máx. 50 elementos, cada uno: longitud mín. 1, cada uno: longitud máx. 100

overlapsFromstring<date-time>

Inicio de la ventana de solapamiento (ISO 8601 con desplazamiento): devuelve los pedidos cuyo periodo de alquiler se solapa con [overlapsFrom, overlapsTo].

overlapsTostring<date-time>

Fin de la ventana de solapamiento (ISO 8601 con desplazamiento): devuelve los pedidos cuyo periodo de alquiler se solapa con [overlapsFrom, overlapsTo].

orderNumberstring

Filtra por número de pedido: coincidencia exacta o por prefijo.

Límites: longitud mín. 1, longitud máx. 100

orderNumberIsstring

Número de pedido que coincide exactamente.

Límites: longitud mín. 1, longitud máx. 100

orderNumberContainsstring

Número de pedido que contiene este texto en cualquier posición.

Límites: longitud mín. 1, longitud máx. 100

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.

dateFiltersobject

Filtros de fecha por campo. Una fecha sin hora (YYYY-MM-DD) se lee en la zona horaria del negocio; un instante ISO 8601 con desplazamiento se aplica tal cual con gte, lte, gt y lt, mientras que on lo amplía al día completo del negocio que lo contiene. Campos: created, ends, starts, updated.

Mostrar atributos hijos

dateFilters.createdobject

Mostrar atributos hijos

dateFilters.created.gtestring

Desde este día o instante, inclusive.

dateFilters.created.ltestring

Hasta este día o instante, inclusive.

dateFilters.created.gtstring

Estrictamente posterior; una fecha sin hora significa después del final de ese día.

dateFilters.created.ltstring

Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.

dateFilters.created.onstring

Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.

dateFilters.endsobject

Mostrar atributos hijos

dateFilters.ends.gtestring

Desde este día o instante, inclusive.

dateFilters.ends.ltestring

Hasta este día o instante, inclusive.

dateFilters.ends.gtstring

Estrictamente posterior; una fecha sin hora significa después del final de ese día.

dateFilters.ends.ltstring

Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.

dateFilters.ends.onstring

Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.

dateFilters.startsobject

Mostrar atributos hijos

dateFilters.starts.gtestring

Desde este día o instante, inclusive.

dateFilters.starts.ltestring

Hasta este día o instante, inclusive.

dateFilters.starts.gtstring

Estrictamente posterior; una fecha sin hora significa después del final de ese día.

dateFilters.starts.ltstring

Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.

dateFilters.starts.onstring

Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.

dateFilters.updatedobject

Mostrar atributos hijos

dateFilters.updated.gtestring

Desde este día o instante, inclusive.

dateFilters.updated.ltestring

Hasta este día o instante, inclusive.

dateFilters.updated.gtstring

Estrictamente posterior; una fecha sin hora significa después del final de ese día.

dateFilters.updated.ltstring

Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.

dateFilters.updated.onstring

Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.

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 del pedido.

orderNumberstring

Número de pedido legible.

externalReferencestring | null

Referencia externa del pedido (por ejemplo, del sistema del cliente); null si no consta.

statusstring

Estado bruto del pedido tal como se almacena en la base de datos (12 valores): draft, reserved, prepared_partially, prepared, picked_up_partially, picked_up, returned_partially, returned, checked_in_partially, checked_in, archived o cancelled. archived forma parte del conjunto almacenado, pero un pedido archivado no es visible para la API, así que no lo observarás.

Opciones disponibles: draft, reserved, prepared_partially, prepared, picked_up_partially, picked_up, returned_partially, returned, checked_in_partially, checked_in, archived, cancelled

startDatestring<date-time>

Inicio del periodo de alquiler en ISO 8601 con desplazamiento.

endDatestring<date-time>

Fin del periodo de alquiler en ISO 8601 con desplazamiento.

rentalDaysnumber | null

Número de días de alquiler facturables; null si no se ha calculado.

projectIdstring | null

Identificador del proyecto al que pertenece el pedido; null si no está vinculado.

projectNamestring | null

Nombre del proyecto al que pertenece el pedido; null si no está vinculado.

contactobject | null

Referencia compacta al contacto del pedido; null si no hay.

Mostrar atributos hijos

contact.idstring

Identificador único del contacto.

contact.namestring

Nombre del contacto.

itemsCountinteger

Número de artículos del pedido.

subTotalPricestring

Subtotal antes de descuentos e impuestos, como cadena decimal "1234.50" (ROUND_HALF_UP).