> ## 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 products > Lists store products. Use the `state` parameter to filter, sort, and paginate results. ## OpenAPI ````yaml /api/openapi.json get /v1/store-products openapi: 3.0.0 info: title: Vori API description: >- Read and manage your store catalog, vendors, and inventory. Requests require a bearer token; see "Connect to the Vori REST API" for how to obtain one. version: 1.0.0 contact: {} servers: - url: https://api.vori.com description: production security: [] tags: [] paths: /v1/store-products: get: tags: - Store products summary: List store products description: >- Lists store products. Use the `state` parameter to filter, sort, and paginate results. operationId: listStoreProducts parameters: - name: state required: false in: query description: >- Filter, sort, and paginate products with a URL-encoded JSON object: ```json { "startRow": 0, "endRow": 50, "filterModel": { "": }, "sortModel": [{ "colId": "", "sort": "asc" }] } ``` Any other top-level property is rejected. **Pagination** — `startRow` and `endRow` select which slice of results to return: `startRow` defaults to 0, and `endRow` defaults to `startRow` plus 10. You can request at most 1000 rows at a time (`endRow - startRow <= 1000`). The response's `rowCount` field always reflects the total number of matching rows across the entire result set, not just the rows returned in this request. **Sorting** — `sortModel` orders results by any filterable field except the related-entity fields, plus `id`. If you don't specify a `sortModel`, results are sorted by `created_at` descending (newest first). **Filtering** — `filterModel` is an object keyed by field name, where each value describes how to match that field: | Filter | Example | `type` values | Fields | | ------ | ------- | --------------- | ------ | | Set | `{"filterType": "set", "values": ["1", "2"]}` |
  • in
  • notIn
|
  • barcode_type
  • retail_price_uom_id
  • store_department_id
  • store_id
  • unit_of_measure_mapping_id
| | Boolean | `{"filterType": "boolean", "values": [true]}` |
  • in
  • notIn
|
  • active
  • earns_loyalty_points
  • ebt_enabled
  • ecommerce_enabled
  • esl_enabled
  • is_blackhawk_gift_card
  • is_reloadable_blackhawk_gift_card
  • is_tippable
  • manual_item
  • print_physical_tag
  • prompt_for_quantity
  • snap_incentive_earnable
  • snap_incentive_redeemable
  • sync_to_deli_scales
  • variable_sale_price
  • wic_enabled
| | Text | `{"filterType": "text", "type": "contains", "filter": "cola"}` |
  • equals
  • notEqual
  • contains
  • notContains
  • startsWith
  • endsWith
  • blank
  • notBlank
|
  • barcode
  • brand_string
  • country_of_origin
  • description
  • name
  • raw_barcode
  • unit_volume_string
  • wic_override_plu
| | Number | `{"filterType": "number", "type": "greaterThan", "filter": 10}` |
  • equals
  • notEqual
  • lessThan
  • lessThanOrEqual
  • greaterThan
  • greaterThanOrEqual
  • inRange
  • blank
  • notBlank
|
  • base_retail_price
  • case_cost
  • case_size
  • current_margin
  • each_cost
  • lb_cost
  • min_customer_age
  • pack_size
  • store_product.unit_of_measure_amount
  • target_margin
| | Date | `{"filterType": "date", "type": "greaterThan", "dateFrom": "2026-01-01", "dateTo": null}` |
  • equals
  • notEqual
  • lessThan
  • greaterThan
  • inRange
  • blank
  • notBlank
|
  • base_retail_price_start_time
  • created_at
  • updated_at
| | Related entities | `{"filterType": "set", "values": ["1"]}` |
  • in
|
  • store_product_item_modifiers.item_modifier_id
  • store_product_tax_rates.tax_rate_id
  • store_product_variable_weights.variable_weight_id
| | Product group rules | `{"filterType": "set", "values": ["0195f9a8-7d64-7c3a-b7f5-3e0a5a2b9c11"]}` |
  • in
|
  • store_product_group_rule_ids
