Sumtracker Public API v2025-03

Stock

Download schema

Stock API.

List Stock Levels

GET

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

/stock/levels/

Authorization (header)

⚠️ DEPRECATED: This API version will be deprecated on 24th November 2025 00:00 UTC. Please migrate to API version 2025-11 which uses cursor pagination for better performance.

List all non-bundle stock levels. 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.

Migration Guide: Use /public-apis/2025-11/stock/stocklevels/ for improved cursor pagination.

List Stock Levels › query Parameters

available_max

integer

available_min

integer

booked_max

integer · min: -2147483648 · max: 2147483647

booked_min

integer · min: -2147483648 · max: 2147483647

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

id - Id
-id - Id (descending)
product_id - Product id
-product_id - Product id (descending)
warehouse_id - Warehouse id
-warehouse_id - Warehouse id (descending)
product__sku - Product sku
-product__sku - Product sku (descending)
product__name - Product name
-product__name - Product name (descending)
product__variant_name - Product variant name
-product__variant_name - Product variant name (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

-id

-in_stock

-incoming

-product__name

-product__sku

-product__variant_name

offset

integer

The initial index from which to return the results.

ordering

string

Which field to use when ordering the results.

product

number

Product id

product_barcode

string

Product barcode. Case sensitive.

product_categories

string[] · style: form

Product category names separated by comma. A product type name also matches. Case insensitive.

product_name

string

Product name. Case insensitive.

product_sku

string

Product SKU. Case insensitive.

product_tags

string[] · style: form

Multiple values may be separated by commas.

product_variant_name

string

Product variant name. Case insensitive.

products

integer[] · style: form

Product ids separated by comma

warehouse

number

Warehouse id

List Stock Levels › Responses

200

PaginatedStockLevelList

count

integer · required

StockLevel[] · required

next

string | null · uri

previous

string | null · uri

GET/stock/levels/

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

Example Responses

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "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

List Bundle Stock Levels

GET

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

/stock/levels/bundles/

Authorization (header)

⚠️ DEPRECATED: This API version will be deprecated on 24th November 2025 00:00 UTC. Please migrate to API version 2025-11 which uses cursor pagination for better performance.

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.

Migration Guide: Use /public-apis/2025-11/stock/stocklevels/bundles/ for improved cursor pagination.

List Bundle Stock Levels › query Parameters

limit

integer

Number of results to return per page.

o

string[] · style: form

Ordering

id - Id
-id - Id (descending)
product_id - Product id
-product_id - Product id (descending)
warehouse_id - Warehouse id
-warehouse_id - Warehouse id (descending)
product__sku - Product sku
-product__sku - Product sku (descending)
product__name - Product name
-product__name - Product name (descending)
product__variant_name - Product variant name
-product__variant_name - Product variant name (descending)

Enum values:

-id

-product__name

-product__sku

-product__variant_name

-product_id

-warehouse_id

id

product__name

offset

integer

The initial index from which to return the results.

ordering

string

Which field to use when ordering the results.

product

number

Product id

product_barcode

string

Product barcode. Case sensitive.

product_categories

string[] · style: form

Product category names separated by comma. A product type name also matches. Case insensitive.

product_name

string

Product name. Case insensitive.

product_sku

string

Product SKU. Case insensitive.

product_tags

string[] · style: form

Multiple values may be separated by commas.

product_variant_name

string

Product variant name. Case insensitive.

products

integer[] · style: form

Product ids separated by comma

warehouse

number

Warehouse id

List Bundle Stock Levels › Responses

200

PaginatedStockLevelBundleList

count

integer · required

StockLevelBundle[] · required

next

string | null · uri

previous

string | null · uri

GET/stock/levels/bundles/

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

Example Responses

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "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

Stock Adjustment Documents/Lines Products