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.

POST /imports/{id}/commit

Confirmar una carga

Aplica las filas válidas de la carga. Si la carga no tiene nada por confirmar o ya se está confirmando, responde 409 import_refused.

Alcance (cliente de integración)
products:write
Permiso (token de usuario)
imports.run
Idempotency-Key
Opcional
Requisitos
Carga masiva activa

Parámetros de ruta

  • id integer obligatorio

    Identificador numérico del recurso.

Cabeceras

  • Idempotency-Key string

    Llave única por operación (se recomienda un UUID v4). Reenviar la misma solicitud con la misma llave en las siguientes 24 horas devuelve la respuesta original sin repetir la operación.

Respuestas

202 Carga aplicada o en proceso.
  • data objeto obligatorio
    9 campos de data
    • id integer obligatorio
    • kind string obligatorio
    • status string obligatorio
      Valores: uploaded, validating, validated, invalid, committing, committed, failed, cancelled
    • file string | null
    • rows objeto obligatorio
      3 campos de rows
      • total integer | null
      • valid integer | null
      • error integer | null
    • documents objeto obligatorio
      3 campos de documents
      • total integer | null
      • valid integer | null
      • committed integer | null
    • structure_errors array de textos
    • error_report_url string (uri) | null

      Excel con cada fila rechazada y su motivo.

    • committed_at string (date-time) | null
  • warning string

    Aviso cuando el mismo archivo ya se había subido.

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.

409 La solicitud choca con el estado actual (por ejemplo, un pedido ya está en otra ola).

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 -X POST "https://empresa.chainlink.mx/api/v1/imports/101/commit" \
  -H "Authorization: Bearer $CHAINLINK_TOKEN" \
  -H "Accept: application/json" \
  -H "Idempotency-Key: $(uuidgen)"
Respuesta 
{
    "data": {
        "id": 1,
        "kind": "products",
        "status": "committed",
        "file": "catalogo.csv",
        "rows": {
            "total": 1,
            "valid": 1,
            "error": 0
        },
        "documents": {
            "total": 1,
            "valid": 1,
            "committed": 1
        },
        "structure_errors": [],
        "error_report_url": null,
        "committed_at": "2026-10-06T10:20:11-06:00"
    }
}