POST api/HCS_SkuExplorer/GetForecast

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SummaryView	boolean	None.
SummaryBulk	boolean	None.
SummaryBag	boolean	None.
SummaryRaw	boolean	None.
DetailView	boolean	None.
YearMonth	string	None.
ItemNmbr	string	None.
LOCNCODE	string	None.
Category	string	None.
SortBy	string	None.
SortDirection	string	None.
Skip	integer	None.
Take	integer	None.
IsExcelReport	boolean	None.
CUSTNMBR	string	None.
EmpID	string	None.

Request Formats

application/json, text/json

Sample:

{
  "SummaryView": true,
  "SummaryBulk": true,
  "SummaryBag": true,
  "SummaryRaw": true,
  "DetailView": true,
  "YearMonth": "sample string 6",
  "ItemNmbr": "sample string 7",
  "LOCNCODE": "sample string 8",
  "Category": "sample string 9",
  "SortBy": "sample string 10",
  "SortDirection": "sample string 11",
  "Skip": 12,
  "Take": 13,
  "IsExcelReport": true,
  "CUSTNMBR": "sample string 15",
  "EmpID": "sample string 16"
}

application/xml, text/xml

Sample:

<HCSSkuExplorerCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HCSAPI.DTOs">
  <CUSTNMBR>sample string 15</CUSTNMBR>
  <Category>sample string 9</Category>
  <DetailView>true</DetailView>
  <EmpID>sample string 16</EmpID>
  <IsExcelReport>true</IsExcelReport>
  <ItemNmbr>sample string 7</ItemNmbr>
  <LOCNCODE>sample string 8</LOCNCODE>
  <Skip>12</Skip>
  <SortBy>sample string 10</SortBy>
  <SortDirection>sample string 11</SortDirection>
  <SummaryBag>true</SummaryBag>
  <SummaryBulk>true</SummaryBulk>
  <SummaryRaw>true</SummaryRaw>
  <SummaryView>true</SummaryView>
  <Take>13</Take>
  <YearMonth>sample string 6</YearMonth>
</HCSSkuExplorerCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of HCSForecast

Name	Type	Additional information
ItemNmbr	string	None.
MonthName	string	None.
MonthNmbr	integer	None.
Year1	integer	None.
Year1Qty	decimal number	None.
Year1QtyOrdered	decimal number	None.
Year1QtyActual	decimal number	None.
Year1QtyRemaining	decimal number	None.
Year2	integer	None.
Year2Qty	decimal number	None.
Year2QtyActual	decimal number	None.
Year2QtyRemaining	decimal number	None.
Year3	integer	None.
Year3Qty	decimal number	None.
Year3QtyActual	decimal number	None.
Year3QtyRemaining	decimal number	None.
CustNmbr	string	None.
ForecastRowID	integer	None.
ForecastDate	date	None.
ForecastQty	decimal number	None.
ForecastComments	string	None.
DeleteIt	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ItemNmbr": "sample string 1",
    "MonthName": "sample string 2",
    "MonthNmbr": 3,
    "Year1": 4,
    "Year1Qty": 5.1,
    "Year1QtyOrdered": 6.1,
    "Year1QtyActual": 7.1,
    "Year1QtyRemaining": 0.0,
    "Year2": 9,
    "Year2Qty": 10.1,
    "Year2QtyActual": 11.1,
    "Year2QtyRemaining": 0.0,
    "Year3": 13,
    "Year3Qty": 14.1,
    "Year3QtyActual": 15.1,
    "Year3QtyRemaining": 0.0,
    "CustNmbr": "sample string 17",
    "ForecastRowID": 1,
    "ForecastDate": "2025-05-15T10:13:59.3596348+00:00",
    "ForecastQty": 19.1,
    "ForecastComments": "sample string 20",
    "DeleteIt": true
  },
  {
    "ItemNmbr": "sample string 1",
    "MonthName": "sample string 2",
    "MonthNmbr": 3,
    "Year1": 4,
    "Year1Qty": 5.1,
    "Year1QtyOrdered": 6.1,
    "Year1QtyActual": 7.1,
    "Year1QtyRemaining": 0.0,
    "Year2": 9,
    "Year2Qty": 10.1,
    "Year2QtyActual": 11.1,
    "Year2QtyRemaining": 0.0,
    "Year3": 13,
    "Year3Qty": 14.1,
    "Year3QtyActual": 15.1,
    "Year3QtyRemaining": 0.0,
    "CustNmbr": "sample string 17",
    "ForecastRowID": 1,
    "ForecastDate": "2025-05-15T10:13:59.3596348+00:00",
    "ForecastQty": 19.1,
    "ForecastComments": "sample string 20",
    "DeleteIt": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfHCSForecast xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HCSAPI.DTOs">
  <HCSForecast>
    <CustNmbr>sample string 17</CustNmbr>
    <DeleteIt>true</DeleteIt>
    <ForecastComments>sample string 20</ForecastComments>
    <ForecastDate>2025-05-15T10:13:59.3596348+00:00</ForecastDate>
    <ForecastQty>19.1</ForecastQty>
    <ForecastRowID>1</ForecastRowID>
    <ItemNmbr>sample string 1</ItemNmbr>
    <MonthName>sample string 2</MonthName>
    <MonthNmbr>3</MonthNmbr>
    <Year1>4</Year1>
    <Year1Qty>5.1</Year1Qty>
    <Year1QtyActual>7.1</Year1QtyActual>
    <Year1QtyOrdered>6.1</Year1QtyOrdered>
    <Year1QtyRemaining>0</Year1QtyRemaining>
    <Year2>9</Year2>
    <Year2Qty>10.1</Year2Qty>
    <Year2QtyActual>11.1</Year2QtyActual>
    <Year2QtyRemaining>0</Year2QtyRemaining>
    <Year3>13</Year3>
    <Year3Qty>14.1</Year3Qty>
    <Year3QtyActual>15.1</Year3QtyActual>
    <Year3QtyRemaining>0</Year3QtyRemaining>
  </HCSForecast>
  <HCSForecast>
    <CustNmbr>sample string 17</CustNmbr>
    <DeleteIt>true</DeleteIt>
    <ForecastComments>sample string 20</ForecastComments>
    <ForecastDate>2025-05-15T10:13:59.3596348+00:00</ForecastDate>
    <ForecastQty>19.1</ForecastQty>
    <ForecastRowID>1</ForecastRowID>
    <ItemNmbr>sample string 1</ItemNmbr>
    <MonthName>sample string 2</MonthName>
    <MonthNmbr>3</MonthNmbr>
    <Year1>4</Year1>
    <Year1Qty>5.1</Year1Qty>
    <Year1QtyActual>7.1</Year1QtyActual>
    <Year1QtyOrdered>6.1</Year1QtyOrdered>
    <Year1QtyRemaining>0</Year1QtyRemaining>
    <Year2>9</Year2>
    <Year2Qty>10.1</Year2Qty>
    <Year2QtyActual>11.1</Year2QtyActual>
    <Year2QtyRemaining>0</Year2QtyRemaining>
    <Year3>13</Year3>
    <Year3Qty>14.1</Year3Qty>
    <Year3QtyActual>15.1</Year3QtyActual>
    <Year3QtyRemaining>0</Year3QtyRemaining>
  </HCSForecast>
</ArrayOfHCSForecast>