# Integrador Pigz

# O que é o Integrador Pigz

A API do **Integrador Pigz** permite que sistemas terceiros (como PDVs ou plataformas de pedidos) recebam e manipulem pedidos da Pigz.

Ela foi projetada para integrar pedidos da Pigz em **sistemas de Ponto de Venda (PDV)** ou plataformas de captação de pedidos online. 
Através dela é possível consultar pedidos novos ou cancelados e atualizar o status de cada pedido conforme o fluxo de operação da loja.

### Exemplo de fluxo
1. Um cliente realiza um pedido na Pigz.
2. O sistema PDV parceiro consulta periodicamente os pedidos via `Pooling`.
3. Assim que o pedido chega ao PDV, ele deve confirmar o recebimento via `Change Stage Order` (stage = `conhecido` ou `integrado`).
4. O PDV atualiza os status seguintes até o pedido ser entregue, retirado ou cancelado.

Essa comunicação garante sincronização entre a Pigz e os sistemas parceiros.


Version: 1.1.0
License: MIT

## Servers

```
https://integrador.pigz.dev
```

```
https://integrador.pigz.com.br
```

## Security

### basicAuth

Type: http
Scheme: basic

### bearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[Integrador Pigz](https://docs.pigz.com.br/_spec/openapi.yaml)

## Auth

Autenticação e geração de token

### Gerar token de autenticação

 - [POST /authentication](https://docs.pigz.com.br/openapi/auth/authenticate.md): Gera um token JWT válido por 12 horas.  
É necessário enviar credenciais via  ( em Base64).


## Orders

Consulta e atualização de pedidos

### Consultar pedidos

 - [GET /pooling](https://docs.pigz.com.br/openapi/orders/getorders.md): Retorna os  desde a última consulta.  
É necessário enviar um .

⚠️ : após receber um pedido, utilize o endpoint  
para marcar como  ou . Assim o pedido não será enviado novamente.


### Alterar estágio do pedido

 - [PUT /pedido/{id}/{stage}](https://docs.pigz.com.br/openapi/orders/updateorderstage.md): Atualiza o .  
É necessário enviar um .

### Estágios possíveis:
-  ou : pedido recebido pelo PDV
- : pedido aceito pela loja
- : pedido enviado para entrega
- : pedido pronto para retirada na loja
- : pedido entregue ao cliente
- : pedido cancelado

⚠️ : não marque o pedido como  e depois tente cancelar.


## Merchant

Gerenciamento de abertura/fechamento de lojas

### Abrir ou fechar loja

 - [POST /merchant/{openOrClose}](https://docs.pigz.com.br/openapi/merchant/setmerchantstatus.md): Define a loja como aberta ou fechada.  
Somente abrirá se estiver dentro do horário de funcionamento.

### Valores aceitos:
-  ou 
-  ou