Desarrolladores API v1

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/{id}

Consultar un almacén

El almacén con todas sus ubicaciones. Para almacenes grandes conviene paginar con GET /warehouse-positions?warehouse_id=.

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

Parámetros de ruta

  • id integer obligatorio

    Identificador numérico del recurso.

Respuestas

200 El almacén con sus ubicaciones.
  • data objeto 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
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.

404 El recurso no existe.

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/101" \
  -H "Authorization: Bearer $CHAINLINK_TOKEN" \
  -H "Accept: application/json"
Respuesta 
{
    "data": {
        "id": 1,
        "whs_code": "CEDIS-GDL",
        "name": "CEDIS Guadalajara",
        "site_code": null,
        "is_virtual": false,
        "timezone": null,
        "street": null,
        "block": null,
        "city": null,
        "state": null,
        "zip_code": null,
        "country": null,
        "positions_count": 20,
        "positions": [
            {
                "id": 1,
                "warehouse_id": 1,
                "whs_code": "CEDIS-GDL",
                "bin_code": "A-01-01-1",
                "description": null,
                "type": "pick_face",
                "zone_id": 1,
                "aisle": "01",
                "rack": "01",
                "level": "1",
                "slot": null,
                "pick_sequence": 1,
                "is_pickable": true,
                "is_blocked": false,
                "is_crossdock": false,
                "disabled": false,
                "capacity_units": null,
                "capacity_weight_kg": null,
                "capacity_volume_m3": null,
                "created_at": "2026-10-06T16:20:11.000000Z",
                "updated_at": "2026-10-06T16:20:11.000000Z"
            },
            {
                "id": 2,
                "warehouse_id": 1,
                "whs_code": "CEDIS-GDL",
                "bin_code": "A-01-01-2",
                "description": null,
                "type": "pick_face",
                "zone_id": 1,
                "aisle": "01",
                "rack": "01",
                "level": "2",
                "slot": null,
                "pick_sequence": 2,
                "is_pickable": true,
                "is_blocked": false,
                "is_crossdock": false,
                "disabled": false,
                "capacity_units": null,
                "capacity_weight_kg": null,
                "capacity_volume_m3": null,
                "created_at": "2026-10-06T16:20:11.000000Z",
                "updated_at": "2026-10-06T16:20:11.000000Z"
            }
        ],
        "created_at": "2026-10-06T16:20:11.000000Z",
        "updated_at": "2026-10-06T16:20:11.000000Z"
    }
}