*API REST › Referencia de endpoints › Alquileres › Pedidos*

# Obtener un pedido

> Devuelve el detalle de un pedido.

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

`GET /api/v1/orders/{orderId}` — permiso `orders:read`

Permiso: `orders:read` · 120/min · If-None-Match · MCP: `filmo_orders_get`

## Autorizaciones

Clave de API como Bearer, con el permiso de abajo. `orders:read`

## Cabeceras

| Nombre | Tipo | Obligatorio | Descripción |
| --- | --- | --- | --- |
| `If-None-Match` | string | No | Lectura condicional: el `ETag` de la copia que ya tienes. Si el recurso no ha cambiado, la respuesta es `304` sin cuerpo. |

## Parámetros de ruta

| Nombre | Tipo | Obligatorio | Descripción |
| --- | --- | --- | --- |
| `orderId` | string | Sí | Identificador del pedido. |

## Ejemplos de petición

*Obtener un pedido*

**cURL**

```bash
curl https://app.filmo.io/api/v1/orders/orde_8f2a1c \
  --header "Authorization: Bearer $FILMO_API_KEY"
```

**Node.js**

```javascript
fetch('https://app.filmo.io/api/v1/orders/orde_8f2a1c', {
  headers: {
    Authorization: 'Bearer YOUR_FILMO_API_KEY'
  }
})
```

**Python**

```python
import requests

requests.get(
    "https://app.filmo.io/api/v1/orders/orde_8f2a1c",
    headers={
      "Authorization": "Bearer YOUR_FILMO_API_KEY"
    }
)
```

## Respuesta

Esquema de la respuesta: `OrderDetailDto`

