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 Inventories

||View as Markdown|
GET
https://sandbox-api.shipbob.com/Experimental/inventory
GET
/Experimental/inventory
$curl -G https://sandbox-api.shipbob.com/Experimental/inventory \
>     -H "Authorization: Bearer <token>" \
>     -d SearchBy=string \
>     -d "FilterOperations[key]=string" \
>     -d "FilterOperations[rawValue]=string" \
>     -d InventoryIds=0 \
>     -d IsActive=true \
>     -d IsDigital=true \
>     -d SortBy=string
1{
2  "first": "string",
3  "items": [
4    {
5      "barcode": "string",
6      "dimensions": {
7        "height": 0.1,
8        "is_locked": true,
9        "length": 0.1,
10        "unit": "string",
11        "validated": true,
12        "width": 0.1
13      },
14      "inventory_id": 0,
15      "is_case": true,
16      "is_lot": true,
17      "name": "string",
18      "sku": "string",
19      "user_id": 0,
20      "variant": {
21        "hazmat": {
22          "is_hazmat": true,
23          "validated": true
24        },
25        "is_active": true,
26        "is_bundle": true,
27        "is_digital": true
28      },
29      "weight": {
30        "unit": "string",
31        "value": 0.1
32      }
33    }
34  ],
35  "last": "string",
36  "next": "string",
37  "prev": "string"
38}
Retrieves a paginated list of all inventory items. Supports filtering by active status, tags, and various product attributes. Use query parameters to search and filter results.
Was this page helpful?
Previous

Get Inventory

Next

Get All Inventory Levels

Built with

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Query parameters

SearchBystringOptional

Search is available for 3 fields: Inventory ID, Name, and SKU. Expected behavior for search by Inventory ID is exact match. Expected behavior for search by Inventory Name or SKU is partial match (consecutive characters, case insensitive).

FilterOperationslist of objectsOptional

Advanced filtering operations. Apply multiple key-value filters to refine inventory results. Each filter operation contains a ‘key’ (field name) and ‘rawValue’ (filter value) to match.

InventoryIdslist of integersOptional

Comma-separated list of inventory IDs to filter results. Use this to retrieve information for specific inventory items only.

IsActivebooleanOptional
Filter by active status. True returns only active inventory items, False returns only inactive items. Omit to return both.
IsDigitalbooleanOptional

Filter by digital product status. True returns only digital products (no physical fulfillment), False returns only physical products. Omit to return both.

PageSizeintegerOptional
Number of items to return per page. Controls pagination size for the response.
SortBystringOptional

Sort results by field name. Default is ascending order. Prefix with ’-’ for descending order (e.g., ‘-name’ sorts by name descending). Multiple fields can be comma-separated.

Response

OK
firststring
URL to retrieve the first page of results. Null if already on the first page.
itemslist of objects
Array of inventory items in the current page of results.
laststring
URL to retrieve the last page of results. Null if already on the last page.
nextstring
URL to retrieve the next page of results. Null if on the last page.
prevstring
URL to retrieve the previous page of results. Null if on the first page.

Errors

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