Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceQueries

Inventory__products

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

QUERYinventory__products(where: CommonPaginationDto): ProductsWithPagination!

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

Arguments

where?

Returns

  1. inventory__products
meta?
nodes?
Example Request
query Inventory__products {  inventory__products {    meta {      currentPage      hasNextPage      totalCount      totalPages    }    nodes {      _id      allowBackorder      buyingPrice      collections {        _id        createdAt        description        isDemo        level        name        parentCategory        slug      }      commits {        action        committedAt        note      }      comparingPrice      createdAt      handle      isDemo      isInStock    }  }}
Example Response
{  "data": {    "inventory__products": {      "meta": {        "currentPage": 10.5,        "hasNextPage": true,        "totalCount": 10.5,        "totalPages": 10.5      },      "nodes": [        {          "_id": "1",          "allowBackorder": true,          "buyingPrice": 10.5,          "collections": [            {              "_id": "1",              "createdAt": "<DateTime>",              "description": "string",              "isDemo": true,              "level": 10,              "name": "string",              "parentCategory": "1",              "slug": "string"            }          ],          "commits": [            {              "action": "string",              "committedAt": "<DateTime>",              "note": "string"            }          ],          "comparingPrice": 10.5,          "createdAt": "<DateTime>",          "handle": "string",          "isDemo": true,          "isInStock": true        }      ]    }  }}

Inventory__product Reviews QUERY

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

Inventory__seed Dataset For Theme QUERY

Returns the demo dataset suggested for a given theme slug (e.g. when activating a theme), or null if that theme has no suggested dataset. 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).