Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceQueries

Identity__visible User Notices

Requires a signed-in staff user.

QUERYidentity__visibleUserNotices: [UserNotice!]!

Requires a signed-in staff user.

Returns

  1. identity__visibleUserNotices
_id*ID!
body*String!
createdAt?DateTime

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

createdBy?
sendAsEmail?Boolean
severity*NoticeSeverity!
Value inCRITICALINFOWARNING
title*String!
updatedAt?DateTime

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

visible?Boolean
Example Request
query Identity__visibleUserNotices {  identity__visibleUserNotices {    _id    body    createdAt    createdBy {      email      name      phoneNumber      referenceId    }    sendAsEmail    severity    title    updatedAt    visible  }}
Example Response
{  "data": {    "identity__visibleUserNotices": [      {        "_id": "1",        "body": "string",        "createdAt": "<DateTime>",        "createdBy": {          "email": "string",          "name": "string",          "phoneNumber": "string",          "referenceId": "1"        },        "sendAsEmail": true,        "severity": "CRITICAL",        "title": "string",        "updatedAt": "<DateTime>",        "visible": true      }    ]  }}

Identity__visible Tenant Notices QUERY

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

Inventory__collection QUERY

Only collection that the user has access to will be returned. Requires a signed-in staff user. Needs the `inventory__Collection` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).