> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usenash.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get products

> List products in the store catalog with pagination and optional filtering. Filter by IDs, SKUs, text search, or semantic search.



## OpenAPI

````yaml get /v1/products
openapi: 3.1.0
info:
  title: Nash API
  version: 1.0.0
servers:
  - url: https://api.sandbox.usenash.com
    description: Sandbox API
  - url: https://api.sandbox.ap-southeast-2.usenash.com
    description: Sandbox API (Australia)
  - url: https://api.usenash.com
    description: Production API
  - url: https://api.ap-southeast-2.usenash.com
    description: Production API (Australia)
security: []
tags:
  - name: Notifications
    description: Notifications
    x-nash-topic: config
  - name: Annotate
    description: Annotate
    x-nash-topic: wismo
  - name: Notifications — Send
    description: One-off notification send without a NotificationTrigger.
    x-nash-topic: notifications
  - name: Shipping
    description: Shipping operations
    x-nash-topic: shipping
  - name: Workflow
    description: Workflow automation management
    x-nash-topic: scheduling
  - name: Workflow Execution
    description: Workflow execution history and monitoring
    x-nash-topic: scheduling
  - name: Optimization Strategies
    description: Create, read, update, and delete route optimization strategies.
    x-nash-topic: scheduling
  - name: AI Agents
    description: AI agent management — create, read, update, and delete agents
    x-nash-topic: config
  - name: AI Functions
    description: LLM-backed domain tools
    x-nash-topic: ai
  - name: Webhooks
    description: Webhook delivery inspection
    x-nash-topic: webhooks
  - name: Fleet Simulator
    description: Simulate delivery status transitions in dev and sandbox environments.
    x-nash-topic: testing
  - name: Miscellaneous
    description: Miscellaneous
  - name: Job
    description: Job
    x-nash-topic: wismo
  - name: Batch Job
    description: Batch Job
    x-nash-topic: wismo
  - name: Order
    description: Order
    x-nash-topic: wismo
  - name: Route
    description: Route
    x-nash-topic: scheduling
  - name: Provider
    description: Provider
    x-nash-topic: provider
  - name: Dispatch Strategies
    description: Dispatch Strategies
    x-nash-topic: scheduling
  - name: Store Locations
    description: Store Locations
    x-nash-topic: config
  - name: Vehicles
    description: Vehicles
    x-nash-topic: provider
  - name: Couriers
    description: Couriers
    x-nash-topic: provider
  - name: Shifts
    description: Shifts
    x-nash-topic: provider
  - name: Delivery Windows
    description: Delivery Windows
    x-nash-topic: config
  - name: Templates
    description: Templates
    x-nash-topic: config
  - name: Zones
    description: Zones
    x-nash-topic: config
  - name: Feedback
    description: Feedback
    x-nash-topic: reporting
  - name: Organizations
    description: Organizations
    x-nash-topic: config
  - name: Store Catalog
    description: Store Catalog
    x-nash-topic: config
  - name: Messaging
    description: Messaging
    x-nash-topic: config
  - name: Contracts
    description: Provider contract pricing and version listings
    x-nash-topic: provider
  - name: Event Timeline
    description: Entity-scoped event timeline + outbound provider traffic for one entity.
    x-nash-topic: internal
  - name: Fleet
    description: Inbound endpoints fleets call to update in-flight deliveries.
    x-nash-topic: delivery
  - name: Route Restrictions
    description: Org-scoped geographic areas the route optimizer must avoid traversing.
    x-nash-topic: config
  - name: Users
    description: User, role, and organization-membership management.
    x-nash-topic: config
