Inventory

List inventory items

Cursor-paginated, scoped to the token's account and role.

Besides the filter[<field>_<predicate>] fields, these filters take a plain value:

  • filter[low_stock] — true: only items at or below their warehouse reorder point.
get/v1/inventory_items

Request

  • Base URL: https://api.topkey.io
  • URL: https://api.topkey.io/v1/inventory_items
  • Auth: HTTP bearer

Query parameters

page[size]integer

Rows per page (max 100).

page[after]string

Opaque cursor from the previous page's meta.next_cursor.

low_stockstring

true: only items at or below their warehouse reorder point.

filter[field_predicate]=value (Ransack, per-resource allowlist), and the plain-value filters listed. Unknown filters return 400. Filterable fields: category, created_at, external_id, id, integration_key, inventory_category_id, name, sku, status, track_as_asset, updated_at.

Comma-separated relationships to sideload into included.

Response

A page of inventory.

Changes

No recorded changes to this operation across all 1 revision of this API.