Árbol del API · Catálogos › unitOptions

Unidades de medida

unitOptions

Tipo

Query

Devuelve

[UnitOption!]!

Permiso de la llave

Selects y autocompletes GraphQL

Estable

Lista las unidades de medida de la empresa ordenadas por clave, o sólo la unidad de un artículo.

Cada artículo tiene una sola unidad de medida, la de Product.unit, y sus precios y cantidades están en esa unidad. Con productId recibes sólo esa.

unitOptions(
  productId: ID
): [UnitOption!]!

# unidades.graphql
query Unidades {
  unitOptions {
    value
    code
    label
  }
}

jq -n --rawfile q unidades.graphql \
  '{query: $q}' |
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("unidades.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 }),
});
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.unitOptions);

import os, requests

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

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

<?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('unidades.graphql'),
    ]),
]);
$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']['unitOptions'];

Respuesta 200 OK · 3 unidades

{
  "data": {
    "unitOptions": [
      {
        "value": "4",
        "code": "CJA",
        "label": "CJA | Caja"
      },
      {
        "value": "2",
        "code": "KG",
        "label": "KG | Kilogramo"
      },
      {
        "value": "1",
        "code": "PZA",
        "label": "PZA | Pieza"
      }
    ]
  }
}

Ver en el explorador

Argumentos

Argumento	Tipo	Descripción
`productId`ID	ID	Sólo la unidad de medida de este artículo. Si el artículo no existe, la lista llega vacía.

Lo que devuelve

[UnitOption!]!

Campos principales de UnitOption:

Campo	Tipo	Descripción
`value`ID!	ID!	Identificador de la unidad; es el mismo `id` de `Product.unit`.
`code`String	String	Clave de la unidad, p. ej. `PZA`.
`label`String!	String!	Clave y nombre de la unidad, p. ej. `PZA \| Pieza`.

Ver todos los campos de UnitOption

Permisos

Llave API Integraciones

Selects y autocompletes GraphQL

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

Sin el permiso Sin error

La consulta responde sin error, pero la lista llega vacía.

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.
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