Skip to main content

Get Inventory

GET 
/api/veracore/integration-instances/:integration_instance/inventory

Paginated Veracore inventory for an integration instance, one row per offer per facility.

Every balance in this surface is the Veracore available with reserved figure (on hand minus unavailable), exposed as veracore_available. Veracore publishes no raw on-hand number, so nothing here should be presented as "On Hand". The on_hand key is retained only because it is the sort and filter key for the same value.

Search — filter[search] matches item code, title and warehouse name.

Filterable columns

  • Text: veracore_product_id, title, veracore_warehouse_id, veracore_warehouse_name, unit_of_measure
  • Numeric: id, on_hand, available, committed, incoming
  • Checkbox (filter[is_multi_product_offer.is]=1): is_multi_product_offer, is_aggregate_fallback
  • Date/time: last_synced_at, created_at, updated_at
  • Bespoke: filter[sku_warehouse_id] (id or array of ids), filter[mapped] (1 for rows with a linked SKU.io product, 0 for rows without)

Sortable columns — id, veracore_product_id, veracore_warehouse_id, veracore_warehouse_name, title, unit_of_measure, on_hand, available, committed, incoming, last_synced_at, created_at, updated_at. Prefix with - for descending. Defaults to veracore_product_id.

Filters use filter[column.operator]=value; the bare key filter[column]=value is an implicit is.

  • Text operators: contains, does_not_contain, is, is_not, is_one_of, is_not_one_of, starts_with, does_not_start_with, ends_with, does_not_end_with, is_empty, is_not_empty
  • Numeric operators: is, is_not, is_one_of, is_not_one_of, greater_than, less_than, greater_than_or_equal, less_than_or_equal, between, is_empty, is_not_empty
  • Date operators: is, is_not, before, after, on_or_before, on_or_after, between, is_empty, is_not_empty, today, yesterday, tomorrow, past_week, past_month, past_year, next_week, next_month, next_year, days_ago, days_from_now, past_days, next_days

Authentication: Requires Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type