Skip to main content

Notable

union Notable = ASN | InventoryItem | Order | Product

Possible types​

Notable.ASN object shipments​

Notable.InventoryItem object inventory​

Represents an inventory item that tracks stock quantities and locations for a specific product within a brand's warehouses.

Inventory Calculations​

The inventory system uses a hierarchical structure where:

  • **Physical** = Total units present in the building
  • **Available** = Physical - Reserved (units available for sale)
  • **Stock** = Physical - Unavailable (usable inventory)
  • **Allocated** = Units assigned to specific orders

Warehouse Filtering​

Most quantity fields accept an optional warehouse_id argument to get inventory levels for a specific warehouse. When omitted, returns totals across all active warehouses.

Depth Status​

The depth field indicates stock availability:

  • FULL_STOCK: Available inventory exceeds ordered quantities
  • OUT_OF_STOCK: No available inventory
  • OVERSOLD: Ordered quantities exceed available inventory

Incoming Items​

The incoming_items field shows Shipment items that haven't been closed yet, ordered by expected arrival date (earliest first).

Notable.Order object orders​

The order type. This type represents an order in the system.

Notable.Product object products​

Represents a product in the catalog, including its specifications, pricing, inventory, supplier relationships, and composition details. Products can be base items, kits, components, or non-inventory items.

Member Of​

Note object