Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceQueries

Inventory__stock Groups

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__stockGroups(lifecycleStatus: [InventoryStockLifecycleStatus!], search: String, status: [InventoryStockStatus!], where: CommonPaginationDto): InventoryStockGroupsWithPagination!

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__stockGroups
meta*
nodes*
summary*
Example Request
query Inventory__stockGroups {  inventory__stockGroups {    meta {      currentPage      hasNextPage      totalCount      totalPages    }    nodes {      _id      available      onHand      productId      reserved      sku      status      variants {        _id        allowBackorder        archivedAt        available        createdAt        lifecycleStatus        lowStockThreshold        onHand      }    }  }}
Example Response
{  "data": {    "inventory__stockGroups": {      "meta": {        "currentPage": 10.5,        "hasNextPage": true,        "totalCount": 10.5,        "totalPages": 10.5      },      "nodes": [        {          "_id": "1",          "available": 10,          "onHand": 10,          "productId": "1",          "reserved": 10,          "sku": "string",          "status": "string",          "variants": [            {              "_id": "1",              "allowBackorder": true,              "archivedAt": "<DateTime>",              "available": 10,              "createdAt": "<DateTime>",              "lifecycleStatus": "ACTIVE",              "lowStockThreshold": 10,              "onHand": 10            }          ]        }      ]    }  }}

Inventory__seed Job Status QUERY

Progress for a background seed job started via inventory__startSeedJob. Requires a signed-in staff user. Needs the `inventory__Product` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).

Inventory__stock Items 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).