List inventory levels for a product

Retrieve inventory levels for a specific product with pagination and filtering options

Path Parameters

productIdRequiredstring

The ID of the product

Format: "uuid"

Query Parameters

limitinteger

Maximum number of items to return

Default: 10Minimum: 1Maximum: 100

pageinteger

Page number for pagination

Default: 1Minimum: 1

searchstring

Search term to filter inventory levels

cursorstring

Cursor for pagination

sortBystring

Field to sort by

sortOrderstring

Sort order (ascending or descending)

Default: "asc"Value in: "asc" | "desc"

warehouseIdstring

Filter by warehouse ID

Format: "uuid"

childInventoryboolean

Include child inventory levels

Default: false

curl -X GET "https://www.shipsidekick.com/api/v1/products/497f6eca-6276-4993-bfeb-53cbbbba6f08/inventory-level?limit=10&page=1&search=string&cursor=string&sortBy=string&sortOrder=asc&warehouseId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Successful response

{
  "object": "list",
  "data": [
    {
      "id": "cmea9mpv7002bmktvm9plplez",
      "organizationId": "cmea9fzxt00ccmkmpkwzwsata",
      "incomingQuantity": 0,
      "availableQuantity": 96,
      "committedQuantity": 4,
      "reservedQuantity": 0,
      "damagedQuantity": 0,
      "safetyStockQuantity": 0,
      "qualityControlQuantity": 0,
      "organization": null,
      "productVariant": {
        "id": "cmea9mki30015mktvhpdebfta",
        "organizationId": "cmea9fzxt00ccmkmpkwzwsata",
        "productId": "cmea9mgq30003mktv3nu37xp6",
        "title": "White T-Shirt",
        "sku": "WHITETEE",
        "skuAliases": [],
        "product": {
          "id": "cmea9mgq30003mktv3nu37xp6",
          "name": "White T-Shirt",
          "slug": "white-t-shirt"
        }
      },
      "warehouse": {
        "id": "cmea9fzvv00b4mkmp9ktawc7e",
        "name": "Main Warehouse",
        "address": {
          "street1": "9911 W Broadview Drive",
          "city": "Bay Harbor Islands",
          "state": "FL",
          "country": "US"
        }
      },
      "serviceObjects": []
    }
  ],
  "hasMore": false,
  "totalCount": 1,
  "limit": 10
}

List inventory levels for a product

Path Parameters

Query Parameters

Response

TypeScript