Solid Commerce Docs
GET/v1/reports/inventory/low-stock/download

GET /v1/reports/inventory/low-stock/download

Scopes: reports:inventory:read

Requires scope: reports:inventory:read.

Parameters

NameInTypeRequiredDescription
filter_fieldquerystringno
filter_valuequerystringno
order_byquerystringno
order_directionquerystringno

Examples

import { SolidCommerceClient } from '@solidcommerce/sdk';

const client = new SolidCommerceClient({
  apiKey: process.env.SOLIDCOMMERCE_API_KEY!,
});

const { data, error } = await client.raw.GET('/v1/reports/inventory/low-stock/download', {
  // params: { path: { id: '...' }, query: { limit: 25 } },
  // body: { /* request body */ },
});

if (error) throw error;
console.log(data);