POST api/HCS/GetSalesUsage

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 PurchaseAdviceUsage

Name	Type	Additional information
ITEMNMBR	string	None.
LOCNCODE	string	None.
Year	string	None.
JanUsage	decimal number	None.
FebUsage	decimal number	None.
MarUsage	decimal number	None.
AprUsage	decimal number	None.
MayUsage	decimal number	None.
JunUsage	decimal number	None.
JulUsage	decimal number	None.
AugUsage	decimal number	None.
SepUsage	decimal number	None.
OctUsage	decimal number	None.
NovUsage	decimal number	None.
DecUsage	decimal number	None.
Day1Total	decimal number	None.
Day2Total	decimal number	None.
Day3Total	decimal number	None.
Day4Total	decimal number	None.
Day5Total	decimal number	None.
Day6Total	decimal number	None.
Day7Total	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ITEMNMBR": "sample string 1",
    "LOCNCODE": "sample string 2",
    "Year": "sample string 3",
    "JanUsage": 4.1,
    "FebUsage": 5.1,
    "MarUsage": 6.1,
    "AprUsage": 7.1,
    "MayUsage": 8.1,
    "JunUsage": 9.1,
    "JulUsage": 10.1,
    "AugUsage": 11.1,
    "SepUsage": 12.1,
    "OctUsage": 13.1,
    "NovUsage": 14.1,
    "DecUsage": 15.1,
    "Day1Total": 16.1,
    "Day2Total": 17.1,
    "Day3Total": 18.1,
    "Day4Total": 19.1,
    "Day5Total": 20.1,
    "Day6Total": 21.1,
    "Day7Total": 22.1
  },
  {
    "ITEMNMBR": "sample string 1",
    "LOCNCODE": "sample string 2",
    "Year": "sample string 3",
    "JanUsage": 4.1,
    "FebUsage": 5.1,
    "MarUsage": 6.1,
    "AprUsage": 7.1,
    "MayUsage": 8.1,
    "JunUsage": 9.1,
    "JulUsage": 10.1,
    "AugUsage": 11.1,
    "SepUsage": 12.1,
    "OctUsage": 13.1,
    "NovUsage": 14.1,
    "DecUsage": 15.1,
    "Day1Total": 16.1,
    "Day2Total": 17.1,
    "Day3Total": 18.1,
    "Day4Total": 19.1,
    "Day5Total": 20.1,
    "Day6Total": 21.1,
    "Day7Total": 22.1
  }
]

application/xml, text/xml

Sample:

<ArrayOfPurchaseAdviceUsage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HCSAPI.DTOs">
  <PurchaseAdviceUsage>
    <AprUsage>7.1</AprUsage>
    <AugUsage>11.1</AugUsage>
    <Day1Total>16.1</Day1Total>
    <Day2Total>17.1</Day2Total>
    <Day3Total>18.1</Day3Total>
    <Day4Total>19.1</Day4Total>
    <Day5Total>20.1</Day5Total>
    <Day6Total>21.1</Day6Total>
    <Day7Total>22.1</Day7Total>
    <DecUsage>15.1</DecUsage>
    <FebUsage>5.1</FebUsage>
    <ITEMNMBR>sample string 1</ITEMNMBR>
    <JanUsage>4.1</JanUsage>
    <JulUsage>10.1</JulUsage>
    <JunUsage>9.1</JunUsage>
    <LOCNCODE>sample string 2</LOCNCODE>
    <MarUsage>6.1</MarUsage>
    <MayUsage>8.1</MayUsage>
    <NovUsage>14.1</NovUsage>
    <OctUsage>13.1</OctUsage>
    <SepUsage>12.1</SepUsage>
    <Year>sample string 3</Year>
  </PurchaseAdviceUsage>
  <PurchaseAdviceUsage>
    <AprUsage>7.1</AprUsage>
    <AugUsage>11.1</AugUsage>
    <Day1Total>16.1</Day1Total>
    <Day2Total>17.1</Day2Total>
    <Day3Total>18.1</Day3Total>
    <Day4Total>19.1</Day4Total>
    <Day5Total>20.1</Day5Total>
    <Day6Total>21.1</Day6Total>
    <Day7Total>22.1</Day7Total>
    <DecUsage>15.1</DecUsage>
    <FebUsage>5.1</FebUsage>
    <ITEMNMBR>sample string 1</ITEMNMBR>
    <JanUsage>4.1</JanUsage>
    <JulUsage>10.1</JulUsage>
    <JunUsage>9.1</JunUsage>
    <LOCNCODE>sample string 2</LOCNCODE>
    <MarUsage>6.1</MarUsage>
    <MayUsage>8.1</MayUsage>
    <NovUsage>14.1</NovUsage>
    <OctUsage>13.1</OctUsage>
    <SepUsage>12.1</SepUsage>
    <Year>sample string 3</Year>
  </PurchaseAdviceUsage>
</ArrayOfPurchaseAdviceUsage>