Pedidos

Obtener un pedido

Devuelve el detalle de un pedido.

Herramienta
filmo_orders_get
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_get",
    "arguments": {
      "orderId": "orde_8f2a1c"
    }
  }
}

generado desde el esquema

El campo status emite el estado bruto (12 valores de la base de datos).

Argumentos

orderIdstringObligatorio

Identificador del pedido.

Límites: longitud mín. 1

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

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

discountTotalstring | null

Total de descuentos como cadena decimal "1234.50" (ROUND_HALF_UP); null si no hay descuento.

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

insuranceTotalstring

Total del seguro como cadena decimal "1234.50" (ROUND_HALF_UP).

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

depositTotalstring

Total de fianzas como cadena decimal "1234.50" (ROUND_HALF_UP).

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

taxesPricestring

Total de impuestos como cadena decimal "1234.50" (ROUND_HALF_UP).

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

netPricestring

Base imponible (neto antes de impuestos) como cadena decimal "1234.50" (ROUND_HALF_UP).

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

grossPricestring

Total con impuestos, como cadena decimal "1234.50" (ROUND_HALF_UP).

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

tagsobject[]

Etiquetas adjuntas al pedido, con su identificador y nombre.

Mostrar atributos hijos
tags.idstring

Identificador único de la etiqueta.

tags.namestring

Nombre de la etiqueta.

customFieldsobject<string, any>

Valores de los campos personalizados por identificador de campo personalizado; las definiciones están en /api/v1/custom-fields.

sourcestring | null

Origen desde el que se creó el pedido (por ejemplo web, mobile, admin); null si no consta.

createdAtstring<date-time>

Fecha de creación en ISO 8601 con desplazamiento.

updatedAtstring<date-time>

Fecha de la última actualización en ISO 8601 con desplazamiento.

billingAddressobject | null

Dirección de facturación del pedido; null si no hay.

Mostrar atributos hijos
billingAddress.labelstring | null

Etiqueta descriptiva de la dirección; null si no consta.

billingAddress.addressLine1string | null

Primera línea de la dirección; null si no consta.

billingAddress.addressLine2string | null

Segunda línea de la dirección; null si no consta.

billingAddress.citystring | null

Ciudad; null si no consta.

billingAddress.provincestring | null

Provincia o región; null si no se ha registrado.

billingAddress.postcodestring | null

Código postal; null si no se ha registrado.

billingAddress.countrystring | null

País; null si no consta.

shippingAddressobject | null

Dirección de envío del pedido; null si no hay.

Mostrar atributos hijos
shippingAddress.labelstring | null

Etiqueta descriptiva de la dirección; null si no consta.

shippingAddress.addressLine1string | null

Primera línea de la dirección; null si no consta.

shippingAddress.addressLine2string | null

Segunda línea de la dirección; null si no consta.

shippingAddress.citystring | null

Ciudad; null si no consta.

shippingAddress.provincestring | null

Provincia o región; null si no se ha registrado.

shippingAddress.postcodestring | null

Código postal; null si no se ha registrado.

shippingAddress.countrystring | null

País; null si no consta.

contactPersonobject | null

Persona de contacto vinculada al pedido; null si no hay ninguna.

Mostrar atributos hijos
contactPerson.idstring

Identificador único del contacto.

contactPerson.namestring

Nombre del contacto.

quotesobject[]

Referencias informativas a los presupuestos generados a partir del pedido.

Mostrar atributos hijos
quotes.idstring

Identificador único del documento referenciado.

quotes.numberstring | null

Número del documento; null hasta que se numera.

quotes.statusstring | null

Estado del documento en el momento en que se escribió la referencia; null si no consta. Informativo: puede estar desactualizado.

invoicesobject[]

Referencias informativas a las facturas generadas a partir del pedido.

Mostrar atributos hijos
invoices.idstring

Identificador único del documento referenciado.

invoices.numberstring | null

Número del documento; null hasta que se numera.

invoices.statusstring | null

Estado del documento en el momento en que se escribió la referencia; null si no consta. Informativo: puede estar desactualizado.

proformasobject[]

Referencias informativas a las proformas generadas a partir del pedido.

Mostrar atributos hijos
proformas.idstring

Identificador único del documento referenciado.

proformas.numberstring | null

Número del documento; null hasta que se numera.

proformas.statusstring | null

Estado del documento en el momento en que se escribió la referencia; null si no consta. Informativo: puede estar desactualizado.

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

Prompts de ejemplo

Enséñame el detalle del pedido 2026-0142, con sus líneas.

La misma operación por REST

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

  • Pedidos

    Obtener un pedido

    Devuelve el detalle de un pedido.

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