Identity__vendor

Returns a single vendor/supplier by ID or filter. Requires a signed-in staff user. Needs the `identity__Vendor` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).

QUERYidentity__vendor(where: CommonFindDocumentDto!): Vendor!

Returns a single vendor/supplier by ID or filter. Requires a signed-in staff user. Needs the identity__Vendor read permission. Send the x-tenant header (the gateway sets it from your API key).

Arguments

where*

Returns

identity__vendor

_id*ID!

address?

commits?

createdAt?DateTime

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

description?String

email?String

isActive?Boolean

lastLoginAt?DateTime

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

logo?

name*String!

phoneNumber?String

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__vendor($where: CommonFindDocumentDto!) {
  identity__vendor(where: $where) {
    _id
    address {
      caption
      lat
      lng
    }
    commits {
      action
      commitedBy {
        email
        name
        phoneNumber
        referenceId
      }
      committedAt
      note
    }
    createdAt
    description
    email
    isActive
    lastLoginAt
    name
    phoneNumber
  }
}

query Identity__vendor($where: CommonFindDocumentDto!) {  identity__vendor(where: $where) {    _id    address {      caption      lat      lng    }    commits {      action      commitedBy {        email        name        phoneNumber        referenceId      }      committedAt      note    }    createdAt    description    email    isActive    lastLoginAt    name    phoneNumber  }}

Variables

{
  "where": {
    "and": [
      {
        "and": [
          {
            "and": [
              {
                "and": [
                  {}
                ],
                "key": "string"
              }
            ],
            "key": "string"
          }
        ],
        "key": "string"
      }
    ],
    "key": "string"
  }
}

Variables

{  "where": {    "and": [      {        "and": [          {            "and": [              {                "and": [                  {}                ],                "key": "string"              }            ],            "key": "string"          }        ],        "key": "string"      }    ],    "key": "string"  }}

Example Response

{
  "data": {
    "identity__vendor": {
      "_id": "1",
      "address": {
        "caption": "string",
        "lat": 10.5,
        "lng": 10.5
      },
      "commits": [
        {
          "action": "string",
          "commitedBy": {
            "email": "string",
            "name": "string",
            "phoneNumber": "string",
            "referenceId": "1"
          },
          "committedAt": "<DateTime>",
          "note": "string"
        }
      ],
      "createdAt": "<DateTime>",
      "description": "string",
      "email": "string",
      "isActive": true,
      "lastLoginAt": "<DateTime>",
      "name": "string",
      "phoneNumber": "string"
    }
  }
}

Example Response

{  "data": {    "identity__vendor": {      "_id": "1",      "address": {        "caption": "string",        "lat": 10.5,        "lng": 10.5      },      "commits": [        {          "action": "string",          "commitedBy": {            "email": "string",            "name": "string",            "phoneNumber": "string",            "referenceId": "1"          },          "committedAt": "<DateTime>",          "note": "string"        }      ],      "createdAt": "<DateTime>",      "description": "string",      "email": "string",      "isActive": true,      "lastLoginAt": "<DateTime>",      "name": "string",      "phoneNumber": "string"    }  }}

ArgumentsCopy Anchor Link

ReturnsCopy Anchor Link

Arguments

Returns