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

Merchant

Store open/close management

Operations

Open or close store

Request

Sets the store as open or closed.
The store will only open if it is within the configured business hours.

Accepted values:

  • open
  • close
Security
bearerAuth
Path
openOrClosestringrequired

Desired store status

Example: open
curl -i -X POST \
  https://docs.pigz.dev/_mock/openapi/merchant/open \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Estado da loja alterado

Bodyapplication/json
Messagestring
Example: "Opening state changed to close"
Response
application/json
{
  "Message": "Opening state changed to close"
}