Orders

Archive or restore an order

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

Tool

filmo_orders_archive

Writeorders:write

orders:write
120/min
Server annotation: Idempotent

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

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

generated from the schema

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.

Arguments

orderIdstringRequired

Order identifier.

Limits: min length 1

archivedbooleanRequired

true removes the order from the active views; false brings it back.

idempotencyKeystring

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.

Limits: min length 1, max length 255

ifMatchstring

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.

Limits: min length 1

Result

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

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs PUT /api/v1/orders/{orderId}/archive.

Orders
Archive or restore an order
Takes the order out of the active views or brings it back to them.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with isError: true and the problem in the first text block. Branch on its code.

Was this page helpful?

Result

Arguments

Result

The same operation by REST

Related pages

Archive or restore an order

Safe writes

Errors