Skip to main content
GET
List inventory lots

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status
enum<string>

ACTIVE: dentro da validade, com volume disponível. DEPLETED: sem volume disponível (todo reservado ou utilizado); volta a ACTIVE se uma reserva for liberada dentro da validade. EXPIRED: passou de expiresAt; não aceita novos withdrawals. O tratamento do volume remanescente após a expiração será comunicado antes da disponibilidade geral. Enum extensível.

Available options:
ACTIVE,
DEPLETED,
EXPIRED
externalId
string
from
string<date-time>
to
string<date-time>
cursor
string

Cursor opaco retornado em pagination.nextCursor.

limit
integer
default:20
Required range: 1 <= x <= 100

Response

Lista paginada de Inventory Lots do cliente

data
object[]
required
pagination
object
required