Identity__tenant

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

QUERYidentity__tenant(where: CommonFindDocumentDto): Tenant!

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

Arguments

where?

Returns

identity__tenant

_id*ID!

address?

businessPhoneNumber?String

charges?

commits?

createdAt?DateTime

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

customDomain?

customerSupportInfo?

description?String

favicon?

footerLogo?

kyc?

legalPolicies?

logo?

name*String!

notices?

orderFlow?

plugins?

seo?

siteDomain?String

socialLinks?

status?String

tagline?String

uid?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__tenant {
  identity__tenant {
    _id
    address {
      caption
      lat
      lng
    }
    businessPhoneNumber
    charges {
      deliveryRegions {
        charge
        label
      }
      taxRate
    }
    createdAt
    description
    name
    siteDomain
    status
    tagline
  }
}

query Identity__tenant {  identity__tenant {    _id    address {      caption      lat      lng    }    businessPhoneNumber    charges {      deliveryRegions {        charge        label      }      taxRate    }    createdAt    description    name    siteDomain    status    tagline  }}

Example Response

{
  "data": {
    "identity__tenant": {
      "_id": "1",
      "address": {
        "caption": "string",
        "lat": 10.5,
        "lng": 10.5
      },
      "businessPhoneNumber": "string",
      "charges": {
        "deliveryRegions": [
          {
            "charge": 10.5,
            "label": "string"
          }
        ],
        "taxRate": 10.5
      },
      "createdAt": "<DateTime>",
      "description": "string",
      "name": "string",
      "siteDomain": "string",
      "status": "string",
      "tagline": "string"
    }
  }
}

Example Response

{  "data": {    "identity__tenant": {      "_id": "1",      "address": {        "caption": "string",        "lat": 10.5,        "lng": 10.5      },      "businessPhoneNumber": "string",      "charges": {        "deliveryRegions": [          {            "charge": 10.5,            "label": "string"          }        ],        "taxRate": 10.5      },      "createdAt": "<DateTime>",      "description": "string",      "name": "string",      "siteDomain": "string",      "status": "string",      "tagline": "string"    }  }}

ArgumentsCopy Anchor Link

ReturnsCopy Anchor Link

Arguments

Returns