Stock Correction GET
URI
https://{DATACENTER}.brightpearlconnect.com/public-api/{ACCOUNT}/warehouse-service/warehouse/{WAREHOUSE_ID}/stock-correction/{GOODS_NOTE_ID_SET} Refer to our documentation on URI syntax for more information on how to construct URIs.
Description
Returns a list of stock corrections with all their goods movements. Typically an additive correction will have a single movement whereas a subtractive correction may remove stock from several batches so will be split over several movements.
A warehouse ID and goods note ID set are required and the maximum potential number of goods note IDs which may be requested at one time is 200.
A stock correction consists of the following fields:
| Field | Data type | Description |
|---|---|---|
| goodsNoteId | Integer | Stock correction note ID |
| warehouseId | Integer | Warehouse ID |
| orderId | Integer | Order related to stock correction (optional) |
| reason | String | Reason given for correction |
| goodsMoved[].productId | Integer | Product ID |
| goodsMoved[].quantity | Integer | Quantity of stock corrected |
| goodsMoved[].destinationLocationId | Integer | Stock location corrected |
| goodsMoved[].productValue.currency | String | Currency of stock cost per item |
| goodsMoved[].productValue.value | Decimal | Value of stock cost per item |
| goodsMoved[].batchGoodsNoteId | Integer | ID of corrected goods note batch |
| goodsMoved[].createdOn | Timestamp | Date correction was made |
| goodsMoved[].createdBy | Integer | ID of staff member who made the correction |
Example 1
Retrieve stock correction 8796 from warehouse 2. This correction added 5 items
to location 2 with a single movement.
Request URI
/warehouse/2/stock-correction/8796 Response
{
"response": [
{
"goodsNoteId": 8796,
"warehouseId": 2,
"reason": "Stock take 2016-9-15",
"goodsMoved": [
{
"productId": 3174,
"quantity": 5,
"destinationLocationId": 2,
"batchGoodsNoteId": 8796,
"productValue": {
"currency": "GBP",
"value": 2.68
},
"createdOn": "2016-09-16T18:16:37.000+01:00",
"createdBy": 863
}
]
}
]
}Example 2
Retrieve stock correction 8801 from warehouse 2. This correction removed 6 items
from location 48 which contained multiple batches so there are 2 movements.
Request URI
/warehouse/2/stock-correction/8801 Response
{
"response": [
{
"goodsNoteId": 8801,
"warehouseId": 12,
"reason": "Damaged",
"goodsMoved": [
{
"productId": 3174,
"quantity": -5,
"destinationLocationId": 48,
"batchGoodsNoteId": 8795,
"productValue": {
"currency": "GBP",
"value": 2.45
},
"createdOn": "2016-09-16T18:23:14.000+01:00",
"createdBy": 6
},
{
"productId": 3174,
"quantity": -1,
"destinationLocationId": 48,
"batchGoodsNoteId": 8797,
"productValue": {
"currency": "GBP",
"value": 2.99
},
"createdOn": "2016-09-16T18:23:14.000+01:00",
"createdBy": 6
}
]
}
]
}