| `type` is optional for set and boolean filters and defaults to `in`. Boolean fields also accept set filters, and date fields also accept `"filterType": "datetime"`. Set filters must be flat — compound `AND`/`OR` conditions are rejected. schema: $ref: '#/components/schemas/DataFrameListConfigDto' - name: include required: false in: query description: >- Comma-separated list of related data to include on each product: - `active_vendor` — Populates `active_vendor` with the product's primary vendor. - `active_vendor_product` — Populates `active_vendor_product` with the primary vendor's catalog entry, including costs. - `inventory` — Populates `inventory` with on-hand quantity data. - `store_vendor_products` — Populates `store_vendor_products` with every vendor's catalog entry for the product. schema: type: array items: $ref: '#/components/schemas/StoreProductLoaders' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/StoreProductsListDto' '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/InvalidStoresError' - $ref: '#/components/schemas/UnsupportedStateFieldError' '403': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/InsufficientPermissionsError' - $ref: '#/components/schemas/NoBannerAssociationError' security: - bearer: [] components: schemas: DataFrameListConfigDto: type: object properties: startRow: type: integer endRow: type: integer filterModel: type: object sortModel: type: array items: $ref: '#/components/schemas/DataFrameSortConfigDto' StoreProductLoaders: type: string enum: - active_vendor - active_vendor_product - inventory - store_vendor_products StoreProductsListDto: type: object properties: data: description: Products in the requested row window. type: array items: $ref: '#/components/schemas/StoreProductDto' rowCount: type: integer description: >- Total number of products matching the filters, across all row windows. required: - data - rowCount InvalidStoresError: type: object properties: error_code: type: string enum: - invalid_stores required: - error_code UnsupportedStateFieldError: type: object properties: error_code: type: string enum: - unsupported_state_field 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 DataFrameSortConfigDto: type: object properties: colId: type: string sort: allOf: - $ref: '#/components/schemas/DataFrameSortDirection' type: type: string description: AG Grid sort metadata accepted for compatibility. required: - colId - sort StoreProductDto: type: object properties: id: type: string created_at: type: string format: date-time updated_at: type: string format: date-time deleted_at: type: string nullable: true description: >- When the product was soft-deleted, or null if it has not been deleted. format: date-time store_id: type: string description: ID of the store this product belongs to. pattern: ^[0-9]+$ department_id: type: string description: ID of the store department this product belongs to. pattern: ^[0-9]+$ tax_rates: description: Tax rates applied to this product at the register. type: array items: $ref: '#/components/schemas/NestedTaxRateDto' item_modifiers: description: Item modifiers available for this product. type: array items: $ref: '#/components/schemas/NestedItemModifierDto' food_modifier_categories: description: >- Food modifier categories, and their modifiers, available for this product, ordered by category priority. type: array items: $ref: '#/components/schemas/NestedFoodModifierCategoryDto' additional_barcodes: description: >- Barcodes that resolve to this product in addition to the primary `barcode`. type: array items: $ref: '#/components/schemas/StoreProductBarcodeDto' variable_weights: description: Preset weights for products sold by weight. type: array items: $ref: '#/components/schemas/NestedVariableWeightDto' active_vendor: description: The vendor currently supplying this product. allOf: - $ref: '#/components/schemas/NestedStoreVendorDTO' active_vendor_product: description: The vendor catalog entry currently supplying this product. allOf: - $ref: '#/components/schemas/NestedStoreVendorProductDTO' store_vendor_products: description: Vendor catalog entries for this product. type: array items: $ref: '#/components/schemas/NestedStoreVendorProductDTO' inventory: description: >- Current inventory levels. Included when requested via `include=inventory`. allOf: - $ref: '#/components/schemas/NestedStoreProductInventoryDto' brand: type: string nullable: true description: Brand name. description: type: string nullable: true description: >- Short description, intended for character-limited use cases (e.g., printed receipts). active: type: boolean description: Whether the product is active. name: type: string description: Human-readable product name. barcode: type: string description: Primary barcode. target_margin: type: string nullable: true description: >- Target gross margin for pricing decisions, as a whole-number percentage (35 means 35%). example: '199.99' pattern: ^-?[0-9]+(\.[0-9]+)?$ case_size: type: integer nullable: true description: Number of sellable units in a vendor case. pack_size: type: integer nullable: true description: Number of units in a retail pack. print_physical_tag: type: boolean description: Whether a physical shelf tag should be printed for this product. esl_enabled: type: boolean description: Whether electronic shelf labels are enabled for this product. label_last_printed_at: type: string nullable: true description: When a shelf tag was last printed for this product. format: date-time wicable: type: integer nullable: true description: WIC eligibility indicator. min_customer_age: type: integer nullable: true description: Minimum customer age, in years, required to purchase. wic_enabled: type: boolean description: Whether the product is eligible for WIC payment. snap_enabled: type: boolean description: Whether the product is eligible for SNAP payment. ebt_enabled: type: boolean description: Whether the product is eligible for EBT/SNAP payment. ecommerce_enabled: type: boolean description: Whether the product is available for e-commerce. variable_sale_price: type: boolean description: Whether the sale price is entered at the register instead of fixed. sold_by_weight: type: boolean description: Whether the product is sold by weight rather than by unit. prompt_for_quantity: type: boolean description: >- Whether the register prompts for a quantity when the product is scanned. manual_item: type: boolean description: >- Whether the product is entered manually at the register rather than scanned. is_tippable: type: boolean description: Whether purchases of this product can include a tip. is_blackhawk_gift_card: type: boolean description: Whether the product is a Blackhawk gift card. is_reloadable_blackhawk_gift_card: type: boolean description: Whether the product is a reloadable Blackhawk gift card. snap_incentive_earnable: type: boolean description: Whether purchases of this product earn SNAP incentives. snap_incentive_redeemable: type: boolean description: Whether SNAP incentives can be redeemed against this product. discount_restrictions: type: array nullable: true description: Discount types that may not be applied to this product. items: $ref: '#/components/schemas/DiscountRestriction' loyalty_points_per_dollar: type: string nullable: true description: >- Loyalty points earned per dollar spent. Null defaults to one point per dollar. pattern: ^[0-9]+(\.[0-9]+)?$ example: '199.99' unit_volume_quantity: type: string nullable: true description: Net content quantity, in the unit given by `unit_volume_uom_name`. example: '199.99' pattern: ^-?[0-9]+(\.[0-9]+)?$ unit_volume_uom_name: type: string nullable: true description: Unit of measure for `unit_volume_quantity`. unit_price: type: string nullable: true description: Retail price per unit of measure, in dollars. example: '199.99' pattern: ^-?[0-9]+(\.[0-9]+)?$ retail_price: type: string nullable: true description: Current shelf/retail price in dollars. format: positive-monetary pattern: ^[0-9]+(\.[0-9]+)?$ example: '199.99' minimum_retail_price: type: string nullable: true description: Lower bound for the retail price, in dollars. format: positive-monetary pattern: ^[0-9]+(\.[0-9]+)?$ example: '199.99' maximum_retail_price: type: string nullable: true description: Upper bound for the retail price, in dollars. format: positive-monetary pattern: ^[0-9]+(\.[0-9]+)?$ example: '199.99' retail_price_effective_at: type: string nullable: true description: When the current retail price took effect. format: date-time retail_price_unit_of_measure: nullable: true description: Unit of measure the retail price applies to. allOf: - $ref: '#/components/schemas/UnitOfMeasureDto' disable_pos_sync: type: boolean description: >- Whether synchronization of this product to the point-of-sale is disabled. primary_vendor_configuration: description: How the primary vendor is selected for this product. allOf: - $ref: '#/components/schemas/PrimaryVendorConfiguration' country_of_origin: type: string nullable: true maxLength: 3 minLength: 3 description: ISO 3166-1 alpha-3 country code of origin. sync_to_deli_scales: type: boolean default: false description: Whether the product is synchronized to deli scales. required: - id - created_at - updated_at - deleted_at - store_id - department_id - tax_rates - item_modifiers - food_modifier_categories - additional_barcodes - variable_weights - brand - description - active - name - barcode - target_margin - case_size - pack_size - print_physical_tag - esl_enabled - label_last_printed_at - wicable - min_customer_age - wic_enabled - snap_enabled - ebt_enabled - ecommerce_enabled - variable_sale_price - sold_by_weight - prompt_for_quantity - manual_item - is_tippable - is_blackhawk_gift_card - is_reloadable_blackhawk_gift_card - snap_incentive_earnable - snap_incentive_redeemable - discount_restrictions - loyalty_points_per_dollar - unit_volume_quantity - unit_volume_uom_name - unit_price - retail_price - minimum_retail_price - maximum_retail_price - retail_price_effective_at - retail_price_unit_of_measure - disable_pos_sync - primary_vendor_configuration - country_of_origin - sync_to_deli_scales InsufficientPermissionsErrorDetails: type: object properties: resource: allOf: - $ref: '#/components/schemas/Resource' action: allOf: - $ref: '#/components/schemas/Action' required: - resource - action DataFrameSortDirection: type: string enum: - asc - desc NestedTaxRateDto: type: object properties: id: type: string name: type: string type: allOf: - $ref: '#/components/schemas/TaxRateType' value: type: string pattern: ^[0-9]+(\.[0-9]+)?$ example: '199.99' tax_type: allOf: - $ref: '#/components/schemas/TaxType' required: - id - name - type - value - tax_type NestedItemModifierDto: type: object properties: id: type: string name: type: string type: allOf: - $ref: '#/components/schemas/ItemModifierType' tax_behavior: allOf: - $ref: '#/components/schemas/ItemModifierTaxBehavior' value: type: string pattern: ^[0-9]+(\.[0-9]+)?$ example: '199.99' required: - id - name - type - tax_behavior - value NestedFoodModifierCategoryDto: type: object properties: id: type: string name: type: string description: Category name priority: type: integer description: Display priority (lower = shown first) min_selection: type: integer description: Minimum number of options customer must select (0 = no minimum) max_selection: type: integer description: Maximum number of options customer can select nullable: true modifiers: description: Modifiers assigned to this product in this category type: array items: $ref: '#/components/schemas/FoodModifierDto' required: - id - name - priority - min_selection - max_selection - modifiers StoreProductBarcodeDto: type: object properties: id: type: string created_at: type: string format: date-time updated_at: type: string format: date-time store_id: type: string barcode: type: string barcode_type: allOf: - $ref: '#/components/schemas/BarcodeType' store_product_id: type: string required: - id - created_at - updated_at - store_id - barcode - barcode_type - store_product_id NestedVariableWeightDto: type: object properties: id: type: string nullable: true name: type: string unit: allOf: - $ref: '#/components/schemas/VariableWeightUnit' value: type: string pattern: ^[0-9]+(\.[0-9]+)?$ example: '199.99' required: - id - name - unit - value NestedStoreVendorDTO: type: object properties: id: type: string created_at: type: string format: date-time updated_at: type: string format: date-time name: type: string code: type: string nullable: true required: - id - created_at - updated_at - name - code NestedStoreVendorProductDTO: type: object properties: id: type: string created_at: type: string format: date-time updated_at: type: string format: date-time uuid: type: string format: uuid mutation_key: type: string format: uuid store_product: nullable: true allOf: - $ref: '#/components/schemas/NestedStoreProductDTO' store_product_id: type: string nullable: true store_id: type: string nullable: true store_vendor: nullable: true allOf: - $ref: '#/components/schemas/NestedStoreVendorDTO' description: type: string barcode: type: string nullable: true barcode_type: nullable: true allOf: - $ref: '#/components/schemas/BarcodeType' item_code: type: string case_size: type: string nullable: true example: '199.99' pattern: ^-?[0-9]+(\.[0-9]+)?$ each_cost: type: string nullable: true example: '199.99' pattern: ^-?[0-9]+(\.[0-9]+)?$ each_cost_start_time: type: string nullable: true format: date-time case_cost: type: string nullable: true example: '199.99' pattern: ^-?[0-9]+(\.[0-9]+)?$ case_cost_start_time: type: string nullable: true format: date-time lb_cost: type: string nullable: true example: '199.99' pattern: ^-?[0-9]+(\.[0-9]+)?$ lb_cost_start_time: type: string nullable: true format: date-time brand_name: type: string nullable: true unit_volume: type: string nullable: true is_order_primary: type: boolean purchase_order_uom_lock: nullable: true allOf: - $ref: '#/components/schemas/PurchaseOrderLineItemUnitOfMeasure' required: - id - created_at - updated_at - uuid - mutation_key - store_product - store_product_id - store_id - store_vendor - description - barcode - barcode_type - item_code - case_size - each_cost - each_cost_start_time - case_cost - case_cost_start_time - lb_cost - lb_cost_start_time - brand_name - unit_volume - is_order_primary - purchase_order_uom_lock NestedStoreProductInventoryDto: type: object properties: current: type: string nullable: false example: '199.99' pattern: ^-?[0-9]+(\.[0-9]+)?$ min_par: type: string nullable: true max_stock: type: string nullable: true last_changed_at: type: string nullable: true format: date-time required: - current - min_par - max_stock - last_changed_at DiscountRestriction: type: string enum: - NO_DISCOUNT_WHEN_ON_PROMOTION - NO_DISCOUNTING - NO_DOUBLE_DISCOUNTING UnitOfMeasureDto: type: object properties: id: type: string name: type: string description: type: string required: - id - name - description PrimaryVendorConfiguration: type: string enum: - LATEST_COST - SELECTED_BY_USER Resource: type: string enum: - '*' - accounting_integration - agent_chats - 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 - lanes - loyalty_bonuses - loyalty_campaigns - loyalty_rewards - notification_templates - offers - 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_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 Action: type: string enum: - '*' - cancel - check_in - create - delete - read - record_events - refund - restart - update - void TaxRateType: type: string enum: - amount - percentage TaxType: type: string enum: - other - sales ItemModifierType: type: string enum: - bottle_deposit - custom - food_modifier ItemModifierTaxBehavior: type: string enum: - EXCLUDE - INHERIT_FROM_STORE_PRODUCT FoodModifierDto: type: object properties: id: type: string priority: type: integer description: Display priority (lower = shown first) item_modifier: description: Item modifier data allOf: - $ref: '#/components/schemas/ItemModifierDto' required: - id - priority - item_modifier BarcodeType: type: string enum: - EAN 13 Type 2 Without Check Digit - EAN-13 - EAN-13 Without Check Digit - EAN-14 - EAN-14 Without Check Digit - EAN-8 - EAN-8 Without Check Digit - PLU - PRODUCE PLU - Type 2 EAN - Type 2 UPC - Unsanitized - UPC Shipping Container - UPC-A - UPC-A Type 2 Without Check Digit - UPC-A Without Check Digit - UPC-E - UPC-E Without Check Digit VariableWeightUnit: type: string enum: - LBS - OZ NestedStoreProductDTO: type: object properties: id: type: string created_at: type: string format: date-time updated_at: type: string format: date-time name: type: string primaryVendorConfiguration: allOf: - $ref: '#/components/schemas/PrimaryVendorConfiguration' barcode: type: string required: - id - created_at - updated_at - name - primaryVendorConfiguration - barcode PurchaseOrderLineItemUnitOfMeasure: type: string enum: - CASE - EACH - LB ItemModifierDto: type: object properties: id: type: string created_at: type: string format: date-time updated_at: type: string format: date-time name: type: string type: allOf: - $ref: '#/components/schemas/ItemModifierType' taxBehavior: allOf: - $ref: '#/components/schemas/ItemModifierTaxBehavior' value: type: string pattern: ^[0-9]+(\.[0-9]+)?$ example: '199.99' priceTagModifier: nullable: true allOf: - $ref: '#/components/schemas/PriceTagModifier' required: - id - created_at - updated_at - name - type - taxBehavior - value - priceTagModifier PriceTagModifier: type: string enum: - BOTTLE_DEPOSIT - CRV securitySchemes: bearer: scheme: bearer bearerFormat: JWT type: http ```` ## Related topics - [List store product history](/api-reference/store-products/list-store-product-history.md) - [List processed store product rules](/api-reference/store-products/list-processed-store-product-rules.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)