Sumtracker Public API v2025-11

Stock

Download schema

Stock API.

deprecated

List Stock Levels

GET

https://inventory-api.sumtracker.com/api/version/2025-11

/stock/levels/

Authorization (header)

List all non-bundle stock levels for given warehouse. Stock levels have inventory information for a product at particular warehouse. This API does not include bundle stock levels.

in_stock is the current stock.
booked is the stock which is reserved for unfulfilled orders.
available is the current stock minus the booked stock.
incoming is the stock which is pending to be received from purchase orders or stock transfers.

Raises

ValidationError if either the warehouse or product is not provided.

List Stock Levels › query Parameters

available_max

string

available_min

string

booked_max

integer · min: -2147483648 · max: 2147483647

booked_min

integer · min: -2147483648 · max: 2147483647

cursor

string

The pagination cursor value.

in_stock_max

integer · min: -2147483648 · max: 2147483647

in_stock_min

integer · min: -2147483648 · max: 2147483647

incoming_max

integer · min: -2147483648 · max: 2147483647

incoming_min

integer · min: -2147483648 · max: 2147483647

is_below_threshold

boolean

Available + incoming stock is less than min level.

limit

integer

Number of results to return per page.

o

string[] · style: form

Ordering

product_id - Product id
-product_id - Product id (descending)
warehouse_id - Warehouse id
-warehouse_id - Warehouse id (descending)
in_stock - In stock
-in_stock - In stock (descending)
booked - Booked
-booked - Booked (descending)
incoming - Incoming
-incoming - Incoming (descending)
available - Available
-available - Available (descending)

Enum values:

-available

-booked

-in_stock

-incoming

-product_id

-warehouse_id

available

booked

product

number

Product id. Either product or warehouse is required.

products

integer[] · style: form

Product ids separated by comma

warehouse

number

Warehouse id. Either warehouse or product is required.

List Stock Levels › Responses

200

PaginatedStockLevelList

StockLevel[] · required

next

string | null · uri

previous

string | null · uri

GET/stock/levels/

curl https://inventory-api.sumtracker.com/api/version/2025-11/stock/levels \
  --header 'Authorization: <api-key>'

Example Responses

{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "id": 0,
      "updated": "2024-08-25T15:00:00Z",
      "product_id": 0,
      "product": {
        "id": 0,
        "created": "2024-08-25T15:00:00Z",
        "updated": "2024-08-25T15:00:00Z",
        "name": "name",
        "sku": "sku",
        "variant_name": "variant_name",
        "barcode": "barcode",
        "categories": [
          "string"
        ],
        "image_url": "https://www.example.com/path/to/resource",
        "notes": "notes",
        "bundle_type": "bundle_type",
        "wavg_landed_cost": "wavg_landed_cost",
        "uom": "uom"
      },
      "warehouse_id": 0,
      "in_stock": 0,
      "incoming": 0,
      "available": 0,
      "booked": 0,
      "close_at_quantity": 0
    }
  ]
}

json

application/json

deprecated

List Bundle Stock Levels

GET

https://inventory-api.sumtracker.com/api/version/2025-11

/stock/levels/bundles/

Authorization (header)

List all bundle stock levels. Each bundle product has a list of component stock levels.

How is bundle available stock calculated?

The available stock of a bundle is based on the lowest available stock of its components. Each component in the bundle has a component_quantity which represents how many components are needed to make 1 bundle product. Based on the available stock of component divided by the component_quantity we can calculate the available stock of the bundle.

Raises

ValidationError if warehouse not provided.

List Bundle Stock Levels › query Parameters

cursor

string

The pagination cursor value.

limit

integer

Number of results to return per page.

o

string[] · style: form

Ordering

product_id - Product id
-product_id - Product id (descending)
warehouse_id - Warehouse id
-warehouse_id - Warehouse id (descending)

Enum values:

-product_id

-warehouse_id

product_id

warehouse_id

product

number

Product id

products

integer[] · style: form

Product ids separated by comma

warehouse

number

Warehouse id. warehouse is required.

List Bundle Stock Levels › Responses

200

PaginatedStockLevelBundleList

StockLevelBundle[] · required

next

string | null · uri

previous

string | null · uri

GET/stock/levels/bundles/

curl https://inventory-api.sumtracker.com/api/version/2025-11/stock/levels/bundles \
  --header 'Authorization: <api-key>'

Example Responses

{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "id": 0,
      "product_id": 0,
      "product": {
        "id": 0,
        "created": "2024-08-25T15:00:00Z",
        "updated": "2024-08-25T15:00:00Z",
        "name": "name",
        "sku": "sku",
        "variant_name": "variant_name",
        "barcode": "barcode",
        "categories": [
          "string"
        ],
        "image_url": "https://www.example.com/path/to/resource",
        "notes": "notes",
        "bundle_type": "bundle_type",
        "wavg_landed_cost": "wavg_landed_cost",
        "uom": "uom"
      },
      "warehouse_id": 0,
      "in_stock": 0,
      "booked": 0,
      "available": 0,
      "components": [
        {
          "id": 0,
          "product": {
            "id": 0,
            "created": "2024-08-25T15:00:00Z",
            "updated": "2024-08-25T15:00:00Z",
            "name": "name",
            "sku": "sku",
            "variant_name": "variant_name",
            "barcode": "barcode",
            "categories": [
              "string"
            ],
            "image_url": "https://www.example.com/path/to/resource",
            "notes": "notes",
            "bundle_type": "bundle_type",
            "wavg_landed_cost": "wavg_landed_cost",
            "uom": "uom"
          },
          "product_id": 0,
          "warehouse_id": 0,
          "in_stock": 0,
          "booked": 0,
          "available": 0,
          "component_quantity": 0,
          "possible_bundles": 0,
          "close_at_quantity": 0
        }
      ]
    }
  ]
}

json

application/json