For clean Markdown of any page, append .md to the page URL. For a complete documentation index, see https://developer-dev.shipbob.dev/experimental/api/inventory/llms.txt. For full documentation content, see https://developer-dev.shipbob.dev/experimental/api/inventory/llms-full.txt.

#     Get Inventory Levels


GET https://gateway-dev.shipbob.dev/Experimental/inventory-level/{inventoryId}

    Retrieves the aggregated inventory levels for a specific inventory item across all locations, including available, on-hand, committed, and other quantity types.


Reference: https://developer-dev.shipbob.dev/api/inventory/get-inventory-levels

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: api-experimental
  version: 1.0.0
paths:
  /Experimental/inventory-level/{inventoryId}:
    get:
      operationId: get-inventory-levels
      summary: |2
            Get Inventory Levels
      description: |2
            Retrieves the aggregated inventory levels for a specific inventory item across all locations, including available, on-hand, committed, and other quantity types.
      tags:
        - subpackage_inventory
      parameters:
        - name: inventoryId
          in: path
          description: ''
          required: true
          schema:
            type: string
            format: int32
        - name: Authorization
          in: header
          description: Authentication using Personal Access Token (PAT) token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Inventory.InventoryQuantityV4Response'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Inventory.ProblemDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Inventory.ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Inventory.ProblemDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Inventory.ProblemDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                description: Any type
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                description: Any type
servers:
  - url: https://gateway-dev.shipbob.dev
components:
  schemas:
    Inventory.InventoryQuantityV4Response:
      type: object
      properties:
        inventory_id:
          type: integer
          description: Unique identifier for the inventory item
        name:
          type:
            - string
            - 'null'
          description: Name of the inventory item
        sku:
          type:
            - string
            - 'null'
          description: Stock keeping unit identifier
        total_awaiting_quantity:
          type: integer
          description: Total quantity expected to arrive from receiving or transfers
        total_backordered_quantity:
          type: integer
          description: Total quantity on backorder for pending shipments
        total_committed_quantity:
          type: integer
          description: Total quantity reserved for existing orders and allocations
        total_damaged_quantity:
          type: integer
          description: Total quantity currently marked as damaged
        total_exception_quantity:
          type: integer
          description: >-
            Total quantity in exception status (damaged, lost, or under
            investigation)
        total_fulfillable_quantity:
          type: integer
          description: >-
            Total quantity available to fulfill new orders (on-hand minus
            committed)
        total_in_fulfillment_quantity:
          type: integer
          description: >-
            Total quantity of inventory items that are currently in the
            fulfillment process
        total_internal_transfer_quantity:
          type: integer
          description: Total quantity currently in transit between fulfillment centers
        total_on_hand_quantity:
          type: integer
          description: Total quantity physically present in all fulfillment centers
        total_quarantine_quantity:
          type: integer
          description: Total quantity currently in quarantine status
        total_sellable_quantity:
          type: integer
          description: >-
            Total quantity available for sale (fulfillable plus awaiting minus
            quarantine minus damaged)
        userId:
          type: integer
      title: Inventory.InventoryQuantityV4Response
    Inventory.ProblemDetails:
      type: object
      properties:
        detail:
          type:
            - string
            - 'null'
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
        instance:
          type:
            - string
            - 'null'
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem. It may or may not yield further information if
            dereferenced.
        status:
          type:
            - integer
            - 'null'
          description: The HTTP status code for this occurrence of the problem.
        title:
          type:
            - string
            - 'null'
          description: A short, human-readable summary of the problem type.
        type:
          type:
            - string
            - 'null'
          description: >-
            A URI reference that identifies the problem type. This URI should
            provide human-readable documentation for the problem.
      title: Inventory.ProblemDetails
  securitySchemes:
    PAT:
      type: http
      scheme: bearer
      description: Authentication using Personal Access Token (PAT) token
    OAuth2:
      type: http
      scheme: bearer
      description: OAuth2 authentication using JWT tokens

```

## SDK Code Examples

```python Inventory_getInventoryLevels_example
import requests

url = "https://gateway-dev.shipbob.dev/Experimental/inventory-level/inventoryId"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Inventory_getInventoryLevels_example
const url = 'https://gateway-dev.shipbob.dev/Experimental/inventory-level/inventoryId';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Inventory_getInventoryLevels_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://gateway-dev.shipbob.dev/Experimental/inventory-level/inventoryId"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Inventory_getInventoryLevels_example
require 'uri'
require 'net/http'

url = URI("https://gateway-dev.shipbob.dev/Experimental/inventory-level/inventoryId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Inventory_getInventoryLevels_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://gateway-dev.shipbob.dev/Experimental/inventory-level/inventoryId")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Inventory_getInventoryLevels_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://gateway-dev.shipbob.dev/Experimental/inventory-level/inventoryId', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Inventory_getInventoryLevels_example
using RestSharp;

var client = new RestClient("https://gateway-dev.shipbob.dev/Experimental/inventory-level/inventoryId");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Inventory_getInventoryLevels_example
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://gateway-dev.shipbob.dev/Experimental/inventory-level/inventoryId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```