Árbol del API · Pedidos › orderDefaults

Valores iniciales de una orden

orderDefaults

Tipo

Query

Devuelve

OrderDefaults!

Permiso de la llave

Ventas

Estable

Devuelve los valores con los que conviene empezar una orden para un cliente: estructura de precios, términos de crédito, tipos de venta, vendedor, almacén, moneda, lugares de entrega y contactos.

Llámala al elegir el cliente y usa sus valores para armar el input de quoteOrder y createOrder: priceStructureId es la estructura de precios que esas operaciones aceptan para el cliente, y creditTerms y saleTypes son las opciones válidas.

Cuando creditTermLocked o salespersonLocked es true, la configuración de la empresa fija ese valor: la orden lo toma aunque envíes otro.

orderDefaults(
  customerId: ID!  userId: ID  warehouseId: ID
  saleTypeId: ID
): OrderDefaults!

# valores-iniciales.graphql
query ValoresIniciales($cliente: ID!, $usuario: ID!) {
  orderDefaults(customerId: $cliente, userId: $usuario) {
    priceStructureId
    creditTerm { id name }
    creditTermLocked
    saleTypes { id name }
    salesperson { id name }
    warehouse { id code name }
    currency { id code }
    shippingMethod { id name }
    addresses { id code street city }
  }
}

Variables: {"cliente": "1207", "usuario": "35"}

jq -n --rawfile q valores-iniciales.graphql \
  '{query: $q, variables: {"cliente":"1207","usuario":"35"}}' |
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("valores-iniciales.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: { cliente: "1207", usuario: "35" },
  }),
});
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.orderDefaults);

import os, requests

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

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

<?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('valores-iniciales.graphql'),
        'variables' => ['cliente' => '1207', 'usuario' => '35'],
    ]),
]);
$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']['orderDefaults'];

Respuesta 200 OK

{
  "data": {
    "orderDefaults": {
      "priceStructureId": "4",
      "creditTerm": {
        "id": "2",
        "name": "Crédito 30 días"
      },
      "creditTermLocked": false,
      "saleTypes": [
        {
          "id": "1",
          "name": "Venta normal"
        },
        {
          "id": "3",
          "name": "Venta a distribuidor"
        }
      ],
      "salesperson": {
        "id": "18",
        "name": "Laura Méndez"
      },
      "warehouse": {
        "id": "3",
        "code": "MTY01",
        "name": "Monterrey Centro"
      },
      "currency": {
        "id": "1",
        "code": "MXN"
      },
      "shippingMethod": {
        "id": "2",
        "name": "Entrega a domicilio"
      },
      "addresses": [
        {
          "id": "88",
          "code": "MATRIZ",
          "street": "Av. Constitución",
          "city": "Monterrey"
        }
      ]
    }
  }
}

Ver en el explorador

Argumentos

Argumento	Tipo	Descripción
`customerId`ID!	ID!	Cliente de la orden. Obligatorio.
`userId`ID	ID	Usuario activo de AdvantaCloud a nombre de quien se capturará la orden. Obligatorio con Llave API: el vendedor y el almacén propuestos pueden depender de ese usuario.
`warehouseId`ID	ID	Almacén que quieres usar; si no es un almacén de venta válido, se propone otro.
`saleTypeId`ID	ID	Tipo de venta, cuando el término de crédito depende de él.

Lo que devuelve

OrderDefaults!

Campos principales de OrderDefaults:

Campo	Tipo	Descripción
`priceStructureId`ID	ID	Estructura de precios que `quoteOrder` y `createOrder` aceptan para el cliente.
`creditTerm`CreditTerm	CreditTerm	Término de crédito propuesto.
`creditTerms`[CreditTerm!]!	[CreditTerm!]!	Términos de crédito que puede usar la orden.
`creditTermLocked`Boolean!	Boolean!	`true` si la empresa fija el término de crédito (del cliente o del tipo de venta).
`saleTypes`[SaleType!]!	[SaleType!]!	Tipos de venta activos.
`salesperson`Employee	Employee	Vendedor propuesto (el del cliente, o el del usuario si así lo configura la empresa).
`salespersonLocked`Boolean!	Boolean!	`true` si la empresa fija el vendedor.
`warehouse`Warehouse	Warehouse	Almacén propuesto.
`currency`Currency	Currency	Moneda propuesta.
`shippingMethod`ShippingMethod	ShippingMethod	Forma de embarque del cliente.
`addresses`[CustomerAddress!]!	[CustomerAddress!]!	Lugares de entrega del cliente. Requiere «Cliente» en la llave; sin él llega una lista vacía.
`contacts`[CustomerContact!]!	[CustomerContact!]!	Contactos del cliente. Requiere «Cliente» en la llave; sin él llega una lista vacía.

Ver todos los campos de OrderDefaults

Permisos

Llave API Integraciones

Ventas

Cliente

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

«Cliente»: Sin él la consulta responde FORBIDDEN.

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 «Ventas». La respuesta es HTTP 422 con el cuerpo `{"error": "invalid_graphql_request"}`, sin `data`.	La llave necesita ese permiso; reintentar no ayuda.
`FORBIDDEN`	La llave tiene «Ventas» pero no «Cliente».	La llave necesita también «Cliente».
`VALIDATION`	Falta `userId` o ese usuario no está activo.	Envía el usuario de tu integración.
`NOT_FOUND`	El cliente o el tipo de venta no existe en la empresa.	Revisa `customerId` y `saleTypeId`.
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