1. Search

Introducing search index tools for Portal

The premium search feature now includes self-service tools for viewing and rebuilding search indexes. These tools enable marketplace administrators to investigate and resolve basic search indexing errors without requiring additional support.

Search index concepts

Core functionality

  • Premium search endpoints use Elasticsearch
  • Caches Product and submitted Order data
  • Provides enhanced search capabilities
  • Delivers improved performance

Index management

  • Manual rebuilds create new indexes
  • Old index remains active until rebuild completes
  • Automatic maintenance optimizations occur
  • Resource limitations apply

Common scenarios

Manual rebuilds required after:

  • Toggling Active on:
    • Buyers
    • Suppliers
    • Catalogs
    • Categories
  • Toggling ViewAllProducts on:
    • Catalogs
    • Categories
  • Updating SupplierID

Troubleshooting tools

Portal access

  • Available to registered users
  • Marketplace-specific visibility
  • Product and Order index views

Index details

Status indicators:

  • Active: Current production index
  • Building: Initial creation
  • Rebuilding: Manual refresh
  • WaitingToBuild: Queued
  • Failed: Build error
  • Canceled: User terminated
  • Invalid: Schema issues

Error logging

  • Schema error details
  • Affected item IDs
  • Problem field identification
  • Value type conflicts
  • Limited to 100 documents

Visibility requirements

  • Resource items must exist
  • Premium search enabled
  • Orders must be submitted
  • API calls required

Schema error handling

Common issues

Most frequent error: Inconsistent extended property (xp) data types within resources.

Example scenario

Different value types for same property:

javascript
product1.xp.FreeShipping: false  // boolean
product2.xp.FreeShipping: 0      // integer

Error message:

Failed to parse field [xp.FreeShipping] of type [boolean] in document with id 'product2'. Preview of field's value: '0'

Impact

  • Search results inconsistency
  • Direct lookups work (GET v1/products/product2)
  • List operations fail (GET v1/products)

Resolution steps

  1. Ensure consistent xp types
  2. Update incorrect values
  3. Rebuild index if schema changes

SDK support

Type consistency tools:

Index rebuilding

Process overview

  1. Ensure consistent xp types
  2. Navigate to active index
  3. Locate rebuild button
  4. Trigger rebuild operation
  5. Monitor build progress

Usage limits

Production/Staging environments:

  • 3 rebuilds per hour
  • 5 rebuilds per week

Sandbox environments:

  • 10 rebuilds per hour
  • 30 rebuilds per week

Requirements

  • Active index only
  • Administrator access
  • No concurrent rebuilds
  • Cannot cancel in progress

Build considerations

  • Resource-intensive operation
  • Build time varies by data volume
  • Progress tracking available
  • Error retention: 24 hours

Contact OrderCloud support for persistent issues.

If you have suggestions for improving this article, let us know!