Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceQueries

Identity__vendors

Returns all vendors/suppliers for the tenant. 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__vendors(where: CommonPaginationDto): VendorsWithPagination!

Returns all vendors/suppliers for the tenant. 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

  1. identity__vendors
meta?
nodes?
Example Request
query Identity__vendors {  identity__vendors {    meta {      currentPage      hasNextPage      totalCount      totalPages    }    nodes {      _id      address {        caption        lat        lng      }      commits {        action        committedAt        note      }      createdAt      description      email      isActive      lastLoginAt      name      phoneNumber    }  }}
Example Response
{  "data": {    "identity__vendors": {      "meta": {        "currentPage": 10.5,        "hasNextPage": true,        "totalCount": 10.5,        "totalPages": 10.5      },      "nodes": [        {          "_id": "1",          "address": {            "caption": "string",            "lat": 10.5,            "lng": 10.5          },          "commits": [            {              "action": "string",              "committedAt": "<DateTime>",              "note": "string"            }          ],          "createdAt": "<DateTime>",          "description": "string",          "email": "string",          "isActive": true,          "lastLoginAt": "<DateTime>",          "name": "string",          "phoneNumber": "string"        }      ]    }  }}