Árbol del API · Pedidos › order

Detalle de una orden de venta

order

Tipo

Query

Devuelve

Order

Permiso de la llave

Ventas

Estable

Devuelve una orden de venta por su id, con su cliente, sus importes y sus partidas.

Si la llave no tiene el permiso, la respuesta es order: null sin error; una orden que no existe responde NOT_FOUND. Así distingues una llave mal configurada de un id equivocado.

Para el PDF de la orden, pide pdfUrl(formatId:) con un formato de orderPrintOptions: la liga está firmada y vence a los 10 minutos.

order(
  id: ID!
): Order

# orden.graphql
query Orden($id: ID!) {
  order(id: $id) {
    id
    folio
    status
    customer { id name rfc }
    deliveryAddress { code street city state zip }
    currency
    subtotal
    tax
    total
    lines(first: 100) {
      nodes {
        lineNumber
        product { idpart name }
        quantity
        unit { code }
        unitPrice
        total
      }
      pageInfo { hasNextPage endCursor }
    }
  }
}

Variables: {"id": "48213"}

jq -n --rawfile q orden.graphql \
  '{query: $q, variables: {"id":"48213"}}' |
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("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: "48213" },
  }),
});
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);
console.log(data.order);

import os, requests

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

r = requests.post(URL, headers=HEADERS, timeout=30, json={
    "query": QUERY,
    "variables": {"id": "48213"},
})
r.raise_for_status()
body = r.json()
if "errors" in body:
    raise RuntimeError(body["errors"][0]["message"])
print(body["data"]["order"])

<?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('orden.graphql'),
        'variables' => ['id' => '48213'],
    ]),
]);
$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']['order'];

Respuesta 200 OK

{
  "data": {
    "order": {
      "id": "48213",
      "folio": "OV00512",
      "status": "CONFIRMED",
      "customer": {
        "id": "1207",
        "name": "Público en General",
        "rfc": "XAXX010101000"
      },
      "deliveryAddress": {
        "code": "MATRIZ",
        "street": "Av. Constitución",
        "city": "Monterrey",
        "state": "NLE",
        "zip": "64000"
      },
      "currency": "MXN",
      "subtotal": "4200.00",
      "tax": "672.00",
      "total": "4872.00",
      "lines": {
        "nodes": [
          {
            "lineNumber": 1,
            "product": {
              "idpart": "TOR-0420",
              "name": "Tornillo hexagonal 1/4 x 2"
            },
            "quantity": "1200.00",
            "unit": {
              "code": "PZA"
            },
            "unitPrice": "2.50",
            "total": "3480.00"
          },
          {
            "lineNumber": 2,
            "product": {
              "idpart": "TUE-0420",
              "name": "Tuerca hexagonal 1/4"
            },
            "quantity": "1200.00",
            "unit": {
              "code": "PZA"
            },
            "unitPrice": "1.00",
            "total": "1392.00"
          }
        ],
        "pageInfo": {
          "hasNextPage": false,
          "endCursor": "WyJvcmRlci1saW5lczo0ODIxMyIsWzIsNzMxNTYyXV0="
        }
      }
    }
  }
}

Ver en el explorador

Argumentos

Argumento	Tipo	Descripción
`id`ID!	ID!	Identificador de la orden, el mismo `id` que llega en `ordersConnection` o en `createOrder`. Obligatorio.

Lo que devuelve

Order

Campos principales de Order:

Campo	Tipo	Descripción
`id`ID	ID	Identificador de la orden; úsalo con `order(id:)`.
`folio`String	String	Folio visible en la aplicación y en los documentos, p. ej. `OV00512`.
`status`OrderStatus!	OrderStatus!	Estatus de la orden.
`customer`Customer	Customer	Cliente de la orden.
`deliveryAddress`CustomerAddress	CustomerAddress	Lugar de entrega.
`contact`CustomerContact	CustomerContact	Contacto del cliente para esta orden.
`creditTerm`CreditTerm	CreditTerm	Término de crédito.
`currency`String	String	Clave de la moneda de la orden, p. ej. `MXN`.
`exchangeRate`Decimal	Decimal	Tipo de cambio de la orden.
`subtotal`Money	Money	Importe antes de impuestos.
`discount`Money	Money	Descuento total.
`tax`Money	Money	Impuestos.
`total`Money	Money	Total de la orden.
`openBalance`Money	Money	Saldo por cobrar de la orden.
`lines`OrderLineConnection!	OrderLineConnection!	Partidas de la orden por número de partida, paginadas con cursores igual que las listas.20 por omisión, hasta 100 por página.
`payments`[OrderPayment!]	[OrderPayment!]	Cobros aplicados a la orden, del más reciente al más antiguo. Requiere «Ventas» en la llave; sin él llega `null`.
`pdfUrl`String	String	Liga al PDF de la orden con el formato (`formatId`) y la leyenda opcional (`legendId`) de `orderPrintOptions`. Está firmada y vence a los 10 minutos. Requiere «Ventas» en la llave; sin él llega `null`.

Ver todos los campos de Order

Las partidas llegan en lines, una conexión con 20 partidas por omisión y hasta 100 por página. Para una orden con más partidas, repite la consulta con lines(first: 100, after: $cursor).

Permisos

Llave API Integraciones

Ventas

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

Sin el permiso Sin error

La consulta responde sin error, pero el resultado llega null.

Así lo conserva el API para las integraciones que ya lo usan: revisa los permisos de la llave si una lista llega vacía sin razón.

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.
`NOT_FOUND`	No hay una orden con ese `id` en la empresa, o el `id` es de una cotización de venta.	Revisa el `id`; las cotizaciones de venta no se consultan aquí.
HTTP 422	Falla interna o dato rechazado al guardar. El cuerpo es `{"error": …}`, sin `data`.	Si no cambiaste nada, reintenta con espera exponencial.

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