Skip to main content

Notable

union Notable = ASN | InventoryItem | Order | Product | PurchaseOrder

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.

Notable.PurchaseOrder object purchase-orders​

Represents a purchase order in the supply chain module.

Purchase orders are formal documents sent to suppliers to request materials, products, or services. They contain details about quantities, prices, delivery dates, and terms of the purchase agreement.

Core Information​

  • **PO Number**: Unique identifier for the purchase order
  • **Status Management**: Tracks financial status and cost allocation status
  • **Dates**: Issue date, expected dates, delivery dates, and payment due dates
  • **Terms**: Payment terms, Incoterms, and special instructions

Relationships​

Each purchase order is associated with a supplier, created by a party, and can be approved by another party. It contains multiple line items (POItems).

Status Tracking​

  • **Financial Status**: Tracks payment status (unpaid, partially paid, paid)
  • **Cost Allocation Status**: Tracks if costs are complete or incomplete
  • **Milestones**: Current milestone and status name for workflow tracking

Member Of​

Note object