GoldLeaf DocumentationGoldLeaf Documentation
User Guide
API
User Guide
API
  • Getting Started

    • Introduction
    • API Key Types
    • Configuration
    • Limitations
  • E-Commerce Configurator

    • Introduction
    • Security Tokens
    • Setting up the Configurator
  • API Endpoints

    • Adaptor

      • [GET]adaptors-cross
      • [GET]adaptors-search
      • [GET]adaptor-{adaptorId}
      • [GET]adaptors-configuration
      • [POST]adaptors-create
      • [GET]organization-adaptors
      • [GET]organization-customadaptors
      • [POST]organization-adaptor-{adaptorId}-update
    • Brand

      • [GET]brands
      • [GET]hosebrands
      • [GET]adaptorbrands
      • [GET]wrapbrands
      • [GET]otheritembrands
      • [GET]brandnames
      • [POST]brand-{brandId}-delete
      • [POST]brand-{brandId}-update
      • [POST]brands-export
      • [GET]organization-defaultbrand
      • [GET]organization-defaultadaptorbrand
    • Component

      • [POST]components-import
      • [POST]components-exceltemplate
      • [POST]components-export
      • [GET]organization-components
    • CrimpFitting

      • [POST]crimpfittings-sizes
      • [POST]crimpfittings-create
      • [GET]crimpfitting-{crimpfittingId}
      • [POST]organization-crimpfitting-{crimpfittingId}-update
      • [GET]organization-couplingseries
      • [GET]organization-couplingseriesdetails
      • [GET]organization-crimpfittings
      • [GET]organization-crimpfittingswithferrules
      • [GET]organization-customcrimpfittings
    • Customer

      • [GET]customers
      • [GET]customernamess
      • [POST]customers-create
      • [GET]customer-{customerId}
      • [POST]customer-{customerId}-update
      • [POST]customer-{customerId}-delete
      • [POST]customers-exceltemplate
      • [POST]customers-export
      • [GET]customer-{customerId}-items
      • [POST]customer-{customerId}-item-{itemId}-update
      • [POST]customer-{customerId}-item-{itemId}-delete
      • [POST]customers-items-import
      • [POST]customers-items-exceltemplate
      • [POST]customer-{customerId}-items-export
      • [GET]customer-{customerId}-locations
      • [POST]customer-{customerId}-location-{locationId}-update
      • [POST]customer-{customerId}-location-{locationId}-delete
    • Ferrule

      • [POST]ferrules-create
      • [GET]ferrule-{ferruleId}
      • [GET]organization-ferrule
      • [POST]organization-ferrule-{ferruleId}-update
      • [GET]organization-ferrules
      • [GET]organization-customferrules
    • Gender

      • [GET]genders
    • Hose

      • [POST]hoses-sizes
      • [POST]hoses-create
      • [GET]hose-{hoseId}
      • [GET]hose-{hoseId}-crimpspecs
      • [POST]organization-hose-{hoseId}-update
      • [GET]organization-hoses
      • [GET]organization-customhoses
      • [GET]organization-hasparker
    • HoseAssembly

      • [POST]hoseassemblies-checkexisting
      • [POST]hoseassemblies-create
      • [POST]hoseassembly-:hoseAssemblyId-datasheet
      • [POST]hoseassembly-{hoseAssemblyId}-label
      • [GET]hoseassemblies
      • [GET]hoseassembly-{hoseAssemblyId}
      • [GET]hoseassemblies-parse
      • [POST]hoseassemblies-parsefeedback
      • [POST]hoseassembly-{hoseAssemblyId}-saveas
      • [POST]hoseassembly-:hoseAssemblyId-update
      • [POST]hoseassembly-:hoseAssemblyId-delete
      • [POST]hoseassembly-{hoseAssemblyId}-customers-update
      • [POST]hoseassembly-{hoseAssemblyId}-customers-delete
      • [POST]hoseassemblies-import
      • [POST]hoseassemblies-exceltemplate
      • [POST]hoseassemblies-export
      • [POST]hoseassembly-{hoseAssemblyId}-getBillOfMaterials
      • [POST]hoseassembly-{hoseAssemblyId}-getmarkenfile
      • [POST]hoseassembly-{hoseAssemblyId}-getparkerptsfile
      • [POST]hoseassembly-{hoseAssemblyId}-price
      • [POST]hoseassembly-price
      • [POST]hoseassembly-{hoseAssemblyId}-release
      • [POST]hoseassembly-{hoseAssemblyId}-unrelease
      • [POST]hoseassembly-{hoseAssemblyId}-obsolete
      • [POST]hoseassembly-{hoseAssemblyId}-newversion
      • [POST]hoseassembly-{hoseAssemblyId}-rollback
      • [POST]hoseassembly-{hoseAssemblyId}-revise
    • HoseKit

      • [POST]hosekits-checkexisting
      • [POST]hosekits-create
      • [GET]hosekits
      • [GET]hosekit-{hoseKitId}
      • [POST]hosekit-{hoseKitId}-update
      • [POST]hosekit-{hoseKitId}-release
      • [POST]hosekit-{hoseKitId}-newversion
      • [POST]hosekit-{hoseKitId}-rollback
      • [POST]hosekit-{hoseKitId}-revise
      • [POST]hosekit-{hoseKitId}-delete
      • [POST]hosekit-{hoseKitId}-addhoseassembly
      • [POST]hosekit-{hoseKitId}-addadaptor
      • [POST]hosekit-{hoseKitId}-addotheritem
      • [GET]hosekit-{hoseKitId}-hoseassemblies
      • [GET]hosekit-{hoseKitId}-adaptors
      • [GET]hosekit-{hoseKitId}-otheritems
      • [GET]hosekit-{hoseKitId}-allitems
      • [POST]hosekit-{hoseKitId}-item-{itemId}-delete
      • [POST]hosekit-{hoseKitId}-hoseassembly-{itemId}-update
      • [POST]hosekit-{hoseKitId}-adaptor-{itemId}-update
      • [POST]hosekit-{hoseKitId}-otheritem-{itemId}-update
      • [POST]hosekit-:hoseKitId-getHoseKitDataSheet
      • [POST]hosekit-{hoseKitId}-getBillOfMaterials
      • [POST]hosekit-{hoseKitId}-getmarkenfile
      • [POST]hosekit-{hoseKitId}-getparkerptsfile
      • [POST]hosekits-export
      • [POST]hosekit-{hoseKitId}-labels
      • [POST]hosekit-{hoseKitId}-price
    • Image

      • [GET]image-{belongsToId}
    • Inventory

      • [GET]inventory
      • [POST]inventory-import
      • [POST]inventory-exceltemplate
      • [POST]inventoryitems-export
      • [POST]inventoryitem-{inventoryItemId}-delete
      • [POST]inventoryitem-update
      • [GET]organization-hideinventory
    • Item

      • [GET]item-{itemId}
      • [GET]organization-items
      • [GET]organization-itemtypes
      • [GET]organization-pendingitems
      • [POST]organization-item-{itemId}-update
    • Organization

      • [GET]organization
      • [POST]organization-update
      • [GET]organization-defaults
      • [GET]organization-currencies
      • [POST]organization-currencies-update
      • [GET]organization-subscription
      • [GET]organization-erpname
      • [GET]organization-usebetafeatures
      • [POST]organization-acceptterms
      • [GET]organization-hasacceptedterms
      • [POST]organization-productgroups-update
      • [POST]organization-suppliers-update
      • [POST]organization-locations-update
      • [GET]organization-productgroups
      • [GET]organization-suppliers
      • [GET]organization-locations
      • [GET]organization-apikeys
      • [POST]organization-apikeys-{apiKeyId}-update
      • [POST]organization-apikeys-{apiKeyId}-delete
      • [GET]organization-nextpartnumber
      • [GET]organization-revisiondelimiter
      • [GET]organization-api-history
    • OtherItem

      • [POST]otheritems-create
      • [POST]otheritems-{itemId}-delete
      • [POST]otheritems-{itemId}-update
      • [GET]otheritem-{otherItemId}
      • [POST]organization-otheritem-{otherItemId}-update
      • [GET]organization-customotheritems
    • PriceList

      • [GET]pricelists
      • [GET]pricelistnames
      • [POST]pricelists-create
      • [GET]pricelist-{priceListId}
      • [POST]pricelist-{priceListId}-update
      • [POST]pricelist-{priceListId}-delete
      • [POST]pricelists-import
      • [POST]pricelists-exceltemplate
      • [POST]pricelists-export
    • SalesEstimate

      • [POST]salesestimates-checkexisting
      • [POST]salesestimates-create
      • [GET]salesestimates
      • [GET]salesestimate-{salesEstimateId}
      • [GET]salesestimate-{salesEstimateId}-currentpricing
      • [POST]salesestimate-{salesEstimateId}-update
      • [POST]salesestimate-{salesEstimateId}-item-{itemId}-update
      • [POST]salesestimate-{salesEstimateId}-item-{itemId}-delete
      • [POST]salesestimate-{salesEstimateId}-release
      • [POST]salesestimate-{salesEstimateId}-newversion
      • [POST]salesestimate-{salesEstimateId}-rollback
      • [POST]salesestimate-{salesEstimateId}-revise
      • [POST]salesestimate-:salesEstimateId-getSalesEstimateDataSheet
      • [POST]salesestimate-{salesEstimateId}-getBillOfMaterials
      • [GET]salesestimate-{salesEstimateId}-refresh
      • [GET]salesestimate-{salesEstimateId}-items
      • [POST]salesestimates-export
    • Shape

      • [GET]shapes
    • Size

      • [GET]hosesizes
      • [GET]endsizes
    • Style

      • [GET]styles
    • User

      • [GET]user
      • [POST]users-update
      • [POST]user-resetpassword
      • [GET]organization-userroles
      • [GET]organization-userrolesandsubscription
      • [GET]organization-roles
      • [POST]organization-users-invite
      • [POST]organization-user-{userId}-delete
      • [POST]organization-user-{userId}-remind
      • [GET]organization-users
    • Warehouse

      • [GET]warehouses
      • [GET]warehouse-{warehouseId}
      • [POST]warehouses-create
      • [POST]warehouse-{warehouseId}-delete
      • [POST]warehouse-{warehouseId}-update
      • [POST]warehouses-export
      • [POST]warehouses-import
      • [POST]warehouses-exceltemplate
      • [GET]organization-defaultwarehouse
    • WorkOrder

      • [POST]workorders-checkexisting
      • [POST]workorders-create
      • [GET]workorders
      • [GET]workorder-{workOrderId}
      • [POST]workorder-{workOrderId}-update
      • [POST]workorder-{workOrderId}-delete
      • [POST]workorder-{workOrderId}-addline
      • [POST]workorder-{workOrderId}-release
      • [POST]workorder-{workOrderId}-newversion
      • [POST]workorder-{workOrderId}-rollback
      • [POST]workorder-{workOrderId}-revise
      • [GET]workorder-{workOrderId}-items
      • [POST]workorder-{workOrderId}-item-{itemId}-delete
      • [POST]workorder-{workOrderId}-item-{itemId}-update
      • [POST]workorder-{workOrderId}-getWorkOrderDataSheet
      • [POST]workorder-{workOrderId}-getmarkenfile
      • [POST]workorder-{workOrderId}-getparkerptsfile
      • [POST]workorders-export
      • [POST]workorder-{workOrderId}-labels
    • Wrap

      • [POST]wraps-create
      • [GET]wrap-{wrapId}
      • [GET]organization-wrapstyles
      • [GET]organization-wrapcoverage
      • [POST]organization-wrap-{wrapId}-update
      • [GET]organization-wraps
      • [GET]organization-customwraps
  • API Schemas

    • Adaptor
    • Brand
    • BrandProperties
    • CrimpFitting
    • Customer
    • CustomerItemProperties
    • Ferrule
    • Hose
    • HoseAssembly
    • HoseKit
    • ImageProperties
    • InventoryItem
    • ItemProperties
    • Item
    • OrganizationCurrency
    • OrganizationOtherItem
    • OrganizationProperties
    • PriceList
    • PriceListItem
    • SalesEstimate
    • Warehouse
    • WorkOrder
    • Wrap

