GET/v1/reports/inventory/low-stock

GET /v1/reports/inventory/low-stock

Scopes: reports:inventory:read

Requires scope: reports:inventory:read.

Parameters

Name	In	Type	Required
`filter_field`	query	`string`	no
`filter_value`	query	`string`	no
`order_by`	query	`string`	no
`order_direction`	query	`string`	no
`page_number`	query	`integer<int32>`	no
`page_size`	query	`integer<int32>`	no

Response (200)

Field	Type	Required
`reportType`	`string`	no
`title`	`string`	no
`generatedAt`	`string<date-time>`	no
`totalRecords`	`integer<int32>`	no
`data`	`LowInventoryRecord[]`	no
`parameters`	`ReportParameter[]`	no

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', {
  // params: { path: { id: '...' }, query: { limit: 25 } },
  // body: { /* request body */ },
});

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