Skip to main content
GET
List dispatches

Authorizations

Authorization
string
header
required

An API key created by the chain owner in the panel (Integrações → Nova chave), sent as Authorization: Bearer <key>. The key (<id>|na_…) is shown once, at creation; rotate or revoke it on the same screen. It is a server secret: never ship it in browser or mobile code.

Headers

Accept-Language
enum<string>

Language of message and of translated content such as item names (pt-BR or en). Without it, the chain's default language.

Available options:
pt-BR,
en
X-Request-Id
string

Your own correlation id (1–64 characters of A-Za-z0-9._-), echoed back; generated when absent. Quote it to support.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9._-]{1,64}$

Path Parameters

establishment
integer
required

The establishment ID

Query Parameters

item_id
integer
status
enum<string>
Available options:
pending,
processing,
dispatched,
failed,
cancelled,
scheduled
per_page
integer
Required range: 1 <= x <= 100
page
integer
default:1

Page number.

Response

Paginated set of Event

data
Event · object[]
required
meta
object
required