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

Consultar una carga

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

Parámetros de ruta

id integer obligatorio

Identificador numérico del recurso.

Respuestas

200 Estado, conteos y enlace al reporte de errores.

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.

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.

Instancia https://.chainlink.mx Token de acceso

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.

client_id client_secret

Alcances (scope)

id obligatorio

Solicitud

curl "https://empresa.chainlink.mx/api/v1/imports/101" \
  -H "Authorization: Bearer $CHAINLINK_TOKEN" \
  -H "Accept: application/json"

<?php

$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://empresa.chainlink.mx/api/v1/imports/101', [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('CHAINLINK_TOKEN'),
        'Accept' => 'application/json',
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const response = await fetch('https://empresa.chainlink.mx/api/v1/imports/101', {
  headers: {
    Authorization: `Bearer ${process.env.CHAINLINK_TOKEN}`,
    Accept: 'application/json',
  },
});

const data = await response.json();

import os

import requests

response = requests.get(
    "https://empresa.chainlink.mx/api/v1/imports/101",
    headers={
        "Authorization": f"Bearer {os.environ['CHAINLINK_TOKEN']}",
        "Accept": "application/json",
    },
)
data = response.json()

Respuesta

{
    "data": {
        "id": 1,
        "kind": "products",
        "status": "validated",
        "file": "catalogo.csv",
        "rows": {
            "total": 1,
            "valid": 1,
            "error": 0
        },
        "documents": {
            "total": 1,
            "valid": 1,
            "committed": 0
        },
        "structure_errors": [],
        "error_report_url": null,
        "committed_at": null
    }
}

{
    "error": {
        "code": "unauthenticated",
        "message": "Falta el token de acceso o ya no es válido.",
        "doc_url": "https://chainlink.mx/developers/errores#unauthenticated",
        "request_id": "req_01j9x2m4k7q8r5t6v3w0y1z2a3"
    },
    "errors": [],
    "message": "Falta el token de acceso o ya no es válido."
}

{
    "error": {
        "code": "feature_not_in_plan",
        "message": "Función no disponible en tu plan actual.",
        "feature": "webhooks.enabled",
        "upgrade_url": "/billing/plans",
        "doc_url": "https://chainlink.mx/developers/errores#feature_not_in_plan",
        "request_id": "req_01j9x2m4k7q8r5t6v3w0y1z2a3"
    },
    "errors": [],
    "message": "Función no disponible en tu plan actual."
}

{
    "error": {
        "code": "missing_scope",
        "message": "El cliente no tiene el alcance products:write.",
        "scope": "products:write",
        "doc_url": "https://chainlink.mx/developers/errores#missing_scope",
        "request_id": "req_01j9x2m4k7q8r5t6v3w0y1z2a3"
    },
    "errors": [],
    "message": "El cliente no tiene el alcance products:write."
}

{
    "error": {
        "code": "not_found",
        "message": "El recurso no existe.",
        "doc_url": "https://chainlink.mx/developers/errores#not_found",
        "request_id": "req_01j9x2m4k7q8r5t6v3w0y1z2a3"
    },
    "errors": [],
    "message": "El recurso no existe."
}

{
    "error": {
        "code": "rate_limited",
        "message": "Superaste el límite de solicitudes por minuto. Espera los segundos que indica Retry-After.",
        "doc_url": "https://chainlink.mx/developers/errores#rate_limited",
        "request_id": "req_01j9x2m4k7q8r5t6v3w0y1z2a3"
    },
    "errors": [],
    "message": "Superaste el límite de solicitudes por minuto. Espera los segundos que indica Retry-After."
}