Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceQueries

Report__stock Report

Current stock mix plus movements in the selected dates. Optional from/to (YYYY-MM-DD). Stock levels are a live snapshot. Requires a signed-in staff user. Needs the `report__Analytics` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).

QUERYreport__stockReport(from: String, to: String): StockReport!

Current stock mix plus movements in the selected dates. Optional from/to (YYYY-MM-DD). Stock levels are a live snapshot. Requires a signed-in staff user. Needs the report__Analytics read permission. Send the x-tenant header (the gateway sets it from your API key).

Arguments

from?String
to?String

Returns

  1. report__stockReport
byStatus*
lowStockItems*
movementsByType*
totals*
Example Request
query Report__stockReport {  report__stockReport {    byStatus {      count      status    }    lowStockItems {      available      onHand      productId      reserved      sku      status      title      variantKey    }  }}
Example Response
{  "data": {    "report__stockReport": {      "byStatus": [        {          "count": 10,          "status": "string"        }      ],      "lowStockItems": [        {          "available": 10,          "onHand": 10,          "productId": "string",          "reserved": 10,          "sku": "string",          "status": "string",          "title": "string",          "variantKey": "string"        }      ]    }  }}

Report__detailed Report QUERY

Returns detailed report including: - Orders breakdown by status - Revenue and order counts by period - Top 10 selling products Optional from/to (YYYY-MM-DD) filter the report window. Without dates, revenue uses the last 6 months and other totals are all-time. Requires a signed-in staff user. Needs the `report__Analytics` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).

Sale__abandoned Carts QUERY

{ collectionName: 'sale__Invoice', permissions: ['*', 'read'], } Requires a signed-in staff user. Needs the `sale__Invoice` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).