> ## Documentation Index > Fetch the complete documentation index at: https://help.vori.com/llms.txt > Use this file to discover all available pages before exploring further. # List store product inventory > Lists the current on-hand quantity for each store product. Filter by `updated_at` to retrieve only the products counted since a previous request. ## OpenAPI ````yaml /api/openapi.json get /v1/store-product-inventory openapi: 3.0.0 info: title: Vori API description: '' version: 1.0.0 contact: {} servers: - url: https://api.vori.com description: production security: [] tags: [] paths: /v1/store-product-inventory: get: tags: - Inventory summary: List store product inventory description: >- Lists the current on-hand quantity for each store product. Filter by `updated_at` to retrieve only the products counted since a previous request. operationId: listStoreProductInventory parameters: - name: ending_before required: false in: query description: Return records that precede the record with this ID, in list order. schema: type: string pattern: ^[0-9]+$ - name: limit required: false in: query description: Maximum number of records to return. schema: minimum: 1 maximum: 100 default: 20 type: integer - name: starting_after required: false in: query description: Return records that follow the record with this ID, in list order. schema: type: string pattern: ^[0-9]+$ - name: store_department_id required: false in: query style: form explode: true description: >- The department the product belongs to. Repeat to match any of up to 20 values. schema: type: array items: type: string - name: store_id required: false in: query style: form explode: true description: >- The store the product belongs to. Repeat to match any of up to 20 values. schema: type: array items: type: string - name: updated_at required: false in: query schema: type: string format: date-time description: >- When the on-hand quantity was last written. Pair a lower bound with a page size to poll for products counted since the previous request. UTC unless the value carries an offset. - name: updated_at[gt] required: false in: query schema: type: string format: date-time description: >- When the on-hand quantity was last written. Pair a lower bound with a page size to poll for products counted since the previous request. UTC unless the value carries an offset. - name: updated_at[gte] required: false in: query schema: type: string format: date-time description: >- When the on-hand quantity was last written. Pair a lower bound with a page size to poll for products counted since the previous request. UTC unless the value carries an offset. - name: updated_at[lt] required: false in: query schema: type: string format: date-time description: >- When the on-hand quantity was last written. Pair a lower bound with a page size to poll for products counted since the previous request. UTC unless the value carries an offset. - name: updated_at[lte] required: false in: query schema: type: string format: date-time description: >- When the on-hand quantity was last written. Pair a lower bound with a page size to poll for products counted since the previous request. UTC unless the value carries an offset. responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/StoreProductInventoryList' '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/ConflictingListParametersError' - $ref: '#/components/schemas/InvalidListCursorError' '403': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/InsufficientPermissionsError' - $ref: '#/components/schemas/NoBannerAssociationError' security: - bearer: [] components: schemas: StoreProductInventoryList: type: object properties: data: type: array items: $ref: '#/components/schemas/StoreProductInventory' has_more: type: boolean description: Whether more records follow this page. description: A page of store product inventory. required: - data - has_more ConflictingListParametersError: type: object properties: error_code: type: string enum: - conflicting_list_parameters required: - error_code InvalidListCursorError: type: object properties: error_code: type: string enum: - invalid_list_cursor required: - error_code InsufficientPermissionsError: type: object properties: error_code: type: string enum: - insufficient_permissions error_details: $ref: '#/components/schemas/InsufficientPermissionsErrorDetails' required: - error_code - error_details NoBannerAssociationError: type: object properties: error_code: type: string enum: - no_banner_association required: - error_code StoreProductInventory: type: object properties: id: type: string description: Store product ID pattern: ^[0-9]+$ barcode: type: string description: Barcode scanned at the register for this product. current: type: string nullable: true description: >- Quantity currently on hand. Goes negative when sales outrun the last count. Null when the product has never been counted. example: '199.99' pattern: ^-?[0-9]+(\.[0-9]+)?$ store_department_id: type: string description: The department the product belongs to. pattern: ^[0-9]+$ store_id: type: string description: The store the product belongs to. pattern: ^[0-9]+$ updated_at: type: string nullable: true description: >- When the on-hand quantity was last written, regardless of the date the change applies to. A count entered today but dated last week carries today. Null when the product has never been counted. format: date-time description: A store product's current on-hand quantity. required: - id - barcode - current - store_department_id - store_id - updated_at InsufficientPermissionsErrorDetails: type: object properties: action: allOf: - $ref: '#/components/schemas/Action' resource: allOf: - $ref: '#/components/schemas/Resource' required: - action - resource Action: type: string enum: - '*' - cancel - check_in - create - delete - read - record_events - refund - restart - update - void Resource: type: string enum: - '*' - accounting_integration - agent_chats - api_clients - asynchronous_tasks - banners - blackhawk_transactions - capabilities - coupons - custom_quick_actions - datacap_transactions - departments - discounts - ditto_auth_tokens - edge_agents - electronic_shelf_labels - employees - files - food_modifiers - gift_cards - gl_code_mappings - house_accounts - inventory - inventory_sessions - invoices - item_modifiers - label_dimension_sets - label_sheet_profiles - label_stock_products - lanes - loyalty_bonuses - loyalty_campaigns - loyalty_rewards - notification_templates - offers - order_guides - pos_banner_configurations - pos_orders - pos_tills - price_tags - product_ranges - products - promotions - purchase_orders - receiving - reporting - revision_sessions - revisions - roles - shopper_tags - shoppers - store_product_inventory_counts - store_product_lots - store_product_rules - store_product_tag_templates - store_snap_incentive_program_coupons - store_vendor_merge_requests - store_vendor_product_merge_requests - store_vendor_products - store_vendors - stores - tag_printings - tag_template_presets - tag_templates - tax_rates - users - variable_weights - vendor_merge_requests - vendor_product_merge_requests - vendors - wallet_payments - wic_products securitySchemes: bearer: type: http scheme: bearer ```` ## Related topics - [List store products](/api-reference/store-products/list-store-products.md) - [Build Your Product List (APL) From Scratch – For New Stores](/product-and-product-catalog-management/product-creation-and-set-up/build-your-product-list-apl-from-scratch-for-new-stores.md) - [The store product inventory object](/api/store-product-inventory/object.md)