Pedidos

Archivar o restaurar un pedido

Saca el pedido de las vistas activas o lo devuelve a ellas.

Herramienta

filmo_orders_archive

Escrituraorders:write

orders:write
120/min
Anotación del servidor: Idempotente

{
  "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
      }
    }
  }
}

generado desde el esquema

No borra nada y no toca ni el stock, ni las líneas, ni los documentos: solo la visibilidad. PUT porque la llamada FIJA el valor —no hay alternancia—, así que repetirla no hace nada nuevo. Solo se puede archivar un pedido en borrador o cancelado: cualquier otro estado responde 409 conflict, nombrándolo. Responde 204 sin cuerpo: un pedido archivado ya no es visible para la API (su GET responde 404), y uno restaurado se vuelve a leer con su GET.

Argumentos

orderIdstringObligatorio

Identificador del pedido.

Límites: longitud mín. 1

archivedbooleanObligatorio

true retira el pedido de las vistas activas; false lo recupera.

idempotencyKeystring

Clave de idempotencia elegida por el cliente (se recomienda un UUID). Repetir la misma clave con los mismos argumentos en 24 h devuelve la respuesta almacenada sin volver a ejecutar; con argumentos distintos responde 422. Es la forma segura de reintentar tras un fallo de red.

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

ifMatchstring

Bloqueo optimista: el meta.etag que obtuviste de la lectura de detalle de este recurso (o "*"). Si el recurso ha cambiado desde entonces, la llamada falla con 412 precondition_failed antes de escribir nada; léelo de nuevo y reintenta. Omítelo para escribir sin condiciones.

Límites: longitud mín. 1

Resultado

En un éxito el resultado lleva structuredContent con data y meta. Estos son los atributos de data.

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

La misma operación por REST

Esta herramienta ejecuta PUT /api/v1/orders/{orderId}/archive.

Pedidos
Archivar o restaurar un pedido
Saca el pedido de las vistas activas o lo devuelve a ellas.
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.

¿Te ha resultado útil esta página?

Resultado

Argumentos

Resultado

La misma operación por REST

Páginas relacionadas

Archivar o restaurar un pedido

Escrituras seguras

Errores