Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceQueries

Inventory__product Review

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

QUERYinventory__productReview(where: CommonFindDocumentDto!): AdminProductReview

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

Arguments

where*

Returns

  1. inventory__productReview
_id*ID!
content?String
createdAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

customerEmail?String
customerId*ID!
customerName?String
images?
invoiceId?ID
productHandle?String
productId*ID!
productTitle?String
rating*Int!
status?ProductReviewStatus
Value inACTIVEHIDDEN
updatedAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

Example Request
query Inventory__productReview($where: CommonFindDocumentDto!) {  inventory__productReview(where: $where) {    _id    content    createdAt    customerEmail    customerId    customerName    images {      alt      external      fileAssetId      key      provider    }    invoiceId    productHandle  }}
Variables
{  "where": {    "and": [      {        "and": [          {            "and": [              {                "and": [                  {}                ],                "key": "string"              }            ],            "key": "string"          }        ],        "key": "string"      }    ],    "key": "string"  }}
Example Response
{  "data": {    "inventory__productReview": {      "_id": "1",      "content": "string",      "createdAt": "<DateTime>",      "customerEmail": "string",      "customerId": "1",      "customerName": "string",      "images": [        {          "alt": "string",          "external": "string",          "fileAssetId": "1",          "key": "string",          "provider": "CLOUDINARY"        }      ],      "invoiceId": "1",      "productHandle": "string"    }  }}

Inventory__product QUERY

Only product that the user has access to will be returned. 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__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).