> For the complete documentation index, see [llms.txt](https://ola.meajuda.cc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ola.meajuda.cc/extras/api-de-integracoes/api-delivery-and-retirada.md).

# API - Delivery & Retirada

A API Delivery permite integrar sistemas externos aos pedidos e ao estoque da loja. Além de consultar pedidos e atualizar seus status, você pode consultar insumos, fichas técnicas e movimentações, registrar entradas e saídas e ajustar saldos sem acessar o painel.

Link para documentação da API: <https://documenter.getpostman.com/view/569841/TzeXmntp>

Para usar os endpoints de estoque, envie o token da loja no header `Bearer` e o token do integrador no header `integrador-token`. Para obter o token da loja, acesse **Integrações → API** e copie o código exibido. Consulte a documentação técnica para configurar os headers das requisições.

<div data-with-frame="true"><figure><img src="https://3193212287-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-ME41abfRf7bWmvqahTl%2F-McVOe13FbTjOB1Eu70g%2F-McVQKNnSZAprUysQ7Gz%2FAPI.png?alt=media&amp;token=7063f592-3ba4-4952-9e98-3007e35dfc97" alt=""><figcaption></figcaption></figure></div>

Na tela lateral, copie o código do token gerado. Caso necessite gerar um novo token, clique no botão **Gerar Novo Token**.

<div data-with-frame="true"><figure><img src="https://3193212287-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-ME41abfRf7bWmvqahTl%2F-McVOe13FbTjOB1Eu70g%2F-McVQaWmLNmJF7Dn3QP4%2Fapi%20token.png?alt=media&amp;token=020a10c8-6ea4-4932-9bbe-adc61b52e6af" alt=""><figcaption></figcaption></figure></div>

## Consultar e movimentar estoque

1. Abra a [documentação da API Delivery](https://documenter.getpostman.com/view/569841/TzeXmntp).
2. Acesse a pasta **Estoque**.
3. Configure o token do integrador e o token da loja nas requisições.
4. Escolha a operação e siga os campos e exemplos da documentação.

A integração permite:

* Consultar insumos, produtos e complementos com saldo, unidade e categoria.
* Consultar as fichas técnicas dos itens e complementos.
* Listar movimentações por período, com filtros por insumo, item ou complemento.
* Registrar entradas e saídas de quantidade.
* Definir o saldo de um insumo ou de um item ou complemento com estoque simples.
* Criar, editar e excluir insumos de cadastro.
* Alterar o controle de estoque e a ficha técnica de itens e complementos.

{% hint style="success" %}
**Exemplo prático**

Ao receber uma compra de farinha, o sistema integrado pode registrar a entrada pela API. O saldo é atualizado e a alteração fica registrada como uma movimentação, sem precisar repetir o lançamento no painel.
{% endhint %}

{% hint style="info" %}
**Observações importantes**

* As operações usam os dados da loja identificada pelo token.
* A consulta de movimentações exige um período de até 31 dias por requisição.
* Alterações de saldo sempre geram movimentações. Ao definir um saldo, o sistema registra a diferença entre a quantidade atual e a informada.
* A operação de definir saldo não se aplica diretamente a itens controlados por ficha técnica. Nesses casos, ajuste os insumos que compõem a ficha.
* A exclusão pela API é permitida para insumos de cadastro, não para produtos ou complementos. Quando o insumo já possui movimentações, o cadastro é marcado como excluído para preservar o histórico.
  {% endhint %}

Para receber notificações quando o estoque mudar, veja [Notificações e Eventos (Webhook)](https://ola.meajuda.cc/extras/api-de-integracoes/notificacoes-e-eventos-webhook.md).
