Suppliers Queries

Access supplier records, contact information, and linked products.

Supplier — Returns a single supplier by id

query 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

query 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

FieldTypeDescription
idIntUnique identifier for the supplier.
labelStringSupplier name or company name.
emailStringPrimary contact email.
phoneStringPrimary contact phone number.
activeBooleanActivation status.
supplier_numberStringInternal reference number.
websiteStringWebsite URL.
notesStringPublic notes for documents.
discountFloatDefault discount granted by this supplier.
languageStringPreferred language for communication.
currencyCurrencyProcurement currency.
price_levelPriceLevelAssigned price level for purchasing.
addressAddressPrimary 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_templatePdfTemplateTemplate used for Purchase Orders.
purchase_receipt_templatePdfTemplateTemplate used for Purchase Receipts.
created_atDateTimeCreation time.
updated_atDateTimeLast update time.
custom_fields[EntityCustomField]Custom fields for this entity.

Data Types

VariantSupplierPivot

FieldTypeDescription
supplier_skuStringSupplier'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:

FieldExample
active{ "column": "ACTIVE", "operator": "EQ", "value": true }
label{ "column": "LABEL", "operator": "LIKE", "value": "%Suppliers%" }
city{ "column": "CITY", "operator": "EQ", "value": "Paris" }
trashedFilter by trashed status. Accepts ALL, TRASHED, or NOT_TRASHED.

Sorting

You can sort results using the orderBy parameter:

  • id
  • label
  • email
  • phone
  • active
  • created_at
  • updated_at