Endpoints de la API. Especificación exacta de cada operación de la API v1 (parámetros, cuerpo, respuestas y ejemplos), generada del documento OpenAPI con el que se valida cada respuesta real. Los procedimientos completos están en Guías.

GET /warehouses

Listar almacenes

Alcance (cliente de integración)
warehouses:read
Permiso (token de usuario)
Token válido
Idempotency-Key
No aplica

Parámetros de consulta

  • page integer valor por omisión: 1

    Número de página, desde 1.

  • per_page integer valor por omisión: 25

    Elementos por página, de 1 a 100. Un valor mayor se toma como 100.

  • sort string valor por omisión: name

    Campo de orden; antepón - para descendente.

    Valores: name, -name, whs_code, -whs_code, updated_at, -updated_at
  • updated_since string (date-time)

    Solo lo que cambió desde esta fecha (ISO 8601), para sincronización incremental.

  • search string

    Parte del nombre o del código.

  • whs_code string

    Código exacto del almacén.

Respuestas

200 Página de almacenes, con el número de ubicaciones de cada uno.
  • data array de objetos obligatorio
    16 campos de data
    • id integer obligatorio
    • whs_code string obligatorio

      Código del almacén; así lo nombran documentos, órdenes y olas.

    • name string obligatorio
    • site_code string | null
    • is_virtual boolean
    • timezone string | null
    • street string | null
    • block string | null
    • city string | null
    • state string | null
    • zip_code string | null
    • country string | null
    • positions_count integer
    • positions array de objetos

      Solo en el detalle.

      22 campos de positions
      • id integer obligatorio
      • warehouse_id integer obligatorio
      • whs_code string | null
      • bin_code string obligatorio
      • description string | null
      • type string | null

        Uso de la ubicación (storage, pick_face, reserve, receiving, staging_out, dock…).

      • zone_id integer | null
      • aisle string | null
      • rack string | null
      • level string | null
      • slot string | null
      • pick_sequence integer | null
      • is_pickable boolean
      • is_blocked boolean
      • is_crossdock boolean
      • disabled boolean
      • capacity_units number | null
      • capacity_weight_kg number | null
      • capacity_volume_m3 number | null
      • warehouse objeto | null
        3 campos de warehouse
        • id integer
        • whs_code string
        • name string
      • created_at string (date-time) | null
      • updated_at string (date-time) | null
    • created_at string (date-time) | null
    • updated_at string (date-time) | null
  • links objeto obligatorio
    4 campos de links
    • first string (uri) | null obligatorio
    • last string (uri) | null obligatorio
    • prev string (uri) | null obligatorio

      Página anterior; null en la primera.

    • next string (uri) | null obligatorio

      Página siguiente; null en la última.

  • meta objeto obligatorio
    8 campos de meta
    • current_page integer obligatorio
    • from integer | null

      Posición del primer elemento de la página.

    • last_page integer obligatorio
    • links array de objetos

      Enlaces de página para interfaces; no hace falta leerlos.

    • path string (uri)
    • per_page integer obligatorio
    • to integer | null
    • total integer obligatorio

      Total de elementos con los filtros aplicados.

401 Falta el token o no es válido.

Cuerpo: el sobre de error.

402 La función no está en el plan de la empresa, o la cuenta está suspendida o cancelada.

Cuerpo: el sobre de error.

403 Al cliente le falta el alcance (missing_scope), al usuario el permiso (forbidden), o el token de usuario no tiene acceso a la ruta (client_not_allowed: aplicación móvil o usuario con verificación en dos pasos).

Cuerpo: el sobre de error.

422 Datos no válidos (validation_failed), una llave de idempotencia reutilizada con otra solicitud (idempotency_key_reused) o una regla de negocio que bloquea la operación (rule_blocked).

Cuerpo: el sobre de error.

429 Se superó el límite por minuto. Reintente después de los segundos de Retry-After.

Cuerpo: el sobre de error.

Probar

Probar con una instancia

La solicitud sale del navegador hacia la instancia indicada; nada pasa por chainlink.mx. El token se conserva solo en esta pestaña.

Obtener un token con un cliente de integración

Credenciales de Configuración › Clientes API (grant client_credentials). El secreto se usa una vez y no se guarda. Los tokens de usuario se obtienen fuera de la consola; ver Autenticación.

Solicitud
curl "https://empresa.chainlink.mx/api/v1/warehouses" \
  -H "Authorization: Bearer $CHAINLINK_TOKEN" \
  -H "Accept: application/json"
Respuesta
{
    "data": [
        {
            "id": 1,
            "whs_code": "CEDIS-GDL",
            "name": "CEDIS Guadalajara",
            "site_code": "GDL",
            "is_virtual": false,
            "timezone": "America/Mexico_City",
            "street": "Av. Vallarta 1200",
            "block": null,
            "city": "Guadalajara",
            "state": "Jalisco",
            "zip_code": "44100",
            "country": "MX",
            "positions_count": 412,
            "created_at": "2026-09-14T15:00:00.000000Z",
            "updated_at": "2026-09-30T12:00:00.000000Z"
        }
    ],
    "links": {
        "first": "https://demo.chainlink.mx/api/v1/warehouses?page=1",
        "last": "https://demo.chainlink.mx/api/v1/warehouses?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [],
        "path": "https://demo.chainlink.mx/api/v1/warehouses",
        "per_page": 25,
        "to": 1,
        "total": 1
    }
}