Inventory Items

List inventory items

List inventory items for the authenticated organization and live mode, optionally filtered by warehouse_id/variant_id, cursor-paginated.

get/v1/inventory_items

Request

Base URL
https://inventories-api.paymongo.com
URL
https://inventories-api.paymongo.com/v1/inventory_items
Auth
HTTP basic

Query parameters

warehouse_idstring

Filter by warehouse id

variant_idstring

Filter by variant id

beforestring

Cursor: return results before this item id

afterstring

Cursor: return results after this item id

limitinteger

Maximum number of results (>= 1)

Response

has_moreboolean

Example response

{
  "data": [
    {
      "available": 90,
      "created_at": 1752000000,
      "held": 10,
      "id": "invitem_abc123",
      "livemode": true,
      "low_stock_threshold": 5,
      "on_hand": 100,
      "updated_at": 1752000000,
      "variant_id": "prdvar_abc123",
      "warehouse_id": "ww_abc123"
    }
  ]
}

Changes

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