Skip to content
Orders
/
Alterar estágio do pedido

Integrador Pigz (1.1.0)

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.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
E-mail

dev@pigz.com.br

License

MIT

Languages
Servers
Mock server

https://docs.pigz.dev/_mock/openapi/

https://integrador.pigz.dev/

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

Auth

Autenticação e geração de token

Operations

Orders

Consulta e atualização de pedidos

Operations

Consultar pedidos

Request

Retorna os pedidos novos e cancelados desde a última consulta.
É necessário enviar um Bearer Token válido.

⚠️ Atenção: após receber um pedido, utilize o endpoint Change Stage Order para marcar como conhecido ou integrado. Assim o pedido não será enviado novamente.

Security
bearerAuth
curl -i -X GET \
  https://docs.pigz.dev/_mock/openapi/pooling \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Lista de pedidos retornados

Bodyapplication/jsonArray [
codigonumber

Código do pedido

Example: 1234
dataHorastring

Data e hora do pedido (ISO 8601)

Example: "2025-08-26T12:34:56Z"
clienteobject
itensArray of objects
pagamentoobject
statusstring

Status atual do pedido

Example: "confirmado"
tipoEntregastring

Tipo de entrega do pedido

Example: "delivery"
]
Response
application/json
[
  {
    "codigo": 1234,
    "dataHora": "2025-08-26T12:34:56Z",
    "cliente": { … },
    "itens": [ … ],
    "pagamento": { … },
    "status": "confirmado",
    "tipoEntrega": "delivery"
  }
]

Alterar estágio do pedido

Request

Atualiza o status de um pedido.
É necessário enviar um Bearer Token válido.

Estágios possíveis:

  • integrado ou conhecido: pedido recebido pelo PDV
  • confirmado: pedido aceito pela loja
  • despachado: pedido enviado para entrega
  • prontoRetirada: pedido pronto para retirada na loja
  • entregue: pedido entregue ao cliente
  • cancelado: pedido cancelado

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

Security
bearerAuth
Path
idintegerrequired

ID do Pedido

Example: 3105
stagestringrequired

Novo estágio do pedido

Example: conhecido
curl -i -X PUT \
  https://docs.pigz.dev/_mock/openapi/pedido/3105/conhecido \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Estágio atualizado com sucesso

Bodyapplication/json
messagestring
Example: "Altered Stage"
timenumber
Example: 959804400
Response
application/json
{
  "message": "Altered Stage",
  "time": 959804400
}

Merchant

Gerenciamento de abertura/fechamento de lojas

Operations