POST api/HCS/GetSku
Request Information
URI Parameters
None.
Body Parameters
HCSSkuExplorerCriteria| Name | Description | 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 HCSSKUExplorer| Name | Description | Type | Additional information |
|---|---|---|---|
| ItemNmbr | string |
None. |
|
| ItemDesc | string |
None. |
|
| UOMSCHDL | string |
None. |
|
| OnHand | decimal number |
None. |
|
| Allocated | decimal number |
None. |
|
| Available | decimal number |
None. |
|
| OnOrder | decimal number |
None. |
|
| MTDUse | decimal number |
None. |
|
| ForecastQty | decimal number |
None. |
|
| Month1SoldQty | decimal number |
None. |
|
| Month1Name | string |
None. |
|
| Month2SoldQty | decimal number |
None. |
|
| Month2Name | string |
None. |
|
| Month3SoldQty | decimal number |
None. |
|
| Month3Name | string |
None. |
|
| LotNumber | string |
None. |
|
| Bin | string |
None. |
|
| DateReceived | date |
None. |
|
| QtyRecvd | decimal number |
None. |
|
| QtyAllocated | decimal number |
None. |
|
| QtySold | decimal number |
None. |
|
| LOCNCODE | string |
None. |
|
| ItmClsCd | string |
None. |
|
| Category | string |
None. |
|
| BaseUofM | string |
None. |
|
| SellUofM | string |
None. |
|
| StndCost | decimal number |
None. |
|
| CurrCost | decimal number |
None. |
|
| ListPrice | decimal number |
None. |
|
| SellStndCost | decimal number |
None. |
|
| SellCurrCost | decimal number |
None. |
|
| SellListPrice | decimal number |
None. |
|
| ItemType | string |
None. |
|
| Categories | Collection of string |
None. |
|
| Items | Collection of NameValue |
None. |
|
| FullAccess | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"ItemNmbr": "sample string 1",
"ItemDesc": "sample string 2",
"UOMSCHDL": "sample string 3",
"OnHand": 4.1,
"Allocated": 5.1,
"Available": 6.1,
"OnOrder": 7.1,
"MTDUse": 8.1,
"ForecastQty": 9.1,
"Month1SoldQty": 10.1,
"Month1Name": "sample string 11",
"Month2SoldQty": 12.1,
"Month2Name": "sample string 13",
"Month3SoldQty": 14.1,
"Month3Name": "sample string 15",
"LotNumber": "sample string 16",
"Bin": "sample string 17",
"DateReceived": "2025-12-17T03:23:33.4712621+00:00",
"QtyRecvd": 19.1,
"QtyAllocated": 20.1,
"QtySold": 21.1,
"LOCNCODE": "sample string 22",
"ItmClsCd": "sample string 23",
"Category": "sample string 24",
"BaseUofM": "sample string 25",
"SellUofM": "sample string 26",
"StndCost": 27.1,
"CurrCost": 28.1,
"ListPrice": 29.1,
"SellStndCost": 30.1,
"SellCurrCost": 31.1,
"SellListPrice": 32.1,
"ItemType": "sample string 33",
"Categories": [
"sample string 1",
"sample string 2"
],
"Items": [
{
"Name": "sample string 1",
"Value": "sample string 2",
"Permission": "sample string 3",
"id": 4,
"defaultselection": true,
"Location": "sample string 6",
"ViewOption": true,
"EditOption": true,
"Prefix": "sample string 9",
"ProductionStatus": "sample string 10",
"MixerID": 11,
"MixerNmbr": 12,
"MixerName": "sample string 13"
},
{
"Name": "sample string 1",
"Value": "sample string 2",
"Permission": "sample string 3",
"id": 4,
"defaultselection": true,
"Location": "sample string 6",
"ViewOption": true,
"EditOption": true,
"Prefix": "sample string 9",
"ProductionStatus": "sample string 10",
"MixerID": 11,
"MixerNmbr": 12,
"MixerName": "sample string 13"
}
],
"FullAccess": true
},
{
"ItemNmbr": "sample string 1",
"ItemDesc": "sample string 2",
"UOMSCHDL": "sample string 3",
"OnHand": 4.1,
"Allocated": 5.1,
"Available": 6.1,
"OnOrder": 7.1,
"MTDUse": 8.1,
"ForecastQty": 9.1,
"Month1SoldQty": 10.1,
"Month1Name": "sample string 11",
"Month2SoldQty": 12.1,
"Month2Name": "sample string 13",
"Month3SoldQty": 14.1,
"Month3Name": "sample string 15",
"LotNumber": "sample string 16",
"Bin": "sample string 17",
"DateReceived": "2025-12-17T03:23:33.4712621+00:00",
"QtyRecvd": 19.1,
"QtyAllocated": 20.1,
"QtySold": 21.1,
"LOCNCODE": "sample string 22",
"ItmClsCd": "sample string 23",
"Category": "sample string 24",
"BaseUofM": "sample string 25",
"SellUofM": "sample string 26",
"StndCost": 27.1,
"CurrCost": 28.1,
"ListPrice": 29.1,
"SellStndCost": 30.1,
"SellCurrCost": 31.1,
"SellListPrice": 32.1,
"ItemType": "sample string 33",
"Categories": [
"sample string 1",
"sample string 2"
],
"Items": [
{
"Name": "sample string 1",
"Value": "sample string 2",
"Permission": "sample string 3",
"id": 4,
"defaultselection": true,
"Location": "sample string 6",
"ViewOption": true,
"EditOption": true,
"Prefix": "sample string 9",
"ProductionStatus": "sample string 10",
"MixerID": 11,
"MixerNmbr": 12,
"MixerName": "sample string 13"
},
{
"Name": "sample string 1",
"Value": "sample string 2",
"Permission": "sample string 3",
"id": 4,
"defaultselection": true,
"Location": "sample string 6",
"ViewOption": true,
"EditOption": true,
"Prefix": "sample string 9",
"ProductionStatus": "sample string 10",
"MixerID": 11,
"MixerNmbr": 12,
"MixerName": "sample string 13"
}
],
"FullAccess": true
}
]
application/xml, text/xml
Sample:
<ArrayOfHCSSKUExplorer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HCSAPI.DTOs">
<HCSSKUExplorer>
<Allocated>5.1</Allocated>
<Available>6.1</Available>
<BaseUofM>sample string 25</BaseUofM>
<Bin>sample string 17</Bin>
<Categories xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</Categories>
<Category>sample string 24</Category>
<CurrCost>28.1</CurrCost>
<DateReceived>2025-12-17T03:23:33.4712621+00:00</DateReceived>
<ForecastQty>9.1</ForecastQty>
<FullAccess>true</FullAccess>
<ItemDesc>sample string 2</ItemDesc>
<ItemNmbr>sample string 1</ItemNmbr>
<ItemType>sample string 33</ItemType>
<Items>
<NameValue>
<EditOption>true</EditOption>
<Location>sample string 6</Location>
<MixerID>11</MixerID>
<MixerName>sample string 13</MixerName>
<MixerNmbr>12</MixerNmbr>
<Name>sample string 1</Name>
<Permission>sample string 3</Permission>
<Prefix>sample string 9</Prefix>
<ProductionStatus>sample string 10</ProductionStatus>
<Value>sample string 2</Value>
<ViewOption>true</ViewOption>
<defaultselection>true</defaultselection>
<id>4</id>
</NameValue>
<NameValue>
<EditOption>true</EditOption>
<Location>sample string 6</Location>
<MixerID>11</MixerID>
<MixerName>sample string 13</MixerName>
<MixerNmbr>12</MixerNmbr>
<Name>sample string 1</Name>
<Permission>sample string 3</Permission>
<Prefix>sample string 9</Prefix>
<ProductionStatus>sample string 10</ProductionStatus>
<Value>sample string 2</Value>
<ViewOption>true</ViewOption>
<defaultselection>true</defaultselection>
<id>4</id>
</NameValue>
</Items>
<ItmClsCd>sample string 23</ItmClsCd>
<LOCNCODE>sample string 22</LOCNCODE>
<ListPrice>29.1</ListPrice>
<LotNumber>sample string 16</LotNumber>
<MTDUse>8.1</MTDUse>
<Month1Name>sample string 11</Month1Name>
<Month1SoldQty>10.1</Month1SoldQty>
<Month2Name>sample string 13</Month2Name>
<Month2SoldQty>12.1</Month2SoldQty>
<Month3Name>sample string 15</Month3Name>
<Month3SoldQty>14.1</Month3SoldQty>
<OnHand>4.1</OnHand>
<OnOrder>7.1</OnOrder>
<QtyAllocated>20.1</QtyAllocated>
<QtyRecvd>19.1</QtyRecvd>
<QtySold>21.1</QtySold>
<SellCurrCost>31.1</SellCurrCost>
<SellListPrice>32.1</SellListPrice>
<SellStndCost>30.1</SellStndCost>
<SellUofM>sample string 26</SellUofM>
<StndCost>27.1</StndCost>
<UOMSCHDL>sample string 3</UOMSCHDL>
</HCSSKUExplorer>
<HCSSKUExplorer>
<Allocated>5.1</Allocated>
<Available>6.1</Available>
<BaseUofM>sample string 25</BaseUofM>
<Bin>sample string 17</Bin>
<Categories xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</Categories>
<Category>sample string 24</Category>
<CurrCost>28.1</CurrCost>
<DateReceived>2025-12-17T03:23:33.4712621+00:00</DateReceived>
<ForecastQty>9.1</ForecastQty>
<FullAccess>true</FullAccess>
<ItemDesc>sample string 2</ItemDesc>
<ItemNmbr>sample string 1</ItemNmbr>
<ItemType>sample string 33</ItemType>
<Items>
<NameValue>
<EditOption>true</EditOption>
<Location>sample string 6</Location>
<MixerID>11</MixerID>
<MixerName>sample string 13</MixerName>
<MixerNmbr>12</MixerNmbr>
<Name>sample string 1</Name>
<Permission>sample string 3</Permission>
<Prefix>sample string 9</Prefix>
<ProductionStatus>sample string 10</ProductionStatus>
<Value>sample string 2</Value>
<ViewOption>true</ViewOption>
<defaultselection>true</defaultselection>
<id>4</id>
</NameValue>
<NameValue>
<EditOption>true</EditOption>
<Location>sample string 6</Location>
<MixerID>11</MixerID>
<MixerName>sample string 13</MixerName>
<MixerNmbr>12</MixerNmbr>
<Name>sample string 1</Name>
<Permission>sample string 3</Permission>
<Prefix>sample string 9</Prefix>
<ProductionStatus>sample string 10</ProductionStatus>
<Value>sample string 2</Value>
<ViewOption>true</ViewOption>
<defaultselection>true</defaultselection>
<id>4</id>
</NameValue>
</Items>
<ItmClsCd>sample string 23</ItmClsCd>
<LOCNCODE>sample string 22</LOCNCODE>
<ListPrice>29.1</ListPrice>
<LotNumber>sample string 16</LotNumber>
<MTDUse>8.1</MTDUse>
<Month1Name>sample string 11</Month1Name>
<Month1SoldQty>10.1</Month1SoldQty>
<Month2Name>sample string 13</Month2Name>
<Month2SoldQty>12.1</Month2SoldQty>
<Month3Name>sample string 15</Month3Name>
<Month3SoldQty>14.1</Month3SoldQty>
<OnHand>4.1</OnHand>
<OnOrder>7.1</OnOrder>
<QtyAllocated>20.1</QtyAllocated>
<QtyRecvd>19.1</QtyRecvd>
<QtySold>21.1</QtySold>
<SellCurrCost>31.1</SellCurrCost>
<SellListPrice>32.1</SellListPrice>
<SellStndCost>30.1</SellStndCost>
<SellUofM>sample string 26</SellUofM>
<StndCost>27.1</StndCost>
<UOMSCHDL>sample string 3</UOMSCHDL>
</HCSSKUExplorer>
</ArrayOfHCSSKUExplorer>