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 /waves

Listar olas

Requiere el módulo de olas y el permiso exits.manage (o el alcance pickings:read).

Alcance (cliente de integración)
pickings:read
Permiso (token de usuario)
exits.manage
Idempotency-Key
No aplica
Requisitos
Módulo de olas

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: -id

    Campo de orden; antepón - para descendente.

    Valores: id, -id, created_at, -created_at, updated_at, -updated_at, due_at, -due_at
  • updated_since string (date-time)

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

  • status string

    Estado de la ola.

    Valores: draft, planned, released, in_progress, picked, completed, closed, cancelled
  • warehouse string

    Código del almacén.

  • from string (date)

    Creadas desde esta fecha.

  • to string (date)

    Creadas hasta esta fecha.

Respuestas

200 Página de olas.
  • data array de objetos obligatorio
    12 campos de data
    • id integer obligatorio
    • code string obligatorio
    • warehouse_code string | null
    • strategy string obligatorio
      Valores: discrete, by_customer, batch, cluster, zone, pick_and_pass
    • status string obligatorio
      Valores: draft, planned, released, in_progress, picked, completed, closed, cancelled
    • carrier_code string | null
    • cutoff_at string (date-time) | null
    • released_at string (date-time) | null
    • metrics objeto

      Pedidos, líneas, unidades y avance de la ola.

    • created_at string (date-time) | null
    • updated_at string (date-time) | null
    • orders array de objetos

      Solo en el detalle.

      2 campos de orders
      • picking_id integer obligatorio
      • status string obligatorio
  • 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/waves" \
  -H "Authorization: Bearer $CHAINLINK_TOKEN" \
  -H "Accept: application/json"
Respuesta 
{
    "data": [
        {
            "id": 1,
            "code": "W-0001",
            "warehouse_code": "CEDIS-GDL",
            "strategy": "cluster",
            "status": "planned",
            "carrier_code": null,
            "cutoff_at": null,
            "released_at": null,
            "metrics": {
                "lines": 2,
                "trips": 0,
                "units": 3,
                "orders": 2,
                "standard_minutes": 1
            },
            "created_at": "2026-10-06T10:20:11-06:00",
            "updated_at": "2026-10-06T10:20:11-06:00"
        }
    ],
    "links": {
        "first": "https://empresa.chainlink.mx/api/v1/waves?page=1",
        "last": "https://empresa.chainlink.mx/api/v1/waves?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [],
        "path": "https://empresa.chainlink.mx/api/v1/waves",
        "per_page": 25,
        "to": 1,
        "total": 1
    }
}