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

CrimpFittings

getOrganizationCrimpFittingsWithFerrules

Code samples

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

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

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

GET /organization/crimpfittingswithferrules

Gets crimp fittings plus ferrules

Gets the crimp fittings for this organization, along with the suitable ferrule for this hose

Parameters

Name	In	Type	Required	Description
dashSize	query	string	false	The dash size of the part.
hoseSize	query	string	false	The size of the hose.
nominalHoseSize	query	string	false	The nominal size of the hose.
series	query	array[string]	false	The series to filter by.
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 brands with unavailable items.
includeCustom	query	boolean	false	Flag to include custom items.
search	query	object	false	none

Example responses

500 Response

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "No hose fittings available"
          },
          "image": {
            "type": "string",
            "nullable": true,
            "example": null
          }
        }
      }
    },
    "total": {
      "type": "integer",
      "example": 0
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	An array of crimp fittings	None
500	Internal Server Error	Server error with default response	Inline

Response Schema

Status Code 500

Name	Type	Required	Restrictions	Description
» items	[object]	false	none	none
»» name	string	false	none	none
»» image	string¦null	false	none	none
» total	integer	false	none	none