/hoseassemblies/export 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 Assembly

postHoseAssembliesExport

Code samples

const inputBody = '{
  "type": "object",
  "properties": {
    "hoseAssemblies": {
      "type": "array",
      "description": "List of MongoDB ObjectIds for hose assemblies to export.",
      "items": {
        "type": "string",
        "format": "objectId"
      }
    },
    "selectAll": {
      "type": "boolean",
      "description": "If true, all items matching the search criteria will be exported."
    },
    "search": {
      "type": "object",
      "description": "Optional filters for searching hose assemblies.",
      "properties": {
        "customerName": {
          "type": "string"
        },
        "partNumberWithRevision": {
          "type": "string"
        },
        "customerPartNumber": {
          "type": "string"
        },
        "customerRevision": {
          "type": "string"
        },
        "hosePartNumber": {
          "type": "string"
        },
        "end1PartNumber": {
          "type": "string"
        },
        "end2PartNumber": {
          "type": "string"
        },
        "length": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "comments": {
          "type": "string"
        },
        "hoseBrand": {
          "type": "string"
        },
        "commonSearch": {
          "type": "string"
        },
        "status": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "hoseAssemblies",
    "selectAll"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

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

POST /hoseassemblies/export

Export hose assemblies

Exports hose assemblies based on selected IDs or filtered search criteria.

Body parameter

{
  "type": "object",
  "properties": {
    "hoseAssemblies": {
      "type": "array",
      "description": "List of MongoDB ObjectIds for hose assemblies to export.",
      "items": {
        "type": "string",
        "format": "objectId"
      }
    },
    "selectAll": {
      "type": "boolean",
      "description": "If true, all items matching the search criteria will be exported."
    },
    "search": {
      "type": "object",
      "description": "Optional filters for searching hose assemblies.",
      "properties": {
        "customerName": {
          "type": "string"
        },
        "partNumberWithRevision": {
          "type": "string"
        },
        "customerPartNumber": {
          "type": "string"
        },
        "customerRevision": {
          "type": "string"
        },
        "hosePartNumber": {
          "type": "string"
        },
        "end1PartNumber": {
          "type": "string"
        },
        "end2PartNumber": {
          "type": "string"
        },
        "length": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "comments": {
          "type": "string"
        },
        "hoseBrand": {
          "type": "string"
        },
        "commonSearch": {
          "type": "string"
        },
        "status": {
          "type": "string"
        }
      }
    }
  },
  "required": ["hoseAssemblies", "selectAll"]
}

Parameters

NameInTypeRequiredDescription
bodybodyobjecttruenone
» hoseAssembliesbody[string]trueList of MongoDB ObjectIds for hose assemblies to export.
» selectAllbodybooleantrueIf true, all items matching the search criteria will be exported.
» searchbodyobjectfalseOptional filters for searching hose assemblies.
»» customerNamebodystringfalsenone
»» partNumberWithRevisionbodystringfalsenone
»» customerPartNumberbodystringfalsenone
»» customerRevisionbodystringfalsenone
»» hosePartNumberbodystringfalsenone
»» end1PartNumberbodystringfalsenone
»» end2PartNumberbodystringfalsenone
»» lengthbodystringfalsenone
»» descriptionbodystringfalsenone
»» commentsbodystringfalsenone
»» hoseBrandbodystringfalsenone
»» commonSearchbodystringfalsenone
»» statusbodystringfalsenone

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "string",
      "description": "Download link or reference to exported file."
    }
  }
}

Responses

StatusMeaningDescriptionSchema
200OKHose assemblies export successfulInline
400Bad RequestServer errorstring
500Internal Server ErrorServer errorstring

Response Schema

Status Code 200

NameTypeRequiredRestrictionsDescription
» successbooleanfalsenonenone
» datastringfalsenoneDownload link or reference to exported file.
To perform this operation, you must be authenticated by means of one of the following methods: None
Last Updated:: 2025-07-03, 5:53 p.m.
Prev
[POST]hoseassemblies-exceltemplate
Next
[POST]hoseassembly-{hoseAssemblyId}-getBillOfMaterials