On this page
vendors
query · in the family Vendor
What it does
The vendor list — each entry is a vendor — who sells to you.
The caller's org-group family's ACTIVE LISTING of Vendors — doomed records DROP from listings.
What happens
Reads only — changes nothing.
Who may call it
Capability area: Reading your records — Looking up and listing the records of your organization.
- Owner
- System Administrator
- Manager
- Associate Manager
- Warehouse Associate
- Sales Associate
- An API key whose scope allows
api:vendors
Returns
Vendor [Vendor!]! — A vendor — WHO SOLD to the merchant: the shared supplier MASTER (group pool), orthogonal to the Manufacturer (who built it). Deliberately thin: contact data is; the org-specific commercial payload (account#, terms, purchasing currency) IS the OrgVendor relationship (the enablement — no purchasing without an active one), arriving. The FIRST procurement-domain construct.
Example request
query ExampleVendors {
vendors {
id
sysId
type
caption
status
parentId
rootId
createdAt
updatedAt
revisionNum
revision
code
}
}
Example response
{
"data": {
"vendors": [
{
"id": "01900000-0000-7000-8000-37386ae00000",
"sysId": "VN-EXMP-0000-000F",
"type": "Vendor",
"caption": "Blue jeans",
"status": "active",
"parentId": "01900000-0000-7000-8000-065235280000",
"rootId": "01900000-0000-7000-8000-a093dd800000",
"createdAt": "2027-01-31T00:00:00.000Z",
"updatedAt": "2027-01-31T00:00:00.000Z",
"revisionNum": 1,
"revision": "01900000-0000-7000-8000-b7960e180000",
"code": "BJ-001"
}
]
},
"extensions": {
"at": {
"callId": "01EXAMPLE-CALL-ID",
"version": {
"requested": null,
"serviced": {
"name": "genesis",
"number": 0
}
}
}
}
}
Errors this call can answer
VALIDATION/INVALID— Something in the request is not valid. (VALIDATION)AUTHN/REQUIRED— Sign in to do this. (AUTHN)AUTHZ/FORBIDDEN— Your role does not allow this action. (AUTHZ)RATE_LIMIT/THROTTLED— Too many requests in a short time. (RATE_LIMIT)