/organization/customferrules 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:
Ferrules
getOrganizationCustomFerrules
Code samples
const headers = {
Accept: "application/json",
};
fetch("https://goldleaf.app/api/v1/organization/customferrules", {
method: "GET",
headers: headers,
})
.then(function (res) {
return res.json();
})
.then(function (body) {
console.log(body);
});
GET /organization/customferrules
Gets custom ferrules
Gets ferrules created by this organization.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| size | query | string | false | The size to search for. |
| search.brand | query | string | false | The brand to search for within a specific search context. |
| search.partNumber | query | string | false | The part number to search for within a specific search context. |
| search.size | query | string | false | The size to search for within a specific search context. |
| search.orgPartNumber | query | string | false | The original part number to search for within a specific search context. |
| 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. |
Example responses
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | An array of ferrules | None |