/organization/customadaptors 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

getOrganizationCustomAdaptors

Code samples

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

fetch("https://goldleaf.app/api/v1/organization/customadaptors", {
  method: "GET",

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

GET /organization/customadaptors

Gets custom adaptors

Gets the custom adaptors created by this organization.

Parameters

Name	In	Type	Required	Description
search.partNumber	query	string	false	The part number to search for.
search.brand	query	string	false	The brand to search for.
search.description	query	string	false	The description to search for.
search.orgPartNumber	query	string	false	The organization part number to search for.
customerId	query	string(mongo-id)	false	The MongoDB ID of the customer.
hideUnavailable	query	boolean	false	Flag to hide unavailable items.
hideUnavailableBrands	query	boolean	false	Flag to hide items from unavailable brands.

Example responses

500 Response

{
  "type": "object",
  "properties": {
    "item": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "image": {
          "type": "string",
          "nullable": true
        }
      }
    },
    "total": {
      "type": "number"
    }
  }
}

Responses

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

Response Schema

Status Code 500

Name	Type	Required	Restrictions	Description
» item	object	false	none	none
»» name	string	false	none	none
»» image	string¦null	false	none	none
» total	number	false	none	none