Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceQueries

Inventory__stock Items

Requires a signed-in staff user. Needs the `inventory__Stock` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).

QUERYinventory__stockItems(lifecycleStatus: [InventoryStockLifecycleStatus!], search: String, status: [InventoryStockStatus!], where: CommonPaginationDto): InventoryStocksWithPagination!

Requires a signed-in staff user. Needs the inventory__Stock read permission. Send the x-tenant header (the gateway sets it from your API key).

Arguments

lifecycleStatus?[InventoryStockLifecycleStatus!]
Value inACTIVEARCHIVED
search?String
status?[InventoryStockStatus!]
Value inBACKORDERIN_STOCKLOW_STOCKNOT_TRACKEDOUT_OF_STOCK
where?

Returns

  1. inventory__stockItems
meta?
nodes?
Example Request
query Inventory__stockItems {  inventory__stockItems {    meta {      currentPage      hasNextPage      totalCount      totalPages    }    nodes {      _id      allowBackorder      archivedAt      available      createdAt      lifecycleStatus      lowStockThreshold      onHand    }  }}
Example Response
{  "data": {    "inventory__stockItems": {      "meta": {        "currentPage": 10.5,        "hasNextPage": true,        "totalCount": 10.5,        "totalPages": 10.5      },      "nodes": [        {          "_id": "1",          "allowBackorder": true,          "archivedAt": "<DateTime>",          "available": 10,          "createdAt": "<DateTime>",          "lifecycleStatus": "ACTIVE",          "lowStockThreshold": 10,          "onHand": 10        }      ]    }  }}

Inventory__stock Groups QUERY

Requires a signed-in staff user. Needs the `inventory__Stock` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).

Inventory__stock Movements QUERY

Requires a signed-in staff user. Needs the `inventory__Stock` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).