Sumtracker
Sumtracker Public API v2025-11
Sumtracker Public API v2025-11

Schemas

Download schema

PaginatedStockLevelBundleList

​StockLevelBundle[] · required
next
​string | null · uri
previous
​string | null · uri

PaginatedStockLevelList

​StockLevel[] · required
next
​string | null · uri
previous
​string | null · uri

Product

Product object.
id
​integer · readOnly · required
created
​string · date-time · readOnly · required
updated
​string · date-time · readOnly · required
name
​string · maxLength: 200 · readOnly · required
sku
​string · maxLength: 200 · readOnly · required
variant_name
​string · maxLength: 200 · readOnly · required
barcode
​string · maxLength: 200 · readOnly · required
categories
​array | null · readOnly · required
​readOnly · required
notes
​string · maxLength: 500 · readOnly · required
bundle_type
​string · maxLength: 20 · readOnly · required
wavg_landed_cost
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
uom
​string · maxLength: 10 · readOnly · required

StockLevel

The stock of a product at a warehouse.
id
​integer · readOnly · required
updated
​string · date-time · readOnly · required
product_id
​integer · readOnly · required
​object · readOnly · required

Product object.

warehouse_id
​integer · readOnly · required
in_stock
​integer · min: -2147483648 · max: 2147483647 · readOnly · required
incoming
​integer · min: -2147483648 · max: 2147483647 · readOnly · required
available
​integer · readOnly · required
booked
​integer · min: -2147483648 · max: 2147483647 · readOnly · required
close_at_quantity
​integer | null · min: -2147483648 · max: 2147483647 · readOnly · required

StockLevelBundle

The stock level of a bundle, with the stock levels of its components.
id
​integer · readOnly · required
product_id
​integer · readOnly · required
​object · readOnly · required

Product object.

warehouse_id
​integer · readOnly · required
in_stock
​integer · readOnly · required
booked
​integer · min: -2147483648 · max: 2147483647 · readOnly · required
available
​integer · readOnly · required
​_Component[] · readOnly · required

_Component

The stock level of a component of a bundle, with the quantity of the component in the bundle and the number of bundles its stock makes.
id
​integer · readOnly · required
​object · readOnly · required

Product object.

product_id
​integer · readOnly · required
warehouse_id
​integer · readOnly · required
in_stock
​integer · min: -2147483648 · max: 2147483647 · readOnly · required
booked
​integer · min: -2147483648 · max: 2147483647 · readOnly · required
available
​integer · readOnly · required
component_quantity
​integer · readOnly · required
possible_bundles
​integer · readOnly · required
close_at_quantity
​integer | null · min: -2147483648 · max: 2147483647 · readOnly · required