Consultas e informes

Stock de artículos

POST https://api.afer.pro/consultarStock

El stock de tus artículos, con el número de referencias bajo mínimo para la tarjeta de alertas del panel.

Listado paginado de artículos con su stock actual y su stock mínimo. articulos_bajo_minimo llega siempre (independientemente de los filtros): es el KPI de la tarjeta de alertas.

Un artículo está bajo mínimo cuando su stock es igual o inferior al mínimo configurado (solo cuenta entre los que tienen mínimo > 0, el mismo criterio que el listado interno de productos).

Autenticación

Envía tus claves API en las cabeceras X-API-KEY y X-API-SECRET. La cuenta sobre la que se opera se resuelve automáticamente a partir de la clave. Cómo obtener tus claves →

Este endpoint requiere autenticación con API key: sin credenciales responde 401.

Parámetros del cuerpo

El cuerpo de la petición es un objeto JSON con Content-Type: application/json.

`bajo_minimo`bool opcional	Con `true`, solo los artículos bajo mínimo.
`busqueda`string opcional	Filtra por descripción del artículo.
`pagina`int opcional	Página a devolver. Por defecto `1`.
`por_pagina`int opcional	Resultados por página. Por defecto `100`, máximo `500`.

Ejemplo de petición

curl -X POST 'https://api.afer.pro/consultarStock' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: afer_tk_TU_TOKEN' \
  -H 'X-API-SECRET: afer_sk_TU_SECRET' \
  -d '{
    "bajo_minimo": true
}'

<?php

$data = [
  'bajo_minimo' => true,
];

$ch = curl_init('https://api.afer.pro/consultarStock');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'X-API-KEY: afer_tk_TU_TOKEN',
    'X-API-SECRET: afer_sk_TU_SECRET',
]);

$respuesta = json_decode(curl_exec($ch), true);
curl_close($ch);

const respuesta = await fetch('https://api.afer.pro/consultarStock', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-API-KEY': 'afer_tk_TU_TOKEN',
    'X-API-SECRET': 'afer_sk_TU_SECRET'
  },
  body: JSON.stringify({
      "bajo_minimo": true
  })
});

const resultado = await respuesta.json();

Respuesta

200 · application/json

{
    "errorCode": 200,
    "errorMsg": "",
    "data": {
        "total_articulos": 2,
        "articulos_bajo_minimo": 2,
        "pagina": 1,
        "por_pagina": 100,
        "num_paginas": 1,
        "articulos": [
            {
                "articulo_fk": 52087,
                "descripcion": "CANNONDALE SYNAPSE CARBON",
                "familia_fk": 18,
                "stock": 2,
                "stock_minimo": 4,
                "bajo_minimo": true
            }
        ]
    }
}

Notas

articulo_fk es el mismo identificador que usan las líneas de crearFactura y los endpoints de disponibilidad.