/adaptors/cross v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

https://goldleaf.app/api/v1

Adaptors

getAdaptorCrossReference

Code samples

const headers = {
  Accept: "application/json",
};

fetch("https://goldleaf.app/api/v1/adaptors/cross?partNumber=type,string&brand=type,string", {
  method: "GET",

  headers: headers,
})
  .then(function (res) {
    return res.json();
  })
  .then(function (body) {
    console.log(body);
  });

GET /adaptors/cross

Gets an adaptor cross-reference

Retrieves cross references for an adaptor based on part number and brand. It validates input, performs aggregation to find the adaptor, and retrieves related adaptors along with their brand properties.

Parameters

Name	In	Type	Required	Description
partNumber	query	string	true	The part number of the adaptor to cross-reference from.
brand	query	string	true	The brand name of the adaptor to cross-reference from.
onlySelectable	query	boolean	false	Optional flag to filter only selectable items as set by your organization.

Example responses

200 Response

{
  "type": "array"
}

Responses

Status	Meaning	Description	Schema
200	OK	An array of adaptors	Inline
500	Internal Server Error	Server error	Inline

Response Schema

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none