SmartPyme Inventory: Product Catalog and Stock Levels

The Inventory endpoints give you programmatic access to your full product catalog and warehouse stock data in SmartPyme. You can filter by category, brand, or stock status to build integrations such as low-stock alerts, e-commerce catalog syncs, or cost-of-goods reports. All requests must include your API key in the Authorization header.

GET /inventory

Returns a paginated list of products from your catalog. Each product record includes pricing, cost, and an inventarios array showing current stock levels broken down by warehouse and branch.

curl --request GET \
  --url "https://api.smartpyme.site/api/external/v1/inventory?marca=Dell&con_stock=true&per_page=50" \
  --header "Authorization: Bearer {api_key}"

import requests

url = "https://api.smartpyme.site/api/external/v1/inventory"
headers = {"Authorization": "Bearer {api_key}"}
params = {
    "marca": "Dell",
    "con_stock": True,
    "per_page": 50,
}

response = requests.get(url, headers=headers, params=params)
print(response.json())

const response = await fetch(
  "https://api.smartpyme.site/api/external/v1/inventory" +
    "?marca=Dell&con_stock=true&per_page=50",
  {
    method: "GET",
    headers: { Authorization: "Bearer {api_key}" },
  }
);
const data = await response.json();
console.log(data);

Query parameters

string

Filter by product SKU or internal code. Performs a partial match.

string

Filter by product name. Performs a partial, case-insensitive match.

string

Filter by category name. Performs a partial match against nombre_categoria.

string

Filter by brand name. Performs a partial match.

string

Filter by product type. Accepted values: Producto, Servicio.

integer

Filter by active status. Use 1 for active products and 0 for inactive products.

boolean

When true, returns only products that have stock greater than zero across at least one warehouse.

boolean

When true, returns only products whose current stock is at or below their configured minimum stock threshold.

integer

Page number to retrieve. Defaults to 1.

integer

Number of records per page. Accepts values between 1 and 200. Defaults to 100.

string

Field to sort results by. Accepted values: nombre, codigo, precio, costo, created_at.

string

Sort direction. Accepted values: asc, desc.

Response example

