Skip to main content

Stock on Hand by Area

This interface provides stock on hand data by area at the time of extract.

Below you will find the Actions with descriptions and the Specfication for the requests.

Actions

POST

This interface allows you to post to the StockOnHandByAreaSTD_API Interface

Request details

MethodEndpointHeader keyHeader Value
POSTBaseURL/api/productX-AUTH-TOKENIntegration Service API key

Request Body


{
"interfaceName" : "StockOnHandByAreaSTD_API",
"returnDetailedData" : true
}

Request Response

{
"success": true,
"message": "Success",
"errorData": null,
"returnData": {
"Snapshot": {
"CreateDate": "2021-06-02T10:12:49.5718107+02:00",
"Items": [
{
"BuildingNo": "01",
"BuildingDesc": "Building01",
"AreaNo": "A01",
"AreaDesc": "Area01",
"ClientDesc": "Client Description",
"CustomerDesc": "Customer Description",
"StyleNo": "12345677",
"SKUNo": "12345677",
"ItemAtt1": "",
"ItemAtt2": "",
"ItemAtt3": "",
"ItemAtt4": "",
"ItemAtt5": "",
"ItemAttValue1": 0.0,
"ItemAttValue2": 0.0,
"ItemAttValue3": 0.0,
"Qty": 10,
"Status": "Packing"
},
{
"BuildingNo": "01",
"BuildingDesc": "Building01",
"AreaNo": "A02",
"AreaDesc": "Area02",
"ClientDesc": "Client Description",
"CustomerDesc": "Customer Description",
"StyleNo": "12345678",
"SKUNo": "12345678",
"ItemAtt1": "",
"ItemAtt2": "",
"ItemAtt3": "",
"ItemAtt4": "",
"ItemAtt5": "",
"ItemAttValue1": 0.0,
"ItemAttValue2": 0.0,
"ItemAttValue3": 0.0,
"Qty": 100,
"Status": "Available"
},
{
"BuildingNo": "01",
"BuildingDesc": "Building01",
"AreaNo": "A03",
"AreaDesc": "Area03",
"ClientDesc": "Client Description",
"CustomerDesc": "Customer Description",
"StyleNo": "12345679",
"SKUNo": "12345679",
"ItemAtt1": "",
"ItemAtt2": "",
"ItemAtt3": "",
"ItemAtt4": "",
"ItemAtt5": "",
"ItemAttValue1": 0.0,
"ItemAttValue2": 0.0,
"ItemAttValue3": 0.0,
"Qty": 1000,
"Status": "Received"
}
]
}
}
}

Specification

Snapshot

The Snapshot object will contain the Create Date for the snapshot along with the items

Items

FieldType
BuildingNoString
BuildingDescString
AreaNoString
AreaDescString
ClientDescString
CustomerDescString
StyleNoString
SKUNoString
ItemAtt1String
ItemAtt2String
ItemAtt3String
ItemAtt4String
ItemAtt5String
ItemAttValue1Double
ItemAttValue2Double
ItemAttValue3Double
QtyInteger
StatusString