×

👋 Welcome to Constructor's new and improved documentation

Pardon the interruption. You have been redirected to Constructor's new and improved documentation platform.

In an effort to provide the best experience, Constructor has consolidated all documentation into a single platform.

If you've arrived at this page via a bookmark, we'd suggest updating your bookmark to point to this new resource URL.

Thank you! If you have any feedback, we would love to hear from you.

Proceed

Jump to Content
Constructor Documentation
HomeGuidesAPI Reference
Release NotesProof Schedule®UI LibrariesClient LibrariesBlogMain SiteConstructor Documentation
API Reference
Release NotesProof Schedule®UI LibrariesClient LibrariesBlogMain Site
HomeGuidesAPI Reference

Main

  • Readme
  • Authentication

Autocomplete

  • Autocomplete results
    • Retrieve by prefixget

Shared

  • Variations mapping
  • Variations slicing
  • Pre-filter expressions
  • Filter expressions
  • Results response structure
  • Filter names & values

Search

  • Search results
    • Retrieve by queryget
  • Natural language search results
    • Retrieve by queryget

Image Search

  • Image Search results
    • Retrieve by imagepost

Browse

  • Browse results
    • Retrieve by filter name/valueget
    • Retrieve by item IDget
  • Browse groups
    • Retrieve groupsget
  • Browse facets
    • Retrieve facetsget
    • Retrieve facet options (values) by facet nameget
    • Retrieve facets with their options (values)get

Recommendations

  • Recommendation results
    • Retrieve by podget

AI Shopping Agent

  • Results
    • Retrieve by intentget
    • Retrieve questionsget
    • Retrieves answersget

Quizzes

  • Results
    • Next questionget
    • Get resultsget
    • Get results page configget

Catalog management

  • Introduction
  • Catalog
    • Create or replace catalogput
    • Update catalogpatch
  • Item groups
    • Retrieve item groupget
    • Retrieve item groupsget
    • Create or replace item groupsput
    • Update item groupspatch
    • Retrieve item group (Deprecated)get
    • Retrieve item groups (Deprecated)get
    • Create new item groups (Deprecated)post
    • Create or replace item groups (Deprecated)put
    • Create or update item group (Deprecated)put
    • Create or update item groups (Deprecated)patch
    • Delete item groups (Deprecated)del
  • Items
    • Retrieve itemsget
    • Create or replace itemsput
    • Update itemspatch
    • Delete itemsdel
    • Retrieve itemget
  • Item statistics
    • Retrieve item field statisticsget
    • Retrieve item field statisticget
  • Variations
    • Retrieve variationsget
    • Create or replace variationsput
    • Update variationspatch
    • Delete variationsdel
    • Retrieve variationget
  • Tasks
    • Retrieve tasksget
    • Create taskpost
    • Update taskspatch
    • Retrieve taskget
    • Update taskpatch
  • Limitations

Configuration

  • Facets
    • Retrieve facet configurationsget
    • Create facet configurationpost
    • Update facet configurationspatch
    • Retrieve facet configurationget
    • Replace facet configurationput
    • Update facet configurationpatch
    • Delete facet configurationdel
    • Retrieve facet optionsget
    • Create facet optionpost
    • Create or update facet optionspatch
    • Retrieve facet optionget
    • Replace facet optionput
    • Update facet optionpatch
    • Delete facet optiondel
  • Synonyms
    • Retrieve one-way synonymget
    • Create one-way synonympost
    • Replace one-way synonymput
    • Delete one-way synonymdel
    • Retrieve one-way synonymsget
    • Delete one-way synonymsdel
  • Searchabilities
    • Retrieve searchabilitiesget
    • Create or update searchabilitiespatch
    • Delete searchabilitiesdel
    • Retrieve searchabilityget
    • Create or update searchabilitypatch
    • Delete searchabilitydel
  • Sort options
    • Retrieve sort optionsget
    • Create or replace sort optionsput
    • Delete sort optionsdel
    • Create a sort optionpost
    • Replace a sort optionput
    • Update a sort optionpatch
  • Synonym groups
    • Retrieve synonym groupget
    • Update synonym groupput
    • Delete synonym groupdel
    • Retrieve synonym groupsget
    • Create synonym grouppost
    • Delete synonym groupsdel
  • Quizzes
    • Retrieve quizget
    • Create or replace quizput
    • Update quizpatch
    • Delete quizdel
  • Collections
    • Retrieve collectionget
    • Replace collectionput
    • Update collectionpatch
    • Delete collectiondel
    • Retrieve collectionsget
    • Create collectionpost
    • Delete item from a collectiondel
    • Retrieve collection itemsget
    • Add items to a collectionput
    • Delete items from a collectiondel
  • Redirect rules
    • Retrieve redirect ruleget
    • Replace redirect ruleput
    • Update redirect rulepatch
    • Delete redirect ruledel
    • Retrieve redirect rulesget
    • Create redirect rulepost
  • Metadata overrides
    • Get metadata overrides for the specified index key and optionally query via field name.get
    • Create a new metadata override rule for the specified field name.post
    • Patch an existing metadata override rule for the specified field name.patch
    • Delete an existing metadata override rule for the specified field name.del
    • Limitations

Searchandising

  • Searchandising for Browse
    • Retrieve refined filtersget
    • Retrieve refined filterget
    • Create or replace refined filterput
    • Update refined filterpatch
    • Delete refined filterdel
    • Retrieve refined filter rulesget
    • Delete refined filter rulesdel
  • Searchandising for Collections
    • Retrieve refined collectionsget
    • Retrieve refined collectionget
    • Create or replace refined collectionput
    • Update refined collectionpatch
    • Delete refined collectiondel
  • Searchandising for Search
    • Retrieve refined queriesget
    • Create refined querypost
    • Retrieve refined queryget
    • Replace refined queryput
    • Update refined querypatch
    • Delete refined querydel
  • Searchandising by User Request Data
    • Retrieve refined tagget
    • Create or replace refined tagput
    • Update refined tagpatch
    • Delete refined tagdel
    • Retrieve refined tagsget
  • Campaigns
    • Retrieve campaignsget
    • Create campaignpost
    • Retrieve campaignget
    • Update campaignpatch
    • Delete campaigndel

Behavioral actions

  • Behavioral actions
    • Post a list of offline behavioral actionspost

User profile

  • User preferences
    • Create user preferencesput

Offsite Discovery recommendations

  • Offsite Discovery results
    • Retrieve by podget
  • Product resources
    • Retrieve product resourcesget
    • Retrieve product URL resourceget
    • Retrieve product resources (Deprecated)get
    • Retrieve product URL resource (Deprecated)get

Browse groups

The Browse retrieve groups endpoint lists all the customer-configured groups present in the latest index. This endpoint does not return individual item results - for this purpose reference the standard retrieve by filter name/value endpoint.

API endpoints

  • Retrieve groups
  • Table of Contents
    • API endpoints
Products
  • Search
  • Autosuggest
  • Browse
  • Recommendations
  • Collections
  • Quizzes
How It Works
  • Natural Language Processing
  • ML-enhanced Reranking
  • Collaborative Personalization
  • Merchant Controls
  • Deployment
About
  • Security & Compliance
  • Contact Us
  • Careers
  • News
  • Blog

Copyright ©  Constructor. All rights reserved.