Get All Inventory Levels Grouped By Fulfillment Center

curl https://gateway-dev.shipbob.dev/Experimental/inventory-level/locations \
     -H "Authorization: Bearer <token>"

{
  "first": "string",
  "items": [
    {
      "inventory_id": 0,
      "locations": [
        {
          "awaiting_quantity": 0,
          "committed_quantity": 0,
          "damaged_quantity": 0,
          "exception_quantity": 0,
          "fulfillable_quantity": 0,
          "in_fulfillment_quantity": 0,
          "internal_transfer_quantity": 0,
          "location_id": 0,
          "name": "string",
          "on_hand_quantity": 0,
          "quarantine_quantity": 0,
          "userId": 0
        }
      ],
      "name": "string",
      "sku": "string",
      "userId": 0
    }
  ],
  "last": "string",
  "next": "string",
  "prev": "string"
}

Retrieves inventory levels for all inventory items grouped by fulfillment center location. Supports filtering by location type, location ID, and various product attributes.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Query parameters

LocationTypestringOptional

LocationIdstringOptionalformat: "int32"

SearchBystringOptional

InventoryIdsstringOptional

IsActivebooleanOptional

IsDigitalbooleanOptional

PageSizestringOptionalformat: "int32"

SortBystringOptional

Response

firststring or null

itemslist of objects or null

laststring or null

nextstring or null

prevstring or null

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

503

Service Unavailable Error