> For the complete documentation index, see [llms.txt](https://developer.emporix.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.emporix.io/api-documentation/api-guides/configuration/indexing-service/api-reference/models.md).

# Models

## The errorMessage object

```json
{"openapi":"3.0.0","info":{"title":"Indexing Service","version":"v1"},"components":{"schemas":{"errorMessage":{"title":"error","description":"Schema for API specified errors.","type":"object","properties":{"code":{"description":"Original HTTP error code, should be consistent with the response HTTP code","type":"integer"},"status":{"description":"Classification of the error type","type":"string"},"message":{"description":"Descriptive error message for debugging","type":"string"},"details":{"type":"array","description":"Error details","items":{"type":"string"}}}}}}}
```

## The ReindexJobStatus object

```json
{"openapi":"3.0.0","info":{"title":"Indexing Service","version":"v1"},"components":{"schemas":{"ReindexJobStatus":{"type":"string","description":"Informs about status of reindex job. `PENDING` means that the maximum number of parallel `IN_PROGRESS` jobs is reached and such job will be processed when one of current `IN_PROGRESS` jobs is released. `PUBLISHED` means that all the indexing events were emitted. `SUCCESS` means that all the indexing events were consumed.","enum":["FAILURE","IN_PROGRESS","PENDING","PUBLISHED","SUCCESS"]}}}}
```

## The Metadata object

```json
{"openapi":"3.0.0","info":{"title":"Indexing Service","version":"v1"},"components":{"schemas":{"Metadata":{"type":"object","properties":{"createdAt":{"description":"Date and time when the object was created. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-30T13:18:02.379Z`","type":"string","format":"date-time"},"modifiedAt":{"description":"Date and time when the object was last modified. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-30T13:18:02.379Z`","type":"string","format":"date-time"}}}}}}
```

## The ReindexEntityType object

```json
{"openapi":"3.0.0","info":{"title":"Indexing Service","version":"v1"},"components":{"schemas":{"ReindexEntityType":{"type":"string","description":"Entity type to reindex. The following values are supported:\n* `PRODUCT`\n* `ORDER`\n* `CUSTOMER`\n* `LEGAL-ENTITY`\n\nYou can also use a custom schema type.\n\nValues are case-insensitive. `LEGAL-ENTITY` uses a hyphen, not an underscore."}}}}
```

## The ReindexJob object

```json
{"openapi":"3.0.0","info":{"title":"Indexing Service","version":"v1"},"components":{"schemas":{"ReindexJob":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the reindex job."},"entityType":{"$ref":"#/components/schemas/ReindexEntityType"},"message":{"type":"string","description":"In case if reindex job finishes with `FAILURE` status, the message is populated with information what was the reason of the failure."},"status":{"$ref":"#/components/schemas/ReindexJobStatus"},"expectedCount":{"type":"integer","description":"Expected number of entities which need to be indexed."},"processedCount":{"type":"integer","description":"Actual number of entities which were indexed. Allows to track the progress of reindexing process."},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"ReindexEntityType":{"type":"string","description":"Entity type to reindex. The following values are supported:\n* `PRODUCT`\n* `ORDER`\n* `CUSTOMER`\n* `LEGAL-ENTITY`\n\nYou can also use a custom schema type.\n\nValues are case-insensitive. `LEGAL-ENTITY` uses a hyphen, not an underscore."},"ReindexJobStatus":{"type":"string","description":"Informs about status of reindex job. `PENDING` means that the maximum number of parallel `IN_PROGRESS` jobs is reached and such job will be processed when one of current `IN_PROGRESS` jobs is released. `PUBLISHED` means that all the indexing events were emitted. `SUCCESS` means that all the indexing events were consumed.","enum":["FAILURE","IN_PROGRESS","PENDING","PUBLISHED","SUCCESS"]},"Metadata":{"type":"object","properties":{"createdAt":{"description":"Date and time when the object was created. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-30T13:18:02.379Z`","type":"string","format":"date-time"},"modifiedAt":{"description":"Date and time when the object was last modified. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-30T13:18:02.379Z`","type":"string","format":"date-time"}}}}}}
```

## The ReindexRequest object

```json
{"openapi":"3.0.0","info":{"title":"Indexing Service","version":"v1"},"components":{"schemas":{"ReindexRequest":{"type":"object","properties":{"entityType":{"$ref":"#/components/schemas/ReindexEntityType"},"rag":{"type":"boolean","default":false,"description":"Whether products should be reindexed for RAG. This property is applicable only when `entityType` is `PRODUCT`."}},"required":["entityType"]},"ReindexEntityType":{"type":"string","description":"Entity type to reindex. The following values are supported:\n* `PRODUCT`\n* `ORDER`\n* `CUSTOMER`\n* `LEGAL-ENTITY`\n\nYou can also use a custom schema type.\n\nValues are case-insensitive. `LEGAL-ENTITY` uses a hyphen, not an underscore."}}}}
```

## The IndexPublicConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Indexing Service","version":"v1"},"components":{"schemas":{"IndexPublicConfiguration":{"title":"IndexPublicConfiguration","type":"object","properties":{"searchKey":{"type":"string","description":"API Key used for search purposes."},"applicationId":{"type":"string","description":"Application id of an indexer provider."},"indexName":{"type":"string","description":"Identifier of an index."},"provider":{"type":"string","description":"Index provider name. Supported providers: `ALGOLIA` (https://www.algolia.com), `BATTERY_INCLUDED` (https://www.batteryincluded.io). Only one provider can be active per tenant at a time.","enum":["ALGOLIA","BATTERY_INCLUDED"]},"active":{"type":"boolean","description":"Indicates if the configuration is active or not."}}}}}}
```

## The IndexConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Indexing Service","version":"v1"},"components":{"schemas":{"IndexConfiguration":{"title":"IndexConfiguration","allOf":[{"$ref":"#/components/schemas/IndexPublicConfiguration"},{"type":"object","properties":{"writeKey":{"type":"string","description":"API key used for write purposes. For `BATTERY_INCLUDED`, this key is validated before the configuration is created or updated."},"apiUrl":{"type":"string","description":"Optional base URL of the BatteryIncluded API that holds the tenant's index, for example `https://api-next.batteryincluded.io`. Applies only to the `BATTERY_INCLUDED` provider.\nWhen set, the Indexing Service sends all of the tenant's BatteryIncluded requests to this host and validates `writeKey` against it, so the write key must be valid on this host. When not set, the default BatteryIncluded host is used.\nThe value must be an `https` address of an allowed BatteryIncluded host, without a path, query, fragment, user information, or port. A trailing slash is allowed. Other values are rejected with `400`. A change takes effect within 10 minutes. Change `apiUrl` when no product reindex is running. If the index on the new host does not yet hold all products, start a full product reindex after the change takes effect."},"excludedMixinKeys":{"type":"array","items":{"type":"string"},"description":"Optional list of root product mixin keys to exclude from indexing. When set, the specified mixin keys are omitted from both the non-localized and localized portions of the indexed document. Applies only to the `BATTERY_INCLUDED` provider."},"includedMixinPaths":{"type":"array","items":{"type":"string"},"description":"Optional allowlist of product mixin paths to include in indexing for the `BATTERY_INCLUDED` provider. Patterns are matched against full dot-notation paths rooted at the mixin key, for example `class_EA673_toolsClassification.sk.OnlineIsService_P`.\n`*` matches within a single path segment, `**` matches across one or more path segments, and matching is case sensitive.\nIf a matched path points to an object, the entire subtree under that object is included. When this field is absent or an empty list, path filtering is inactive and existing `excludedMixinKeys` behavior applies.\n`includedMixinPaths` and `excludedMixinKeys` are mutually exclusive when `includedMixinPaths` is non-empty. Malformed glob patterns are rejected with a validation error on configuration writes."},"enrichments":{"type":"array","items":{"type":"string","enum":["AVAILABILITY","PRICE","CUSTOMER_SEGMENT","FEE"]},"description":"Optional list of the Emporix data dependencies that BatteryIncluded product indexing calls. Applies only to the `BATTERY_INCLUDED` provider. The Product, Site Settings, and Configuration services are always called and are not listed.\n`AVAILABILITY` adds availability data, `PRICE` adds prices, and `CUSTOMER_SEGMENT` adds segment IDs to the site-specific data of the indexed document. `FEE` calls the Fee Service, but fee data is not part of the Battery Included document.\nWhen this field is not set, the default set `AVAILABILITY`, `PRICE`, and `CUSTOMER_SEGMENT` is used. An empty list means that no optional dependency is called. Values are case sensitive. The stored list is returned as sent. When the field is not set, the response does not contain it, and the default set applies.\nA dependency that is not listed is not called for any site. Its condition counts as met, so a site without prices or availability still contributes to the merged document when `PRICE` or `AVAILABILITY` is not listed. Its data is not part of the indexed document or of the `index.item-updated` webhook events. A change takes effect within 10 minutes. For details, see [How to choose the data that BatteryIncluded indexing uses](https://developer.emporix.io/api-documentation/api-guides/configuration/indexing-service/indexing#how-to-choose-the-data-that-batteryincluded-indexing-uses)."},"siteAwareMixinsStrategy":{"type":"string","enum":["FAN_OUT","INHERITANCE"],"description":"Optional strategy that defines where BatteryIncluded product indexing writes site-aware mixins. Applies only to the `BATTERY_INCLUDED` provider. A mixin is site-aware when the product has a `{mixin}__{site}` overlay for it, or when the schema file that the product references in `metadata.mixins` has `siteAware: true` at its root.\n`FAN_OUT` merges the base mixin with the site's overlay for every site that contributes to the merged document and every other site with an `_product_siteAware` entry, and writes the result to `_product_siteAware.<site>.mixins` and `_product_siteAware.<site>.localeAware.<language>.mixins`. A site without an overlay receives the base mixin. Neither the base mixin nor its overlays are written to `_product.mixins` or `_product_i18n.<language>.mixins`.\n`INHERITANCE` keeps the base mixin in `_product.mixins` and `_product_i18n.<language>.mixins`, and writes the merged value to `_product_siteAware.<site>.mixins` and `_product_siteAware.<site>.localeAware.<language>.mixins` only for sites that have an overlay.\nOverlay keys in the form `{mixin}__{site}` are not written to the document.\nWhen this field is not set, `FAN_OUT` is used. Values are case sensitive. The stored value is returned as sent. When the field is not set, the response does not contain it. A change takes effect within 10 minutes and applies to each product the next time it is updated or reindexed. To apply it to all products, start a full product reindex after the change takes effect. For details, see [How to choose site-aware mixins indexing for BatteryIncluded](https://developer.emporix.io/api-documentation/api-guides/configuration/indexing-service/indexing#how-to-choose-site-aware-mixins-indexing-for-batteryincluded)."}},"required":["provider"]}]},"IndexPublicConfiguration":{"title":"IndexPublicConfiguration","type":"object","properties":{"searchKey":{"type":"string","description":"API Key used for search purposes."},"applicationId":{"type":"string","description":"Application id of an indexer provider."},"indexName":{"type":"string","description":"Identifier of an index."},"provider":{"type":"string","description":"Index provider name. Supported providers: `ALGOLIA` (https://www.algolia.com), `BATTERY_INCLUDED` (https://www.batteryincluded.io). Only one provider can be active per tenant at a time.","enum":["ALGOLIA","BATTERY_INCLUDED"]},"active":{"type":"boolean","description":"Indicates if the configuration is active or not."}}}}}}
```

## The IndexCreationResponse object

```json
{"openapi":"3.0.0","info":{"title":"Indexing Service","version":"v1"},"components":{"schemas":{"IndexCreationResponse":{"title":"IndexCreationResponse","type":"object","properties":{"id":{"type":"string","description":"Identifier of a newly created configuration."}}}}}}
```

## The Reindex object

```json
{"openapi":"3.0.0","info":{"title":"Indexing Service","version":"v1"},"components":{"schemas":{"Reindex":{"title":"Reindex","type":"object","properties":{"mode":{"type":"string","enum":["FULL"],"description":"Indicates reindex mode. Supported modes: `FULL`."}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developer.emporix.io/api-documentation/api-guides/configuration/indexing-service/api-reference/models.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
