Back

Search

Search

Methods

Inventory

Orders

Inventory /GetBatchInventoryById

Allows 150 calls per minute

Response: GetBatchInventoryByIdResponse



Retruns batch header and only batch inventory for provided batch

Parameters

NameTypeDescription
requestGetBatchInventoryByIdRequest

Permissions

GlobalPermissions.Inventory.MyInventoryNode

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/Inventory/GetBatchInventoryById

Headers

Connection: keep-alive
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Request Body

This is an example of the request structure. Results will vary depending on your data.

request={
  "BatchInventoryIds": [
    1
  ],
  "LoadRelatedInventoryLines": true
}

Response

This is an example of the response JSON. Results will vary depending on your data.

{
  "Batches": [
    {
      "BatchId": 1,
      "SKU": "sample string 2",
      "InventoryTrackingType": 3,
      "StockItemId": "8799d221-916e-4dc6-8d09-bed3540ee5cc",
      "BatchNumber": "sample string 5",
      "ExpiresOn": "2021-05-05T15:35:26.3165957+01:00",
      "SellBy": "2021-05-05T15:35:26.3165957+01:00",
      "Inventory": [
        {
          "BatchInventoryId": 1,
          "BatchId": 2,
          "StockLocationId": "6c3193dc-f29b-4e31-95a6-d0c22807d4ea",
          "BinRack": "sample string 4",
          "PrioritySequence": 5,
          "Quantity": 6,
          "StockValue": 7.0,
          "StartQuantity": 8,
          "PickedQuantity": 9,
          "BatchStatus": "Available",
          "IsDeleted": true,
          "WarehouseBinrackStandardType": 1,
          "WarehouseBinrackTypeName": "sample string 12",
          "InTransfer": 1,
          "BinRackId": 1,
          "WarehouseBinrackTypeId": 1
        }
      ],
      "IsDeleted": true
    }
  ]
}