paths:
  /v1/products:
    get:
      tags:
        - Store Catalog
      summary: Get products
      description: >-
        List products in the store catalog with pagination and optional
        filtering. Filter by IDs, SKUs, text search, or semantic search.
      operationId: get_products_pagination_v1_products_get
      parameters:
        - name: pageIndex
          in: query
          required: false
          schema:
            title: Pageindex
            minimum: 0
            type: integer
            default: 0
            example: 0
          example: 0
        - name: numResultsPerPage
          in: query
          required: false
          schema:
            title: Numresultsperpage
            minimum: 1
            type: integer
            default: 100
            example: 100
          example: 100
        - name: search
          in: query
          required: false
          schema:
            title: Search
            anyOf:
              - type: string
              - type: 'null'
            default: null
            example: organic apples
          example: organic apples
        - name: ids
          in: query
          required: false
          schema:
            title: Ids
            anyOf:
              - type: string
              - type: 'null'
            default: null
            example: pro_123,pro_456
          example: pro_123,pro_456
        - name: skus
          in: query
          required: false
          schema:
            title: Skus
            anyOf:
              - type: string
              - type: 'null'
            default: null
            example: SKU-001,SKU-002
          example: SKU-001,SKU-002
        - name: semanticSearch
          in: query
          required: false
          schema:
            title: Semanticsearch
            anyOf:
              - type: string
              - type: 'null'
            default: null
            example: fresh fruit for smoothies
          example: fresh fruit for smoothies
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductsPaginationOutput'
        '422':
          description: Unprocessable Content
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NashValidationError'
components:
  schemas:
    ProductsPaginationOutput:
      title: ProductsPaginationOutput
      required:
        - products
        - totalResults
      type: object
      properties:
        products:
          title: Products
          type: array
          items:
            $ref: '#/components/schemas/ProductOutputSerializer'
        totalResults:
          title: Totalresults
          type: integer
    NashValidationError:
      title: NashValidationError
      required:
        - error
        - response_status
        - RequestID
      type: object
      properties:
        error:
          $ref: '#/components/schemas/NashErrorDetails'
        response_status:
          title: Response Status
          type: string
        RequestID:
          title: Requestid
          type: string
    ProductOutputSerializer:
      title: ProductOutputSerializer
      required:
        - id
        - name
      type: object
      properties:
        id:
          title: Id
          type: string
        externalIdentifier:
          title: Externalidentifier
          anyOf:
            - type: string
            - type: 'null'
          description: The external ID of the product from an external system
          default: null
          example: ext_001
        sku:
          title: Sku
          anyOf:
            - type: string
            - type: 'null'
          description: The Stock Keeping Unit (SKU) for the product
          default: null
          example: '11111'
        name:
          title: Name
          type: string
          description: The name of the product
          example: Organic Bananas
        description:
          title: Description
          anyOf:
            - type: string
            - type: 'null'
          description: The description of the product
          default: null
          example: Fresh organic bananas, perfect for smoothies and baking
        imageUrls:
          title: Imageurls
          anyOf:
            - type: array
              items:
                type: string
            - type: 'null'
          description: List of image URLs for the product
          default: null
          example:
            - https://example.com/bananas1.jpg
            - https://example.com/bananas2.jpg
        categories:
          title: Categories
          anyOf:
            - type: array
              items:
                type: string
            - type: 'null'
          description: List of categories the product belongs to
          default: null
          example:
            - Produce
            - Fruits
            - Organic
        weight:
          title: Weight
          anyOf:
            - type: number
            - type: 'null'
          description: The weight of the product
          default: null
          example: 0.5
        dimensions:
          anyOf:
            - $ref: '#/components/schemas/DimensionOutputSerializer'
            - type: 'null'
          description: Dimensions of the product
          default: null
          example:
            depth: 8
            height: 4
            width: 12
        identifiers:
          title: Identifiers
          anyOf:
            - type: array
              items:
                $ref: '#/components/schemas/IdentifierOutputSerializer'
            - type: 'null'
          description: List of identifiers for the product
          default: null
          example:
            - type: UPC
              value: '123456789012'
        attributes:
          title: Attributes
          anyOf:
            - type: array
              items:
                type: string
            - type: 'null'
          description: List of attributes for the product
          default: null
          example:
            - WEIGHTED
        details:
          anyOf:
            - $ref: '#/components/schemas/DetailsOutputSerializer'
            - type: 'null'
          description: Additional product details including weight and size specifications
          default: null
          example:
            packSizeSpecification:
              description: 10 units per pack
              value: 10
            sizeSpecification:
              description: ea
              value: 1
            weightedItemInfo:
              weightPerItem: 0.12
              weightUnit: kg
        providerConfigs:
          title: Providerconfigs
          anyOf:
            - type: array
              items:
                $ref: '#/components/schemas/ProviderConfigOutputSerializer'
            - type: 'null'
          description: Provider-specific configurations for this product
          default: null
          example:
            - categories:
                - Produce
                - Fruits
                - Organic
              provider: X
              serviceType: pick_and_deliver
    NashErrorDetails:
      title: NashErrorDetails
      required:
        - code
        - message
      type: object
      properties:
        code:
          title: Code
          type: string
        message:
          title: Message
          type: string
        details:
          title: Details
          anyOf:
            - type: object
              additionalProperties: true
            - type: 'null'
          default: null
    DimensionOutputSerializer:
      title: DimensionOutputSerializer
      type: object
      properties:
        depth:
          title: Depth
          anyOf:
            - type: number
            - type: 'null'
          description: The depth dimension of the product
          default: null
          example: 10.5
        width:
          title: Width
          anyOf:
            - type: number
            - type: 'null'
          description: The width dimension of the product
          default: null
          example: 5
        height:
          title: Height
          anyOf:
            - type: number
            - type: 'null'
          description: The height dimension of the product
          default: null
          example: 15.2
    IdentifierOutputSerializer:
      title: IdentifierOutputSerializer
      required:
        - type
        - value
      type: object
      properties:
        type:
          title: Type
          type: string
          description: The type of identifier
          example: UPC
        value:
          title: Value
          type: string
          description: The value of the identifier
          example: '123456789012'
    DetailsOutputSerializer:
      title: DetailsOutputSerializer
      type: object
      properties:
        weightedItemInfo:
          anyOf:
            - $ref: '#/components/schemas/WeightedItemInfoOutputSerializer'
            - type: 'null'
          description: Weight information per item
          default: null
        sizeSpecification:
          anyOf:
            - $ref: '#/components/schemas/SizeSpecificationOutputSerializer'
            - type: 'null'
          description: Size specification details
          default: null
        packSizeSpecification:
          anyOf:
            - $ref: '#/components/schemas/PackSizeSpecificationOutputSerializer'
            - type: 'null'
          description: Pack size specification details
          default: null
    ProviderConfigOutputSerializer:
      title: ProviderConfigOutputSerializer
      required:
        - provider
        - serviceType
      type: object
      properties:
        provider:
          title: Provider
          type: string
          description: Provider name
          example: X
        serviceType:
          title: Servicetype
          type: string
          description: Service type (e.g., pick_and_deliver, marketplace)
          example: pick_and_deliver
        categories:
          title: Categories
          anyOf:
            - type: array
              items:
                type: string
            - type: 'null'
          description: Provider-specific categories for this product
          default: null
          example:
            - Produce
            - Fruits
            - Organic
        enabled:
          title: Enabled
          anyOf:
            - type: boolean
            - type: 'null'
          description: Whether this provider config is enabled
          default: null
          example: true
    WeightedItemInfoOutputSerializer:
      title: WeightedItemInfoOutputSerializer
      type: object
      properties:
        weightPerItem:
          title: Weightperitem
          anyOf:
            - type: number
            - type: 'null'
          description: The weight per individual item
          default: null
          example: 0.5
        weightUnit:
          title: Weightunit
          anyOf:
            - type: string
            - type: 'null'
          description: The unit of weight measurement
          default: null
          example: kg
    SizeSpecificationOutputSerializer:
      title: SizeSpecificationOutputSerializer
      type: object
      properties:
        value:
          title: Value
          anyOf:
            - type: number
            - type: 'null'
          description: The size value
          default: null
          example: 100
        description:
          title: Description
          anyOf:
            - type: string
            - type: 'null'
          description: Description of the size specification
          default: null
          example: Large
    PackSizeSpecificationOutputSerializer:
      title: PackSizeSpecificationOutputSerializer
      type: object
      properties:
        value:
          title: Value
          anyOf:
            - type: string
            - type: 'null'
          description: The size value
          default: null
          example: 100
        description:
          title: Description
          anyOf:
            - type: string
            - type: 'null'
          description: Description of the size specification
          default: null
          example: Large

````