POST api/ApiIntegration/SBGetMaterialForecastPerComponent

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PrivateApiKey	string	None.
DateType	string	None.
StartDate	date	None.
EndDate	date	None.
GroupBy	string	None.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1",
  "dateType": "sample string 2",
  "startDate": "2026-08-03T21:41:44.3658585+00:00",
  "endDate": "2026-08-03T21:41:44.3658585+00:00",
  "groupBy": "sample string 5"
}

application/xml, text/xml

Sample:

<ApiForecastParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <DateType>sample string 2</DateType>
  <EndDate>2026-08-03T21:41:44.3658585+00:00</EndDate>
  <GroupBy>sample string 5</GroupBy>
  <PrivateApiKey>sample string 1</PrivateApiKey>
  <StartDate>2026-08-03T21:41:44.3658585+00:00</StartDate>
</ApiForecastParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiForecastPerComponent

Name	Description	Type	Additional information
Result		Collection of ApiForecastPerComponentJob	None.

Response Formats

application/json, text/json

Sample:

{
  "result": [
    {
      "jobNumber": "sample string 1",
      "jobKey": "f054f345-6aa6-4d64-b6ed-4eb54eb54d4c",
      "confirmationDate": "sample string 2",
      "installDate": "sample string 3",
      "components": [
        {
          "category": "sample string 1",
          "material": "sample string 2",
          "width": "sample string 3",
          "depth": "sample string 4",
          "sku": "sample string 5",
          "totalQuantityRequired": 6,
          "costMethodOrPartDescription": "sample string 7"
        },
        {
          "category": "sample string 1",
          "material": "sample string 2",
          "width": "sample string 3",
          "depth": "sample string 4",
          "sku": "sample string 5",
          "totalQuantityRequired": 6,
          "costMethodOrPartDescription": "sample string 7"
        }
      ]
    },
    {
      "jobNumber": "sample string 1",
      "jobKey": "f054f345-6aa6-4d64-b6ed-4eb54eb54d4c",
      "confirmationDate": "sample string 2",
      "installDate": "sample string 3",
      "components": [
        {
          "category": "sample string 1",
          "material": "sample string 2",
          "width": "sample string 3",
          "depth": "sample string 4",
          "sku": "sample string 5",
          "totalQuantityRequired": 6,
          "costMethodOrPartDescription": "sample string 7"
        },
        {
          "category": "sample string 1",
          "material": "sample string 2",
          "width": "sample string 3",
          "depth": "sample string 4",
          "sku": "sample string 5",
          "totalQuantityRequired": 6,
          "costMethodOrPartDescription": "sample string 7"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<ApiForecastPerComponent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <Result>
    <ApiForecastPerComponentJob>
      <Components>
        <ApiForecastPerComponentInfo>
          <Category>sample string 1</Category>
          <CostMethodOrPartDescription>sample string 7</CostMethodOrPartDescription>
          <Depth>sample string 4</Depth>
          <Material>sample string 2</Material>
          <SKU>sample string 5</SKU>
          <TotalQuantityRequired>6</TotalQuantityRequired>
          <Width>sample string 3</Width>
        </ApiForecastPerComponentInfo>
        <ApiForecastPerComponentInfo>
          <Category>sample string 1</Category>
          <CostMethodOrPartDescription>sample string 7</CostMethodOrPartDescription>
          <Depth>sample string 4</Depth>
          <Material>sample string 2</Material>
          <SKU>sample string 5</SKU>
          <TotalQuantityRequired>6</TotalQuantityRequired>
          <Width>sample string 3</Width>
        </ApiForecastPerComponentInfo>
      </Components>
      <ConfirmationDate>sample string 2</ConfirmationDate>
      <InstallDate>sample string 3</InstallDate>
      <JobKey>f054f345-6aa6-4d64-b6ed-4eb54eb54d4c</JobKey>
      <JobNumber>sample string 1</JobNumber>
    </ApiForecastPerComponentJob>
    <ApiForecastPerComponentJob>
      <Components>
        <ApiForecastPerComponentInfo>
          <Category>sample string 1</Category>
          <CostMethodOrPartDescription>sample string 7</CostMethodOrPartDescription>
          <Depth>sample string 4</Depth>
          <Material>sample string 2</Material>
          <SKU>sample string 5</SKU>
          <TotalQuantityRequired>6</TotalQuantityRequired>
          <Width>sample string 3</Width>
        </ApiForecastPerComponentInfo>
        <ApiForecastPerComponentInfo>
          <Category>sample string 1</Category>
          <CostMethodOrPartDescription>sample string 7</CostMethodOrPartDescription>
          <Depth>sample string 4</Depth>
          <Material>sample string 2</Material>
          <SKU>sample string 5</SKU>
          <TotalQuantityRequired>6</TotalQuantityRequired>
          <Width>sample string 3</Width>
        </ApiForecastPerComponentInfo>
      </Components>
      <ConfirmationDate>sample string 2</ConfirmationDate>
      <InstallDate>sample string 3</InstallDate>
      <JobKey>f054f345-6aa6-4d64-b6ed-4eb54eb54d4c</JobKey>
      <JobNumber>sample string 1</JobNumber>
    </ApiForecastPerComponentJob>
  </Result>
</ApiForecastPerComponent>