Pedidos
Cancelar un pedido
Cancela el pedido y libera lo que tenía reservado: libera el stock, cancela las tareas de logística —preparación, envío y recogida— y marca los documentos vinculados.
orders:writeorders:write- 120/min
- Anotación del servidor: Destructiva
- Requiere confirmación humana
- No reversible
Resultado
generado desde el esquema
No reversible
Esta herramienta no se puede deshacer.
Requiere confirmación humana
Pon esta herramienta en la lista de «preguntar antes de ejecutar» de tu cliente. Las anotaciones son pistas que declara el servidor, no garantías: no decidas la aprobación solo por destructiveHint. El servidor marca esta herramienta con _meta["anthropic, que los clientes que lo respetan usan para preguntar a una persona antes de cada llamada.
meta. indica cuántas tareas se cancelaron, porque tu agenda cambia con esta llamada. NO es reversible desde la API: para recuperarlo tienes que duplicarlo (/unreserve sobre un pedido cancelado responde 409 conflict, no lo devuelve a borrador). Un pedido ya recepcionado (checked_in) no se puede cancelar (409 conflict, nombrando su estado); uno ya cancelado se devuelve tal cual. 404 si el pedido no existe, pertenece a otra cuenta o está archivado. Devuelve el pedido completo, con la misma proyección que su GET.
Argumentos
Identificador del pedido.
Límites: longitud mín. 1
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
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.
Ver los atributos de data
Identificador único del pedido.
Número de pedido legible.
Referencia externa del pedido (por ejemplo, del sistema del cliente); null si no consta.
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
Inicio del periodo de alquiler en ISO 8601 con desplazamiento.
Fin del periodo de alquiler en ISO 8601 con desplazamiento.
Número de días de alquiler facturables; null si no se ha calculado.
Identificador del proyecto al que pertenece el pedido; null si no está vinculado.
Nombre del proyecto al que pertenece el pedido; null si no está vinculado.
Referencia compacta al contacto del pedido; null si no hay.
Mostrar atributos hijosOcultar atributos hijos
Identificador único del contacto.
Nombre del contacto.
Número de artículos del pedido.
Subtotal antes de descuentos e impuestos, como cadena decimal "1234.50" (ROUND_HALF_UP).
Límites: patrón ^-?\d+\.\d{2}$
Total de descuentos como cadena decimal "1234.50" (ROUND_HALF_UP); null si no hay descuento.
Límites: patrón ^-?\d+\.\d{2}$
Total del seguro como cadena decimal "1234.50" (ROUND_HALF_UP).
Límites: patrón ^-?\d+\.\d{2}$
Total de fianzas como cadena decimal "1234.50" (ROUND_HALF_UP).
Límites: patrón ^-?\d+\.\d{2}$
Total de impuestos como cadena decimal "1234.50" (ROUND_HALF_UP).
Límites: patrón ^-?\d+\.\d{2}$
Base imponible (neto antes de impuestos) como cadena decimal "1234.50" (ROUND_HALF_UP).
Límites: patrón ^-?\d+\.\d{2}$
Total con impuestos, como cadena decimal "1234.50" (ROUND_HALF_UP).
Límites: patrón ^-?\d+\.\d{2}$
Valores de los campos personalizados por identificador de campo personalizado; las definiciones están en /api.
Origen desde el que se creó el pedido (por ejemplo web, mobile, admin); null si no consta.
Fecha de creación en ISO 8601 con desplazamiento.
Fecha de la última actualización en ISO 8601 con desplazamiento.
Dirección de facturación del pedido; null si no hay.
Mostrar atributos hijosOcultar atributos hijos
Etiqueta descriptiva de la dirección; null si no consta.
Primera línea de la dirección; null si no consta.
Segunda línea de la dirección; null si no consta.
Ciudad; null si no consta.
Provincia o región; null si no se ha registrado.
Código postal; null si no se ha registrado.
País; null si no consta.
Dirección de envío del pedido; null si no hay.
Mostrar atributos hijosOcultar atributos hijos
Etiqueta descriptiva de la dirección; null si no consta.
Primera línea de la dirección; null si no consta.
Segunda línea de la dirección; null si no consta.
Ciudad; null si no consta.
Provincia o región; null si no se ha registrado.
Código postal; null si no se ha registrado.
País; null si no consta.
Persona de contacto vinculada al pedido; null si no hay ninguna.
Mostrar atributos hijosOcultar atributos hijos
Identificador único del contacto.
Nombre del contacto.
Referencias informativas a los presupuestos generados a partir del pedido.
Mostrar atributos hijosOcultar atributos hijos
Identificador único del documento referenciado.
Número del documento; null hasta que se numera.
Estado del documento en el momento en que se escribió la referencia; null si no consta. Informativo: puede estar desactualizado.
Referencias informativas a las facturas generadas a partir del pedido.
Mostrar atributos hijosOcultar atributos hijos
Identificador único del documento referenciado.
Número del documento; null hasta que se numera.
Estado del documento en el momento en que se escribió la referencia; null si no consta. Informativo: puede estar desactualizado.
Referencias informativas a las proformas generadas a partir del pedido.
Mostrar atributos hijosOcultar atributos hijos
Identificador único del documento referenciado.
Número del documento; null hasta que se numera.
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].; no hay structuredContent. Consulta Errores.
La misma operación por REST
Esta herramienta ejecuta POST /api/v1/orders/{orderId}/cancel.
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasPedidos
Cancelar un pedido
Cancela el pedido y libera lo que tenía reservado: libera el stock, cancela las tareas de logística —preparación, envío y recogida— y marca los documentos vinculados.
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: truey el problema en el primer bloque de texto. Ramifica por sucode.
¿Te ha resultado útil esta página?