Skip to main content
View as Markdown

supMultiMatch

Match multiple manufacturer + mpn pairs at once. Useful for when you have a list of parts, as with a BOM (Bill of Materials)

Type​

SupPartMatch object​

supMultiMatch(
  queries: [SupPartMatchQuery!]!
  options: SupPartMatchOptions
  country: String! = US
  currency: String! = USD
  distributorApi: Boolean
  distributorApiTimeout: String! = 3s
  customPricingCredentials: [SupApiCredentials!]
  rankingMethod: SupSearchRankingMethod! = DEFAULT
): [SupPartMatch!]!

Arguments​

queries ● [SupPartMatchQuery!]! non-null input​

list of inputs to attempt to match

options ● SupPartMatchOptions input​

options when matching such as applying filters or only including authorized or in-stock parts

country ● String! non-null scalar​

user's country

currency ● String! non-null scalar​

user's currency

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.