| Estado | Descripción |
| --- | --- |
| 200 | Respuesta correcta. |
| 304 | No modificado: el `If-None-Match` enviado coincide con el `ETag` actual. Sin cuerpo; la copia que tienes está al día. |
| 401 | Fallo de autenticación (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 403 | No permitido (insufficient_scope: la clave de API no tiene el scope requerido, indicado en `requiredScope`; forbidden: el propietario de la clave carece del permiso que exige la operación). `insufficient_scope` se responde antes de que la petición cuente contra el límite de peticiones, así que no lleva cabeceras `RateLimit-*`; `forbidden` sí. |
| 404 | Recurso no encontrado (not_found): no existe o está fuera del alcance de la clave de API. |
| 429 | Límite de peticiones superado (rate_limited): reintenta tras `Retry-After` segundos; `RateLimit-*` indica qué cuota se ha agotado. |
| 500 | Error interno (internal_error). |

**200**

| Nombre | Tipo | Descripción |
| --- | --- | --- |
| `data` | object | El pedido completo, tal como lo devuelve la API. |
| `data.id` | string | Identificador único del pedido. |
| `data.orderNumber` | string | Número de pedido legible. |
| `data.externalReference` | string | Referencia externa del pedido (por ejemplo, del sistema del cliente); null si no consta. |
| `data.status` | string | 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. `draft`, `reserved`, `prepared_partially`, `prepared`, `picked_up_partially`, `picked_up`, `returned_partially`, `returned`, `checked_in_partially`, `checked_in`, `archived`, `cancelled` |
| `data.startDate` | string<date-time> | Inicio del periodo de alquiler en ISO 8601 con desplazamiento. |
| `data.endDate` | string<date-time> | Fin del periodo de alquiler en ISO 8601 con desplazamiento. |
| `data.rentalDays` | number | Número de días de alquiler facturables; null si no se ha calculado. |
| `data.projectId` | string | Identificador del proyecto al que pertenece el pedido; null si no está vinculado. |
| `data.projectName` | string | Nombre del proyecto al que pertenece el pedido; null si no está vinculado. |
| `data.contact` | object | Referencia compacta al contacto del pedido; null si no hay. |
| `data.contact.id` | string | Identificador único del contacto. |
| `data.contact.name` | string | Nombre del contacto. |
| `data.itemsCount` | integer | Número de artículos del pedido. |
| `data.subTotalPrice` | string | Subtotal antes de descuentos e impuestos, como cadena decimal "1234.50" (ROUND_HALF_UP). |
| `data.discountTotal` | string | Total de descuentos como cadena decimal "1234.50" (ROUND_HALF_UP); null si no hay descuento. |
| `data.insuranceTotal` | string | Total del seguro como cadena decimal "1234.50" (ROUND_HALF_UP). |
| `data.depositTotal` | string | Total de fianzas como cadena decimal "1234.50" (ROUND_HALF_UP). |
| `data.taxesPrice` | string | Total de impuestos como cadena decimal "1234.50" (ROUND_HALF_UP). |
| `data.netPrice` | string | Base imponible (neto antes de impuestos) como cadena decimal "1234.50" (ROUND_HALF_UP). |
| `data.grossPrice` | string | Total con impuestos, como cadena decimal "1234.50" (ROUND_HALF_UP). |
| `data.tags` | object[] | Etiquetas adjuntas al pedido, con su identificador y nombre. |
| `data.tags.id` | string | Identificador único de la etiqueta. |
| `data.tags.name` | string | Nombre de la etiqueta. |
| `data.customFields` | object<string, any> | Valores de los campos personalizados por identificador de campo personalizado; las definiciones están en `/api/v1/custom-fields`. |
| `data.source` | string | Origen desde el que se creó el pedido (por ejemplo web, mobile, admin); null si no consta. |
| `data.createdAt` | string<date-time> | Fecha de creación en ISO 8601 con desplazamiento. |
| `data.updatedAt` | string<date-time> | Fecha de la última actualización en ISO 8601 con desplazamiento. |
| `data.billingAddress` | object | Dirección de facturación del pedido; null si no hay. |
| `data.billingAddress.label` | string | Etiqueta descriptiva de la dirección; null si no consta. |
| `data.billingAddress.addressLine1` | string | Primera línea de la dirección; null si no consta. |
| `data.billingAddress.addressLine2` | string | Segunda línea de la dirección; null si no consta. |
| `data.billingAddress.city` | string | Ciudad; null si no consta. |
| `data.billingAddress.province` | string | Provincia o región; null si no se ha registrado. |
| `data.billingAddress.postcode` | string | Código postal; null si no se ha registrado. |
| `data.billingAddress.country` | string | País; null si no consta. |
| `data.shippingAddress` | object | Dirección de envío del pedido; null si no hay. |
| `data.shippingAddress.label` | string | Etiqueta descriptiva de la dirección; null si no consta. |
| `data.shippingAddress.addressLine1` | string | Primera línea de la dirección; null si no consta. |
| `data.shippingAddress.addressLine2` | string | Segunda línea de la dirección; null si no consta. |
| `data.shippingAddress.city` | string | Ciudad; null si no consta. |
| `data.shippingAddress.province` | string | Provincia o región; null si no se ha registrado. |
| `data.shippingAddress.postcode` | string | Código postal; null si no se ha registrado. |
| `data.shippingAddress.country` | string | País; null si no consta. |
| `data.contactPerson` | object | Persona de contacto vinculada al pedido; null si no hay ninguna. |
| `data.contactPerson.id` | string | Identificador único del contacto. |
| `data.contactPerson.name` | string | Nombre del contacto. |
| `data.quotes` | object[] | Referencias informativas a los presupuestos generados a partir del pedido. |
| `data.quotes.id` | string | Identificador único del documento referenciado. |
| `data.quotes.number` | string | Número del documento; null hasta que se numera. |
| `data.quotes.status` | string | Estado del documento en el momento en que se escribió la referencia; null si no consta. Informativo: puede estar desactualizado. |
| `data.invoices` | object[] | Referencias informativas a las facturas generadas a partir del pedido. |
| `data.invoices.id` | string | Identificador único del documento referenciado. |
| `data.invoices.number` | string | Número del documento; null hasta que se numera. |
| `data.invoices.status` | string | Estado del documento en el momento en que se escribió la referencia; null si no consta. Informativo: puede estar desactualizado. |
| `data.proformas` | object[] | Referencias informativas a las proformas generadas a partir del pedido. |
| `data.proformas.id` | string | Identificador único del documento referenciado. |
| `data.proformas.number` | string | Número del documento; null hasta que se numera. |
| `data.proformas.status` | string | Estado del documento en el momento en que se escribió la referencia; null si no consta. Informativo: puede estar desactualizado. |
| `meta` | object | Información adicional sobre la respuesta. |
| `meta.warnings` | object[] | Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta. |
| `meta.warnings.code` | string | Código de aviso estable. `deprecated` |
| `meta.warnings.message` | string | Para personas: qué está obsoleto, hasta cuándo y qué usar. |
| `meta.warnings.sunset` | string | Día (YYYY-MM-DD) en que la operación deja de estar disponible. |
| `meta.warnings.replacement` | string | `operationId` de la operación que hay que usar en su lugar, o null si no hay ninguna. |
| `meta.warnings.link` | string | Dónde está documentada la deprecación (el changelog). |

*Respuesta de ejemplo · 200*

```json
{
  "data": {
    "id": "order_9f3a2b",
    "orderNumber": "2026-0001",
    "externalReference": "2026-0001",
    "status": "draft",
    "startDate": "2026-09-01T08:00:00.000Z",
    "endDate": "2026-09-01T08:00:00.000Z",
    "rentalDays": 1,
    "projectId": "project_9f3a2b",
    "projectName": "Example project name",
    "contact": {
      "id": "contact_9f3a2b",
      "name": "Example contact"
    },
    "itemsCount": 1,
    "subTotalPrice": "120.00",
    "discountTotal": "120.00",
    "insuranceTotal": "120.00",
    "depositTotal": "120.00",
    "taxesPrice": "120.00",
    "netPrice": "120.00",
    "grossPrice": "120.00",
    "tags": [
      {
        "id": "tag_9f3a2b",
        "name": "Example tag"
      }
    ],
    "customFields": {
      "example": "example"
    },
    "source": "Example source",
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z",
    "billingAddress": {
      "label": "Main",
      "addressLine1": "Calle de Ejemplo 12",
      "addressLine2": "Calle de Ejemplo 12",
      "city": "Madrid",
      "province": "Madrid",
      "postcode": "28001",
      "country": "ES"
    },
    "shippingAddress": {
      "label": "Main",
      "addressLine1": "Calle de Ejemplo 12",
      "addressLine2": "Calle de Ejemplo 12",
      "city": "Madrid",
      "province": "Madrid",
      "postcode": "28001",
      "country": "ES"
    },
    "contactPerson": {
      "id": "contact_person_9f3a2b",
      "name": "Example contact person"
    },
    "quotes": [
      {
        "id": "quote_9f3a2b",
        "number": "2026-0001",
        "status": "Example status"
      }
    ],
    "invoices": [
      {
        "id": "invoice_9f3a2b",
        "number": "2026-0001",
        "status": "Example status"
      }
    ],
    "proformas": [
      {
        "id": "proforma_9f3a2b",
        "number": "2026-0001",
        "status": "Example status"
      }
    ]
  }
}
```

304: Sin cuerpo.

## Errores

| Estado | Códigos | Significado |
| --- | --- | --- |
| 404 | `not_found` | No existe o queda fuera del alcance de la clave de API. |

## Obsolescencia

Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada.

---

URL canónica: https://docs.filmo.io/es/rest-api/endpoint-reference/orders/get-an-order  
Última actualización: 2026-10-25