Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceQueries

Identity__customer

{ collectionName: 'identity__User', privileges: ['*', 'read'], } Requires a signed-in staff user. Needs the `identity__Customer` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).

QUERYidentity__customer(where: CommonFindDocumentDto!): Customer

{ collectionName: 'identity__User', privileges: ['*', 'read'], } Requires a signed-in staff user. Needs the identity__Customer read permission. Send the x-tenant header (the gateway sets it from your API key).

Arguments

where*

Returns

  1. identity__customer
_id*ID!
avatar?
createdAt?DateTime

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

email?String
emailVerifiedAt?DateTime

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

lastLoginAt?DateTime

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

name*String!
phoneNumber?String
shippingAddress?
status*CustomerStatus!
Value inACTIVEINACTIVESUSPENDED
tenant*String!
updatedAt?DateTime

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

Example Request
query Identity__customer($where: CommonFindDocumentDto!) {  identity__customer(where: $where) {    _id    avatar {      alt      external      fileAssetId      key      provider    }    createdAt    email    emailVerifiedAt    lastLoginAt    name    phoneNumber    shippingAddress {      addressLine      area      district      division      postalCode      title      upazila    }    status  }}
Variables
{  "where": {    "and": [      {        "and": [          {            "and": [              {                "and": [                  {}                ],                "key": "string"              }            ],            "key": "string"          }        ],        "key": "string"      }    ],    "key": "string"  }}
Example Response
{  "data": {    "identity__customer": {      "_id": "1",      "avatar": {        "alt": "string",        "external": "string",        "fileAssetId": "1",        "key": "string",        "provider": "CLOUDINARY"      },      "createdAt": "<DateTime>",      "email": "string",      "emailVerifiedAt": "<DateTime>",      "lastLoginAt": "<DateTime>",      "name": "string",      "phoneNumber": "string",      "shippingAddress": [        {          "addressLine": "string",          "area": "string",          "district": "string",          "division": "string",          "postalCode": "string",          "title": "string",          "upazila": "string"        }      ],      "status": "ACTIVE"    }  }}

Identity__current Tenant Users QUERY

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

Identity__customers QUERY

{ permissions: ['*', 'create'], collectionName: 'identity__Customer', } Requires a signed-in staff user. Needs the `identity__Customer` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).