Árbol del API · Catálogos › warehouseOptions

Almacenes

warehouseOptions

Tipo

Query

Devuelve

[WarehouseOption!]!

Permiso de la llave

Selects y autocompletes GraphQL

Estable

Lista los almacenes de la empresa ordenados por clave, con el identificador que piden las órdenes de venta y los cobros.

value es el warehouseId que piden las órdenes de createOrder, los cobros de createCollection y sus terminales en bankTerminals. Para una orden nueva, orderDefaults propone el almacén de venta que corresponde al cliente.

No llegan los almacenes de tránsito que AdvantaCloud usa en los traspasos ni los de clave terminada en -PR o -TR.

warehouseOptions(
  active: Boolean  companyId: ID
): [WarehouseOption!]!

# almacenes.graphql
query Almacenes {
  warehouseOptions(active: true) {
    value
    code
    label
    companyId
  }
}

jq -n --rawfile q almacenes.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("almacenes.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.warehouseOptions);

import os, requests

URL = "https://mi-empresa.advantacloud.com/graphql"
HEADERS = {"Authorization": f"Bearer {os.environ['ADVANTA_API_KEY']}"}
QUERY = open("almacenes.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"]["warehouseOptions"])

<?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('almacenes.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']['warehouseOptions'];

Respuesta 200 OK · 2 almacenes

{
  "data": {
    "warehouseOptions": [
      {
        "value": "7",
        "code": "GDL02",
        "label": "GDL02 | Guadalajara Periférico",
        "companyId": "1"
      },
      {
        "value": "3",
        "code": "MTY01",
        "label": "MTY01 | Monterrey Centro",
        "companyId": "1"
      }
    ]
  }
}

Ver en el explorador

Argumentos

Argumento	Tipo	Descripción
`active`Boolean	Boolean	`true`: sólo los almacenes activos. Si lo omites o envías `false`, llegan activos e inactivos.
`companyId`ID	ID	Sólo los almacenes de esta empresa del grupo. Es el `companyId` que llega en cada almacén.

Lo que devuelve

[WarehouseOption!]!

Campos principales de WarehouseOption:

Campo	Tipo	Descripción
`value`ID!	ID!	Identificador del almacén; es el que se envía en `warehouseId`.
`code`String	String	Clave del almacén, p. ej. `MTY01`.
`label`String!	String!	Clave y nombre del almacén, p. ej. `MTY01 \| Monterrey Centro`.
`companyId`ID	ID	Empresa del grupo a la que pertenece el almacén. Sirve para filtrar con `warehouseOptions(companyId:)`.

Ver todos los campos de WarehouseOption

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