supSearchMpn

Search parts by mpn only, including filters, pagination, aggregation, sorting

Type

SupPartResultSet object

Result of part search.

supSearchMpn(
  q: String
  country: String! = US
  currency: String! = USD
  start: Int
  limit: Int
  sort: String
  sortDir: SupSortDirection
  inStockOnly: Boolean
  filters: Map
  distributorApi: Boolean
  distributorApiTimeout: String! = 3s
  customPricingCredentials: [SupApiCredentials!]
  rankingMethod: SupSearchRankingMethod! = DEFAULT
): SupPartResultSet!

Arguments

q ● String scalar

the query to search on mpn

Constraint: max=2000.

country ● String! non-null scalar

user's country

currency ● String! non-null scalar

user's currency

start ● Int scalar

offset in the result set

limit ● Int scalar

page size of results

sort ● String scalar

field to sort by. See sort values

sortDir ● SupSortDirection enum

direction of sort: asc or desc

inStockOnly ● Boolean scalar

filter to remove parts with no stocking distributors

filters ● Map scalar

a key: value map of filters. See filter values

distributorApi ● Boolean scalar

fetch latest pricing and stock data from distributor API. Company.isDistributorApi indicates if a distributor supports this feature.

distributorApiTimeout ● String! non-null scalar

how long to wait for distributor API to respond as a duration string (e.g. 3s or 500ms)

customPricingCredentials ● [SupApiCredentials!] list input

if needed, pass along credentials for API integrations

Requires plan tier: ENTERPRISE.

rankingMethod ● SupSearchRankingMethod! non-null enum

Specifying a ranking method.