List inventory levels

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 organization inventory levels

Default: false

curl -X GET "https://www.shipsidekick.com/api/v1/inventory/levels?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": [],
        "barcode": "",
        "asin": null,
        "ean": null,
        "isbn": null,
        "upc": null,
        "price": 19.99,
        "compareAtPrice": 24.99,
        "wholesalePrice": 4,
        "costPrice": null,
        "currency": "usd",
        "position": 1,
        "taxable": true,
        "discountable": true,
        "requiresShipping": true,
        "inventoryPolicy": "continue",
        "inventoryAllocationStrategy": "FIFO",
        "selectedOptions": [
          {
            "name": "Product Name",
            "value": "White T-Shirt"
          }
        ],
        "weight": 1,
        "weightUnit": "lb",
        "dimensions": {
          "width": 1,
          "height": 1,
          "length": 1
        },
        "dimensionsUnit": "in",
        "tracksInventory": true,
        "tariffCode": null,
        "countryOfOrigin": null,
        "featuredMediaId": null,
        "organization": null,
        "product": {
          "id": "cmea9mgq30003mktv3nu37xp6",
          "organizationId": "cmea9fzxt00ccmkmpkwzwsata",
          "isBundle": false,
          "name": "White T-Shirt",
          "slug": "white-t-shirt",
          "description": "Crafted from soft cotton, our white t-shirt offers a comfortable and relaxed fit.",
          "brand": null,
          "vendor": "Test Vendor",
          "manufacturer": null,
          "eccn": null,
          "featuredMediaId": "cmea9mh580004mktvjczk45fw",
          "organization": null,
          "productVariants": [],
          "serviceObjects": [],
          "media": [],
          "featuredMedia": null
        }
      },
      "warehouse": {
        "id": "cmea9fzvv00b4mkmp9ktawc7e",
        "organizationId": "cmea9fzt3009nmkmpd9z9ktaq",
        "addressId": "cmea9fzvs00b3mkmpiqte374p",
        "name": "Main Warehouse",
        "isThirdParty": false,
        "sharedWithChildren": true,
        "organization": null,
        "address": {
          "id": "cmea9fzvs00b3mkmpiqte374p",
          "organizationId": "cmea9fzt3009nmkmpd9z9ktaq",
          "street1": "333 Bush St.",
          "street2": "",
          "city": "San Francisco",
          "state": "CA",
          "postalCode": "94104",
          "country": "US",
          "latitude": null,
          "longitude": null,
          "isResidential": null,
          "facilityCode": "",
          "isVerified": false,
          "verificationDetails": null
        }
      },
      "serviceObjects": []
    }
  ],
  "hasMore": false,
  "totalCount": 1,
  "limit": 10
}

List inventory levels

Query Parameters

Response

TypeScript