Skip to main content

Get Inventory Change Summary

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

Aggregate the ledger over exactly the rows the list endpoint would return: how many changes were observed, how many went each way, and the net and gross unit swing.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Veracore publishes no movement feed, so each row is the difference between two consecutive snapshots — an observation, never a warehouse transaction. Treat these as observed changes, not as inventory movements, and do not reconcile them against a movement ledger.

Same filters as the list endpoint — this endpoint accepts the identical filter[...] query parameters as Get Inventory Changes and aggregates over the identical filtered set, so a summary and a page of rows fetched with the same query string always describe the same data. sort, page and per_page are ignored. Narrow the window with a changed_at filter rather than a separate window parameter.

First observations are out of scope by default. A row whose source is initial is an opening balance — Veracore reported a quantity for an offer that had never been seen before, so there was no earlier snapshot to diff against. Counting it as a receipt would report an entire catalogue as having been received the instant it was first synced. changes, increases, decreases, net_delta, units_in and units_out therefore cover only snapshot and absent rows, and those rows are the only ones in scope at all unless filter[source_scope] says otherwise — so on the default view baseline is zero and observations equals changes. Send filter[source_scope]=all (or =initial) to bring the opening balances into scope, where they are reported separately under baseline and still kept out of every movement figure.

Response fields

  • changes — observations that represent real movement (excludes initial)
  • increases / decreases — movement observations by direction
  • net_delta — signed sum of the moved units
  • units_in / units_out — gross units gained and lost, both positive
  • observations — every row in scope, including first observations when filter[source_scope] brings them in; matches the list endpoint's total
  • baseline.observations / baseline.units — the first observations and the units they opened with
  • by_source — row count keyed by source
  • range.from / range.to — the observed span of the rows in scope, or null when nothing matches

Authentication: Requires Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type