/hosekit/{hoseKitId}/getBillOfMaterials 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

Hose Kits

postHoseKitIdGetBillOfMaterialS

Code samples

const inputBody = '{
  "type": "object",
  "properties": {
    "format": {
      "type": "string",
      "description": "Format of the BOM file (e.g., 'pdf', 'xlsx').",
      "example": "pdf"
    }
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/pdf',
  'Authorization':{
  "type": "string"
}
};

fetch('https://goldleaf.app/api/v1/hosekit/{hoseKitId}/getBillOfMaterials',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /hosekit/{hoseKitId}/getBillOfMaterials

Retrieve Bill of Materials (BOM) for a hose kit

Retrieves the bill of materials (BOM) for the specified hose kit in the requested format.

Body parameter

{
  "type": "object",
  "properties": {
    "format": {
      "type": "string",
      "description": "Format of the BOM file (e.g., 'pdf', 'xlsx').",
      "example": "pdf"
    }
  }
}

Parameters

Name	In	Type	Required	Description
hoseKitId	path	string(objectId)	true	The ID of the hose kit to retrieve the BOM for.
Authorization	header	string	true	Bearer token for authentication.
body	body	object	true	none
» format	body	string	false	Format of the BOM file (e.g., 'pdf', 'xlsx').

Example responses

200 Response

500 Response

{
  "type": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved BOM file	string
500	Internal Server Error	Server error.	string