Using Order Search APIs

Creating an index
In order to save any order document to Order Search, create an index with a predefined schema consisting of mappings and settings by using the createSearchIndex API.
Cloning an index
An important part of good Elasticsearch hygiene is the indexing strategy that helps to avoid massive indices, which holds too much of your data.
Cloning an index for History Mass Sync
Before you set up the integration with Order Service, many orders might have been copied to order history tables. To have a single source of visibility, save these orders in Order Search.
Updating an index
The process of defining mappings is made flexible to suit your business requirements. However, an existing field in the mappings cannot be updated once created.
Reading an index
You can use the readSearchIndex API to query an index name to retrieve the schema information and the settings on the index. You can also view whether the index is used for writing new documents.
Retrieving the fields of an index
You can retrieve searchable fields, sortable fields, and returnable fields of an index by using the readSearchIndexFields API by providing the field type criteria as input.
Retrieving index statistics and document count
You can use the readSearchIndexStatistics API to query an index name or the index identifier to get the document count and numerous other statistics for the index or indices recognized by the identifier. You can also list all the available indices by using the index identifier.
Saving orders in bulk
After you define an index, use the SaveBulkOrderSummary API to save the summary of multiple orders to the index. You can integrate Sterling™ Order Management System Software with Order Service by using the built-in Order Search integration to save order documents to the writable index in batch.
Saving an order
You can save or update a single order document by using the saveOrderSummary API.
Reading an order
You can retrieve a single saved order by passing orderId.id as an input to the readOrderSummary API.
Searching an order
All order documents that are saved and indexed in the Order Search repository can be searched by the searchable attributes by using the SearchOrder API.
Initiating reindex
You can use initiateReindex API to initiate the asynchronous order reindexing using backend consumers.

Parent topic: Using Order Service