GraphQL Reference

Complete reference for all queries, return types, input types, and enums. For worked examples and usage patterns, see the GraphQL guide.

POST https://api.zenode.ai/graphql

An interactive GraphiQL explorer is available at api.zenode.ai/graphql.

Queries

supSearchMpn→ SupPartResultSet!

Search for parts by manufacturer part number (MPN). Supports partial and fuzzy matching.

Argument	Type	Default	Description
`mpn`*	`String!`	—	MPN search string.
`start`	`Int`	0	Offset into the result set.
`limit`	`Int`	10	Page size. Clamped to 1–100.
`filters`	`JSON`	null	Filter map keyed by attribute shortname, manufacturerId, distributorId, etc.
`country`	`String`	"US"	Country context for pricing and availability.
`currency`	`String`	"USD"	Currency for pricing.
`sort`	`String`	null	Sort field.
`sortDir`	`SupSortDirection`	null	ASC or DESC.
`inStockOnly`	`Boolean`	false	Exclude parts with no available stock.
`hasDatasheetOnly`	`Boolean`	false	Exclude parts without a datasheet.
`distributorApi`	`Boolean`	false	Request live distributor pricing and stock where supported.
`distributorApiTimeout`	`String`	"3s"	Duration string, e.g. "3s" or "500ms".
`customPricingCredentials`	`[SupApiCredentials]`	null	Optional distributor API credentials.
`rankingMethod`	`SupSearchRankingMethod`	DEFAULT	Ranking strategy for results.

supSearch→ SupPartResultSet!

Search for parts using natural-language or keyword queries.

Argument	Type	Default	Description
`q`*	`String!`	—	Keyword or natural-language search string.
`start`	`Int`	0	Offset into the result set.
`limit`	`Int`	10	Page size. Clamped to 1–100.
`filters`	`JSON`	null	Filter map keyed by attribute shortname, manufacturerId, distributorId, etc.
`country`	`String`	"US"	Country context for pricing and availability.
`currency`	`String`	"USD"	Currency for pricing.
`sort`	`String`	null	Sort field.
`sortDir`	`SupSortDirection`	null	ASC or DESC.
`inStockOnly`	`Boolean`	false	Exclude parts with no available stock.
`hasDatasheetOnly`	`Boolean`	false	Exclude parts without a datasheet.
`distributorApi`	`Boolean`	false	Request live distributor pricing and stock where supported.
`distributorApiTimeout`	`String`	"3s"	Duration string, e.g. "3s" or "500ms".
`customPricingCredentials`	`[SupApiCredentials]`	null	Optional distributor API credentials.
`rankingMethod`	`SupSearchRankingMethod`	DEFAULT	Ranking strategy for results.

supParts→ [SupPart!]!

Fetch one or more parts by their internal ID. Numeric IDs and slugs are both accepted.

Argument	Type	Default	Description
`ids`*	`[String!]!`	—	List of part IDs or slugs.
`country`	`String`	"US"	Country context for pricing.
`currency`	`String`	"USD"	Currency for pricing.
`distributorApi`	`Boolean`	false	Request live distributor pricing and stock.
`distributorApiTimeout`	`String`	"3s"	Duration string.
`customPricingCredentials`	`[SupApiCredentials!]`	null	Optional distributor API credentials.

supManufacturers→ [SupCompany!]!

List manufacturer companies. Omit both ids and slugs to fetch all. When both are provided, manufacturers matching either filter are returned.

Argument	Type	Default	Description
`ids`	`[String!]`	null	Filter by manufacturer ID.
`slugs`	`[String!]`	null	Filter by manufacturer slug.
`minNumberOfActivePartsInt`	`Int`	null	Reserved for API compatibility. Has no effect.

supCategories→ [SupCategory!]!

List part categories. Omit ids and paths to fetch all categories under the given root.

Argument	Type	Default	Description
`ids`	`[String!]`	null	List of category IDs.
`paths`	`[String!]`	null	List of SEO page paths.
`root`	`SupCategoryRoot!`	ELECTRONIC_PARTS	Root of the category tree to include.

supMultiMatch→ [SupPartMatch!]!

Match many BOM lines in one request. At most 50 queries per request. Search priority per line: mpn → sku → mpnOrSku.

Argument	Type	Default	Description
`queries`*	`[SupPartMatchQuery!]!`	—	List of BOM lines to match. See SupPartMatchQuery below.
`options`	`SupPartMatchOptions`	null	Options applied across all lines. See SupPartMatchOptions below.
`country`	`String`	"US"	Country context for pricing.
`currency`	`String`	"USD"	Currency for pricing.
`distributorApi`	`Boolean`	false	Request live distributor pricing and stock.
`distributorApiTimeout`	`String`	"3s"	Duration string.
`customPricingCredentials`	`[SupApiCredentials]`	null	Optional distributor API credentials.
`rankingMethod`	`SupSearchRankingMethod`	DEFAULT	Ranking strategy.

