Skip to main content
GET
Batches

Authorizations

X-API-Key
string
header
required

Integration API Key (Integrations → New Integration).

Query Parameters

branch_id
string<uuid>
required

Branch (GET /branches). From another business → 404.

product_id
string<uuid>

Filter by product.

status
enum<string>

available with stock, expiring expiring within days days, expired already expired.

Available options:
available,
expiring,
expired
days
integer
default:30

Window for expiring (1–365, default 30).

Required range: 1 <= x <= 365
per_page
integer
default:50

Results per page (1–200, default 50).

Required range: 1 <= x <= 200
page
integer

Page.

Required range: x >= 1

Response

Success

status
boolean
required
Example:

true

data
object
required