Árbol del API · Pedidos › cancelOrder

Cancelar una orden de venta

cancelOrder

Tipo

Mutation

Devuelve

CancelOrderPayload

Permiso de la llave

Creacion de Orden de Venta

Reintentos

Seguros con idempotencyKey

Estable

Cancela una orden de venta. Una orden de venta registrada se elimina; una confirmada regresa a registrada con el motivo en sus comentarios.

El resultado depende del estatus de la orden:

Origen y estatus	Qué pasa	Respuesta
Orden de venta (`OV`) `REGISTERED`	La orden se elimina.	`order: null` y `deletedOrderId` con su `id`.
Orden de venta (`OV`) `CONFIRMED`	Regresa a `REGISTERED` y libera lo apartado; el motivo se agrega a los comentarios.	`order` con su nuevo estatus.
Pedido por especificación (`EP`) `CONFIRMED`	Queda `CANCELLED`.	`order` con estatus `CANCELLED`.
Cualquier otro origen o estatus	No cambia.	`errors` con código `CONFLICT`.

Repetir la cancelación con la misma idempotencyKey no cancela dos veces: devuelve la orden como está en ese momento o, si se eliminó, su deletedOrderId.

cancelOrder(
  id: ID!  reason: String!  userId: ID
  idempotencyKey: String!
): CancelOrderPayload

# cancelar-orden.graphql
mutation CancelarOrden($id: ID!, $motivo: String!, $usuario: ID!, $clave: String!) {
  cancelOrder(id: $id, reason: $motivo, userId: $usuario, idempotencyKey: $clave) {
    order { id folio status }
    deletedOrderId
    errors { field code message }
  }
}

jq -n --rawfile q cancelar-orden.graphql \
  '{query: $q, variables: {"id":"48231","motivo":"El cliente canceló el pedido","usuario":"35","clave":"cancela-pedido-web-100482"}}' |
curl https://mi-empresa.advantacloud.com/graphql \
  -H "Authorization: Bearer $ADVANTA_API_KEY" \
  -H "Content-Type: application/json" \
  --data @-

import { readFile } from "node:fs/promises";

const query = await readFile("cancelar-orden.graphql", "utf8");

const res = await fetch("https://mi-empresa.advantacloud.com/graphql", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.ADVANTA_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    query,
    variables: {
      id: "48231",
      motivo: "El cliente canceló el pedido",
      usuario: "35",
      clave: "cancela-pedido-web-100482",
    },
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);

const { data, errors } = await res.json();
if (errors) throw new Error(errors[0].extensions?.code ?? errors[0].message);
if (data.cancelOrder.errors.length) throw new Error(data.cancelOrder.errors[0].code);
console.log(data.cancelOrder);

import os, requests

URL = "https://mi-empresa.advantacloud.com/graphql"
HEADERS = {"Authorization": f"Bearer {os.environ['ADVANTA_API_KEY']}"}
QUERY = open("cancelar-orden.graphql").read()

r = requests.post(URL, headers=HEADERS, timeout=30, json={
    "query": QUERY,
    "variables": {
        "id": "48231",
        "motivo": "El cliente canceló el pedido",
        "usuario": "35",
        "clave": "cancela-pedido-web-100482",
    },
})
r.raise_for_status()
body = r.json()
if "errors" in body:
    raise RuntimeError(body["errors"][0]["message"])
if body["data"]["cancelOrder"]["errors"]:
    raise RuntimeError(body["data"]["cancelOrder"]["errors"][0]["code"])
print(body["data"]["cancelOrder"])

