Access supplier records, contact information, and linked products.
Supplier — Returns a single supplier by id
Supplier — Returns a single supplier by idquery GetSupplier($id: ID!) {
Supplier(id: $id) {
id
label
email
phone
active
supplier_number
website
notes
currency { id label }
address { id city country }
}
}Suppliers — Returns a paginated list of suppliers with sorting and filters
Suppliers — Returns a paginated list of suppliers with sorting and filtersquery Suppliers(
$where: QuerySuppliersWhereWhereConditions,
$orderBy: [QuerySuppliersOrderByOrderByClause!],
$search: String,
$first: Int,
$page: Int,
$trashed: Trashed
) {
Suppliers(
where: $where,
orderBy: $orderBy,
search: $search,
first: $first,
page: $page,
trashed: $trashed
) {
paginatorInfo {
total
currentPage
}
data {
id
label
email
active
phone
}
}
}Available fields
| Field | Type | Description |
|---|---|---|
id | Int | Unique identifier for the supplier. |
label | String | Supplier name or company name. |
email | String | Primary contact email. |
phone | String | Primary contact phone number. |
active | Boolean | Activation status. |
supplier_number | String | Internal reference number. |
website | String | Website URL. |
notes | String | Public notes for documents. |
discount | Float | Default discount granted by this supplier. |
language | String | Preferred language for communication. |
currency | Currency | Procurement currency. |
price_level | PriceLevel | Assigned price level for purchasing. |
address | Address | Primary business address. |
tax_codes | [TaxCode] | Applied tax configurations. |
supplier_tags | [SupplierTag] | Labels for categorization. |
employees | [Employee] | List of subsidiary contacts. |
files | [File] | Attached documents. |
integrations | [Integration] | Linked external platforms. |
purchase_template | PdfTemplate | Template used for Purchase Orders. |
purchase_receipt_template | PdfTemplate | Template used for Purchase Receipts. |
created_at | DateTime | Creation time. |
updated_at | DateTime | Last update time. |
custom_fields | [EntityCustomField] | Custom fields for this entity. |
Data Types
VariantSupplierPivot
VariantSupplierPivot| Field | Type | Description |
|---|---|---|
supplier_sku | String | Supplier's SKU for this variant. |
Filters
The following fields can be used in the where parameter:
id, label, email, phone, active, created_at, updated_at, country, city.
Example Filters:
| Field | Example |
|---|---|
active | { "column": "ACTIVE", "operator": "EQ", "value": true } |
label | { "column": "LABEL", "operator": "LIKE", "value": "%Suppliers%" } |
city | { "column": "CITY", "operator": "EQ", "value": "Paris" } |
trashed | Filter by trashed status. Accepts ALL, TRASHED, or NOT_TRASHED. |
Sorting
You can sort results using the orderBy parameter:
idlabelemailphoneactivecreated_atupdated_at
