Queries

Stock levels are the current inventory quantities and valuations of each variant per location.

Available queries

`StockLevels` - Returns a list of stock levels based on the filter define

query {
  StockLevels {
    data {
      id
      location {
        id
        label
      }
      variant {
        id
        label
        sku
      }
      on_hand
      available
      incoming
      reserved
      reorder_point
      bin_location
      to_reorder
      last_sold_date
    }
  }
}

Available fields

StockLevel data type

id Int
Id of the stock level

variant Variant
Variant concerned

location Location
Location

on_hand Float
On hand quantity

available Float
Available quantity

incoming Float
Incoming quantity

reserved Float
Reserved quantity

reorder_point Float
Re-order point

bin location String
Bin location

to_reorder Float
Quantity to re-order

last_sold_date String
Date of the last variant sold for the location

on_hand_aggregate Float
Aggregated on hand quantity across the selected stock levels

available_aggregate Float
Aggregated available quantity across the selected stock levels

incoming_aggregate Float
Aggregated incoming quantity across the selected stock levels

reserved_aggregate Float
Aggregated reserved quantity across the selected stock levels

valuation ValuationHistory
Valuation history of the stock level

Filters

You can create filters based on following fields

id
Example: {"column": "ID", "operator": "EQ", "value": 200050}

on_hand
Example: {"column": "ON_HAND", "operator": "EQ", "value": 10}

available
Example: {"column": "AVAILABLE", "operator": "EQ", "value": 8}

incoming
Example: {"column": "INCOMING", "operator": "EQ", "value": 2}

bin_location
Example: {"column": "BIN_LOCATION", "operator": "EQ", "value": "A1"}

reorder_point
Example: {"column": "REORDER_POINT", "operator": "EQ", "value": 5}

reserved
Example: {"column": "RESERVED", "operator": "EQ", "value": 1}

to_reorder
Example: {"column": "TO_REORDER", "operator": "EQ", "value": 2}

last_sold_date
Example: {"column": "LAST_SOLD_DATE", "operator": "EQ", "value": "2023-03-03"}

location_id
Example: {"column": "LOCATION_ID", "operator": "EQ", "value": 100001}

location_active
Example: {"column": "LOCATION_ACTIVE", "operator": "EQ", "value": true}

location_deleted_at
Example: {"column": "LOCATION_DELETED_AT", "operator": "EQ", "value": null}

variant_id
Example: {"column": "VARIANT_ID", "operator": "EQ", "value": 100012}

variant_label
Example: {"column": "VARIANT_LABEL", "operator": "LIKE", "value": "%Jacket%"}

variant_sku
Example: {"column": "VARIANT_SKU", "operator": "EQ", "value": "135267U23"}

variant_active
Example: {"column": "VARIANT_ACTIVE", "operator": "EQ", "value": true}

variant_type
Example: {"column": "VARIANT_TYPE", "operator": "EQ", "value": "standard"}

supplier_id
Example: {"column": "SUPPLIER_ID", "operator": "EQ", "value": 300001}

Sorting

You can sort data based on following fields: id, on_hand, available, incoming, reorder_point, bin_location, to_reorder, reserved, last_sold_date, location_id, location_label, variant_id, variant_sku, variant_label, variant_active

InventoryLog data type

id Int
Unique identifier of the inventory log

location Location
Location concerned by the inventory log

line_item LineItem
Line item that triggered the inventory log

sku String
SKU of the variant concerned

arguments String
Arguments of the inventory log operation

variant Variant
Variant concerned

user User
User who performed the inventory log operation

on_hand Float
On hand quantity after the operation

available Float
Available quantity after the operation

incoming Float
Incoming quantity after the operation

on_hand_diff Float
Difference of on hand quantity

available_diff Float
Difference of available quantity

incoming_diff Float
Difference of incoming quantity

cost Float
Unit cost of the variant at the time of the operation

valuation Float
Valuation difference of the operation

type String
Type of the inventory log operation (sale, purchase, adjustment, ...)

created_at DateTime
Date of the inventory log

dated_at String
Business date of the inventory log

source String
Source of the inventory log (document, stock adjustment, ...)

context String
Context of the operation (linked document, order type, ...)

variant_sku String
SKU of the variant

variant_label String
Label of the variant

variant_type String
Type of the variant

batch_number_id Int
ID of the batch number, if applicable

batch_number_label String
Label of the batch number, if applicable

has_batch_numbers Boolean
If true, the variant uses batch numbers

batch_number_inventory_logs Array of BatchNumberInventoryLog
Batch number inventory logs linked to this inventory log