Bem-vindo à documentação do Integrador Pigz, a API que permite que sistemas terceiros (como PDVs ou plataformas de pedidos) recebam e manipulem pedidos da Pigz.
O Integrador Pigz foi projetado para facilitar a integração de pedidos, permitindo consultar novos pedidos ou cancelamentos, atualizar o status de pedidos e gerenciar o estado das lojas.
O Integrador Pigz possui endpoints para autenticação, consulta de pedidos, alteração de estágio de pedidos e abertura/fechamento de lojas.
Você precisará de um token de autenticação (JWT) para acessar a maioria dos endpoints. Este token é gerado via Basic Auth com email e senha de uma loja cadastrada na Pigz.
Esta página é a landing page da documentação do Integrador Pigz.
Você pode adicionar descrições, instruções de uso e links úteis aqui. Suporta Markdown e tags Markdoc.
O arquivo openapi.yaml contém a descrição completa da API do Integrador Pigz em formato OpenAPI 2.0 (Swagger).
Ele inclui:
- Autenticação (
/authentication) - Consulta de pedidos (
/pooling) - Alteração de estágio de pedidos (
/pedido/{id}/{stage}) - Abertura/fechamento de loja (
/merchant/{openOrClose})
Você pode baixar o arquivo e utilizá-lo em ferramentas como Swagger UI, Postman ou Redocly para testar a API ou gerar SDKs.
- Gere seu token enviando suas credenciais via
/authentication. - Use o Bearer Token para consultar pedidos com
/pooling. - Atualize o status dos pedidos usando
/pedido/{id}/{stage}. - Abra ou feche lojas com
/merchant/{openOrClose}conforme necessário.
⚠️ Atenção: Para que os pedidos não sejam enviados novamente, sempre marque o pedido como
conhecidoouintegradoapós recebê-lo.
- Guia do Reunite Editor para começar a editar sua documentação.
- Swagger UI para testar os endpoints.
- Postman para interagir com a API de forma prática.
Para dúvidas sobre integração, entre em contato com o suporte da Pigz.