> For the complete documentation index, see [llms.txt](https://docs.hotwax.co/documents/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hotwax.co/documents/integrate-with-hotwax/components/available-to-promise/solr-facets.md).

# Solr Facets

solrFacets

## autoComplete SolrFacet

> Autocomplete options from a Solr JSON facet. Native maarg port of the OMS\
>             AutoCompleteSolrFacet screen: the facet definition named facetToSelect is taken\
>             from the facet block of jsonQuery when the caller predefines it there, otherwise\
>             from the merged component solr/{solrVersion}/Facets.json files (keyed\
>             coreName → docType → facet name, merged and cached like schema.json). An edismax\
>             fq is built from searchfield × term tokens and the facet is executed with rows=0\
>             via co.hotwax.solr.SolrQuery. The response is the same \[{id, label, value}] list\
>             the OMS endpoint returned.

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"4.0.0"},"tags":[{"name":"solrFacets","description":"solrFacets"}],"servers":[{"url":"https://demo-maarg.hotwax.io/rest/s1/available-to-promise"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"co.hotwax.search.SearchServices.autoCompleteSolrFacet.Out":{"type":"object","properties":{"response":{"type":"array"}}}}},"paths":{"/solrFacets":{"get":{"tags":["solrFacets"],"summary":"autoComplete SolrFacet","description":"Autocomplete options from a Solr JSON facet. Native maarg port of the OMS\n            AutoCompleteSolrFacet screen: the facet definition named facetToSelect is taken\n            from the facet block of jsonQuery when the caller predefines it there, otherwise\n            from the merged component solr/{solrVersion}/Facets.json files (keyed\n            coreName → docType → facet name, merged and cached like schema.json). An edismax\n            fq is built from searchfield × term tokens and the facet is executed with rows=0\n            via co.hotwax.solr.SolrQuery. The response is the same [{id, label, value}] list\n            the OMS endpoint returned.","parameters":[{"schema":{"type":"string","format":""},"name":"facetToSelect","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"coreName","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"collectionName","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"docType","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"searchfield","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"jsonQuery","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"noConditionFind","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"limit","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"q","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"term","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"offset","in":"query","required":false,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.search.SearchServices.autoCompleteSolrFacet.Out"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.hotwax.co/documents/integrate-with-hotwax/components/available-to-promise/solr-facets.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.