Crownpeak
  • Product Discovery Developer Guide
  • 🛒Item catalog management
    • What is the Items API?
    • How to work with Items
      • Item Schema
        • Attributes
        • Nested Item Schemas
        • Using the Item Schema API
        • DefaultLocale API
        • Onboarding on/migrating to Fredhopper
        • List of Reserved Attributes
      • Category Tree
        • Using the Category Tree API
        • Onboarding on XO
      • Item Catalog
        • Using the Catalog API
      • Items
        • Using the streaming Items API
        • Using the batch Items API
    • Step by Step guide
      • Step by step guide for Fredhopper customers
    • Feedback
      • Using the Feedback API
    • Authorization to APIs
    • Troubleshooting API errors
  • 🎯XO Recommendations
    • Introduction
    • Using the Recommendations API
    • Setting up the Chrome extension
    • Micro-segmentation
    • XO Legacy APIs
  • 🔎XO Search
    • Introduction
    • Getting started
    • API Reference
      • Search API
      • Autocomplete API (Beta)
      • Product Suggest API
    • API Parameters
      • Search
      • Pagination
      • Faceting
      • Sorting
      • Grouping
      • Filtering
      • Disable features
      • Response mask
      • Context
    • Configuration limitation
  • 🧪A/B testing
    • Fredhopper A/B testing
      • Integration steps for a non-caching solution
      • Integration steps for a caching solution
        • Java SDK Integration
          • Setup
          • Retrieve running A/B tests - Java SDK
          • Filter and request variant - Java SDK
          • Extending the SDK
        • Manual A/B tests integration
          • Retrieve running A/B tests
          • Filter out irrelevant A/B tests
          • Assign variants to user
          • Request variant for page
        • Limitations and Best Practices
  • 📚Resources
    • Glossary
    • Best Practices
      • Tracker Best Practices
      • Items API Best Practices
      • Fredhopper Data Configuration Best Practices
      • Fredhopper Query Response Best Practices
      • Fredhopper Merchandising Studio Best Practices
    • Privacy Notice
  • Archived Pages
    • FHR Tracking plan
    • XO Tracking plan
    • The Tracking API and JS Library
      • What to Track
        • Generic Actions
          • View
          • Click
          • Add to Cart
          • Remove from Cart
          • Purchase
        • Custom Actions
      • Initializing the JavaScript Library
      • REST API Technical Documentation
Powered by GitBook
On this page
  • Method
  • Format
  • APIs
  • Go further
  1. XO Search

API Reference

The search API provides a single endpoint, available with both GET and POST methods.

PreviousGetting startedNextSearch API

Last updated 27 days ago

Although the SDK is the recommended way of using XO Search, a REST API is provided for convenience. This API provides a single endpoint, available with both GET and POST methods.

Method

XO Search API supports both GET and POST methods:

  • GET requests: parameters must be passed in the URL's query string. Parameters must be .

  • POST requests: parameters must be passed in the request body, as JSON

Both will work the same as long as you follow the right format, which is described below.

Format

The API uses JSON encoded as UTF-8.

The body of POST requests must be a JSON object and the Content-Type header should be set to application/json; charset=UTF-8.

The body of responses is always a JSON object, and the Content-Type is always application/json; charset=UTF-8.

APIs

Go further

For more detailed information about the parameters and usage, check the following pages.

🔎
URL-encoded
Search API
Product Suggest API
Autocomplete API (Beta)
Search
Pagination
Faceting
Sorting
Grouping
Filtering
Disable features
Response mask