Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
IndexerApi	add	POST /indexer-api/v1/full/add	Add one or more documents to a running import session.
IndexerApi	cancel	POST /indexer-api/v1/full/cancel	Cancels the import and in case there was an index created, it will be deleted.
IndexerApi	done	POST /indexer-api/v1/full/done	Finishes the import, flushing the new index and (in case there is already an index with the initialized name) replacing the old one.
IndexerApi	startImport	GET /indexer-api/v1/full/start/{indexName}	Starts a new full import. Returns a handle containing meta data, that has to be passed to all following calls.
SearchApi	arrangedSearch	POST /search-api/v1/search/arranged/{tenant}
SearchApi	getDocument	GET /search-api/v1/doc/{tenant}/{id}
SearchApi	getTenants	GET /search-api/v1/tenants
SearchApi	search	GET /search-api/v1/search/{tenant}	Search for documents
SuggestApi	suggest	GET /suggest-api/v1/{indexname}/suggest	Autocomplete the user input
UpdateApi	deleteDocuments	DELETE /indexer-api/v1/update/{indexName}	Delete existing document. If document does not exist, it returns code 304.
UpdateApi	patchDocuments	PATCH /indexer-api/v1/update/{indexName}	Partial update of existing documents. If a document does not exist, no update will be performed and it gets the result status ‘NOT_FOUND’. In case a document is a master product with variants, the provided master product may only contain the changed values. However if some of the variants should be updated, all data from all variant products are required, unless you have an ID data-field inside variant - then you can update single variants. Without variant ID field, the missing variants won’t be there after the update! This is how single variants can be deleted.
UpdateApi	putDocuments	PUT /indexer-api/v1/update/{indexName}	Puts a document to the index. If document does not exist, it will be added, but in that case the langCode parameter is required. An existing product will be overwritten unless the parameter ‘replaceExisting" is set to "false". Provided document should be a complete object, partial updates should be done using the updateDocument method.

Documentation for Models

• ArrangedSearchQuery
• Attribute
• BulkImportData
• Category
• Document
• Document_data_value
• DynamicProductSet
• Facet
• FacetEntry
• GenericProductSet
• HierarchialFacetEntry
• ImportSession
• IntervalFacetEntry
• Product
• ProductSet
• QueryStringProductSet
• RangeFacetEntry
• ResultHit
• SearchQuery
• SearchResult
• SearchResultSlice
• Sorting
• StaticProductSet
• Suggestion

Documentation for Authorization

basic-auth

• Type: HTTP basic authentication