Skip to content

Pigz Integrator (1.1.0)

What is the Pigz Integrator

The Pigz Integrator API allows third-party systems (such as POS systems or order platforms) to receive and manage orders from Pigz.

It is designed to integrate Pigz orders into Point of Sale (POS) systems or online ordering platforms.
Through this API, you can query new or canceled orders and update each order’s status according to the store’s operational flow.

Example Workflow

  1. A customer places an order on Pigz.
  2. The partner POS system periodically fetches orders via the Pooling endpoint.
  3. Once the order reaches the POS, it should confirm receipt using the Change Stage Order endpoint (stage = known or integrated).
  4. The POS then updates the order status through its lifecycle until it is delivered, picked up, or canceled.

This communication ensures synchronization between Pigz and partner systems.

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

Authentication and token generation

Operations

Orders

Order retrieval and status updates

Operations

Retrieve orders

Request

Returns new and canceled orders since the last request.
A valid Bearer Token must be provided.

⚠️ Important: After receiving an order, use the Change Stage Order endpoint
to mark it as known or integrated. Orders not marked will be sent again in future queries.

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

Responses

List of orders

Bodyapplication/jsonArray [
codigonumber
Example: 123
dataHorastring

Timestamp Unix em string

Example: "1633185348"
clienteobject(Cliente)
itensArray of objects(Item)
pagamentosArray of objects(Pagamento)
statusstring
Example: "PENDENTE"
descontonumber
Example: 10
subTotalnumber
Example: 43
totalnumber
Example: 39
taxaEntreganumber
Example: 6
tipoEntregastring
Enum"DELIVERY""RETIRADA"
Example: "RETIRADA"
entregadorstring
Example: "Leonercio Goesfeeld"
EnderecoRetiradaobject(EnderecoRetirada)
]
Response
application/json
[
  {
    "codigo": 123,
    "dataHora": "1633185348",
    "cliente": { … },
    "itens": [ … ],
    "pagamentos": [ … ],
    "status": "PENDENTE",
    "desconto": 10,
    "subTotal": 43,
    "total": 39,
    "taxaEntrega": 6,
    "tipoEntrega": "RETIRADA",
    "entregador": "Leonercio Goesfeeld",
    "EnderecoRetirada": { … }
  }
]

List orders

Request

Returns order list

Security
bearerAuth
Query
startstring

Start date

Example: start=2021-01-01
endstring

End date

Example: end=2021-01-01
curl -i -X GET \
  'https://docs.pigz.dev/_mock/openapi/orders?start=2021-01-01&end=2021-01-01' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of orders

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(Item)
pagamentosArray of objects(Pagamento)
statusstring

Status atual do pedido

Example: "CONFIRMADO"
tipoEntregastring

Tipo de entrega do pedido

Enum"DELIVERY""RETIRADA"
Example: "DELIVERY"
]
Response
application/json
[
  {
    "codigo": 1234,
    "dataHora": "2025-08-26T12:34:56Z",
    "cliente": { … },
    "itens": [ … ],
    "pagamentos": [ … ],
    "status": "CONFIRMADO",
    "tipoEntrega": "DELIVERY"
  }
]

Update order stage

Request

Updates the status of an order.
Requires a valid Bearer Token.

Available stages:

  • integrado or conhecido: order received by the POS
  • confirmado: order accepted by the store
  • despachado: order sent out for delivery
  • prontoRetirada: order ready for in-store pickup
  • entregue: order delivered to the customer
  • cancelado: order canceled

⚠️ Important: Do not mark an order as delivered and then attempt to cancel it afterward.

Security
bearerAuth
Path
idintegerrequired

Order ID

Example: 3105
stagestringrequired

New order stage

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

Responses

Stage successfully updated

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

Merchant

Store open/close management

Operations