{
  "success": true,
  "data": [
    {
      "id": 301,
      "nombre": "Laptop Dell Inspiron 15",
      "descripcion": "Laptop 15.6\" Intel Core i5, 8GB RAM, 512GB SSD",
      "codigo": "LAP-DELL-015",
      "barcode": "7501234567890",
      "nombre_categoria": "Electrónicos",
      "precio": 850.00,
      "costo": 620.00,
      "costo_anterior": 610.00,
      "costo_promedio": 615.50,
      "marca": "Dell",
      "tipo": "Producto",
      "enable": 1,
      "img": "https://cdn.smartpyme.site/products/lap-dell-015.jpg",
      "created_at": "2024-06-01T08:00:00Z",
      "updated_at": "2025-01-10T14:22:00Z",
      "inventarios": [
        {
          "id_producto": 301,
          "stock": 12,
          "stock_minimo": 5,
          "stock_maximo": 50,
          "nota": null,
          "nombre_bodega": "Bodega Principal",
          "nombre_sucursal": "Sucursal Central"
        },
        {
          "id_producto": 301,
          "stock": 4,
          "stock_minimo": 2,
          "stock_maximo": 20,
          "nota": "Revisar vencimiento",
          "nombre_bodega": "Bodega Norte",
          "nombre_sucursal": "Sucursal Norte"
        }
      ]
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 50,
    "total": 1,
    "total_pages": 1,
    "has_next": false,
    "has_prev": false
  },
  "meta": {
    "empresa": "Mi Empresa S.A.",
    "timestamp": "2025-01-31T15:00:00Z",
    "filters_applied": {
      "marca": "Dell",
      "con_stock": true
    }
  }
}

Response fields

boolean

Indicates whether the request completed successfully.

array

Array of product objects matching the applied filters.

Show Product fields

integer

Unique numeric identifier for the product.

string

Full display name of the product.

string

Optional long-form description of the product.

string

Internal SKU or product code used across your catalog.

string

Barcode or EAN associated with the product, if configured.

string

Category name assigned to the product.

number

Current retail price of the product.

number

Most recent purchase cost of the product.

number

Previous purchase cost, retained for cost-trend comparisons.

number

Weighted average cost calculated across all purchase batches.

string

Brand name of the product.

string

Product type: Producto for physical goods or Servicio for services.

integer

Active status flag. 1 means the product is active; 0 means it is inactive.

string

URL of the product image, if one has been uploaded.

string

ISO 8601 timestamp of when the product record was created.

string

ISO 8601 timestamp of the most recent update to the product record.

array

Stock levels for this product broken down by warehouse and branch.

Show Stock per warehouse

integer

ID of the product this stock entry belongs to.

number

Current available stock quantity in this warehouse. Supports up to three decimal places.

number

Minimum stock threshold configured for this product in this warehouse. Stock at or below this level matches the stock_minimo filter.

number

Maximum stock capacity configured for this product in this warehouse.

string

Optional notes recorded for this product in this warehouse (e.g. "Revisar vencimiento").

string

Name of the warehouse holding this stock.

string

Name of the branch or location to which this warehouse belongs.

GET /inventory/{id}

Retrieves a single product record by its numeric ID. The response returns the same full Product object described above, including the inventarios array with stock levels per warehouse.

Path parameter

integer

required

The unique numeric identifier of the product you want to retrieve.

curl --request GET \
  --url "https://api.smartpyme.site/api/external/v1/inventory/301" \
  --header "Authorization: Bearer {api_key}"

import requests

product_id = 301
url = f"https://api.smartpyme.site/api/external/v1/inventory/{product_id}"
headers = {"Authorization": "Bearer {api_key}"}

response = requests.get(url, headers=headers)
print(response.json())

const productId = 301;
const response = await fetch(
  `https://api.smartpyme.site/api/external/v1/inventory/${productId}`,
  {
    method: "GET",
    headers: { Authorization: "Bearer {api_key}" },
  }
);
const data = await response.json();
console.log(data);

The response wraps the Product object under a data key with "success": true. All fields, including inventarios, are identical to the structure documented in the GET /inventory response above.

GET /inventory/summary

Returns aggregate statistics for your entire product catalog and combined stock position. Use this endpoint to get a quick overview of catalog health — how many products are active, total stock on hand, total inventory value, and which categories contain the most products.

curl --request GET \
  --url "https://api.smartpyme.site/api/external/v1/inventory/summary" \
  --header "Authorization: Bearer {api_key}"

import requests

url = "https://api.smartpyme.site/api/external/v1/inventory/summary"
headers = {"Authorization": "Bearer {api_key}"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://api.smartpyme.site/api/external/v1/inventory/summary",
  {
    method: "GET",
    headers: { Authorization: "Bearer {api_key}" },
  }
);
const data = await response.json();
console.log(data);

Response example

{
  "success": true,
  "data": {
    "productos": {
      "total": 500,
      "activos": 480,
      "inactivos": 20
    },
    "inventario": {
      "stock_total": 15750.5,
      "valor_total": 125000.75,
      "productos_con_stock": 450,
      "productos_sin_stock": 30,
      "productos_stock_bajo": 15
    },
    "productos_por_categoria": [
      { "categoria": "Electrónicos", "cantidad": 150 },
      { "categoria": "Ropa",         "cantidad": 200 }
    ]
  },
  "meta": {
    "empresa": "Mi Empresa S.A.",
    "timestamp": "2025-01-31T15:00:00Z",
    "filters_applied": {}
  }
}

Response fields

integer

Total number of products in your catalog, regardless of status.

integer

Number of products currently marked as active (enable = 1).

integer

Number of products currently marked as inactive (enable = 0).

number

Sum of all stock quantities across every product and warehouse.

number

Total inventory value calculated using each product’s average cost (costo_promedio) multiplied by its current stock.

integer

Number of distinct products that have at least one unit in stock across any warehouse.

integer

Number of distinct products with zero stock across all warehouses.

integer

Number of products whose current stock is at or below their configured stock_minimo threshold in at least one warehouse.

array

List of product counts grouped by category.

Show productos_por_categoria fields

string

Name of the product category.

integer

Number of products assigned to this category.

string

Display name of the company associated with your API key.

string

ISO 8601 timestamp indicating when the summary was generated.

object

Echo of any filters used to compute the summary.

Overview

Endpoints

SmartPyme Inventory: Product Catalog and Stock Levels

GET /inventory

Query parameters

Response example

Response fields

GET /inventory/{id}

Path parameter

GET /inventory/summary

Response example

Response fields

​GET /inventory

​Query parameters

​Response example

​Response fields

​GET /inventory/{id}

​Path parameter

​GET /inventory/summary

​Response example

​Response fields

GET /inventory

Query parameters

Response example

Response fields

GET /inventory/{id}

Path parameter

GET /inventory/summary

Response example

Response fields