> For the complete documentation index, see [llms.txt](https://docs.akinon.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.akinon.com/technical-guides/oms/inventory-locations-and-engine/inventory-engine.md).

# Inventory Engine

## <mark style="color:red;">Stock Engine Integration Configurations</mark>

The authentication features of the service to be integrated must be set to “auth” along side the full URL address of the service, and the mode of operation (single – plural query) must be set in the “service” field.

## <mark style="color:red;">Authentication</mark>​ <a href="#authentication" id="authentication"></a>

Authentication types supported by OMS Stock Integration services:

1. Anonymous
2. Basic Auth
3. Token Auth

Example of a service integration configuration that does not require authentication, and responds directly to GET requests:

```
{
    "auth": {
        "type": "anonymous"
    },
    "service": {
        "url": "https://yourstockservice.com/api/query/",
        "type":"..."
    }
}
```

Integration settings that require Basic Authentication:

```
{
    "auth": {
        "type": "basic_auth",
        "username": "XXXXXX",
        "password": "YYYYYY"
    },
    "service": {
        "url": "https://yourstockservice.com/api/query/",
        "type":"..."
    }
}
```

Integration settings that require Token Authentication:

```
{
    "auth": {
        "type": "token",
        "url": "https://yourdomain.com/authentication/service/",
        "username": "XXXXX",
        "password": "YYYYY"
    },
    "service": {
        "url": "https://yourstockservice.com/api/query/",
        "type":"..."
    }
}
```

## <mark style="color:red;">Service​</mark> <a href="#service" id="service"></a>

The return scheme of the service you will integrate is prepared depending on which of the multiple- or single-stock query methods was used. Examples include:

1. Multiple-Stock Query: “multiple” (RECOMMENDED)
2. Single-Stock Query: “single”

type information must be specified in the “service” setting group.

The settings of the integration that will enable the OMS to learn the stock status of all SKUs in the correct order with a single request:

```
{
    "auth": {...},
    "service": {
        "url": "https://yourstockservice.com/api/query/",
        "type":"multiple"
    }
}
```

Integration settings (single) that must be prepared in case the OMS is required to issue separate requests for each different SKU in the order to be planned:

```
{
    "auth": {...},
    "service": {
        "url": "https://yourstockservice.com/api/query/",
        "type":"single"
    }
}
```


---

# 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.akinon.com/technical-guides/oms/inventory-locations-and-engine/inventory-engine.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.