Flowls API 🦉
Bem-vindo(a) à documentação da API Flowls! Neste guia, vamos explicar de forma direta como usar nossa API REST.
Esta documentação foi criada para facilitar sua integração inicial com a API da Flowls.
Aqui você encontrará exemplos reais e funcionais, com os campos obrigatórios e fluxos mais utilizados no dia a dia.
Este material não cobre todos os campos possíveis da API — ele serve como base prática e confiável para colocar sua integração em funcionamento.
Para consultar a documentação completa da API, acesse o API Docs da Flowls.
Regras específicas da sua operação e campos personalizados (extra_fields) estão disponíveis na documentação exclusiva do seu ambiente.
Documentação completa do seu ambiente
Visão Geral da Integração
Este guia segue um passo a passo completo para integrar sua aplicação à Flowls:
- Criar um produto
Saiba como cadastrar um novo produto na plataforma. - Criar e gerenciar pedidos
Veja como gerar pedidos de compra ou venda. - Criar processos logísticos
Descubra como iniciar um processo logístico e conectar pedidos a ele. - Vincular intervenientes (handlers)
Aprenda a associar parceiros logísticos aos seus pedidos e processos. - Campos obrigatórios
Em cada etapa, destacamos os campos mínimos necessários para que a requisição seja aceita.
O que é REST?
A API Flowls segue o padrão REST (Representational State Transfer). Em termos simples, isso significa que você pode interagir com nossos serviços usando os métodos HTTP padrão, como GET, POST, PUT e DELETE. Esses métodos são a chave para solicitar, criar, atualizar e excluir recursos na nossa plataforma.
JSON
Todas as solicitações e respostas são formatadas em JSON. Certifique-se de definir o header Content-Type como application/json ao enviar dados para a API. Da mesma forma, nossas respostas também serão retornadas em JSON.
Próximos passos
Agora que você já conhece os principais conceitos e o fluxo geral de integração, siga com a leitura das seções ao lado para entender como utilizar cada recurso da API.
Se tiver dúvidas, entre em contato com nosso time de integração.
Vamos começar!