916e669fc527
Get a list of stock movements
Retrieves a paged collection of stock movements (required scope stock:read)
Query parameters
Only return resources where id matches the value(s) provided (Max items: 50)
Only return resources where jobId matches the value(s) provided (Max items: 50)
Only return stock movement where pickupAt is the same or newer than this UTC value
Only return stock movement where pickupAt is the same or older than this UTC value
Only return resources where 'dropOffDate' is greater than or equal to the UTC value provided
Only return resources where 'dropOffDate' is lesser than or equal to the UTC value provided
Only return resources where stockDetailsId matches the value(s) provided (Max items: 50)
Only return resources where stockItemId matches the value(s) provided (Max items: 50)
Only return resources where vehicleId matches the value(s) provided (Max items: 50)
Only return records where 'dropOffContactId' matches the value(s) provided (Max items: 50)
Only return records where 'dropOffVehicleId' matches the value(s) provided (Max items: 50)
The page number being requested (minimum: 1, maximum: 2147483)
The page size being requested (minimum: 1, maximum: 1000)
Headers
The customer identifier
Response
OK
Example response
{
"items": [
{
"id": 123456,
"stockDetailsId": 876,
"stockItemId": 384,
"jobId": 559,
"pickupAt": "2022-11-29T16:50:16.0000000+00:00",
"dropOffAt": "2022-11-29T16:50:16.0000000+00:00",
"isDropOffForSell": true,
"pickupPosition": {
"latitude": 51.31349,
"longitude": -0.7464233
},
"dropOffPosition": {
"latitude": 51.31349,
"longitude": -0.7464233
},
"pickupVehicleId": 123,
"vehicleId": 123,
"dropOffVehicleId": 123,
"dropOffStockItemId": 123,
"pickupStockItemId": 123,
"isEquipmentAtPickup": true,
"isEquipmentAtDropOff": true,
"ownerId": 74837,
"ownerName": "John Doe",
"invoiceId": 50012345,
"pickupContactId": 50012345,
"dropOffContactId": 50012345,
"pickUpQuantity": 12.3,
"dropOffQuantity": 13.14
}
],
"pageNumber": 2,
"pageSize": 100,
"pageItemCount": 55
}