<?php
$ch = curl_init('https://mi-empresa.advantacloud.com/graphql');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('ADVANTA_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'query' => file_get_contents('cancelar-orden.graphql'),
        'variables' => [
            'id' => '48231',
            'motivo' => 'El cliente canceló el pedido',
            'usuario' => '35',
            'clave' => 'cancela-pedido-web-100482',
        ],
    ]),
]);
$respuesta = curl_exec($ch);
$estatus = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($respuesta === false || $estatus !== 200) {
    throw new RuntimeException("HTTP $estatus " . curl_error($ch));
}
$body = json_decode($respuesta, true);
if (!empty($body['errors'])) {
    throw new RuntimeException($body['errors'][0]['message']);
}
$resultado = $body['data']['cancelOrder'];
if (!empty($resultado['errors'])) {
    throw new RuntimeException($resultado['errors'][0]['code']);
}

Variables

{
  "id": "48231",
  "motivo": "El cliente canceló el pedido",
  "usuario": "35",
  "clave": "cancela-pedido-web-100482"
}

Respuesta 200 OK

{
  "data": {
    "cancelOrder": {
      "order": null,
      "deletedOrderId": "48231",
      "errors": []
    }
  }
}

Ver en el explorador

Argumentos

Argumento	Tipo	Descripción
Orden
`id`ID!	ID!	Orden que quieres cancelar. Obligatorio.
`reason`String!	String!	Motivo de la cancelación; es obligatorio. Al desconfirmar una orden de venta se agrega a sus comentarios. Obligatorio.
`userId`ID	ID	Usuario activo de AdvantaCloud a nombre de quien se cancela. Con Llave API es obligatorio.
Reintentos
`idempotencyKey`String!	String!	Clave única por cancelación. Repetir la petición con la misma clave y los mismos datos devuelve el mismo resultado sin cancelar dos veces. Obligatorio.

Lo que devuelve

CancelOrderPayload

Campos principales de CancelOrderPayload:

Campo	Tipo	Descripción
`order`Order	Order	La orden con su nuevo estatus; `null` si se eliminó o si hubo errores.
`deletedOrderId`ID	ID	El `id` de la orden, cuando se eliminó por estar registrada.
`errors`[FieldError!]!	[FieldError!]!	Errores que impidieron cancelar; vacía si se canceló.

Ver todos los campos de CancelOrderPayload

Permisos

Llave API Integraciones

Creacion de Orden de Venta

La llave ve los registros de toda la empresa del subdominio.

Sin el permiso HTTP 422

La respuesta es HTTP 422 con el cuerpo {"error": "invalid_graphql_request"}, sin data.

Errores

Código	Cuándo ocurre	Qué hacer
HTTP 401	Falta el header `Authorization` o la llave no existe en la empresa del subdominio. La respuesta no trae cuerpo.	Revisa la llave y el subdominio. No reintentes.
HTTP 422	La llave no tiene «Creacion de Orden de Venta». La respuesta es HTTP 422 con el cuerpo `{"error": "invalid_graphql_request"}`, sin `data`.	La llave necesita ese permiso; reintentar no ayuda.
`CONFLICT`	La orden no se puede cancelar en su estatus u origen (ver la tabla), tiene facturas relacionadas, o la empresa sólo deja cancelarla a quien la capturó y `userId` es otro usuario que no es administrador. Llega en `cancelOrder.errors`.	Lee el mensaje; reintentar sin cambios no ayuda.
`VALIDATION`	El motivo está vacío (en `cancelOrder.errors`, `field: "reason"`) o falta un `userId` activo (en `errors` de la respuesta).	Envía el motivo y el usuario.
`NOT_FOUND`	No hay una orden con ese `id` en la empresa.	Revisa el `id`.
HTTP 422	Falla interna o dato rechazado al guardar. El cuerpo es `{"error": …}`, sin `data`.	Si no cambiaste nada, reintenta con la misma `idempotencyKey`.

Los errores de la consulta llegan con HTTP 200 en errors, con su código en extensions.code. Revisa siempre errors, no sólo el estatus HTTP. Errores y reintentos.

Relacionadas

Schema del 26 oct 2026 · Ver cambios¿Algo no cuadra? Repórtalo en ayuda.advanta.mx