For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DocumentationAPI Reference
DocumentationAPI Reference
  • API Reference
      • GET Get Inventory
      • GET Get All Inventories
      • GET Get All Inventory Levels
      • GET Get Inventory Levels Grouped By Fulfillment Center
      • GET Get All Inventory Levels Grouped By Fulfillment Center
      • GET Get All Inventory Levels Grouped By Lot
      • GET Get Inventory Levels
      • GET Get Inventory Levels Grouped By Lot
      • GET Get Lot Exclusions
      • POST Create Lot Exclusion
      • POST Delete Lot Exclusion
      • POST Restore Lot Exclusion
LogoLogo
API ReferenceInventory

Get All Inventory Levels Grouped By Lot

||View as Markdown|
GET
https://sandbox-api.shipbob.com/Experimental/inventory-level/lots
GET
/Experimental/inventory-level/lots
$curl -G https://sandbox-api.shipbob.com/Experimental/inventory-level/lots \
>     -H "Authorization: Bearer <token>" \
>     -d SearchBy=string \
>     -d InventoryIds=0 \
>     -d IsActive=true \
>     -d IsDigital=true \
>     -d SortBy=string
1{
2  "first": "string",
3  "items": [
4    {
5      "inventory_id": 0,
6      "lots": [
7        {
8          "awaiting_quantity": 0,
9          "committed_quantity": 0,
10          "damaged_quantity": 0,
11          "exception_quantity": 0,
12          "fulfillable_quantity": 0,
13          "in_fulfillment_quantity": 0,
14          "internal_transfer_quantity": 0,
15          "locations": [
16            {
17              "awaiting_quantity": 0,
18              "committed_quantity": 0,
19              "damaged_quantity": 0,
20              "exception_quantity": 0,
21              "fulfillable_quantity": 0,
22              "in_fulfillment_quantity": 0,
23              "internal_transfer_quantity": 0,
24              "location_id": 0,
25              "name": "string",
26              "on_hand_quantity": 0,
27              "quarantine_quantity": 0,
28              "userId": 0
29            }
30          ],
31          "lot_date": "2019-08-24T14:15:22+00:00",
32          "lot_number": "string",
33          "on_hand_quantity": 0,
34          "quarantine_quantity": 0,
35          "userId": 0
36        }
37      ],
38      "name": "string",
39      "sku": "string",
40      "userId": 0
41    }
42  ],
43  "last": "string",
44  "next": "string",
45  "prev": "string"
46}
Retrieves inventory levels for all inventory items grouped by lot number. Enables tracking of inventory across multiple lots, including expiration dates and manufacturing batch information.
Was this page helpful?
Previous

Get All Inventory Levels Grouped By Fulfillment Center

Next

Get Inventory Levels

Built with

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Query parameters

LocationIdintegerOptional
SearchBystringOptional
InventoryIdslist of integersOptional
IsActivebooleanOptional
IsDigitalbooleanOptional
PageSizeintegerOptional
SortBystringOptional

Response

OK
firststring
itemslist of objects
laststring
nextstring
prevstring

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error
503
Service Unavailable Error