*MCP › Reference › Rentals › Orders*

# Archive or restore an order

> Takes the order out of the active views or brings it back to them.

It deletes nothing and touches neither the stock, nor the lines, nor the documents: only the visibility. PUT because the call SETS the value —there is no toggle—, so repeating it does nothing new. Only a draft or cancelled order can be archived: any other status responds 409 `conflict`, naming it. Responds 204 with no body: an archived order is no longer visible to the API (its GET responds 404), and a restored one is read again with its GET.

TOOL `filmo_orders_archive` · `orders:write` · 120/min · Server annotation: Idempotent

## Arguments

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `orderId` | string | Yes | Order identifier. |
| `archived` | boolean | Yes | true removes the order from the active views; false brings it back. |
| `idempotencyKey` | string | No | Idempotency key chosen by the client (a UUID is recommended). Repeating the same key with the same arguments within 24 h returns the stored response without executing again; with different arguments it responds 422. It is the safe way to retry after a network failure. |
| `ifMatch` | string | No | Optimistic locking: the meta.etag you got from the detail read of this resource (or "*"). If the resource changed since, the call fails with 412 precondition_failed before writing anything; read it again and retry. Omit it to write unconditionally. |

## Result

On success the result carries `structuredContent` with `data` and `meta`. These are the attributes of `data`.

*Call · filmo_orders_archive*

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_orders_archive",
    "arguments": {
      "orderId": "orde_8f2a1c",
      "archived": true
    }
  }
}
```

*Result (generated from the schema)*

```json
{
  "structuredContent": {
    "data": "<value>",
    "meta": {
      "idempotencyKey": "<the key you sent, or the one the server generated>",
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      }
    }
  }
}
```

## The same operation by REST

This tool runs [`PUT /api/v1/orders/{orderId}/archive`](https://docs.filmo.io/rest-api/endpoint-reference/orders/archive-or-restore-an-order).

---

Canonical URL: https://docs.filmo.io/mcp/tools/orders/filmo-orders-archive  
Last updated: 2026-10-25