Stock on Hand
This interface provides stock on hand data 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 StockOnHandSTD_API Interface
Request details
Method | Endpoint | Header key | Header Value |
---|---|---|---|
POST | BaseURL/api/product | X-AUTH-TOKEN | Integration Service API key |
Request Body
{
"interfaceName" : "StockOnHandSTD_API",
"returnDetailedData" : true
}
Request Response
{
"success": true,
"message": "Success",
"errorData": null,
"returnData": {
"Snapshot": {
"CreateDate": "2021-06-02T10:21:52.5862109+02:00",
"Items": [
{
"ClientNo": "CL01",
"ClientDesc": "Client Description",
"CustomerNo": "CU01",
"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"
},
{
"ClientNo": "CL01",
"ClientDesc": "Client Description",
"CustomerNo": "CU01",
"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"
},
{
"ClientNo": "CL01",
"ClientDesc": "Client Description",
"CustomerNo": "CU01",
"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
Field | Type |
---|---|
ClientNo | String |
ClientDesc | String |
CustomerNo | String |
CustomerDesc | String |
StyleNo | String |
SKUNo | String |
ItemAtt1 | String |
ItemAtt2 | String |
ItemAtt3 | String |
ItemAtt4 | String |
ItemAtt5 | String |
ItemAttValue1 | Double |
ItemAttValue2 | Double |
ItemAttValue3 | Double |
Qty | Integer |
Status | String |