Return types

SupPartResultSet

Returned by supSearchMpn and supSearch.

Field	Type	Description
`hits`	`Int!`	Number of results in this page.
`results`	`[SupPartResult!]!`	List of matched parts with display metadata.
`warnings`	`[String!]!`	Human-readable descriptions of ignored or partially-supported parameters.
`specsViewAttributeGroups`	`JSON`	Spec attributes grouped for a specs-view UI.
`suggestedCategories`	`JSON`	Category suggestions based on the query.
`suggestedFilters`	`JSON`	Filter suggestions based on the query.
`allFilters`	`JSON`	All available filters for the result set.
`appliedCategory`	`JSON`	The category filter applied to this search, if any.
`appliedFilters`	`JSON`	The filters applied to this search.
`manufacturerAgg(size)`	`[SupManufacturerBucket!]!`	Manufacturer buckets with part counts. size defaults to 10.
`categoryAgg(size)`	`[SupCategoryBucket!]!`	Category buckets with part counts. size defaults to 10.
`specAggs(attributeNames, specAggSize)`	`[SupSpecAgg!]!`	Spec value distributions for named attributes. specAggSize defaults to 10.

SupPartResult

A single item inside SupPartResultSet.results.

Field	Type	Description
`part`	`SupPart!`	The matched part.
`description`	`String`	Display description for this result.

SupPart

Represents a single electronic part. Use the GraphiQL explorer to introspect the full field list.

Field	Type	Description
`id`	`ID!`	Internal part ID.
`mpn`	`String!`	Manufacturer part number.
`slug`	`String`	URL-friendly identifier.
`shortDescription`	`String`	One-line part description.
`manufacturer`	`SupCompany`	The part manufacturer.
`descriptions`	`[SupDescription!]`	Full description variants.
`images`	`[SupImage!]`	Part images.
`specs`	`[SupSpec!]`	Electrical and mechanical specifications.
`categories`	`[SupCategory!]`	Part categories.
`sellers`	`[SupPartSeller!]`	Distributors selling this part, with offers and pricing.
`documents`	`[SupDocument!]`	Datasheets and other documents.

SupCompany

A manufacturer or distributor company.

Field	Type	Description
`id`	`String!`	Internal company ID.
`name`	`String!`	Display name.
`slug`	`String`	URL-friendly identifier.
`homepageUrl`	`String`	Company homepage URL.
`isDistributorApi`	`Boolean`	Whether live distributor API pricing is available.

SupCategory

Field	Type	Description
`id`	`String!`	Internal category ID.
`name`	`String!`	Display name.
`path`	`String`	SEO page path.
`numParts`	`Int`	Number of parts in this category.

SupPartMatch

A single row in the supMultiMatch response.

Field	Type	Description
`reference`	`String`	Echoed from the input query line.
`hits`	`Int!`	Total count of matched parts for this line.
`parts`	`[SupPart!]!`	The matched parts for this line (page implied by start/limit).
`errorString`	`String`	Set when the line is invalid (e.g. missing mpn, sku, and mpnOrSku).

Input types

SupPartMatchQuery

A single BOM line for supMultiMatch. At least one of mpn, sku, or mpnOrSku must be provided.

Field	Type	Description
`start`	`Int!`	Pagination offset for this line's results.
`limit`	`Int!`	Page size for this line's results.
`mpn`	`String`	MPN to match. Takes priority over sku and mpnOrSku.
`sku`	`String`	SKU to match. Used if mpn is empty.
`mpnOrSku`	`String`	Treated as MPN. Used if both mpn and sku are empty.
`manufacturer`	`String`	Optional substring filter on manufacturer name.
`seller`	`String`	Optional substring filter on distributor name in offers.
`reference`	`String`	Arbitrary label echoed back on the result row.

SupPartMatchOptions

Options applied across all lines in a supMultiMatch request.

Field	Type	Description
`requireStockAvailable`	`Boolean`	When true, only parts with at least one offer with qty > 0 are returned.
`requireAuthorizedSellers`	`Boolean`	Reserved. Accepted but not yet applied.
`filters`	`JSON`	Reserved. Intended semantics match the filters argument on supSearchMpn.

SupApiCredentials

Credentials for distributor or custom pricing API integrations. Provide the credential fields required by the target distributor.

Field	Type	Description
`companyId`	`String!`	ID of the company you are providing credentials for.
`clientId`	`String`	Use with clientSecret when required.
`clientSecret`	`String`	Use with clientId when required.
`username`	`String`	Use with password when required.
`password`	`String`	Use with username when required.
`apiKey`	`String`	Use when the distributor requires a standalone API key.

Enums

SupSortDirection

ASC
DESC

SupSearchRankingMethod

DEFAULT

SupCategoryRoot

ELECTRONIC_PARTS